ONonetrust
Object Attribute Management

Add Attribute to Schema

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.
post/v1/schema-attributes

Request

  • Base URL
    https://hostname/api/custom-entity
  • URL
    https://hostname/api/custom-entity/v1/schema-attributes
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: OBJECT_MANAGER, OBJECT_MANAGER_WRITE, INTEGRATION

Query parameters

schemaNamestring required

Name of the schema to add attribute to

Example:projects

The name of the attribute schema.

Request body

fieldNamestring required

The fieldName parameter value of the attribute.

namestring required

The name of the attribute.

nameKeystring

The name key of the attribute used for translation purposes.

descriptionstring

The description of the attribute.

descriptionKeystring

The description key of the attribute used for translation purposes.

requiredboolean

This flag indicates whether the attribute is required.

allowOtherboolean

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

responseType'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'Formula' | 'Score' | 'Level' | 'Range' required

The type of response associated with the attribute value.

optionType'None' | 'Static' | 'Dynamic'

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

referenceCategoryIdsstring[]

The list of category identifiers of the attribute.

formulastring

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

sourcestring

The source of the attribute.

responseSubType'STANDARD' | 'FORMULA' | 'MATRIX'

The type of scoring method associated with the attribute value.

maxMultiSelectAllowedOptionValuesinteger

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

encryptedboolean

This flag indicates whether the attribute is encrypted.

metadatastring

The metadata details of the attribute option.

validationRuleIdstring

The validation rule configured for the attribute.

Example request

{
  "fieldName": "nameOfRecord",
  "name": "Type of the Record",
  "nameKey": "IM.Name",
  "description": "Gather Type for the record - provide some value related to nature of record",
  "descriptionKey": "IM.Name.Description",
  "responseType": "Text",
  "optionType": "None",
  "options": [
    {
      "option": "Example Option",
      "optionKey": "example_option",
      "optionSelectionValue": "value1",
      "colorCode": "#FFFFFF"
    }
  ],
  "referenceCategoryIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "formula": "Default:Field4 + Default:Field3 + 100",
  "source": "system",
  "responseSubType": "STANDARD",
  "associatedAttributeRequest": {
    "associatedAttributes": [
      {
        "options": [
          {
            "option": "Example Option",
            "optionKey": "example_option",
            "optionSelectionValue": "value1",
            "colorCode": "#FFFFFF"
          }
        ]
      }
    ]
  },
  "maxMultiSelectAllowedOptionValues": 10,
  "validationRuleId": "email"
}

Response

Created

idstring uuid

The unique identifier of the attribute.

namestring required

The name of the attribute.

nameKeystring

The name key of the attribute used for translation purposes.

descriptionstring

The description of the attribute.

descriptionKeystring

The description key of the attribute used for translation purposes.

fieldNamestring required

The fieldName parameter value of the attribute.

mappedFieldNamestring

The mapped attribute field name.

enabledboolean required

This flag indicates whether the attribute is enabled.

requiredboolean

This flag indicates whether the attribute is required.

readOnlyboolean

This flag indicates whether the attribute is read-only.

encryptedboolean

This flag indicates whether the attribute is encrypted.

allowOtherboolean

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

baseAttributeboolean

This flag indicates whether the attribute is a system attribute.

responseType'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'Formula' | 'Score' | 'Level' | 'Range'

The type of response associated with the attribute value.

formulastring

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

optionType'None' | 'Static' | 'Dynamic'

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

optionAllowedboolean

This flag indicates whether options were configured for the attribute.

schemaIdstring uuid

The unique identifier of the attribute schema.

schemaNamestring

The name of the attribute schema.

responseMaxLengthinteger

The maximum number of characters that can be entered for the attribute value.

responseSubType'STANDARD' | 'FORMULA' | 'MATRIX'

The type of scoring method associated with the attribute value.

multiSelectMaxOptionValuesinteger

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

hiddenboolean

This flag indicates whether the attribute is hidden.

optionUrlstring

The URL of the attribute option.

deleteMarker'MARKED_FOR_DELETE' | 'DELETING' | 'DELETED'

The deletion status of the attribute.

validationRuleIdstring

The validation rule configured for the attribute.

associatedAttributeFieldNamestring

The fieldName parameter value of the attribute.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Type of the Record",
  "nameKey": "IM.Name",
  "description": "Gather Type for the record - provide some value related to nature of record",
  "descriptionKey": "IM.Name.Description",
  "fieldName": "nameOfRecord",
  "mappedFieldName": "name",
  "enabled": true,
  "responseType": "Text",
  "formula": "Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)",
  "optionType": "None",
  "schemaId": "550e8400-e29b-41d4-a716-446655440000",
  "schemaName": "vendors",
  "options": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "option": "TypeA",
      "optionKey": "IM.TypeA",
      "colorCode": "#FF5733",
      "sequence": 1,
      "enabled": true
    }
  ],
  "referenceCategories": [
    {
      "name": "Financial Category",
      "nameKey": "IM.FinancialCategoryName"
    }
  ],
  "responseMaxLength": 4000,
  "responseSubType": "STANDARD",
  "associatedAttributeInformation": [
    {
      "name": "Count of members",
      "nameKey": "IM.CountOfMembersName",
      "description": "Provide details about count associated with this attribute",
      "descriptionKey": "IM.CountOfMembersDesc",
      "schemaName": "risk",
      "fieldName": "countOfMembers",
      "mappedFieldName": "count",
      "formula": "sum(1, 3)",
      "options": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "option": "TypeA",
          "optionKey": "IM.TypeA",
          "colorCode": "#FF5733",
          "sequence": 1,
          "enabled": true
        }
      ]
    }
  ],
  "multiSelectMaxOptionValues": 10,
  "optionUrl": "/api/risk-v2/risk-categories",
  "deleteMarker": "MARKED_FOR_DELETE",
  "optionMetadata": {
    "entityTypeName": "Location",
    "basicServiceContextPath": "/api/location",
    "optionUrl": "/api/location/ui/v1/entity-types/names/Location/entities/basic-details"
  },
  "validationRuleId": "email"
}

Changes

No recorded changes to this operation across all 1 revision of this API.