openapi: 3.2.0
info:
  title: AI Governance - AI Governance Attribute Management API
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: The AI Governance APIs are used to integrate external systems and streamline the flow of data with AI Governance in the OneTrust Platform.
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:
- name: Attribute Management
  description: The Attribute Management APIs are used to manage attributes associated with AI Governance entities.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
paths:
  /api/ai-governance/v1/schema-attribute-options:
    post:
      operationId: addOptionsUsingPOST
      summary: Add Options to Attribute
      description: '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.'
      tags:
      - Attribute Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters:
      - name: attributeId
        in: query
        description: Unique identifier of the attribute to which options will be added
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: Array of attribute options
              type: array
              items:
                $ref: '#/components/schemas/AttributeOptionRequest'
            examples:
              Simple Options Example:
                summary: Add basic options to an attribute
                description: Adds three simple options to a select attribute
                value:
                - option: e
                  optionKey: OneTrustApp.OM.CustomEntity.Attributes.a736fc55-7e46-49a5-9e32-c4e3e25d6684
                - option: f
                  optionKey: OneTrustApp.OM.CustomEntity.Attributes.46fe357c-f1e1-475d-8ee0-45359e6debbb
                - option: g
                  optionKey: OneTrustApp.OM.CustomEntity.Attributes.06f7fbb3-dddb-40b9-aa5f-00a7271da9e3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: Attribute details with added options
                $ref: '#/components/schemas/AttributeInformation'
              examples:
                Updated Attribute With Options:
                  summary: Response showing attribute with added options
                  description: Details of the attribute after new options were added
                  value:
                    id: 123e4567-e89b-12d3-a456-426614174001
                    name: Category_select
                    nameKey: OneTrustApp.OM.CustomEntity.Attributes.123e4567-e89b-12d3-a456-426614174001
                    description: Selection of available categories
                    descriptionKey: OneTrustApp.OM.CustomEntity.Attributes.5591a97c-3dbf-4ba9-8770-11ed6c3e9172
                    encrypted: false
                    enabled: true
                    required: false
                    responseType: SingleSelect
                    scoreLevelName: ''
                    options:
                    - option: a
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.79b34d2e-1426-401e-83b2-4fb29c67ac12
                    - option: b
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.b2a71c8e-7f80-4e87-9e6d-54f2acb93f15
                    - option: c
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.a1fc2c44-3d8e-4376-af6c-2bdd33a4e0c9
                    - option: d
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.5ae7d232-0489-4f9d-9645-7a56f3a0a190
                    - option: e
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.a736fc55-7e46-49a5-9e32-c4e3e25d6684
                    - option: f
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.46fe357c-f1e1-475d-8ee0-45359e6debbb
                    - option: g
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.06f7fbb3-dddb-40b9-aa5f-00a7271da9e3
                    optionType: none
                    referenceCategoryIds: []
                    responseSubType: null
                    maxMultiSelectAllowedOptionValues: null
                    metadata: ''
                    formula: null
                    createdBy: admin@example.com
                    createdTime: '2025-06-18T10:30:15.123Z'
                    lastModifiedBy: admin@example.com
                    lastModifiedTime: '2025-06-18T10:59:44.987Z'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeInformation'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
  /api/ai-governance/v1/schema-attributes:
    post:
      operationId: addAttributeUsingPOST
      summary: Add Attribute to Schema
      description: 'Use this API to add an attribute to a specific schema.


        > 🗒 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.'
      tags:
      - Attribute Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters:
      - name: schemaName
        in: query
        description: Name of the schema where the attribute will be created
        required: true
        schema:
          type: string
        example: datasets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttributeCreateRequest'
            examples:
              Text Attribute Example:
                summary: Create a simple text attribute
                description: Creates a basic text attribute for the specified schema
                value:
                  name: Text Demo Attr
                  scoreLevelName: ''
                  description: Text Demo Attr
                  responseType: Text
                  required: false
                  encrypted: false
                  allowOther: false
                  options: []
                  optionType: none
                  referenceCategoryIds: []
                  formula: null
                  context:
                    parameters:
                      RecomputeFormulaEntities: false
                  responseSubType: null
                  maxMultiSelectAllowedOptionValues: null
                  metadata: ''
              Single Select Attribute Example:
                summary: Create a single select attribute with options
                description: Creates a single select attribute with predefined options
                value:
                  name: Country List Single Select Attribute
                  scoreLevelName: ''
                  description: Country List Single Select Attribute
                  responseType: SingleSelect
                  required: false
                  encrypted: false
                  allowOther: false
                  options:
                  - option: India
                    optionKey: OneTrustApp.OM.CustomEntity.Attributes.734b69e1-4b53-4f45-a1c2-034a72793d89
                  - option: Bangladesh
                    optionKey: OneTrustApp.OM.CustomEntity.Attributes.622816f4-2d9c-41af-bae5-a49e5640c1d9
                  - option: China
                    optionKey: OneTrustApp.OM.CustomEntity.Attributes.449957d1-112c-403b-87fc-92eb591d4957
                  - option: USA
                    optionKey: OneTrustApp.OM.CustomEntity.Attributes.89175fa8-c181-409d-8a86-9403ea61b81e
                  optionType: none
                  referenceCategoryIds: []
                  formula: null
                  context:
                    parameters:
                      RecomputeFormulaEntities: false
                  responseSubType: null
                  maxMultiSelectAllowedOptionValues: 1
                  metadata: ''
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                description: Created attribute details
                $ref: '#/components/schemas/AttributeInformation'
              examples:
                Text Attribute Response:
                  summary: Response for created text attribute
                  description: Details of the created text attribute
                  value:
                    id: 347f4ba0-d705-43c6-a138-16424efb5823
                    name: Text Demo Attr
                    nameKey: Attributes.l5ahlovqi5cstbwen6m3ca7cua
                    description: Text Demo Attr
                    descriptionKey: Attributes.dqiw2vt4uvhizhpjlxaolkknni
                    fieldName: attributeTextValue.value1_3
                    mappedFieldName: attributeTextValue.value1
                    enabled: true
                    required: false
                    readOnly: false
                    encrypted: false
                    allowOther: false
                    baseAttribute: false
                    responseType: Text
                    formula: null
                    optionType: none
                    optionAllowed: false
                    schemaId: 61d99b0d-e980-4339-ac90-2bb21d63da88
                    schemaName: datasets
                    responseMaxLength: 1000
                    source: null
                    responseSubType: null
                    multiSelectMaxOptionValues: null
                    hidden: false
                    abacBasicAssignmentInfo: null
                    associatedAttributeFieldName: null
                Single Select Attribute Response:
                  summary: Response for created single select attribute
                  description: Details of the created single select attribute with options
                  value:
                    id: fc2a023f-b74d-4780-b14a-18f7c6a7cddd
                    name: Country List Single Select Attribute
                    nameKey: Attributes.t5s5j4gsnjfdpfumdivsyepbri
                    description: Country List Single Select Attribute
                    descriptionKey: Attributes.lofo7dsaubaavnxxveqpnsnhwq
                    fieldName: attributeSingleSelectValue.value1_5
                    mappedFieldName: null
                    enabled: true
                    required: false
                    readOnly: false
                    encrypted: false
                    allowOther: false
                    baseAttribute: false
                    responseType: SingleSelect
                    formula: null
                    optionType: none
                    optionAllowed: true
                    schemaId: 61d99b0d-e980-4339-ac90-2bb21d63da88
                    schemaName: datasets
                    options:
                    - id: aadc7dd3-7cf8-4633-80e6-e74326657ae0
                      option: Bangladesh
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.622816f4-2d9c-41af-bae5-a49e5640c1d9
                      enabled: true
                    - id: 887ea48e-a278-4424-86ec-e1f6d6e6d131
                      option: China
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.449957d1-112c-403b-87fc-92eb591d4957
                      enabled: true
                    - id: bf58906f-b4bb-4f75-8a49-83eb1dddd4f8
                      option: India
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.734b69e1-4b53-4f45-a1c2-034a72793d89
                      enabled: true
                    - id: 0a91f37a-ad9c-408f-ba4e-4f3bb2774f11
                      option: USA
                      optionKey: OneTrustApp.OM.CustomEntity.Attributes.89175fa8-c181-409d-8a86-9403ea61b81e
                      enabled: true
                    responseMaxLength: 400
                    source: null
                    responseSubType: null
                    multiSelectMaxOptionValues: 1
                    hidden: false
                    abacBasicAssignmentInfo: null
                    associatedAttributeFieldName: null
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
  /api/ai-governance/v1/schema-attributes/{attributeId}/disable:
    put:
      operationId: disableAttributeUsingPUT
      summary: Disable Attribute
      description: 'Use this API to disable 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.'
      tags:
      - Attribute Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters:
      - name: schemaId
        in: query
        description: Unique identifier of the schema containing the attribute
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      - name: attributeId
        in: path
        description: Unique identifier of the attribute to be disabled
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: Disabled attribute details
                $ref: '#/components/schemas/AttributeInformation'
              examples:
                Disabled Attribute Response:
                  summary: Response after disabling an attribute
                  description: Details of the attribute after it has been disabled
                  value:
                    id: 1ba369d0-ebcd-4340-82ff-aab02f94ae9d
                    name: Test 1
                    nameKey: OneTrustApp.AIG.Attributes.c19fc626-5e0d-4104-b35b-7a6bea71c8c3
                    description: Test 1
                    descriptionKey: OneTrustApp.AIG.Attributes.16f33cf1-a6cc-4ed6-859b-4f66021b380e
                    fieldName: attributeTextValue.value2_32
                    mappedFieldName: attributeTextValue.value2
                    enabled: false
                    required: false
                    readOnly: false
                    encrypted: false
                    allowOther: false
                    baseAttribute: false
                    responseType: Text
                    formula: null
                    optionType: none
                    optionAllowed: false
                    schemaId: 060ef603-4948-4dc6-89da-bd095ab52cfe
                    schemaName: aisystems
                    responseMaxLength: 1000
                    source: null
                    responseSubType: null
                    multiSelectMaxOptionValues: null
                    hidden: false
                    abacBasicAssignmentInfo: null
                    associatedAttributeFieldName: null
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
  /api/ai-governance/v1/schema-attributes/{attributeId}/enable:
    put:
      operationId: enableAttributeUsingPUT
      summary: Enable Attribute
      description: 'Use this API to enable 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.'
      tags:
      - Attribute Management
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/ai-governance.json
      parameters:
      - name: schemaId
        in: query
        description: Unique identifier of the schema containing the attribute
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      - name: attributeId
        in: path
        description: Unique identifier of the attribute to be enabled
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: Enabled attribute details
                $ref: '#/components/schemas/AttributeInformation'
              examples:
                Enabled Attribute Response:
                  summary: Response after enabling an attribute
                  description: Details of the attribute after it has been enabled
                  value:
                    id: 1ba369d0-ebcd-4340-82ff-aab02f94ae9d
                    name: Test 1
                    nameKey: OneTrustApp.AIG.Attributes.c19fc626-5e0d-4104-b35b-7a6bea71c8c3
                    description: Test 1
                    descriptionKey: OneTrustApp.AIG.Attributes.16f33cf1-a6cc-4ed6-859b-4f66021b380e
                    fieldName: attributeTextValue.value2_32
                    mappedFieldName: attributeTextValue.value2
                    enabled: true
                    required: false
                    readOnly: false
                    encrypted: false
                    allowOther: false
                    baseAttribute: false
                    responseType: Text
                    formula: null
                    optionType: none
                    optionAllowed: false
                    schemaId: 060ef603-4948-4dc6-89da-bd095ab52cfe
                    schemaName: aisystems
                    responseMaxLength: 1000
                    source: null
                    responseSubType: null
                    multiSelectMaxOptionValues: null
                    hidden: false
                    abacBasicAssignmentInfo: null
                    associatedAttributeFieldName: null
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - AI_GOVERNANCE
        - AI_GOVERNANCE_WRITE
