OneTrust Glossaries API

openapi: 3.2.0
info:
  title: Data Use Governance - Data Catalog Glossaries 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: Glossaries
  description: APIs to manage business glossaries, including retrieving glossary details, listing all available glossaries, and accessing glossary-specific information with associated terms and metadata.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
  x-displayName: Glossaries
paths:
  /api/glossary/v1/glossaries/all/names:
    get:
      operationId: getAllGlossariesNames
      summary: Get List of Glossaries
      description: Use this API to retrieve a list of all business glossaries.
      tags:
      - Glossaries
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
      responses:
        '200':
          description: "OK \nAll glossary details retrieved successfully."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfListofStringWrapper'
        '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-DataCatalog_OAUTH2:
        - DATA_CATALOG_READ
  /api/glossary/v1/glossaries/name/{glossaryName}:
    get:
      operationId: getAllGlossariesByNames
      summary: Get Glossary
      description: Use this API to retrieve the details for the specified business glossary. The response will include details such as the glossary ID, description, and created date.
      tags:
      - Glossaries
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
      parameters:
      - name: glossaryName
        in: path
        description: The name to get the corresponding glossary details.
        required: true
        schema:
          type: string
        example: Enterprise-Wide Glossary
      responses:
        '200':
          description: "OK \nGlossary Details retrieved successfully."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfGlossaryResponse'
        '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-DataCatalog_OAUTH2:
        - DATA_CATALOG_READ
