OneTrust Data Asset Attributes API

openapi: 3.2.0
info:
  title: Data Use Governance - Data Catalog Data Asset Attributes API
  description: The Data Catalog APIs provide comprehensive functionality for managing data governance assets within Data Catalog, enabling users to create, retrieve, and organize business glossaries, terms, and tags for effective data classification and metadata management.
  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
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: Data Asset Attributes
  x-displayName: Data Asset Attributes
paths:
  /api/metadata-catalog/v1/metadata/attribute-details/{name}:
    get:
      operationId: getDataAssetAttributeByName
      summary: Get Data Asset Attribute
      description: Use this API to retrieve the details for the specified data asset attribute.
      tags:
      - Data Asset Attributes
      parameters:
      - name: name
        in: path
        description: The name to get the related attribute information. For example, including the value for the name FileType, matching Attribute Information will be retrieved.
        required: true
        schema:
          type: string
        example: FileType
      responses:
        '200':
          description: "OK \nAttribute Information retrieved successfully."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_OneTrustResponseListOfAttributeInformationWrapper'
        '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:
      - DataUseGovernance-DataAssetManagement_OAUTH2:
        - INTEGRATION
        - DATA_CATALOG_READ
  /api/metadata-catalog/v1/metadata/attribute-names:
    get:
      operationId: getAllDataAssetAttributeNames
      summary: Get List of Data Asset Attributes
      description: Use this API to retrieve a list of all data asset attributes in the Attribute Manager.
      tags:
      - Data Asset Attributes
      responses:
        '200':
          description: "OK \nMetadata attribute names retrieved successfully."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_OneTrustResponseListOfStringWrapper'
              example:
                data:
                - FileType
                - Content Size
                - File Owner
        '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:
      - DataUseGovernance-DataAssetManagement_OAUTH2:
        - INTEGRATION
        - DATA_CATALOG_READ
components:
  schemas:
    DataUseGovernance-DataAssetManagement_AttributeOptionMetadata:
      type: object
      properties:
        hint:
          description: Hint
          type: string
        hintKey:
          description: Hint key which can be used for translation
          type: string
    DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_AttributeOptionInformation'
        referenceCategories:
          description: Categories for given attribute
          type: array
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_AbacBasicAssignmentInfo'
        optionsByDomain:
          description: Override options by Domain
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_AttributeDomainOptionOverrideInformation'
        formulaByDomain:
          description: Formula by Domain
          type: object
          additionalProperties:
            type: string
        associatedAttributeFieldName:
          type: string
      required:
      - enabled
      - fieldName
      - name
    DataUseGovernance-DataAssetManagement_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
    DataUseGovernance-DataAssetManagement_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
    DataUseGovernance-DataAssetManagement_OneTrustResponseListOfStringWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            type: string
          example:
          - FileType
          - Content Size
          - File Owner
    DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_AttributeOptionMetadata'
      required:
      - option
    DataUseGovernance-DataAssetManagement_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/DataUseGovernance-DataAssetManagement_AttributeOptionInformation'
        optionsByDomain:
          description: Override options by Domain
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_AttributeDomainOptionOverrideInformation'
      required:
      - enabled
      - fieldName
      - id
      - responseType
    DataUseGovernance-DataAssetManagement_OneTrustResponseListOfAttributeInformationWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_AttributeInformation'
        errors:
          type: array
          items:
            type: object
    DataUseGovernance-DataAssetManagement_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
    DataUseGovernance-DataAssetManagement_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
    DataUseGovernance-DataAssetManagement_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'
  securitySchemes:
    DataUseGovernance-DataCatalog_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_CATALOG_READ: Access to Data Catalog read operations for external systems
            DATA_CATALOG_WRITE: Access to Data Catalog write operations for external systems
    DataUseGovernance-DataAssetManagement_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_CATALOG_WRITE: Data Catalog Write Scope gives the user access to write operations
            DATA_CATALOG_READ: Data Catalog Read Scope gives the user access to read operations
    DataUseGovernance-DataCatalogMetadataExchange_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_CATALOG_READ: Access to Data Catalog read operations for external systems
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0