OneTrust Data Use Governance — Data Catalog

{"openapi":"3.1.0","info":{"title":"Data Use Governance - Data Catalog","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":"Catalog Search V1","description":"APIs to manage catalog search operations with basic functionality and providing comprehensive filtering, faceting, and field selection capabilities for data asset discovery.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"x-displayName":"Catalog Search V1"},{"name":"Catalog Search V2","description":"APIs to manage catalog search operations with enhanced scalability, featuring continuation token-based pagination for handling large volumes of search results and improved performance for enterprise-scale data catalog queries.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"x-displayName":"Catalog Search V2"},{"name":"Data Asset Attributes","x-displayName":"Data Asset Attributes"},{"name":"Data Asset Management","x-displayName":"Data Asset Management"},{"name":"Data Assets","description":"The Data Assets APIs are used to manage data asset metadata.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"x-displayName":"Data Assets"},{"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"},{"name":"Tags","description":"APIs to manage tags for data classification, including creating new tags with various types and retrieving tag details with their associated terms.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"x-displayName":"Tags"},{"name":"Terms","description":"APIs to manage glossary terms, including creating new terms with custom attributes, retrieving term lists with search and pagination capabilities, accessing individual term details, and managing term attributes and relationships.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"x-displayName":"Terms"}],"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"]}]}},"/api/glossary/v1/tag-names":{"get":{"operationId":"retrieveAllTagsName","summary":"Get List of Tags","description":"Use this API to retrieve a list of all tag names.","tags":["Tags"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"type","in":"query","description":"Type of the tag. For example, including the value for the type - Category, all the matching Tags will be retrieved.","required":false,"schema":{"type":"string","enum":["CATEGORY","CLASSIFICATION","BUSINESS_DOMAIN","RETENTION","ROT"]},"example":"CATEGORY"}],"responses":{"200":{"description":"OK \nTag names retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseListOfTags"}}}},"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/tags/{name}/details":{"get":{"operationId":"getTagDetailsWithAssociatedTerms","summary":"Get Tag","description":"Use this API to retrieve the details for the specified tag.","tags":["Tags"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"name","in":"path","description":"The name to get the details of the related tag. For example, including the value for the name Resume, matching tag details will be retrieved.","required":true,"schema":{"type":"string"},"example":"Resume"}],"responses":{"200":{"description":"OK \nTag response retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfTagTermResponse"}}}},"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/terms":{"get":{"operationId":"retrieveAllTerms","summary":"Get List of Terms","description":"Use this API to retrieve a list of all terms or search for a specific term. The response will include details for each term along with the corresponding term ID, name, and glossary to which the term belongs.","tags":["Terms"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"name","in":"query","description":"The name of the term that needs to be searched for within the list of terms.","required":false,"schema":{"type":"string"},"example":"URL"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":10}],"responses":{"200":{"description":"OK \nTerm Details response retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfTermResponse"}}}},"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/terms/attribute-details/{name}":{"get":{"operationId":"getTermAttributeByName","summary":"Get Term Attribute","description":"Use this API to retrieve the details of a specific term attribute.","tags":["Terms"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"name","in":"path","description":"The name of attribute to get the term attribute details. For example, including the value for the attribute's name-Notes, matching term attribute will be retrieved.","required":true,"schema":{"type":"string"},"example":"Notes"}],"responses":{"200":{"description":"OK \nTerm Attribute response retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfListOfAttributeInformation"}}}},"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/terms/attribute-names":{"get":{"operationId":"getAllTermAttributeNames","summary":"Get List of Term Attributes","description":"Use this API to retrieve a list of all term attributes created by internal and external systems.","tags":["Terms"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"responses":{"200":{"description":"OK \nTerm attribute names 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/terms/name/{termName}":{"get":{"operationId":"retrieveTermsByName","summary":"Get Term","description":"Use this API to retrieve the details for the specified term. The response will return the term ID, description, and type along with its associated tags.","tags":["Terms"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"termName","in":"path","description":"The name to get the term details along with the tag details. For example, including the value for the name URL, matching term details with the associated tags will be retrieved.","required":true,"schema":{"type":"string"},"example":"URL"}],"responses":{"200":{"description":"OK \nTerm Details response retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfExternalTermResponse"}}}},"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/terms/names":{"get":{"operationId":"retrieveTermsName","summary":"Get List of Term Names","description":"Use this API to retrieve a list of all term names.","tags":["Terms"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"responses":{"200":{"description":"OK \nTerm names retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"URL"}}}}},"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/v2/tags":{"post":{"operationId":"createTagV2","summary":"Create Tag","description":"Use this API to create a new tag in the Glossary.\n\n> 🗒 Things to Know\n>\n> - The `type` parameter is case-sensitive. For example, use CATEGORY instead of Category.","tags":["Tags"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TagRequestV2"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfTagResponse"}}}},"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_WRITE"]}]}},"/api/glossary/v2/terms":{"post":{"operationId":"createTermUsingPOST","summary":"Create Term","description":"Use this API to create a new term in the Glossary.","tags":["Terms"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TermCreateRequestV2"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TermResponse"}}}},"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_WRITE"]}]}},"/api/data-governance/v1/data-assets":{"post":{"operationId":"createOrUpsertDataAssetV1","summary":"Create Data Asset","description":"Use this API to create a new data asset or upsert an existing data asset. Data assets must be added using a structured top-down hierarchy to ensure consistent data organization. The request must include all required data asset details, such as the parent ID, name, type, and data source. The response will confirm successful ingestion with the assigned data asset ID.\n\nThings to Know\n- If terms, tags, additional attributes, or users are added to an existing data asset, the system will merge the new values from the request with the existing values.\n- With the exception of the root (data source) node, every data asset must have its parent record already present in the system before being added.","tags":["Data Assets"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetUpsertRequest"}}}},"responses":{"201":{"description":"Created","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}":{"get":{"operationId":"getDataAssetV1","summary":"Get Data Asset","description":"Use this API to retrieve a specific data asset. The response will include details such as the data source, additional attributes, associated terms, and associated tags.","tags":["Data Assets"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"dataAssetId","in":"path","description":"The unique identifier of the data asset.","required":true,"schema":{"type":"string","format":"uuid"},"example":"6756206c-845c-4ecc-8826-0e25d12b0d0c"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetResponse"}}}},"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_READ"]}]},"delete":{"operationId":"deleteDataAssetV1","summary":"Delete Data Asset","description":"Use this API to delete a data asset. The request must include the data asset ID, and the response will confirm acceptance of the deletion request. If the data asset has child objects, those objects will also be deleted asynchronously along with the parent data asset.","tags":["Data Assets"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"dataAssetId","in":"path","description":"The unique identifier of the data asset.","required":true,"schema":{"type":"string","format":"uuid"},"example":"6756206c-845c-4ecc-8826-0e25d12b0d0c"}],"responses":{"202":{"description":"ACCEPTED"},"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"]}]},"patch":{"operationId":"updateDataAssetV1","summary":"Modify Data Asset","description":"Use this API to modify existing data assets while maintaining a structured top-down hierarchy. With this API, the system will replace existing terms, tags, additional attributes, or users with the new data included in the request. The response will confirm the status along with the updated data asset ID.","tags":["Data Assets"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"dataAssetId","in":"path","description":"The unique identifier of the data asset.","required":true,"schema":{"type":"string","format":"uuid"},"example":"6756206c-845c-4ecc-8826-0e25d12b0d0c"}],"requestBody":{"required":true,"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetPatchRequest"}}}},"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}/tags":{"post":{"operationId":"createDataAssetTagAssociationsV1","summary":"Create Tag Associations","description":"Use this API to create tag associations for the specified data asset. The request should include the data asset ID and the list of tags to assign to the data asset. The response will confirm the successful associations and return the updated data asset ID.","tags":["Data Assets"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"dataAssetId","in":"path","description":"The unique identifier of the 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":{"

# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-data-use-governance-data-catalog-openapi.json