myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Add Attribute to Schema

post
https://{hostname}/api/custom-entity/v1/schema-attributes

Use this API to add an attribute to a specific schema.

🗒

Things to Know

  • This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
Query Params
string
required

The name of the attribute schema.

Body Params
string
required
length ≤ 100

The fieldName parameter value of the attribute.

string
required
length between 1 and 255

The name of the attribute.

string
length ≤ 255

The name key of the attribute used for translation purposes.

string
length ≤ 1000

The description of the attribute.

string
length ≤ 255

The description key of the attribute used for translation purposes.

boolean
Defaults to false

This flag indicates whether the attribute is required.

boolean
Defaults to false

This flag indicates whether Other can be selected as an option for the attribute value.

string
enum
required

The type of response associated with the attribute value.

string
enum
length ≤ 50
Defaults to None

The type of system list used to source the attribute options.

Allowed:
options
array of objects

The options for the attribute.

options
referenceCategoryIds
array of uuids

The list of category identifiers of the attribute.

referenceCategoryIds
string
length ≤ 4000

The mathematical formula containing functions and other numerical attributes that is used to calculate the attribute value.

context
object

The contextual details of the attribute.

string
length ≤ 50

The source of the attribute.

string
enum

The type of scoring method associated with the attribute value.

Allowed:
associatedAttributeRequest
object

The attributes to add to the schema.

int32
1 to 100

The maximum number of options that can be selected for the attribute.

boolean
Defaults to false

This flag indicates whether the attribute is encrypted.

string

The metadata details of the attribute option.

intakeQuestion
object

The details of the attribute intake question.

string
length ≤ 255

The validation rule configured for the attribute.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 3 required scopes
URL
Response 
 Choose an example:
application/json
*/*
Updated 4 months ago