components:
  schemas:
    DataUseGovernance-DataCatalog_OneTrustPage:
      type: object
      properties:
        first:
          description: This parameter indicates whether the current page is the first page of the list.
          type: boolean
        last:
          description: This parameter indicates whether the current page is the last page of the list.
          type: boolean
        number:
          description: The page number of the results.
          type: integer
          format: int64
        size:
          description: The number of results per page.
          type: integer
          format: int64
        totalElements:
          description: The total number of results in the list.
          type: integer
          format: int64
        totalPages:
          description: The total number of pages in the list.
          type: integer
          format: int64
        sort:
          description: The sort criteria that dictates the order of the results.
          type: array
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustSort'
    DataUseGovernance-DataCatalog_IdValueKeyDto:
      type: object
      properties:
        id:
          description: Unique identifier
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        value:
          description: Display value
          type: string
          example: Sample Value
        key:
          description: Key used for localization
          type: string
          example: SAMPLE_KEY
    DataUseGovernance-DataCatalog_OneTrustSort:
      type: object
      properties:
        direction:
          description: The order (ASC|DESC) by which results are sorted.
          type: string
          enum:
          - ASC
          - DESC
        property:
          description: The criteria by which results are sorted.
          type: string
    DataUseGovernance-DataCatalog_OneTrustResponseOfGlossaryResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_GlossaryResponse'
        meta:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata'
    DataUseGovernance-DataCatalog_GlossaryResponse:
      type: object
      properties:
        id:
          description: Unique identifier
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          description: Name of the entity
          type: string
          example: Sample Name
        nameKey:
          description: Key used for name localization
          type: string
          example: SAMPLE_NAME_KEY
        numericId:
          description: Numeric identifier for the glossary
          type: integer
          format: int64
          example: 12345
        description:
          description: Description of the glossary
          type: string
          example: This glossary contains financial terms
        descriptionKey:
          description: Key used for description localization
          type: string
          example: FINANCIAL_GLOSSARY_DESC
        businessOwner:
          type: array
          items:
            type: string
            format: uuid
            description: Business Owner's ID
            example: 123e4567-e89b-12d3-a456-426614174001
          uniqueItems: true
        dataSteward:
          type: array
          items:
            type: string
            format: uuid
            description: Data Steward's ID
            example: 123e4567-e89b-12d3-a456-426614174001
          uniqueItems: true
        subjectMatterExpert:
          type: array
          items:
            type: string
            format: uuid
            description: Subject Matter Expert's ID
            example: 123e4567-e89b-12d3-a456-426614174001
          uniqueItems: true
        createdDate:
          description: Creation timestamp
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        lastUpdatedDate:
          description: Last update timestamp
          type: string
          format: date-time
          example: '2023-01-02T00:00:00Z'
        createdBy:
          description: UUID of the user who created the glossary
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174003
        lastUpdatedBy:
          description: UUID of the user who last updated the glossary
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174004
        terms:
          type: array
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataCatalog_TermResponse'
            description: Term associated with the glossary
    DataUseGovernance-DataCatalog_TagResponse:
      type: object
      properties:
        id:
          description: UUID of the tag
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174001
        tagId:
          description: Numeric identifier for the tag
          type: integer
          format: int64
          example: 45
        name:
          description: Name of the tag
          type: string
          example: Resume
        description:
          description: Description of the tag
          type: string
          example: This tag is used for any information related to Resume
        type:
          description: Type of the tag
          type: string
          example: CLASSIFICATION
        createdBy:
          description: UUID of the user who created the tag
          type: string
          format: uuid
          example: 897e4567-e89b-12d3-2345-426614174789
        createdDate:
          description: Tag creation timestamp
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        updatedBy:
          description: UUID of the user who updated the tag
          type: string
          format: uuid
          example: 897e4567-e89b-12d3-2345-426614174789
        updatedDate:
          description: Tag update timestamp
          type: string
          format: date-time
          example: '2023-01-02T00:00:00Z'
        athenaId:
          description: Athena Id for the tag
          type: string
          format: uuid
          example: 754e4567-de34-12d3-a456-ddf414174777
    DataUseGovernance-DataCatalog_OneTrustMetadata:
      type: object
      properties:
        page:
          description: The page number of the results.
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustPage'
    DataUseGovernance-DataCatalog_TermResponse:
      type: object
      properties:
        id:
          description: Unique identifier
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          description: Name of the entity
          type: string
          example: Sample Name
        nameKey:
          description: Key used for name localization
          type: string
          example: SAMPLE_NAME_KEY
        type:
          description: Type of the term
          type: string
          example: Business
        typeKey:
          description: Key used for type localization
          type: string
          example: BUSINESS_TYPE
        shortDescription:
          description: Brief description of the term
          type: string
          example: A short explanation of what this term means
        glossary:
          description: Glossary information containing the term
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_IdValueKeyDto'
        numericId:
          description: Numeric identifier for the term
          type: integer
          format: int64
          example: 12345
        example:
          description: Example usage of the term
          type: string
          example: Example usage of this term in a sentence
        businessOwner:
          type: array
          items:
            type: string
            format: uuid
            description: Business Owner's ID
            example: 32d50775-17c3-44f0-88da-575b8a10c9fb
          uniqueItems: true
        technicalOwner:
          type: array
          items:
            type: string
            format: uuid
            description: Technical Owner's ID
            example: 123e4567-e89b-12d3-a456-426614174001
          uniqueItems: true
        dataSteward:
          type: array
          items:
            type: string
            format: uuid
            description: Data Steward's ID
            example: 123e4567-e89b-12d3-a456-426614174001
          uniqueItems: true
        notes:
          description: Additional notes about the term
          type: string
          example: Additional information about term usage
        source:
          description: Source of the term
          type: string
          example: Internal Documentation
        createdDate:
          description: Creation timestamp
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        lastUpdatedDate:
          description: Last update timestamp
          type: string
          format: date-time
          example: '2023-01-02T00:00:00Z'
        createdBy:
          description: UUID of the user who created the term
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174003
        lastUpdatedBy:
          description: UUID of the user who last updated the term
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174004
        status:
          description: Current status of the term
          type: string
          example: ACTIVE
        associatedTags:
          type: array
          items:
            type: string
            format: uuid
            description: Associated tag's ID
            example: 123e4567-e89b-12d3-a456-426614174001
        tags:
          type: array
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataCatalog_TagResponse'
            description: Associated tag's detail
    DataUseGovernance-DataCatalog_OneTrustResponseOfListofStringWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            type: string
            example: Notes
        meta:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata'
  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