v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

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

Query parameters

schemaNamestring required

Name of the schema to add attribute to

Example:projects

The name of the attribute schema.

Request body

fieldNamestring required

Field name used to uniquely identify the attribute

namestring required

Attribute name

nameKeystring

Attribute name key used for translation

descriptionstring

Attribute description

descriptionKeystring

Attribute description key used for translation

requiredboolean

Indicates if this attribute is required

allowOtherboolean

Indicates if user-specified values are allowed

Response type for the attribute

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

Source for attribute options

referenceCategoryIdsstring[]

List of category IDs associated with the attribute

formulastring

Formula expression for calculated attributes

sourcestring

Source of the attribute

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

Response sub type for the attribute

maxMultiSelectAllowedOptionValuesinteger

Maximum number of option values allowed for MultiSelect attributes

encryptedboolean

Indicates if this attribute should be encrypted

metadatastring

Metadata about the attribute in JSON format

validationRuleIdstring

ID of the validation rule to associate with 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",
  "abacBasicAssignmentInfo": [
    {
      "assignmentId": "550e8400-e29b-41d4-a716-446655440000",
      "assignmentName": "Assignment1",
      "policyStatus": "ACTIVE"
    }
  ]
}

Response

Created

idstring uuid

The unique identifier of the schema attribute.

namestring required

The name of the schema attribute.

nameKeystring

The translation key for schema attribute.

descriptionstring

The description of the schema attribute.

descriptionKeystring

The translation key for schema description.

fieldNamestring required

The field name of the schema attribute.

mappedFieldNamestring

The mapped field name for schema sorting.

enabledboolean required

The enabled flag for schema attribute.

requiredboolean

The required flag for schema attribute.

readOnlyboolean

The read-only flag for schema attribute.

encryptedboolean

The encryption flag for schema attribute.

allowOtherboolean

The user-defined options flag for schema.

baseAttributeboolean

The core entity flag for schema attribute.

The response type for schema attribute.

formulastring

The formula for schema attribute.

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

The option source type for schema.

optionAllowedboolean

The options allowed flag for schema.

schemaIdstring uuid

The schema identifier for attribute.

schemaNamestring

The schema name for attribute.

responseMaxLengthinteger

The max response length for schema.

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

The response subtype for schema.

multiSelectMaxOptionValuesinteger

The maximum multi-select options for schema.

hiddenboolean

The hidden flag for schema attribute.

optionUrlstring

The option URL for schema attribute.

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

The deletion marker for schema attribute.

validationRuleIdstring

The validation rule for schema attribute.

optionsByDomainobject

Override options by Domain

formulaByDomainobject

Formula by Domain

Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues

associatedAttributeFieldNamestring

The associated field name for schema.

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/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages",
    "optionListUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details",
    "optionType": "BusinessLocations",
    "applicationUrl": "/settings/location-management/location/Location"
  },
  "validationRuleId": "email",
  "abacBasicAssignmentInfo": [
    {
      "assignmentId": "550e8400-e29b-41d4-a716-446655440000",
      "assignmentName": "Assignment1",
      "policyStatus": "ACTIVE"
    }
  ],
  "displayResponseType": "SingleSelect"
}