components:
  schemas:
    AttributeFormulaDetail:
      type: object
      properties:
        formula:
          type: string
        formulaType:
          type: string
    AttributeInformation:
      type: object
      properties:
        id:
          description: Attribute GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          description: Attribute name
          type: string
          example: Type of the Record
          maxLength: 255
          minLength: 1
        nameKey:
          description: Attribute name key which can be used for translation
          type: string
          example: IM.Name
          maxLength: 255
        description:
          description: Attribute description
          type: string
          example: Gather Type for the record - provide some value related to nature of record
          maxLength: 1000
        descriptionKey:
          description: Attribute description key which can be used for translation
          type: string
          example: IM.Name.Description
          maxLength: 255
        fieldName:
          description: Attribute field name which can be used for uniquely identifying an attribute
          type: string
          example: nameOfRecord
          maxLength: 100
          minLength: 1
        mappedFieldName:
          description: Mapped Attribute field name. Should be used for sorting
          type: string
          example: name
          maxLength: 100
        enabled:
          description: Indicator for attribute enabled/disabled
          type: boolean
          example: true
          default: 'true'
        required:
          description: Indicator for mandatory attribute
          type: boolean
          example: false
          default: 'false'
        readOnly:
          description: Indicator for read only attribute
          type: boolean
          example: false
          default: 'false'
        encrypted:
          description: Indicate whether to encrypt the field value or not. Only supported for text, single select and multi select
          type: boolean
          example: false
          default: 'false'
        allowOther:
          description: Indicator for allowing user defined options for attribute
          type: boolean
          example: false
          default: 'false'
        baseAttribute:
          description: Indicate if attribute is part of extendable entity and which cannot be modified
          type: boolean
          example: false
          default: 'false'
        responseType:
          description: Response type for attribute
          type: string
          example: Text
          enum:
          - Text
          - SingleSelect
          - MultiSelect
          - Date
          - Formula
          - Score
          - Level
          - Range
        formula:
          description: Formula for attribute
          type: string
          example: Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)
          maxLength: 4000
        optionType:
          description: Attribute Options value source type
          type: string
          example: None
          enum:
          - None
          - Static
          - Dynamic
        optionAllowed:
          description: Indicate if attribute can have static options or not
          type: boolean
          example: false
          default: 'false'
        schemaId:
          description: Attribute Schema GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        schemaName:
          description: Attribute Schema Name
          type: string
          example: vendors
          maxLength: 100
        options:
          description: Option's for given attribute based on response type
          type: array
          items:
            $ref: '#/components/schemas/AttributeOptionInformation'
        referenceCategories:
          description: Categories for given attribute
          type: array
          items:
            $ref: '#/components/schemas/CategoryInformation'
        responseMaxLength:
          description: Response max length
          type: integer
          format: int32
          example: 4000
          default: '4000'
          maximum: 4000
          minimum: 1
        responseSubType:
          description: Response sub type
          type: string
          example: STANDARD
          enum:
          - STANDARD
          - FORMULA
          - MATRIX
        associatedAttributeInformation:
          description: Associated attribute information
          type: array
          items:
            $ref: '#/components/schemas/AssociatedAttributeInformation'
        multiSelectMaxOptionValues:
          description: MultiSelect max option values
          type: integer
          format: int32
          example: 10
          maximum: 100
          minimum: 1
        hidden:
          description: Hidden
          type: boolean
          example: false
          default: 'false'
        optionUrl:
          description: OptionUrl
          type: string
          example: /api/risk-v2/risk-categories
          maxLength: 255
        intakeQuestion:
          description: Attribute Intake Question Details
          $ref: '#/components/schemas/IntakeQuestion'
        deleteMarker:
          description: Indicate the status of an attribute's deletion process
          type: string
          example: MARKED_FOR_DELETE
          enum:
          - MARKED_FOR_DELETE
          - DELETING
          - DELETED
        optionMetadata:
          description: Option Metadata
          $ref: '#/components/schemas/AttributeOptionMetadataInformation'
        validationRuleId:
          description: Validation Rule configured for Attribute (e.g., email, URL)
          type: string
          example: email
        abacBasicAssignmentInfo:
          description: Contains the id, name and ObjectType of the linked assignment
          type: array
          items:
            $ref: '#/components/schemas/AbacBasicAssignmentInfo'
        optionsByDomain:
          description: Override options by Domain
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeDomainOptionOverrideInformation'
        formulaByDomain:
          description: Formula by Domain
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AttributeFormulaDetail'
        displayResponseType:
          description: Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues
          type: string
          example: SingleSelect
          enum:
          - Text
          - SingleSelect
          - MultiSelect
          - Date
          - DateTime
          - NumericalText
          - NumericalSingleSelect
          - RadioButton
          - TextArea
          - Formula
          - Level
          - Range
          - Score
          - System
        associatedAttributeFieldName:
          type: string
      required:
      - enabled
      - fieldName
      - name
    AttributeDomainOptionOverrideInformation:
      type: object
      properties:
        id:
          description: Override Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        attributeDomainOptionId:
          description: Domain Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440001
        targetAttributeId:
          description: Target Attribute GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440002
        targetOptionId:
          description: Target Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440003
        option:
          description: Option name
          type: string
          example: TypeA
        optionKey:
          description: Option name key
          type: string
          example: TypeB
        optionSelectionValue:
          description: Option selection value
          type: string
          example: 10
        colorCode:
          description: Color code for the option
          type: string
          example: '#FF5733'
          maxLength: 7
        sequence:
          description: Option sequence for ordering
          type: integer
          format: int32
          example: 1
          maximum: 32767
          minimum: 1
        enabled:
          description: Indicates if the option is enabled or disabled
          type: boolean
          example: true
          default: 'true'
        metadata:
          description: Additional metadata for the attribute option
          $ref: '#/components/schemas/AttributeOptionMetadata'
        optionSelectionValueAsDouble:
          type: number
          format: double
        optionAsDouble:
          type: number
          format: double
    AttributeOptionRequest:
      type: object
      properties:
        option:
          description: The option text to be displayed
          type: string
          example: Example Option
          maxLength: 255
          minLength: 1
        optionKey:
          description: Option key which can be used for translation and internationalization
          type: string
          example: example_option
          maxLength: 255
        optionSelectionValue:
          description: Option selection value used to identify the option in forms or programmatic interfaces
          type: string
          example: value1
          maxLength: 255
        colorCode:
          description: Color code in hexadecimal format for UI representation
          type: string
          example: '#FFFFFF'
          enum:
          - '#000000'
          - '#FFFFFF'
          - '#FF0000'
          - '#00FF00'
          - '#0000FF'
          maxLength: 7
          minLength: 4
          pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
        metadata:
          description: Additional metadata associated with the attribute option
          example:
            hint: This option provides additional information about the attribute
            hintKey: attribute.option.hint.key
          $ref: '#/components/schemas/AttributeOptionMetadata'
      example:
        option: Example Option
        optionKey: example_option
        optionSelectionValue: value1
        colorCode: '#FFFFFF'
      required:
      - option
      title: Attribute Option Request
    AssociatedAttribute:
      type: object
      properties:
        fieldName:
          description: Field Name
          type: string
          maxLength: 200
          minLength: 0
        name:
          description: Attribute Name
          type: string
          minLength: 1
        nameKey:
          description: Attribute Name Key. Used for Translation
          type: string
          maxLength: 200
          minLength: 0
        description:
          description: Attribute Description
          type: string
        descriptionKey:
          description: Attribute Description Key
          type: string
          maxLength: 200
          minLength: 0
        options:
          description: Attribute Options
          type: array
          items:
            $ref: '#/components/schemas/AttributeOptionRequest'
          minItems: 1
      required:
      - name
    AssociatedAttributeRequest:
      type: object
      properties:
        associatedAttributes:
          description: Associated attributes
          type: array
          items:
            $ref: '#/components/schemas/AssociatedAttribute'
          minItems: 1
    AttributeOptionMetadataInformation:
      type: object
      properties:
        entityTypeName:
          description: Option Source Entity Type
          type: string
          example: Location
        basicServiceContextPath:
          description: Basic Url for the Option source Service
          type: string
          example: /api/location
        optionUrl:
          description: Api URL for the Drop Down Api
          type: string
          example: /api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages
        optionListUrl:
          description: Api URL for the Drop Down Api. Complete List of entities
          type: string
          example: /api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details
        viewType:
          description: This will help to identify the view type of list
          type: string
        optionType:
          description: Option Type
          type: string
          example: BusinessLocations
        permissions:
          description: Permissions
          type: array
          items:
            type: string
          example: '[features.core-constructs.view]'
        applicationUrl:
          description: Application Url
          type: string
          example: /settings/location-management/location/Location
    AbacBasicAssignmentInfo:
      type: object
      properties:
        assignmentId:
          description: GUID of the linked assignment
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        assignmentName:
          description: Name of the linked assignment
          type: string
          example: Assignment1
        policyStatus:
          description: Policy status of the linked assignment
          type: string
          example: ACTIVE
          enum:
          - INACTIVE
          - ACTIVE
          - PROCESSING
          - FAILED
    IntakeQuestion:
      type: object
      properties:
        nameKey:
          type: string
          maxLength: 100
          minLength: 0
        name:
          type: string
          maxLength: 500
          minLength: 0
        descriptionKey:
          type: string
          maxLength: 100
          minLength: 0
        description:
          type: string
          maxLength: 500
          minLength: 0
    AttributeCreateRequest:
      type: object
      properties:
        fieldName:
          description: Field name used to uniquely identify the attribute
          type: string
          example: nameOfRecord
          maxLength: 200
          minLength: 0
        name:
          description: Attribute name
          type: string
          example: Type of the Record
          maxLength: 255
          minLength: 1
        nameKey:
          description: Attribute name key used for translation
          type: string
          example: IM.Name
          maxLength: 200
          minLength: 0
        description:
          description: Attribute description
          type: string
          example: Gather Type for the record - provide some value related to nature of record
          maxLength: 1000
        descriptionKey:
          description: Attribute description key used for translation
          type: string
          example: IM.Name.Description
          maxLength: 200
          minLength: 0
        required:
          description: Indicates if this attribute is required
          type: boolean
          example: false
          default: 'false'
        allowOther:
          description: Indicates if user-specified values are allowed
          type: boolean
          example: false
          default: 'false'
        responseType:
          description: Response type for the attribute
          type: string
          example: Text
          enum:
          - Text
          - SingleSelect
          - MultiSelect
          - Date
          - Formula
          - Score
          - Level
          - Range
        optionType:
          description: Source for attribute options
          type: string
          example: None
          default: None
          enum:
          - None
          - Static
          - Dynamic
          maxLength: 200
          minLength: 0
        options:
          description: List of options for the attribute (applicable for SingleSelect and MultiSelect)
          type: array
          items:
            $ref: '#/components/schemas/AttributeOptionRequest'
        referenceCategoryIds:
          description: List of category IDs associated with the attribute
          type: array
          items:
            type: string
            format: uuid
          example:
          - 550e8400-e29b-41d4-a716-446655440000
        formula:
          description: Formula expression for calculated attributes
          type: string
          example: Default:Field4 + Default:Field3 + 100
          maxLength: 8000
          minLength: 0
        context:
          description: Attribute context data
          $ref: '#/components/schemas/AttributeContext'
        source:
          description: Source of the attribute
          type: string
          example: system
          maxLength: 50
        responseSubType:
          description: Response sub type for the attribute
          type: string
          example: STANDARD
          enum:
          - STANDARD
          - FORMULA
          - MATRIX
        associatedAttributeRequest:
          description: Associated attribute request information
          $ref: '#/components/schemas/AssociatedAttributeRequest'
        maxMultiSelectAllowedOptionValues:
          description: Maximum number of option values allowed for MultiSelect attributes
          type: integer
          format: int32
          example: 10
          maximum: 100
          minimum: 1
        encrypted:
          description: Indicates if this attribute should be encrypted
          type: boolean
          example: false
          default: 'false'
        metadata:
          description: Metadata about the attribute in JSON format
          type: string
          example:
            sortable: true
            filterOperators:
            - EQUAL_TO
            - NOT_EQUAL_TO
        intakeQuestion:
          description: Attribute intake question details
          $ref: '#/components/schemas/IntakeQuestion'
        validationRuleId:
          description: ID of the validation rule to associate with the attribute
          type: string
          example: email
          maxLength: 255
        abacBasicAssignmentInfo:
          description: GUID, name and the objectType of the linked assignment
          type: array
          items:
            $ref: '#/components/schemas/AbacBasicAssignmentInfo'
      required:
      - fieldName
      - name
      - responseType
    AttributeOptionInformation:
      type: object
      properties:
        id:
          description: Option GUID
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        option:
          description: Option name
          type: string
          example: TypeA
          maxLength: 255
          minLength: 1
        optionKey:
          description: Option Key which can be used for translation
          type: string
          example: IM.TypeA
          maxLength: 255
        colorCode:
          description: Color code for the option
          type: string
          example: '#FF5733'
          maxLength: 7
        sequence:
          description: Option sequence for ordering
          type: integer
          format: int32
          example: 1
          maximum: 32767
          minimum: 1
        enabled:
          description: Indicates if the option is enabled or disabled
          type: boolean
          example: true
          default: 'true'
        metadata:
          description: Additional metadata for the attribute option
          $ref: '#/components/schemas/AttributeOptionMetadata'
      required:
      - option
    AssociatedAttributeInformation:
      type: object
      properties:
        id:
          description: Associated Attribute GUID
          type: string
          format: uuid
        name:
          description: Name
          type: string
          example: Count of members
          minLength: 1
        nameKey:
          description: Name key
          type: string
          example: IM.CountOfMembersName
        description:
          description: Description
          type: string
          example: Provide details about count associated with this attribute
        descriptionKey:
          description: Description Key
          type: string
          example: IM.CountOfMembersDesc
        schemaId:
          description: Attribute Schema GUID
          type: string
          format: uuid
        schemaName:
          description: Attribute Schema Name
          type: string
          example: risk
        fieldName:
          description: Attribute field name
          type: string
          example: countOfMembers
          minLength: 1
        mappedFieldName:
          description: Mapped Attribute field name. Should be used for sorting
          type: string
          example: count
        enabled:
          description: Indicator for attribute enabled/disabled
          type: boolean
        responseType:
          description: Response Type
          type: string
          enum:
          - Text
          - SingleSelect
          - MultiSelect
          - Date
          - DateTime
          - NumericalText
          - NumericalSingleSelect
          - RadioButton
          - TextArea
          - Formula
          - Level
          - Range
          - Score
          - System
        responseSubType:
          description: Response sub type
          type: string
          enum:
          - Standard
          - Formula
          - Matrix
          - RollUp
        formula:
          description: Formula for attribute
          type: string
          example: sum(1, 3)
        options:
          description: Attribute options
          type: array
          items:
            $ref: '#/components/schemas/AttributeOptionInformation'
        optionsByDomain:
          description: Override options by Domain
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeDomainOptionOverrideInformation'
      required:
      - enabled
      - fieldName
      - id
      - responseType
    CategoryInformation:
      type: object
      properties:
        id:
          description: Category unique identifier
          type: string
          format: uuid
        name:
          description: Category name
          type: string
          example: Financial Category
        nameKey:
          description: Category nameKey for localization support
          type: string
          example: IM.FinancialCategoryName
    AttributeOptionMetadata:
      type: object
      properties:
        hint:
          description: Hint
          type: string
        hintKey:
          description: Hint key which can be used for translation
          type: string
    AttributeContext:
      type: object
      properties:
        parameters:
          additionalProperties:
            type: object
          type: object
  securitySchemes:
    OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            AI_GOVERNANCE: Grants full permissions to manage AI Governance operations for external systems
            AI_GOVERNANCE_READ: Allows read-only access to AI Governance entities
            AI_GOVERNANCE_WRITE: Grants permissions to create and modify AI Governance entities
x-onetrust:
  spec-label: OpenAPI 3.1.0
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false