---
title: "Add Options to Attribute"
method: POST
path: "/api/ai-governance/v1/schema-attribute-options"
tags: ["Attribute Management"]
---

# Add Options to Attribute

`POST /api/ai-governance/v1/schema-attribute-options`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/ai-governance/v1/schema-attribute-options`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `AI_GOVERNANCE`, `AI_GOVERNANCE_WRITE`

Use this API to add options to an attribute.

> 🗒 Things to Know
> 
> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
> - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.

## Query parameters

- `attributeId` string, uuid, required

## Request body

- AttributeOptionRequest[]: Array of attribute options
  - `option` string, required: The option text to be displayed
  - `optionKey` string: Option key which can be used for translation and internationalization
  - `optionSelectionValue` string: Option selection value used to identify the option in forms or programmatic interfaces
  - `colorCode` '#000000' | '#FFFFFF' | '#FF0000' | '#00FF00' | '#0000FF': Color code in hexadecimal format for UI representation
  - `metadata` AttributeOptionMetadata
    - `hint` string: Hint
    - `hintKey` string: Hint key which can be used for translation

## Response `200`

OK

- AttributeInformation
  - `id` string, uuid: Attribute GUID
  - `name` string, required: Attribute name
  - `nameKey` string: Attribute name key which can be used for translation
  - `description` string: Attribute description
  - `descriptionKey` string: Attribute description key which can be used for translation
  - `fieldName` string, required: Attribute field name which can be used for uniquely identifying an attribute
  - `mappedFieldName` string: Mapped Attribute field name. Should be used for sorting
  - `enabled` boolean, required: Indicator for attribute enabled/disabled
  - `required` boolean: Indicator for mandatory attribute
  - `readOnly` boolean: Indicator for read only attribute
  - `encrypted` boolean: Indicate whether to encrypt the field value or not. Only supported for text, single select and multi select
  - `allowOther` boolean: Indicator for allowing user defined options for attribute
  - `baseAttribute` boolean: Indicate if attribute is part of extendable entity and which cannot be modified
  - `responseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'Formula' | 'Score' | 'Level' | 'Range': Response type for attribute
  - `formula` string: Formula for attribute
  - `optionType` 'None' | 'Static' | 'Dynamic': Attribute Options value source type
  - `optionAllowed` boolean: Indicate if attribute can have static options or not
  - `schemaId` string, uuid: Attribute Schema GUID
  - `schemaName` string: Attribute Schema Name
  - `options` AttributeOptionInformation[]: Option's for given attribute based on response type
    - `id` string, uuid: Option GUID
    - `option` string, required: Option name
    - `optionKey` string: Option Key which can be used for translation
    - `colorCode` string: Color code for the option
    - `sequence` integer: Option sequence for ordering
    - `enabled` boolean: Indicates if the option is enabled or disabled
    - `metadata` AttributeOptionMetadata
      - `hint` string: Hint
      - `hintKey` string: Hint key which can be used for translation
  - `referenceCategories` CategoryInformation[]: Categories for given attribute
    - `id` string, uuid: Category unique identifier
    - `name` string: Category name
    - `nameKey` string: Category nameKey for localization support
  - `responseMaxLength` integer: Response max length
  - `responseSubType` 'STANDARD' | 'FORMULA' | 'MATRIX': Response sub type
  - `associatedAttributeInformation` AssociatedAttributeInformation[]: Associated attribute information
    - `id` string, uuid, required: Associated Attribute GUID
    - `name` string: Name
    - `nameKey` string: Name key
    - `description` string: Description
    - `descriptionKey` string: Description Key
    - `schemaId` string, uuid: Attribute Schema GUID
    - `schemaName` string: Attribute Schema Name
    - `fieldName` string, required: Attribute field name
    - `mappedFieldName` string: Mapped Attribute field name. Should be used for sorting
    - `enabled` boolean, required: Indicator for attribute enabled/disabled
    - `responseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'DateTime' | 'NumericalText' | 'NumericalSingleSelect' | 'RadioButton' | 'TextArea' | 'Formula' | 'Level' | 'Range' | 'Score' | 'System', required: Response Type
    - `responseSubType` 'Standard' | 'Formula' | 'Matrix' | 'RollUp': Response sub type
    - `formula` string: Formula for attribute
    - `options` AttributeOptionInformation[]: Attribute options
      - `id` string, uuid: Option GUID
      - `option` string, required: Option name
      - `optionKey` string: Option Key which can be used for translation
      - `colorCode` string: Color code for the option
      - `sequence` integer: Option sequence for ordering
      - `enabled` boolean: Indicates if the option is enabled or disabled
      - `metadata` AttributeOptionMetadata
        - `hint` string: Hint
        - `hintKey` string: Hint key which can be used for translation
    - `optionsByDomain` object: Override options by Domain
  - `multiSelectMaxOptionValues` integer: MultiSelect max option values
  - `hidden` boolean: Hidden
  - `optionUrl` string: OptionUrl
  - `intakeQuestion` IntakeQuestion
    - `nameKey` string
    - `name` string
    - `descriptionKey` string
    - `description` string
  - `deleteMarker` 'MARKED_FOR_DELETE' | 'DELETING' | 'DELETED': Indicate the status of an attribute's deletion process
  - `optionMetadata` AttributeOptionMetadataInformation
    - `entityTypeName` string: Option Source Entity Type
    - `basicServiceContextPath` string: Basic Url for the Option source Service
    - `optionUrl` string: Api URL for the Drop Down Api
    - `optionListUrl` string: Api URL for the Drop Down Api. Complete List of entities
    - `viewType` string: This will help to identify the view type of list
    - `optionType` string: Option Type
    - `permissions` string[]: Permissions
    - `applicationUrl` string: Application Url
  - `validationRuleId` string: Validation Rule configured for Attribute (e.g., email, URL)
  - `abacBasicAssignmentInfo` AbacBasicAssignmentInfo[]: Contains the id, name and ObjectType of the linked assignment
    - `assignmentId` string, uuid: GUID of the linked assignment
    - `assignmentName` string: Name of the linked assignment
    - `policyStatus` 'INACTIVE' | 'ACTIVE' | 'PROCESSING' | 'FAILED': Policy status of the linked assignment
  - `optionsByDomain` object: Override options by Domain
  - `formulaByDomain` object: Formula by Domain
  - `displayResponseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'DateTime' | 'NumericalText' | 'NumericalSingleSelect' | 'RadioButton' | 'TextArea' | 'Formula' | 'Level' | 'Range' | 'Score' | 'System': Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues
  - `associatedAttributeFieldName` string

## Other responses

- `201`: Created
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/ai-governance-ai-governance.md) - [All operations](https://skmtc.dev/onetrust/apis/ai-governance-ai-governance/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/ai-governance-ai-governance/revisions/e6d435472846?raw)