OneTrust Data Asset Management API

openapi: 3.2.0
info:
  title: Data Use Governance - Data Catalog Data Asset Management 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 Management
  x-displayName: Data Asset Management
paths:
  /api/data-governance/v1/data-assets/{dataAssetId}/tags/deleteTagAssociations:
    post:
      operationId: deleteDataAssetTagAssociationsV1
      summary: Delete Multiple Data Asset Tag Associations
      description: Use this API to delete multiple tag associations from a specified data asset using its ID. The request should include the asset ID and a list of tags to be removed. The response will confirm the successful removal of associations and return the updated asset ID.
      tags:
      - Data Asset Management
      parameters:
      - name: dataAssetId
        in: path
        description: The unique identifier of a data-asset.
        required: true
        schema:
          type: string
          format: uuid
        example: 6756206c-845c-4ecc-8826-0e25d12b0d0c
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTagAssociationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetBasicResponse'
        '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:
        - DATA_CATALOG_WRITE
  /api/data-governance/v1/data-assets/{dataAssetId}/terms/deleteTermAssociations:
    post:
      operationId: deleteDataAssetTermAssociationsV1
      summary: Delete Multiple Data Asset Term Associations
      description: Use this API to delete multiple term associations from a specified data asset using its ID. The request should include the asset ID and a list of terms to be removed. The response will confirm the successful removal of associations and return the updated asset ID.
      tags:
      - Data Asset Management
      parameters:
      - name: dataAssetId
        in: path
        description: The unique identifier of a data-asset.
        required: true
        schema:
          type: string
          format: uuid
        example: 6756206c-845c-4ecc-8826-0e25d12b0d0c
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTermAssociationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetBasicResponse'
        '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:
        - DATA_CATALOG_WRITE
components:
  schemas:
    DataUseGovernance-DataAssetManagement_DataAssetTermAssociationRequest:
      type: object
      properties:
        termId:
          description: Unique identifier of the Glossary Term
          type: string
          format: uuid
          example: 29d09995-6040-403f-b520-fa9b38ce0bf5
        termName:
          description: Name of the Glossary Term
          type: string
          example: Social Security Number
      required:
      - termId
      - termName
    DataUseGovernance-DataAssetManagement_DataAssetBasicResponse:
      type: object
      properties:
        id:
          description: The unique identifier of the data asset.
          type: string
          format: uuid
          example: 6756206c-845c-4ecc-8826-0e25d12b0d0c
    DataUseGovernance-DataAssetManagement_DataAssetTagAssociationRequest:
      type: object
      properties:
        tagId:
          description: Unique identifier of the Glossary Tag
          type: string
          format: uuid
          example: 29d09995-6040-403f-b520-fa9b38ce0bf5
        tagName:
          description: Name of the Glossary Tag
          type: string
          example: Confidential
      required:
      - tagId
      - tagName
  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