{"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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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/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.\n","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.surrey.idm.oclc.org/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":{"post":{"operationId":"createDataAssetTermAssociationsV1","summary":"Create Term Associations","description":"Use this API to create term associations for the specified data asset. The request should include the data asset ID and the list of terms 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.surrey.idm.oclc.org/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_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.surrey.idm.oclc.org/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.\n","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.surrey.idm.oclc.org/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/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.surrey.idm.oclc.org/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.surrey.idm.oclc.org/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/data-governance/v1/catalog/search":{"post":{"operationId":"externalSearch","summary":"Get Catalog Search Results","description":"Use this API to retrieve a list of all catalog search results by key terms and filters. The response will include relevant details for each result, including the corresponding data asset ID, name, and the associated tags and terms.\n\n> 🗒 Things to Know\n>\n> - This API returns up to 100,000 catalog search results. For larger volumes, use the [Get Catalog Search Results V2](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/externalsearch-using-continuationtoken) API.","tags":["Catalog Search V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-catalog.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_SearchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_SearchResponse"}}}},"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.surrey.idm.oclc.org/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-DataCatalogMetadataExchange_OAUTH2":["DATA_CATALOG_READ"]}]}},"/api/data-governance/v1/field-details":{"get":{"operationId":"get_v1-field-details","summary":"Get Search Fields","description":"Use this API to retrieve a list of all catalog search fields. The response will include details such as the search field names, data types, and supported operators.","tags":["Catalog Search V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-catalog.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_SearchFieldResponse"}}}},"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.surrey.idm.oclc.org/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-DataCatalogMetadataExchange_OAUTH2":["DATA_CATALOG_READ"]}]}},"/api/data-governance/v2/catalog/search":{"post":{"operationId":"externalSearch-using-continuationtoken","summary":"Get Catalog Search Results","description":"Use this API to retrieve a list of all catalog search results by key terms and filters. The response will include relevant details for each result, including the corresponding data asset ID, name, and the associated tags and terms. This API is designed to return large volumes of catalog search results.\n\n> 🗒 Things to Know\n>\n> - The `continuationToken` parameter returned in the response can be used on a subsequent API call to retrieve the next set of catalog search results. For more information, see [Understanding & Implementing Pagination](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/understanding-implementing-pagination#request-continuation-based-keyset--cursor-based-pagination).","tags":["Catalog Search V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-catalog.json"},"parameters":[{"name":"x-onetrust-continuationToken","in":"header","description":"Continuation Token available in Search Response to retrieve next page.","required":false,"schema":{"type":"string"},"example":"AAEADummyTokenMmFiZTNhN2QtYmE0YS00ZjdkLWDummyTokenIwMWMtNzlkMDMwNDAzMTRj6tK7tU1emDummyTokenbIyvCDNSloQC/Zaher0/mpJhLkkymvYdYvtI76p4"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_SearchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_ExternalSearchResponse"}}}},"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.surrey.idm.oclc.org/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-DataCatalogMetadataExchange_OAUTH2":["DATA_CATALOG_READ"]}]}}},"components":{"schemas":{"DataUseGovernance-DataCatalog_customAttributes":{"type":"object","properties":{"name":{"description":"Name of the custom attribute","type":"string","example":"Term other users","minLength":1},"value":{"description":"Value of the custom attribute","type":"string","example":"User of the term"},"options":{"type":"array","items":{"type":"string","description":"Options of the custom attribute","example":"alice@ot.com"}}}},"DataUseGovernance-DataCatalog_TermCreateRequestV2":{"type":"object","properties":{"name":{"description":"Name of the term","type":"string","example":"Account Number"},"type":{"description":"Type of the term","type":"string","example":"Data Element","enum":["Data Element","Business Term","Acronym","Key Performance Indicator","Metric","Type of Individual"]},"glossaryName":{"description":"Valid glossary name","type":"string","example":"Business glossary"},"createAsApproved":{"description":"Create a term as approved","type":"boolean","example":true},"shortDescription":{"description":"Short description about term","type":"string","example":"This is the eight-digit account number which is used to uniquely identify the bank customer"},"example":{"description":"Example Value for the term","type":"string","example":"123-423-45"},"notes":{"description":"Notes for the term","type":"string","example":"This is the term which is used for the Banking data"},"technicalOwner":{"description":"Technical owner usernames or group names","$ref":"#/components/schemas/DataUseGovernance-DataCatalog_UserAndGroupNames"},"businessOwner":{"description":"Business owner usernames or group names","$ref":"#/components/schemas/DataUseGovernance-DataCatalog_UserAndGroupNames"},"dataSteward":{"description":"Data steward usernames or group names","$ref":"#/components/schemas/DataUseGovernance-DataCatalog_UserAndGroupNames"},"tags":{"type":"array","items":{"type":"string","description":"Tags to associate to the Term","example":"Financial"},"uniqueItems":true},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_customAttributes","description":"Custom Attributes of the term"}}},"required":["glossaryName","name","type"]},"DataUseGovernance-DataCatalog_UserAndGroupNames":{"type":"object","properties":{"userEmails":{"type":"array","items":{"type":"string","description":"Valid user email","example":"mallory@ot.com"}},"groupNames":{"type":"array","items":{"type":"string","description":"Group name","example":"Audit group"}}}},"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_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_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_OneTrustMetadata":{"type":"object","properties":{"page":{"description":"The page number of the results.","$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustPage"}}},"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_OneTrustResponseOfTagResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TagResponse"},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"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_TagRequestV2":{"type":"object","properties":{"name":{"description":"Name of the tag","type":"string","example":"Financial"},"type":{"description":"Type of the tag","type":"string","example":"CATEGORY","enum":["CATEGORY","CLASSIFICATION","BUSINESS_DOMAIN","RETENTION","ROT"]},"description":{"description":"Short description about tag","type":"string","example":"This is the Financial information of customer"}}},"DataUseGovernance-DataCatalog_OneTrustResponseOfTermResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TermResponse"}},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"DataUseGovernance-DataCatalog_CustomAttibuteDto":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"object"},"custom":{"type":"boolean"}}},"DataUseGovernance-DataCatalog_ExternalTermResponse":{"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":{"type":"integer","format":"int64"},"example":{"type":"string"},"businessOwner":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"technicalOwner":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"dataSteward":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"notes":{"type":"string"},"source":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid"},"lastUpdatedBy":{"type":"string","format":"uuid"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_CustomAttibuteDto"}},"status":{"type":"string"},"associatedTags":{"type":"array","items":{"type":"string","format":"uuid"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TagResponse"}}}},"DataUseGovernance-DataCatalog_OneTrustResponseOfExternalTermResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_ExternalTermResponse"},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"DataUseGovernance-DataCatalog_OneTrustResponseOfListofStringWrapper":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","example":"Notes"}},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"DataUseGovernance-DataCatalog_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-DataCatalog_AttributeOptionInformation"}}},"required":["enabled","fieldName","id","responseType"]},"DataUseGovernance-DataCatalog_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-DataCatalog_AttributeOptionInformation"}},"referenceCategories":{"description":"Categories for given attribute","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_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-DataCatalog_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-DataCatalog_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-DataCatalog_AttributeOptionMetadataInformation"},"validationRuleId":{"description":"Validation Rule configured for Attribute (e.g., email, URL)","type":"string","example":"email"},"associatedAttributeFieldName":{"type":"string"}},"required":["enabled","fieldName","name"]},"DataUseGovernance-DataCatalog_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-DataCatalog_AttributeOptionMetadata"}},"required":["option"]},"DataUseGovernance-DataCatalog_AttributeOptionMetadata":{"type":"object","properties":{"hint":{"description":"Hint","type":"string"},"hintKey":{"description":"Hint key which can be used for translation","type":"string"}}},"DataUseGovernance-DataCatalog_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/location/ui/v1/entity-types/names/Location/entities/basic-details"},"viewType":{"description":"This will help to identify the view type of list","type":"string"}}},"DataUseGovernance-DataCatalog_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-DataCatalog_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-DataCatalog_OneTrustResponseOfListOfAttributeInformation":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_AttributeInformation"}},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"DataUseGovernance-DataCatalog_OneTrustResponseOfTagTermResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TagTermResponse"},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"DataUseGovernance-DataCatalog_TagTermResponse":{"type":"object","properties":{"tagresponse":{"description":"The tag response object containing tag details","$ref":"#/components/schemas/DataUseGovernance-DataCatalog_TagResponse"},"termnames":{"type":"array","items":{"type":"string","description":"Term name associated with the tag","example":"URL"}}}},"DataUseGovernance-DataCatalog_OneTrustResponseListOfTags":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","example":"Biometric"}},"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_OneTrustResponseOfGlossaryResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_GlossaryResponse"},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata"}}},"DataUseGovernance-DataAssetManagement_MetadataValueDto":{"type":"object","properties":{"name":{"description":"The name of the attribute.","type":"string","example":"DS Multi Select","maxLength":100,"minLength":1},"displayName":{"description":"The display name of the attribute.","type":"string","example":"DS Multi Select","maxLength":100,"minLength":1},"value":{"description":"The value of the attribute.","type":"object","example":[{"value":"Option1"},{"value":"Option2"},{"value":"Option3"}]},"dataType":{"description":"The data type of the attribute.","type":"string","example":"STRING","enum":["LONG","STRING","DATE","TIMESTAMP"]},"custom":{"description":"This flag indicates whether the attribute is a custom attribute.","type":"boolean","example":true}},"required":["name","value"]},"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_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"]},"DataUseGovernance-DataAssetManagement_DataAssetUpsertRequest":{"type":"object","properties":{"name":{"description":"The name of the data asset.","type":"string","example":"resume.pdf","maxLength":100,"minLength":1},"shortDescription":{"description":"The description of the data asset.","type":"string","example":"Professional resume","maxLength":4000},"dataSource":{"description":"The details of the data source.","$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataSource"},"type":{"description":"The type of data asset.","type":"string","enum":["DATASOURCE","DATABASE","OBJECT","SCHEMA","CATALOG","TABLE","COLUMN","FIELD","FOLDER","FILE","DRIVE","FILE_SYSTEM","VIEW","DIRECTORY"]},"parentId":{"description":"The unique identifier of the parent object. This parameter value is null for `type`: `DATASOURCE`.","type":"string","format":"uuid","example":"de6d404d-14d6-487f-bbf7-fd202bde4768"},"oneTrustSourceSystemId":{"description":"The unique identifier of the data source.","type":"string","format":"uuid","example":"9fc8e1a8-b7d1-47c5-8f4b-7ebd451506f8"},"technicalOwners":{"description":"The unique identifier(s) of the technical owner(s) responsible for managing the technical details of the data asset.","type":"array","items":{"type":"string","format":"uuid","description":"Technical Owners of the Data Asset","example":"705992a2-e6a2-4fd7-a3f9-6190caa2365b"}},"businessOwners":{"description":"The unique identifier(s) of the business owner(s) responsible for defining and updating the business context of the glossary.","type":"array","items":{"type":"string","format":"uuid","description":"Business Owners of the Data Asset","example":"70ab1943-4b55-41d4-8183-6fa372579c6a"}},"dataStewards":{"description":"The unique identifier(s) of the data steward(s) responsible for utilizing data governance processes to ensure data reliability and validity within a data asset or business unit.","type":"array","items":{"type":"string","format":"uuid","description":"Data Stewards of the Source/Data Asset","example":"32d50775-17c3-44f0-88da-575b8a10c9fb"}},"pii":{"description":"This flag indicates whether the data asset is classified as PII.","type":"boolean","example":true,"default":"false"},"additionalAttributes":{"description":"The details of the associated attributes.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_MetadataValueDto"}},"terms":{"description":"The list of associated terms.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTermAssociationRequest"}},"tags":{"description":"The list of associated classification tags.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTagAssociationRequest"}}},"required":["dataSource","name","parentId","type"]},"DataUseGovernance-DataAssetManagement_DataSource":{"type":"object","properties":{"id":{"description":"The unique identifier of the data source.","type":"string","format":"uuid","example":"9fc8e1a8-b7d1-47c5-8f4b-7ebd451506f8"},"name":{"description":"The name of the data source.","type":"string","example":"Onetrust-smb"},"systemType":{"description":"The type of data source.","type":"string","example":"Snowflake","enum":["AWS","Azure","AzureCosmos","AzureStorage","Box","Cassandra","Databricks","IBMDB2","Exchange","GCP","GoogleWorkspaceGmail","GoogleBigQuery","GoogleBigTable","MongoDB","MySQL","Netezza","Office365","OneDrive","OracleRDBMS","PostgreSQL","AmazonS3","AmazonSageMaker","SalesForce","SAPHana","ServiceNow","SharePoint","SMB","Snowflake","MicrosoftSQL","Teradata","Workday","Zendesk","AmazonRDSforSQLServer","AzureSQLServer","Redshift","GoogleDrive","CustomConnector","AmazonDynamoDB","AmazonAthena","Hive","SharePoint2019OnPrem","GenericJDBC","SFTP","NFS","GCS","Redis","ElasticSearch","MicrosoftTeams","Slack","AlibabaCloudOSS","AzureFiles","Iceberg","NGFSFILES","Github","RELATIONAL_DATABASE","NON_RELATIONAL_DATABASE","FILE","API","Kafka"]}}},"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_DataAssetPatchRequest":{"type":"object","properties":{"shortDescription":{"description":"Short Description of the Data Asset","type":"string","example":"Professional resume","maxLength":4000},"oneTrustSourceSystemId":{"description":"Unique identifier of the Onetrust Source System","type":"string","format":"uuid","example":"9fc8e1a8-b7d1-47c5-8f4b-7ebd451506f8"},"technicalOwners":{"type":"array","items":{"type":"string","format":"uuid","description":"Technical Owners of the Data Asset","example":"705992a2-e6a2-4fd7-a3f9-6190caa2365b"}},"businessOwners":{"type":"array","items":{"type":"string","format":"uuid","description":"Business Owners of the Data Asset","example":"70ab1943-4b55-41d4-8183-6fa372579c6a"}},"dataStewards":{"type":"array","items":{"type":"string","format":"uuid","description":"Data Stewards of the Source/Data Asset","example":"32d50775-17c3-44f0-88da-575b8a10c9fb"}},"pii":{"description":"Indicates whether Data Asset is classified as PII or not","type":"boolean","example":true,"default":"false"},"additionalAttributes":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_MetadataValueDto"}},"terms":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTermAssociationRequest"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTagAssociationRequest"}}}},"DataUseGovernance-DataAssetManagement_OneTrustResponseListOfStringWrapper":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"},"example":["FileType","Content Size","File Owner"]}}},"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_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_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"}}},"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_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_AttributeOptionMetadata":{"type":"object","properties":{"hint":{"description":"Hint","type":"string"},"hintKey":{"description":"Hint key which can be used for translation","type":"string"}}},"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_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_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_OneTrustResponseListOfAttributeInformationWrapper":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_AttributeInformation"}},"errors":{"type":"array","items":{"type":"object"}}}},"DataUseGovernance-DataAssetManagement_DataAssetUser":{"type":"object","properties":{"id":{"description":"The unique identifier of the user who last updated the data asset.","type":"string","format":"uuid","example":"78d09995-6040-403f-b520-fa9b38ce0bf5"},"name":{"description":"The name of the user who last updated the data asset.","type":"string","example":"Stephen F"}}},"DataUseGovernance-DataAssetManagement_DataAssetTermAssociationResponse":{"type":"object","properties":{"termId":{"description":"The unique identifier of the term.","type":"string","format":"uuid","example":"b83f9fd5-7fdc-4481-90c5-20077239ecc9"},"termName":{"description":"The name of the term.","type":"string","example":"Social Security Number","maxLength":100,"minLength":1},"recommended":{"description":"This flag indicates whether the term was recommended via Data Discovery scan.","type":"boolean","example":true},"status":{"description":"The recommendation status of the term.","type":"string","enum":["PENDING","FLAGGED","APPROVED","REJECTED","DELETED"]},"source":{"description":"The source of the term association.","type":"string","enum":["BULK_IMPORT","DATA_DISCOVERY","DATA_DISCOVERY_REVIEW","CATALOG","SYNC","PARTIAL_SYNC","AUTO_APPROVAL_CLASSIFICATION","BULK_ACTION","GLOSSARY","EXTERNAL","CLOUD_DATA_DISCOVERY","AI_GOVERNANCE"]}}},"DataUseGovernance-DataAssetManagement_DataAssetTagAssociationResponse":{"type":"object","properties":{"tagId":{"description":"The unique identifier of the tag.","type":"string","format":"uuid","example":"67t09995-6040-403f-b520-fa9b38ce0bf5"},"tagName":{"description":"The name of the tag.","type":"string","example":"Confidential","maxLength":100,"minLength":1},"recommended":{"description":"This flag indicates whether the tag was recommended via Data Discovery scan.","type":"boolean","example":true},"inherited":{"description":"This flag indicates whether the tag was automatically inherited from the terms assigned to the data asset. ","type":"boolean","example":true},"status":{"description":"The recommendation status of the tag.","type":"string","enum":["PENDING","FLAGGED","APPROVED","REJECTED","DELETED"]},"source":{"description":"The source of the classification tag association.","type":"string","enum":["BULK_IMPORT","DATA_DISCOVERY","DATA_DISCOVERY_REVIEW","CATALOG","SYNC","PARTIAL_SYNC","AUTO_APPROVAL_CLASSIFICATION","BULK_ACTION","GLOSSARY","EXTERNAL","CLOUD_DATA_DISCOVERY","AI_GOVERNANCE"]}}},"DataUseGovernance-DataAssetManagement_DataAssetResponse":{"type":"object","properties":{"name":{"description":"The name of the data asset.","type":"string","example":"resume.pdf"},"shortDescription":{"description":"The description of the data asset.","type":"string","example":"Professional resume"},"dataSource":{"description":"The details of the data source.","$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataSource"},"type":{"description":"The type of data asset.","type":"string","enum":["DATASOURCE","DATABASE","OBJECT","SCHEMA","CATALOG","TABLE","COLUMN","FIELD","FOLDER","FILE","DRIVE","FILE_SYSTEM","VIEW","DIRECTORY"]},"parentId":{"description":"The unique identifier of the parent object. This parameter value is null for `type`: `DATASOURCE`.","type":"string","format":"uuid","example":"de6d404d-14d6-487f-bbf7-fd202bde4768"},"oneTrustAssetId":{"description":"The unique identifier of the data asset within Data Mapping Automation.","type":"string","format":"uuid","example":"498c3033-94ac-4497-89f2-44985b7f3df4"},"oneTrustSourceSystemId":{"description":"The unique identifier of the data source.","type":"string","format":"uuid","example":"9fc8e1a8-b7d1-47c5-8f4b-7ebd451506f8"},"technicalOwners":{"description":"The details of the technical owner(s) responsible for managing the technical details of the data asset.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetUser","description":"Technical Owners of the Data Asset"}},"businessOwners":{"description":"The details of the business owner(s) responsible for defining and updating the business context of the glossary.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetUser","description":"Business Owners of the Data Asset"}},"dataStewards":{"description":"The details of the data steward(s) responsible for utilizing data governance processes to ensure data reliability and validity within a data asset or business unit.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetUser","description":"Data Stewards of the Source/Data Asset"}},"pii":{"description":"This flag indicates whether the data asset is classified as PII.","type":"boolean","example":true,"default":"false"},"additionalAttributes":{"description":"The details of the associated attributes.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_MetadataValueDto"}},"terms":{"description":"The details of the associated terms.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTermAssociationResponse"}},"tags":{"description":"The details of the associated classification tags.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetTagAssociationResponse"}},"createdDate":{"description":"The date and time that the data asset was created.","type":"string","format":"date-time","example":"2025-02-19T10:00:00Z"},"createdBy":{"description":"The details of the user who created the data asset.","$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetUser"},"updatedDate":{"description":"The date and time that the data asset was last updated.","type":"string","format":"date-time","example":"2025-02-19T10:00:00Z"},"updatedBy":{"description":"The details of the user who last updated the data asset.","$ref":"#/components/schemas/DataUseGovernance-DataAssetManagement_DataAssetUser"},"id":{"description":"The unique identifier of the data asset.","type":"string","format":"uuid","example":"6756206c-845c-4ecc-8826-0e25d12b0d0c"}}},"DataUseGovernance-DataCatalogMetadataExchange_BetweenValue":{"type":"object","properties":{"from":{"description":"Start value for the range","type":"string","example":"61"},"to":{"description":"End value for the range","type":"string","example":"80"}}},"DataUseGovernance-DataCatalogMetadataExchange_Criterion":{"type":"object","properties":{"searchField":{"description":"Search field name","type":"string","example":"name","minLength":1},"operator":{"description":"Search field operator","type":"string","example":"EQ","enum":["EQ","NOT_EQ","GREATER_THAN","GREATER_THAN_EQUAL_TO","LESS_THAN_EQUAL_TO","AFTER_OR_ON","BEFORE_OR_ON","MORE_THAN","CONTAINS","BETWEEN","WITHIN_THE_LAST","DOES_NOT_CONTAIN","IS_EMPTY","IS_NOT_EMPTY","LIST_CONTAINS","LIST_DOES_NOT_CONTAIN","EQUALS_TO_ANY_OF","NOT_EQUALS_TO_ANY_OF","EQUALS_TO_ALL_OF","NOT_EQUALS_TO_ALL_OF","LIST_CONTAINS_ANY_OF","LIST_DOES_NOT_CONTAIN_ANY_OF"]},"value":{"description":"Value for the criterion","type":"string","example":"Table123"},"values":{"description":"Value range for the criterion","$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_BetweenValue"},"multiValue":{"type":"array","items":{"type":"string","description":"Value for the criterion","example":"EmployeeId"}},"dateUnitType":{"description":"Unit of date value","type":"string","example":"DAYS","enum":["DAYS","WEEKS","MONTHS","YEARS"]},"searchFieldDataType":{"description":"Data type of the field selected","type":"string","example":"string"},"searchMode":{"description":"Logical operator of the criterion","type":"string","example":"ALL","enum":["ANY","ALL"]},"searchQueryType":{"description":"Query type of the criterion","type":"string","example":"SIMPLE","enum":["SIMPLE","FULL"]},"multiValueRanges":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_BetweenValue","description":"Value range for the criterion"}}},"required":["operator"]},"DataUseGovernance-DataCatalogMetadataExchange_CriteriaGroup":{"type":"object","properties":{"operator":{"description":"Logical operator between criteria","type":"string","enum":["AND","OR"]},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_Criterion","description":"Individual criterion of a criteria"},"minItems":1}},"required":["operator"]},"DataUseGovernance-DataCatalogMetadataExchange_FilterCriteria":{"type":"object","properties":{"groupOperator":{"description":"Logical operator between criteria groups","type":"string","enum":["AND","OR"]},"criteriaGroups":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_CriteriaGroup","description":"Criteria group of a filter criteria"},"minItems":1}},"required":["groupOperator"]},"DataUseGovernance-DataCatalogMetadataExchange_SearchRequest":{"type":"object","properties":{"searchText":{"description":"Text to search for","type":"string","example":"data privacy"},"filterCriteria":{"description":"Filter criteria for the search","$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_FilterCriteria"},"searchFields":{"type":"array","items":{"type":"string","description":"Search fields for the filter criteria","example":"description"}},"facets":{"type":"array","items":{"type":"string","description":"Facets to include in the response","example":"documentType"}},"selectFields":{"type":"array","items":{"type":"string","description":"Fields to include in the response","example":"description"}},"partialSearch":{"description":"Whether to perform partial text matching","type":"boolean","default":"false"}}},"DataUseGovernance-DataCatalogMetadataExchange_ExternalSearchResponse":{"type":"object","properties":{"facets":{"description":"Faceted search results grouped by field","type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}},"documents":{"description":"List of search documents matching the search criteria","$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_OneTrustResponseListOTSearchDocument"},"continuationToken":{"description":"Token for continuing the search from where it left off","type":"string","example":"AAEADummyTokenMmFiZTNhN2QtYmE0YS00ZjdkLWDummyTokenIwMWMtNzlkMDMwNDAzMTRj6tK7tU1emDummyTokenbIyvCDNSloQC/Zaher0/mpJhLkkymvYdYvtI76p4"}}},"DataUseGovernance-DataCatalogMetadataExchange_FieldValue":{"type":"object","properties":{"value":{"description":"Search field value","type":"object","example":"Employee Details"},"nameKey":{"description":"Search field name key","type":"string","example":"DataDictionaryParent"},"dataType":{"description":"Search field data type","type":"string","example":"String"},"optionType":{"description":"Search field option type","type":"string","example":"users"},"enabled":{"description":"Search field boolean value","type":"boolean","example":true},"mappedFieldSchema":{"description":"Search field mapped field's schema","type":"string","example":"\"{\n \"name\": \"ClassificationTerm\",\n \"type\": \"Object\",\n \"fields\": [\n {\n \"type\": \"String\",\n \"name\": \"approvedTerm\",\n \"nameKey\": \"DataDictionaryGovSearchApprovedTerms\"\n },\n {\n \"type\": \"String\",\n \"name\": \"approvedTermId\",\n \"nameKey\": \"DataDictionaryGovSearchApprovedTermIds\"\n },\n {\n \"type\": \"String\",\n \"name\": \"recommendedTerm\",\n \"nameKey\": \"DataDictionaryGovSearchRecommendedTerms\"\n }\n ]\n}\"\n"}}},"DataUseGovernance-DataCatalogMetadataExchange_OTSearchDocument":{"type":"object","properties":{"id":{"description":"Unique identifier of the search document","type":"string","example":"172a829d-0f9f-45ab-b5f5-028d228c6edf","minLength":1},"documentType":{"description":"Type of the search document","type":"string","example":"metadata","minLength":1},"name":{"description":"Name of the search document","type":"string","example":"Employee table","minLength":1},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_FieldValue"},"writeOnly":true},"jobId":{"description":"Identifier for the job","type":"string","example":"234a829d-0f9f-45ab-b5f5-028d228abcd"},"source":{"description":"Source of the search document","type":"string","example":"data-discovery"}}},"DataUseGovernance-DataCatalogMetadataExchange_OneTrustMetadata":{"type":"object","properties":{"page":{"description":"The page number of the results.","$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_OneTrustPage"}}},"DataUseGovernance-DataCatalogMetadataExchange_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-DataCatalogMetadataExchange_OneTrustSort"}}}},"DataUseGovernance-DataCatalogMetadataExchange_OneTrustResponseListOTSearchDocument":{"type":"object","properties":{"data":{"description":"The parameters that detail entity data.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_OTSearchDocument"}},"errors":{"description":"This parameter provides error details if 400 Bad Request is returned.","type":"array","items":{"type":"object"}},"meta":{"description":"The configuration parameters of the page.","$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_OneTrustMetadata"}}},"DataUseGovernance-DataCatalogMetadataExchange_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-DataCatalogMetadataExchange_SearchResponse":{"type":"object","properties":{"facets":{"description":"Faceted search results grouped by field","type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}},"documents":{"description":"List of search documents matching the search criteria","$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_OneTrustResponseListOTSearchDocument"}}},"DataUseGovernance-DataCatalogMetadataExchange_SearchFieldV2":{"type":"object","properties":{"searchFieldName":{"description":"Name of the search field","type":"string","example":"name","minLength":1},"searchFieldDataType":{"description":"Data type of the field selected","type":"string","example":"string"},"operators":{"type":"array","items":{"type":"string","description":"Operators supported by search field","enum":["EQ","NOT_EQ","GREATER_THAN","GREATER_THAN_EQUAL_TO","LESS_THAN_EQUAL_TO","AFTER_OR_ON","BEFORE_OR_ON","MORE_THAN","CONTAINS","BETWEEN","WITHIN_THE_LAST","DOES_NOT_CONTAIN","IS_EMPTY","IS_NOT_EMPTY","LIST_CONTAINS","LIST_DOES_NOT_CONTAIN","EQUALS_TO_ANY_OF","NOT_EQUALS_TO_ANY_OF","EQUALS_TO_ALL_OF","NOT_EQUALS_TO_ALL_OF","LIST_CONTAINS_ANY_OF","LIST_DOES_NOT_CONTAIN_ANY_OF"],"example":"EQ"}}}},"DataUseGovernance-DataCatalogMetadataExchange_SearchFieldResponse":{"type":"object","properties":{"searchFields":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataCatalogMetadataExchange_SearchFieldV2","description":"List of search fields with their metadata"}}}}},"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"}}}}}}}