{"openapi":"3.1.0","info":{"title":"Data Use Governance - Data Discovery","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"},"description":"The Data Discovery API provides comprehensive REST endpoints for managing data discovery operations including data sources, scan profiles, credentials, and scan jobs with OAuth2 security and extensive filtering capabilities."},"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":"Classification","description":"The Classification APIs are used to manage custom data classifiers and classification rules for Data Discovery.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Classification"},{"name":"Credentials","description":"APIs to manage credential operations including creation, updates, deletion, retrieval, and secure reference key management for multiple system authentication types.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Credentials"},{"name":"Data Sources","description":"APIs to manage data sources including creation, retrieval, updates, deletion, and comprehensive filtering with support for multiple system types and asset integration.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Data Sources"},{"name":"Installer","description":"APIs to retrieve Docker image tags and installation resources for worker node deployment and version management across different environments.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Installer"},{"name":"Scan Jobs","description":"APIs to control scan job execution including creation, cancellation, status monitoring, and comprehensive job history retrieval with filtering and pagination support.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Scan Jobs"},{"name":"Scan Profiles","description":"APIs to handle scan profile lifecycle management including creation, updates, deletion, and retrieval with support for catalog and catalog-scan types across various system platforms.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Scan Profiles"}],"paths":{"/api/discovery-scan-config/v2/credentials":{"get":{"operationId":"getCredentials","summary":"Get List of Credentials","description":"Use this API to retrieve a list of all credentials. The response will include details such as the credential name, ID, and reference key.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"name","in":"query","description":"The parameter to search for a credential by name.","required":false,"schema":{"description":"The parameter to search for a credential by name.","type":"string","maxLength":200,"minLength":0},"example":"AmazonS3 Ref Credential"},{"name":"systemName","in":"query","description":"The parameter to search for a credential by systemName.","required":false,"schema":{"description":"The parameter to search for a credential by systemName.","type":"string","enum":["Azure Cosmos","Box","Cassandra","Azure Databricks","IBM DB2","Exchange","GCP","Google Workspace Gmail","Google BigQuery","Google BigTable","MongoDB","MySQL","OneDrive","Oracle RDBMS","PostgreSQL","Amazon S3","SalesForce","SAP HANA","ServiceNow","SharePoint","SMB","Snowflake","Microsoft SQL","Teradata","Workday","Zendesk","Amazon RDS for SQL Server","Azure SQL Server","Redshift","Google Drive","Amazon DynamoDB","Amazon Athena","SharePoint 2019 OnPrem","SFTP","NFS","GCS","Redis","Elastic Search","Microsoft Teams","Slack","AlibabaCloudOSS","Azure Files","Iceberg","Kafka"],"maxLength":50,"minLength":0},"example":"Amazon S3"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["name,asc","name,desc","systemName,asc","systemName,desc"]},"example":"name,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperCredentialDto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"put":{"operationId":"updateCredential","summary":"Update Credential","description":"Use this API to update an existing credential.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"responses":{"200":{"description":"Credential updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"post":{"operationId":"createCredential","summary":"Create Credential","description":"Use this API to create a new credential.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialRequestV2Dto"}}}},"responses":{"201":{"description":"Credential Created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/credentials/{id}":{"get":{"operationId":"getCredentialById","summary":"Get Credential","description":"Use this API to retrieve a single credential by its unique identifier.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"id","in":"path","description":"ID of the credential. This value can be obtained from Get Credentials API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"200":{"description":"Credential details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"delete":{"operationId":"deleteCredential","summary":"Delete Credential","description":"Use this API to delete an existing credential and its associated reference keys.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"id","in":"path","description":"ID of a credential. This value is obtained using [Create Credential]","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"204":{"description":"Credential deleted successfully"},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job":{"post":{"operationId":"createJobUsingPOST","summary":"Create Scan Job","description":"Use this API to create a new scan job in the specified data source.","tags":["Scan Jobs"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanJobTriggerV3Dto"}}}},"responses":{"201":{"description":"Scan job created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job/datasource/{dataSourceId}":{"get":{"operationId":"getScanJobsByDataSourceUsingGET_1","summary":"Get List of Scan Jobs","description":"Use this API to retrieve a list of all scan jobs in JSON format for the specified data source. The response will include relevant details for each scan job, including the corresponding scan job ID, created date, and cancelled date.","tags":["Scan Jobs"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"dataSourceId","in":"path","description":"The unique identifier of the data source.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d841a8dc-bd67-47cd-b5e3-418f7d243de7"},{"name":"status","in":"query","description":"Status of the job scan","required":false,"schema":{"type":"array","items":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"]}},"example":["PENDING","IN_PROGRESS","COMPLETED"]},{"name":"scanLevel","in":"query","description":"Array of scan levels","required":false,"schema":{"type":"array","items":{"type":"string","enum":["CATALOG","CATALOG_SCAN"]}},"example":["CATALOG","CATALOG_SCAN"]},{"name":"isManual","in":"query","description":"The flag to check if the retrieved jobs are Manual or Scheduled","required":false,"schema":{"type":"boolean"},"example":true},{"name":"createdFrom","in":"query","description":"The date (yyyy-mm-dd) to filter the scan jobs created on or after the specified date. For example, including the parameter createdFrom=2022-06-06 will filter results to scan jobs on or after June 6th, 2022.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00Z"},{"name":"createdTo","in":"query","description":"The date (yyyy-mm-dd) to filter the scan jobs created on or before the specified date. For example, including the parameter createdTo=2022-06-06 would filter results to scan jobs on or before June 6th, 2022.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-12-31T23:59:59Z"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["status,asc","status,desc","scanLevel,asc","scanLevel,desc","createdDate,asc","createdDate,desc"]},"example":"status,desc"}],"responses":{"200":{"description":"List of scan jobs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperMetadataScanJobDto"}}}},"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-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job/{jobId}":{"get":{"operationId":"getJobByIdUsingGET","summary":"Get Scan Job","description":"Use this API to retrieve details of a specific scan job by its unique identifier. Returns comprehensive job information including status, progress, timestamps, metadata counts, scan profile used, and ingestion status.","tags":["Scan Jobs"],"parameters":[{"name":"jobId","in":"path","description":"Unique identifier (UUID) of the scan job. Obtain from Create Scan Job API or Get List of Scan Jobs API. Must be a valid UUID format.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ef5c9081-431e-4577-bd91-1ff8bbd40f96"}],"responses":{"200":{"description":"Scan job details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job/{jobId}/cancel":{"patch":{"operationId":"cancelJobUsingPATCH","summary":"Cancel Scan Job","description":"Use this API to cancel an existing scan job by its unique identifier. The job must be in a cancellable state (PENDING, PROCESSING, PAUSING). Jobs that are already COMPLETED, FAILED, CANCELLED, or CANCELLING cannot be cancelled. The cancellation is asynchronous - the job status will change to CANCELLING immediately, then to CANCELLED once the worker node acknowledges the cancellation.","tags":["Scan Jobs"],"parameters":[{"name":"jobId","in":"path","description":"Unique identifier (UUID) of the scan job to cancel. Obtain from Create Scan Job API or Get List of Scan Jobs API. Must be a valid UUID format.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ef5c9081-431e-4577-bd91-1ff8bbd40f96"}],"responses":{"202":{"description":"Scan job cancellation accepted and initiated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-profiles":{"get":{"operationId":"getAllUsingGET_2","summary":"Get List of Scan Profiles","description":"Use this API to retrieve a list of all scan profiles. The response will include details for each scan profile along with the corresponding scan profile ID and its associated scan type, system, and paths.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"search","in":"query","description":"The parameter to search for a scan profile by name.","required":false,"schema":{"type":"string"},"example":"MySQL Profile"},{"name":"systemName","in":"query","description":"A system name. Include to filter results to be limited to scan profiles with this system. Some examples are \"Box\", \"Snowflake\", and \"MongoDB\".","required":false,"schema":{"type":"string","enum":["Azure Cosmos","Box","Cassandra","Azure Databricks","IBM DB2","Exchange","GCP","Google Workspace Gmail","Google BigQuery","Google BigTable","MongoDB","MySQL","OneDrive","Oracle RDBMS","PostgreSQL","Amazon S3","SalesForce","SAP HANA","ServiceNow","SharePoint","SMB","Snowflake","Microsoft SQL","Teradata","Workday","Zendesk","Amazon RDS for SQL Server","Azure SQL Server","Redshift","Google Drive","Amazon DynamoDB","Amazon Athena","SharePoint 2019 OnPrem","SFTP","NFS","GCS","Redis","Elastic Search","Microsoft Teams","Slack","AlibabaCloudOSS","Azure Files","Iceberg","Kafka"]},"example":"MySQL"},{"name":"scanType","in":"query","description":"It is the scan profile type.","required":false,"schema":{"type":"string","enum":["CATALOG","CATALOG_SCAN","OFFSET_REPORT"]},"example":"CATALOG"},{"name":"createdFrom","in":"query","description":"Include a date (yyyy-mm-dd) to filter the results to scan profiles created on or after the specified date. For example, including the parameter createdFrom=2021-08-17 will filter results to scan profiles on or after August 17th, 2021.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2021-09-11T01:41:50.143+00:00"},{"name":"createdTo","in":"query","description":"Include a date (yyyy-mm-dd) to filter the results to scan profiles created on or before the specified date. For example, including the parameter createdTo=2021-08-17 would filter results to scan profiles on or before August 17th, 2021.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2021-09-11T02:41:50.143+00:00"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["name,asc","name,desc","systemName,asc","systemName,desc","scanType,asc","scanType,desc","createdDate,asc","createdDate,desc"]},"example":"name,desc"}],"responses":{"200":{"description":"Successfully retrieved scan profiles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperScanProfileDto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"put":{"operationId":"updateV2UsingPUT","summary":"Update Scan Profile","description":"Use this API to update an existing scan profile.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"responses":{"200":{"description":"Scan Profile updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"post":{"operationId":"createV2UsingPOST","summary":"Create Scan Profile","description":"Use this API to create a new scan profile.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileRequestV2Dto"}}}},"responses":{"201":{"description":"Scan Profile created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}":{"get":{"operationId":"getScanProfileUsingGET_1","summary":"Get Scan Profile","description":"Use this API to retrieve a single scan profile by its unique identifier along with the associated scan type, system, and paths.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"scanProfileId","in":"path","description":"ID of a scan profile. This value can be obtained from Get All Scan Profiles API. Must be a valid UUID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"200":{"description":"Scan Profile retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"delete":{"operationId":"deleteScanProfileUsingDELETE_1","summary":"Delete Scan Profile","description":"Use this API to delete an existing scan profile.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"scanProfileId","in":"path","description":"ID of a scan profile. This value can be obtained from Get All Scan Profiles API. Must be a valid UUID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"204":{"description":"Scan Profile deleted successfully"},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scanners/{scannerId}/jobs/{jobId}":{"get":{"operationId":"getJobUsingGET_1","summary":"Get Scan Job","description":"Use this API to retrieve a single scan job in JSON format by its unique identifier.","tags":["Scan Jobs"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"scannerId","in":"path","description":"The unique identifier of the scanner, which is an alias for the Worker Node ID running the scan job. The scannerId value from Get List of Scan Jobs API can be used for scannerId","required":true,"schema":{"type":"string","format":"uuid"},"example":"5bb955f1-846f-4db9-a507-a534f1f3f07a"},{"name":"jobId","in":"path","description":"The unique identifier of the scan job. The id value from Get List of Scan Jobs API can be used for jobId","required":true,"schema":{"type":"string","format":"uuid"},"example":"ef5c9081-431e-4577-bd91-1ff8bbd40f96"}],"responses":{"200":{"description":"Scan job details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scanners/{scannerId}/jobs/{jobId}/cancel":{"patch":{"operationId":"cancelScanJob","summary":"Cancel Scan Job","description":"Use this API to cancel an existing scan job by its unique identifier.","tags":["Scan Jobs"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"scannerId","in":"path","description":"The unique identifier of the scanner, which is an alias for the Worker Node ID running the scan job. The scannerId value from Get List of Scan Jobs API can be used for scannerId.","required":true,"schema":{"type":"string","format":"uuid"},"example":"5bb955f1-846f-4db9-a507-a534f1f3f07a"},{"name":"jobId","in":"path","description":"The unique identifier of the scan job. The id value from Get List of Scan Jobs API can be used for jobId.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ef5c9081-431e-4577-bd91-1ff8bbd40f96"}],"responses":{"202":{"description":"Scan job cancellation accepted and initiated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"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-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v3/docker-repository-tags":{"get":{"operationId":"getDockerRepositoryTagsUsingGET","summary":"Get List of Image tags","description":"Use this API to retrieve a list of all Docker images for a specific worker node version.\n\n> 🗒 Things to Know\n>\n> - The list of Docker images will be returned in the following format: [REPOSITORY[ : TAG]], where tag stands for version number.","tags":["Installer"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"version","in":"query","description":"Version of the worker node.","required":false,"schema":{"type":"string"},"example":"202506.1.0"}],"responses":{"200":{"description":"List of installer docker image tag names","content":{"text/plain":{}}},"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-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v3/system":{"get":{"operationId":"getAllUsingGET_1","summary":"Get List of Data Sources","description":"Use this API to retrieve a list of data sources in JSON format. The response will include details for each data source along with the corresponding data source ID, system name, and associated settings.","tags":["Data Sources"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["name,asc","name,desc","systemType,asc","systemType,desc","createdDate,asc","createdDate,desc","status,desc","status,asc"]},"example":"name,desc"},{"name":"name","in":"query","description":"Name of the data source","required":false,"schema":{"type":"string"},"example":"AmazonS3 Datasource"},{"name":"systemType","in":"query","description":"Type of the system (e.g., AmazonS3)","required":false,"schema":{"type":"string","example":"AmazonS3","enum":["AzureCosmos","Box","Cassandra","AzureDatabricks","IBMDB2","Exchange","GCP","GoogleWorkspaceGmail","GoogleBigQuery","GoogleBigTable","MongoDB","MySQL","OneDrive","OracleRDBMS","PostgreSQL","AmazonS3","SalesForce","SAPHana","ServiceNow","SharePoint","SMB","Snowflake","MicrosoftSQL","Teradata","Workday","Zendesk","AmazonRDSforSQLServer","AzureSQLServer","Redshift","GoogleDrive","AmazonDynamoDB","AmazonAthena","SharePoint2019OnPrem","SFTP","NFS","GCS","Redis","ElasticSearch","MicrosoftTeams","Slack","AlibabaCloudOSS","AzureFiles","Iceberg","Kafka"]}},{"name":"createdFrom","in":"query","description":"The date (yyyy-mm-dd) to filter the data sources created on or after the specified date. For example, including the parameter createdFrom=2021-08-17 will filter results to data sources on or after August 17th, 2021.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2021-09-11T01:41:50.143+00:00"},{"name":"createdTo","in":"query","description":"The date (yyyy-mm-dd) to filter the results to data sources created on or before the specified date. For example, including the parameter createdFrom=2021-08-17 will filter results to data sources on or after August 17th, 2021.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2021-09-11T02:41:50.143+00:00"},{"name":"oneTrustAssetId","in":"query","description":"ID of the OneTrust asset.","required":false,"schema":{"type":"string","format":"uuid"},"example":"d841a8dc-bd67-47cd-b5e3-418f7d243de7"},{"name":"status","in":"query","description":"Status of the data source (e.g., ACTIVE, INACTIVE, DELETED)","required":false,"schema":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"]},"example":"ACTIVE"},{"name":"workerNodeId","in":"query","description":"ID of the worker node.","required":false,"schema":{"type":"string","format":"uuid"},"example":"5bb955f1-846f-4db9-a507-a534f1f3f07a"}],"responses":{"200":{"description":"Paginated list of data sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperDataSourceDto"}}}},"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-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]},"put":{"operationId":"upsertSourceSystemV3UsingPUT","summary":"Create or Update Data Source","description":"Use this API to create a new data source or update an existing data source. The data source will be created or updated with the details provided in the request body.","tags":["Data Sources"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_DataSourceV2Dto"}}}},"responses":{"200":{"description":"Data source upserted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_DataSourceV2Dto"}}}},"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-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v3/system/{id}":{"get":{"operationId":"getDataSourceByIdUsingGET_1","summary":"Get Data Source","description":"Use this API to retrieve a single data source in JSON format by its unique identifier.","tags":["Data Sources"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"id","in":"path","description":"UUID of the data source","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"200":{"description":"Data source details returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_OneTrustResponseDataSourceDtoWrapper"}}}},"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-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]},"delete":{"operationId":"deleteSystemUsingDELETE_1","summary":"Delete Data Source","description":"Use this API to delete an existing data source and its associated scan results.","tags":["Data Sources"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"id","in":"path","description":"UUID of the data source to be deleted","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"204":{"description":"Data source deleted"},"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-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]}},"/api/label-manager/v2/custom-classifiers":{"get":{"operationId":"listDetectors","summary":"Get List of Custom Classifiers","description":"Use this API to retrieve a list of all custom classifiers. The response will include details such as the classifier name, ID, and detector type.","tags":["Classification"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"searchTerm","in":"query","description":"The keyword used to search for classifiers.","required":false,"schema":{"description":"The keyword used to search for classifiers.","type":"string"},"example":"Employee Id"},{"name":"mappedTermId","in":"query","description":"The ID of the mapped term.","required":false,"schema":{"description":"The ID of the mapped term.","type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"responses":{"200":{"description":"Custom classifiers retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorSummaryDto"}}}}},"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-DataDiscoveryCustomClassiferMana_OAUTH2":["DATA_DISCOVERY","INTEGRATION"]}]},"post":{"operationId":"createDetector","summary":"Create Custom Classifier","description":"Use this API to create a custom classifier.","tags":["Classification"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_CustomDetectorDto"}}}},"responses":{"201":{"description":"Classifier created successfully","headers":{"Location":{"description":"URL of the created classifier","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_CustomDetectorDto"}}}},"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-DataDiscoveryCustomClassiferMana_OAUTH2":["DATA_DISCOVERY","INTEGRATION"]}]}},"/api/label-manager/v2/custom-classifiers/{classifierName}":{"get":{"operationId":"getDetectorByClassifierName","summary":"Get Custom Classifier","description":"Use this API to retrieve a specific custom classifier. The response will include details such as the detector type, detection rules, last modified date, and created date.","tags":["Classification"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"classifierName","in":"path","description":"The name of the classifier.","required":true,"schema":{"type":"string","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_\\- '\\(\\)]+$"},"example":"Employee Id"}],"responses":{"200":{"description":"Custom classifier retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorDto"}}}},"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-DataDiscoveryCustomClassiferMana_OAUTH2":["DATA_DISCOVERY","INTEGRATION"]}]},"put":{"operationId":"updateDetector","summary":"Update Custom Classifier","description":"Use this API to update an existing custom classifier.","tags":["Classification"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"classifierName","in":"path","description":"The name of the classifier.","required":true,"schema":{"type":"string","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_\\- '\\(\\)]+$"},"example":"Employee Id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_CustomDetectorDto"}}}},"responses":{"200":{"description":"Custom classifier updated successfully"},"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-DataDiscoveryCustomClassiferMana_OAUTH2":["DATA_DISCOVERY","INTEGRATION"]}]},"delete":{"operationId":"deleteDetector","summary":"Delete Custom Classifier","description":"Use this API to delete a custom classifier.","tags":["Classification"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"classifierName","in":"path","description":"The name of the classifier.","required":true,"schema":{"type":"string","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_\\- '\\(\\)]+$"},"example":"Employee Id"}],"responses":{"204":{"description":"Custom classifier deleted successfully"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Custom classifier not found"},"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-DataDiscoveryCustomClassiferMana_OAUTH2":["DATA_DISCOVERY","INTEGRATION"]}]}}},"components":{"schemas":{"DataUseGovernance-DataDiscovery_DataSourceTriggerDto":{"type":"object","properties":{"cronExpression":{"description":"Cron expression to define the schedule in standard cron format.","type":"string","example":"0 0/5 buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils ?"},"dateTime":{"description":"Specific date and time configuration for scheduling.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScheduleDateTime"},"isRunManual":{"description":"Flag to indicate whether the trigger should run manually.","type":"boolean","example":false},"id":{"type":"integer","format":"int64"},"runManual":{"type":"boolean"}}},"DataUseGovernance-DataDiscovery_DataSourceV2Dto":{"type":"object","properties":{"dataSourceName":{"description":"Name of Data Source","type":"string","example":"S3-DS-24thMarch"},"systemType":{"description":"System Type of Data Source","type":"string","example":"AmazonS3","enum":["AWS","Azure","AzureCosmos","AzureStorage","Box","Cassandra","Databricks","IBMDB2","Exchange","GCP","GoogleWorkspaceGmail","GoogleBigQuery","GoogleBigTable","MongoDB","MySQL","Netezza","Office365","OneDrive","OracleRDBMS","PostgreSQL","AmazonS3","AmazonSageMaker","AmazonBedrock","GCPVertex","AzureFoundry","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","Unknown","RELATIONAL_DATABASE","NON_RELATIONAL_DATABASE","FILE","API","Kafka","WorkdayApp"]},"systemName":{"description":"System Name of Data Source","type":"string","example":"Amazon S3"},"status":{"description":"Data Source current status","type":"string","example":"ACTIVE","enum":["INACTIVE","ACTIVE","DELETED"]},"oneTrustAssetId":{"description":"Asset ID for Data Source","type":"string","format":"uuid","example":"860abcce-fbf3-4f32-a38b-df19f8c08eae"},"orgGroupId":{"description":"Org Group ID for Data Source","type":"string","format":"uuid","example":"ec33136e-dd31-492b-8cd7-cb1a0109fe93"},"createdBy":{"description":"UserID who created Data Source","type":"string","format":"uuid","example":"e897fe47-a504-4dd4-8eda-52add1a397f0"},"modifiedBy":{"description":"UserID who modified Data Source","type":"string","format":"uuid","example":"e897fe47-a504-4dd4-8eda-52add1a397f0"},"createdDate":{"description":"Data Source Created date","type":"string","format":"date-time","example":"2022-04-04T11:33:16.538+00:00"},"modifiedDate":{"description":"Data Source modified date","type":"string","format":"date-time","example":"2022-04-04T11:53:16.538+00:00"},"dataSourceSettings":{"description":"Data Source Dto Settings","example":{"workerNodeName":"WN-24thAugust","scannerId":"e897fe47-a504-4dd4-8eda-52add1a397f0","scanProfileName":"ScanProfile-Mysql","scanProfileId":"e897fe47-a504-4dd4-8eda-52add1a397f0","credentialName":"Credential-Mysql","credentialId":"e897fe47-a504-4dd4-8eda-52add1a397f0","classificationProfileId":"c2845b2e-75bf-4a9b-a463-96a15fef85dc","detectorProfileId":"d2845b2e-75bf-4a9b-a463-96a15fef85dc","oneTrustAssetId":"860abcce-fbf3-4f32-a38b-df19f8c08eae"},"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_DataSourceSettingsV2Dto"},"dataSourceTriggerList":{"description":"Data Source Trigger List","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_DataSourceTriggerDto"},"example":[{"cronExpression":"0 0 buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils ? buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils *","dateTime":{"seconds":"0","minutes":"0","hours":{"label":"OneHour","value":"1","cronExp":null},"dayOfMonth":null,"month":null,"dayOfWeek":{"label":"M","value":"2","cronExp":"MON"},"year":null,"frequency":{"label":"Hourly","value":"8","cronExp":"?"},"frequencyIntervalTracker":"?"},"isRunManual":false,"id":17717}]},"systemId":{"description":"SystemTile ID for Data Source","type":"string","format":"uuid","example":"760abcce-fbf3-4f32-a28b-df19f8c08eae"},"id":{"type":"string","format":"uuid"}}},"DataUseGovernance-DataDiscovery_ScheduleDateTime":{"type":"object","properties":{"seconds":{"description":"Seconds field for the cron expression.","type":"string","example":"1"},"minutes":{"description":"Minutes field for the cron expression.","type":"string","example":"1"},"hours":{"description":"Hours field for the cron expression.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScheduleDateTimeField"},"dayOfMonth":{"description":"Day of month field for the cron expression.","type":"string","example":"*"},"month":{"description":"Month field for the cron expression.","type":"string","example":"*"},"dayOfWeek":{"description":"Day of week field for the cron expression.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScheduleDateTimeField"},"year":{"description":"Year field for the cron expression.","type":"string","example":"*"},"frequency":{"description":"Frequency configuration.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScheduleDateTimeField"},"frequencyIntervalTracker":{"description":"Frequency interval tracker information.","type":"string","example":"5"}}},"DataUseGovernance-DataDiscovery_ScheduleDateTimeField":{"type":"object","properties":{"label":{"description":"Label for the field, typically used for display purposes.","type":"string","example":"Every Hour"},"value":{"description":"Value representing the selected option for this field.","type":"string","example":"H"},"cronExp":{"description":"The cron expression fragment for this field.","type":"string","example":"0 0/5 buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils ?"}}},"DataUseGovernance-DataDiscovery_DataSourceSettingsV2Dto":{"type":"object","properties":{"scannerId":{"description":"Scanner Id for Data Source","type":"string","format":"uuid","example":"4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"},"workerNodeName":{"description":"Worker Node Name","type":"string","example":"WN-24thAugust"},"scanProfileId":{"description":"ScanProfile ID for Data Source","type":"string","format":"uuid","example":"3f162d7c-a463-4bf1-a7c4-b7899f6dcdef"},"scanProfileName":{"description":"ScanProfile Name for Data Source","type":"string","example":"ScanProfile-Mysql"},"credentialId":{"description":"Credential ID for Data Source","type":"string","format":"uuid","example":"8f162d7c-a563-4bf1-a0c4-b7899f6dcdef"},"credentialName":{"description":"Credential Name for Data Source","type":"string","example":"Credential-Mysql"},"oneTrustAssetId":{"description":"Asset ID for Data Source","type":"string","format":"uuid","example":"860abcce-fbf3-4f32-a38b-df19f8c08eae"},"classificationProfileId":{"description":"ClassifiactionProfile ID for Data Source","type":"string","format":"uuid","example":"3f162d7c-a863-4bf1-a9c4-b7899f6dcdef"},"detectorProfileId":{"description":"DetectorProfile ID for Data Source","type":"string","format":"uuid","example":"3f162d7c-a863-4bf1-a9c4-b7899f6dcdef"},"metadataClassificationEnabled":{"description":"Metadata Classification Enabled/Disabled","type":"boolean","example":false},"id":{"type":"integer","format":"int64"}}},"DataUseGovernance-DataDiscovery_ScanProfileV2Dto":{"type":"object","properties":{"id":{"description":"Unique ID for Scan Profile","type":"string","format":"uuid","example":"4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"},"name":{"description":"Name of Scan Profile","type":"string","example":"My SQL Scan Profile"},"scanType":{"description":"Scan Type of Scan Profile","type":"string","example":"CATALOG","enum":["CATALOG","CATALOG_SCAN"]},"sourceType":{"description":"Source of this Scan Profile","type":"string","example":"USER_DEFINED","enum":["SEED","USER_DEFINED"]},"systemName":{"description":"System Name of Scan Profile","type":"string","example":"MySQL"},"scanProfileContext":{"description":"Properties of Scan Profile Specific to System","type":"object","example":{"type":"MySQL","includes":[{"database":"OT","table":"Employee","columns":"Name"}],"excludes":[{"database":"OT","table":"Credential","columns":"Id"}],"samplingScan":{"enableSampling":false},"tableLimits":{"randomize":false,"maxCount":10},"tableTypes":["TABLE"],"databaseLimits":{"randomize":false,"maxCount":1}}},"systemType":{"description":"System Type of Scan Profile","type":"string","example":"RELATIONAL_DATABASE","enum":["RELATIONAL_DATABASE","NON_RELATIONAL_DATABASE","FILE","API","CUSTOM","UNKNOWN","CLOUD_PLATFORM","MACHINE_LEARNING_PLATFORM"]},"createdDate":{"description":"Creation Date of Scan Profile","type":"string","format":"date-time","example":"2021-09-11T01:41:50.143+00:00"},"displayName":{"description":"Display Name for System Name of Scan Profile","type":"string","example":"Amazon Redshift"}},"required":["id","name","scanProfileContext","scanType","systemName","systemType"]},"DataUseGovernance-DataDiscovery_CredentialV2Dto":{"type":"object","properties":{"id":{"description":"Unique ID for Credential","type":"string","format":"uuid","example":"4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"},"name":{"description":"Name of Credential","type":"string","example":"MySQL Credential","maxLength":200,"minLength":0},"description":{"description":"Credential Description","type":"string","example":"MySQL Ref Credential","maxLength":1024,"minLength":0},"systemName":{"description":"System Name","type":"string","example":"MySQL","enum":["Azure Cosmos","Box","Cassandra","Azure Databricks","IBM DB2","Exchange","GCP","Google Workspace Gmail","Google BigQuery","Google BigTable","MongoDB","MySQL","OneDrive","Oracle RDBMS","PostgreSQL","Amazon S3","SalesForce","SAP HANA","ServiceNow","SharePoint","SMB","Snowflake","Microsoft SQL","Teradata","Workday","Zendesk","Amazon RDS for SQL Server","Azure SQL Server","Redshift","Google Drive","Amazon DynamoDB","Amazon Athena","SharePoint 2019 OnPrem","SFTP","NFS","GCS","Redis","Elastic Search","Microsoft Teams","Slack","AlibabaCloudOSS","Azure Files","Iceberg","Kafka"],"maxLength":50,"minLength":0},"referenceKey":{"description":"Reference Key","type":"string","example":"kv/mysql","maxLength":100,"minLength":0},"workerNodeName":{"description":"Worker Node Name","type":"string","example":"WN-24thAugust","maxLength":256,"minLength":0}}},"DataUseGovernance-DataDiscovery_ScanProfileRequestV2Dto":{"type":"object","properties":{"name":{"description":"Name of Scan Profile","type":"string","example":"My SQL Scan Profile"},"scanType":{"description":"Scan Type of Scan Profile","type":"string","example":"CATALOG","enum":["CATALOG","CATALOG_SCAN"]},"systemName":{"description":"System Name of Scan Profile","type":"string","example":"MySQL"},"scanProfileContext":{"description":"Properties of Scan Profile Specific to System","type":"object","example":{"type":"MySQL","includes":[],"excludes":[],"dsarExtract":true,"clearingIndex":true,"databaseLimits":{"randomize":false,"maxCount":null,"maxPercentage":null},"tableLimits":{"randomize":false,"maxCount":null,"maxPercentage":null},"rowLimits":{"randomize":false,"maxCount":null,"maxPercentage":null},"customQuery":null,"tableTypes":["TABLE"]}},"systemType":{"description":"System Type of Scan Profile","type":"string","example":"RELATIONAL_DATABASE","enum":["RELATIONAL_DATABASE","NON_RELATIONAL_DATABASE","FILE","API","CUSTOM","UNKNOWN","CLOUD_PLATFORM","MACHINE_LEARNING_PLATFORM"]},"displayName":{"description":"Display Name for System Name of Scan Profile","type":"string","example":"Amazon Redshift"}},"required":["name","scanProfileContext","scanType","systemName","systemType"]},"DataUseGovernance-DataDiscovery_ScanJobTriggerV3Dto":{"type":"object","properties":{"dataSourceId":{"description":"Unique identifier of the data source to scan. This data source must exist and be active.","type":"string","format":"uuid","example":"4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"},"scanProfileId":{"description":"Optional scan profile ID to use for this scan job. If provided, must match the data source system type. If not provided, the data source's default scan profile will be used.","type":"string","format":"uuid","example":"ad390cb4-9ce9-4976-8895-66d724493c7b"},"classificationProfileId":{"description":"Classification profile ID for the scan job. Used when classification v2 is disabled. Either this or detectorProfileId should be provided for classification scans.","type":"string","format":"uuid","example":"cd490cb4-9ce9-4976-8895-66d724493c5d"},"detectorProfileId":{"description":"Detector profile ID for the scan job. Used when classification v2 is enabled. Either this or classificationProfileId should be provided for classification scans.","type":"string","format":"uuid","example":"cd490cb4-9ce9-4976-8895-66d724493c5d"}},"required":["dataSourceId"]},"DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto":{"type":"object","properties":{"name":{"description":"Name of Scan job","type":"string","example":"S3-DS-24thMarch","minLength":1},"sourceSystemId":{"description":"Source System ID for Scan job","type":"string","format":"uuid","example":"4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"},"scannerId":{"description":"Scanner ID for Scan Job","type":"string","format":"uuid","example":"4f162d7c-a563-4bf1-a7c4-b7899f6dcdef"},"status":{"description":"Scan job scan status","type":"string","example":"Completed","enum":["QUEUED","PENDING","PROCESSING","COMPLETED","ABORTED","STOPPED_AS_LOAD_ABORTED","CANCELLED","CANCELLING","FAILED","PAUSED","PAUSING","RESUMING"]},"statusMessage":{"description":"Scan job status message","type":"string","example":"status message"},"scanLevel":{"description":"Scan Job scan level","type":"string","example":"CATALOG_SCAN","enum":["INCREMENTAL_SCAN","FULL_SCAN","SCAN","SOURCING","CATALOG","CATALOG_SCAN","QUERY","FILE_RETRIEVAL","OFFSET_REPORT","CATALOG_POLICY_SCAN","ASSET_DISCOVERY","DATA_ELEMENT_DISCOVERY","POLICY_ORCHESTRATION_APPLY","POLICY_ORCHESTRATION_UNAPPLY","POLICY_ORCHESTRATION_EDIT","POLICY_ORCHESTRATION_DELETE","ROLE_INGESTION","AI_ASSET_DISCOVERY","GUARDRAIL_POLICY_ENFORCEMENT"]},"isManual":{"type":"boolean","writeOnly":true},"isVoyager":{"type":"boolean","writeOnly":true},"jobContext":{"type":"object"},"expectedRecordCount":{"description":"Scan Job expected record count","type":"integer","format":"int64","example":8},"failedRecordCount":{"description":"Scan Job failed record count","type":"integer","format":"int64","example":0},"successRecordCount":{"description":"Scan Job success record count","type":"integer","format":"int64","example":8},"cancelledRecordCount":{"description":"Scan Job cancelled record count","type":"integer","format":"int64","example":0},"scannedMetadataCount":{"description":"Scan Job scanned metadata count","type":"integer","format":"int64","example":38},"uploadedMetadataCount":{"description":"Scan Job uploaded metadata count","type":"integer","format":"int64","example":38},"failedIngestionCount":{"description":"Scan Job failed ingestion count","type":"integer","format":"int64","example":0},"createdDate":{"description":"Scan Job creation date","type":"string","format":"date-time","example":"2022-05-24T14:44:02.596+00:00"},"createdBy":{"description":"User who created Scan Job","type":"string","format":"uuid","example":"2ae93388-bef6-4b84-a612-8a4904b78dac"},"jobProgress":{"description":"Scan Jobs progress","type":"number","format":"double","example":100},"updatedDate":{"description":"Scan Job updated date","type":"string","format":"date-time","example":"2022-05-24T14:44:22.294+00:00"},"updatedBy":{"description":"user who last updated scan job","type":"string","format":"uuid","example":"2ae93388-bef6-4b84-a612-8a4904b78dac"},"cancelledBy":{"description":"user who cancelled scan job","type":"string","format":"uuid","example":"2ae93388-bef6-4b84-a612-8a4904b78dac"},"cancelledDate":{"description":"Scan Job cancelled date","type":"string","format":"date-time","example":"2022-05-24T14:44:22.294+00:00"},"pausedBy":{"description":"user who paused scan job","type":"string","format":"uuid","example":"2ae93388-bef6-4b84-a612-8a4904b78dac"},"pausedDate":{"description":"Scan Job paused date","type":"string","format":"date-time","example":"2022-05-24T14:44:22.294+00:00"},"resumedBy":{"description":"user who resumed scan job","type":"string","format":"uuid","example":"2ae93388-bef6-4b84-a612-8a4904b78dac"},"resumedDate":{"description":"Scan Job resumed date","type":"string","format":"date-time","example":"2022-05-24T14:44:22.294+00:00"},"classifiedTermsCount":{"description":"Scan Job classified terms count","type":"integer","format":"int64","example":7},"ingestionStatus":{"description":"Scan Job ingestion status","type":"string","example":"PUBLISHED","enum":["AWAITING","PUBLISHING","PUBLISHED","NONE"]},"ingestionDate":{"description":"Scan Job ingestion date","type":"string","format":"date-time","example":"2022-05-24T14:44:33.803+00:00"},"ingestedMetadataVolume":{"description":"Scan job ingestion metadata volume in bytes","type":"integer","format":"int64","example":37734},"scannedCount":{"description":"Scan Job Scan count","type":"string","example":{"S3_BUCKET":3,"Column":14,"File":4,"DataSource":1}},"totalContentSize":{"description":"Scan Job total content size in bytes","type":"integer","format":"int64","example":295454},"scanProfile":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"},"retryAttempts":{"description":"Total Retry Attempts for scan job failures","type":"integer","format":"int32","example":1},"maxRetries":{"description":"Max Retries allowed for scan job failures","type":"integer","format":"int32","example":3},"idleScanDuration":{"description":"Idle time of scan when Paused (or) during retry","type":"integer","format":"int64","example":377342131},"scanDuration":{"description":"Actual Scan duration","type":"integer","format":"int64","example":377342131},"scanStartedDate":{"description":"Actual Scan start date","type":"string","format":"date-time","example":"2022-05-24T14:44:22.294+00:00"},"id":{"type":"string","format":"uuid"},"manual":{"type":"boolean"},"voyager":{"type":"boolean"}},"example":[{"id":1,"name":"Item"}],"required":["scannerId","sourceSystemId","status"]},"DataUseGovernance-DataDiscovery_CredentialRequestV2Dto":{"type":"object","properties":{"name":{"description":"Name of Credential","type":"string","example":"MySQL Credential","maxLength":200,"minLength":0},"description":{"description":"Credential Description","type":"string","example":"MySQL Ref Credential","maxLength":1024,"minLength":0},"systemName":{"description":"System Name","type":"string","example":"MySQL","maxLength":50,"minLength":0},"referenceKey":{"description":"Reference Key","type":"string","example":"kv/mysql","maxLength":100,"minLength":0},"workerNodeName":{"description":"Worker Node Name","type":"string","example":"WN-24thAugust","maxLength":256,"minLength":0}}},"DataUseGovernance-DataDiscovery_PageWrapperDataSourceDto":{"type":"object","properties":{"content":{"description":"The content of this page.","example":[{"id":1,"name":"Item"}],"items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_DataSourceV2Dto"},"type":"array"},"number":{"description":"Current page number.","type":"integer","format":"int32","example":0},"size":{"description":"The size of the page (number of elements per page).","type":"integer","format":"int32","example":20},"numberOfElements":{"description":"The number of elements on the current page.","type":"integer","format":"int32","example":15},"totalElements":{"description":"The total number of elements across all pages.","type":"integer","format":"int32","example":150},"totalPages":{"description":"The total number of pages.","type":"integer","format":"int32","example":8},"first":{"description":"Indicates if this is the first page.","type":"boolean","example":true},"last":{"description":"Indicates if this is the last page.","type":"boolean","example":false},"empty":{"description":"Indicates if the page is empty.","type":"boolean","example":false},"sort":{"description":"Sorting information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Sort"},"pageable":{"description":"Pagination information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Pageable"}}},"DataUseGovernance-DataDiscovery_Pageable":{"type":"object","properties":{"page":{"type":"integer","format":"int32","minimum":0},"size":{"type":"integer","format":"int32","minimum":1},"sort":{"type":"array","items":{"type":"string"}}}},"DataUseGovernance-DataDiscovery_Sort":{"type":"object","properties":{"sort":{"type":"array","items":{"type":"string"}}}},"DataUseGovernance-DataDiscovery_OneTrustMetadata":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_OneTrustPage"}}},"DataUseGovernance-DataDiscovery_OneTrustPage":{"type":"object","properties":{"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_OneTrustSort"}}}},"DataUseGovernance-DataDiscovery_OneTrustResponseDataSourceDtoWrapper":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_DataSourceV2Dto"},"errors":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_OneTrustMetadata"}}},"DataUseGovernance-DataDiscovery_OneTrustSort":{"type":"object","properties":{"direction":{"type":"string","enum":["ASC","DESC"]},"property":{"type":"string"}}},"DataUseGovernance-DataDiscovery_PageWrapperScanProfileDto":{"type":"object","properties":{"content":{"description":"The content of this page.","example":[{"id":1,"name":"Item"}],"items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"},"type":"array"},"number":{"description":"Current page number.","type":"integer","format":"int32","example":0},"size":{"description":"The size of the page (number of elements per page).","type":"integer","format":"int32","example":20},"numberOfElements":{"description":"The number of elements on the current page.","type":"integer","format":"int32","example":15},"totalElements":{"description":"The total number of elements across all pages.","type":"integer","format":"int32","example":150},"totalPages":{"description":"The total number of pages.","type":"integer","format":"int32","example":8},"first":{"description":"Indicates if this is the first page.","type":"boolean","example":true},"last":{"description":"Indicates if this is the last page.","type":"boolean","example":false},"empty":{"description":"Indicates if the page is empty.","type":"boolean","example":false},"sort":{"description":"Sorting information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Sort"},"pageable":{"description":"Pagination information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Pageable"}}},"DataUseGovernance-DataDiscovery_PageWrapperMetadataScanJobDto":{"type":"object","properties":{"content":{"description":"The content of this page.","example":[{"id":1,"name":"Item"}],"items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"},"type":"array"},"number":{"description":"Current page number.","type":"integer","format":"int32","example":0},"size":{"description":"The size of the page (number of elements per page).","type":"integer","format":"int32","example":20},"numberOfElements":{"description":"The number of elements on the current page.","type":"integer","format":"int32","example":15},"totalElements":{"description":"The total number of elements across all pages.","type":"integer","format":"int32","example":150},"totalPages":{"description":"The total number of pages.","type":"integer","format":"int32","example":8},"first":{"description":"Indicates if this is the first page.","type":"boolean","example":true},"last":{"description":"Indicates if this is the last page.","type":"boolean","example":false},"empty":{"description":"Indicates if the page is empty.","type":"boolean","example":false},"sort":{"description":"Sorting information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Sort"},"pageable":{"description":"Pagination information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Pageable"}}},"DataUseGovernance-DataDiscovery_PageWrapperCredentialDto":{"type":"object","properties":{"content":{"description":"The content of this page.","example":[{"id":1,"name":"Item"}],"items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"},"type":"array"},"number":{"description":"Current page number.","type":"integer","format":"int32","example":0},"size":{"description":"The size of the page (number of elements per page).","type":"integer","format":"int32","example":20},"numberOfElements":{"description":"The number of elements on the current page.","type":"integer","format":"int32","example":15},"totalElements":{"description":"The total number of elements across all pages.","type":"integer","format":"int32","example":150},"totalPages":{"description":"The total number of pages.","type":"integer","format":"int32","example":8},"first":{"description":"Indicates if this is the first page.","type":"boolean","example":true},"last":{"description":"Indicates if this is the last page.","type":"boolean","example":false},"empty":{"description":"Indicates if the page is empty.","type":"boolean","example":false},"sort":{"description":"Sorting information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Sort"},"pageable":{"description":"Pagination information for the page.","$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_Pageable"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_ContextConfig":{"type":"object","properties":{"windowBefore":{"description":"The maximum number of characters to include for context before the match.","type":"integer","format":"int32","example":10},"windowAfter":{"description":"The maximum number of characters to include for context after the match.","type":"integer","format":"int32","example":15}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_CustomDetectorDto":{"type":"object","properties":{"name":{"description":"The name of the classifier.","type":"string","example":"Employee Id","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_\\- '\\(\\)]+$"},"description":{"description":"The description of the classifier.","type":"string","example":"Find Employee ID"},"isPII":{"description":"This flag indicates whether the classifier contains personally identifiable information.","type":"boolean","example":false},"definition":{"description":"The technical definition of the classifier.","example":{"detections":[{"name":"9 digit Employee ID ","type":"PATTERN","pattern":{"regex":"(?:^|\\b)\\d{9}(?:\\b|$)","flags":"gm"},"likelihood":"POSSIBLE"},{"name":"Known Short Special Employee ID","type":"DICTIONARY","dictionary":{"terms":["00001","10000"],"ignoreCase":true},"likelihood":"POSSIBLE"}],"detectionRules":[{"type":"PATTERN","name":"Invalid Column Name","inverse":false,"target":"COLUMN_NAME","includeExpand":false,"likelihoodAdjustment":{"type":"SET","setLikelihood":"NO_MATCH"},"pattern":{"regex":"license|key|code|security|passport|password|url|token","flags":"mi"}},{"type":"PATTERN","name":"Boost Likelihood for IDs Do Not Start with 123 (Example of Using Inverse)","inverse":true,"target":"FINDING","includeExpand":false,"likelihoodAdjustment":{"type":"ADJUST","adjustLikelihood":1},"pattern":{"regex":"^123","flags":"mi"}},{"type":"PATTERN","name":"Append 4 Digit Extension If Found (Example of Using includeExpand)","inverse":false,"target":"FINDING","includeExpand":true,"likelihoodAdjustment":{"type":"ADJUST","adjustLikelihood":0},"pattern":{"regex":"^[-_+][0-9]{4}","flags":"mi"}},{"name":"Deny List Context","type":"DICTIONARY","target":"CONTEXT","dictionary":{"ignoreCase":true,"terms":["telefon","telefax","telex","telephone"]},"context":{"windowBefore":15,"windowAfter":15},"likelihoodAdjustment":{"type":"SET","setLikelihood":"VERY_UNLIKELY"}},{"name":"Matches Context For Employee ID","type":"DICTIONARY","target":"CONTEXT","dictionary":{"ignoreCase":true,"terms":["Employee ID","Employee Identification"]},"context":{"windowBefore":10,"windowAfter":10},"likelihoodAdjustment":{"type":"ADJUST","adjustLikelihood":1}},{"name":"Matches Term Object Name (File/Column Name)","type":"DICTIONARY","dictionary":{"terms":["Employee","Employee_Id"],"ignoreCase":true},"target":"OBJECT_NAME","likelihoodAdjustment":{"type":"SET","setLikelihood":"VERY_LIKELY"}}]},"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorDefinition"},"glossaryTerm":{"description":"The glossary term associated with the classifier.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_GlossaryTermDto"},"detectorVersion":{"description":"The version number of the detector used by the classifier.","type":"integer","format":"int64","example":1,"readOnly":true},"id":{"description":"The unique identifier of the classifier.","type":"string","format":"uuid","example":"a997fe47-a504-4dd4-8eda-52add1a397f0","readOnly":true},"code":{"description":"The system-generated code of the classifier.","type":"string","readOnly":true},"custom":{"description":"This flag indicates whether the classifier is custom-created.","type":"boolean","example":false,"readOnly":true},"enabled":{"description":"This flag indicates whether the classifier is active.","type":"boolean","example":true,"readOnly":true},"surrogateType":{"description":"The surrogate type associated with the classifier.","type":"string","readOnly":true},"detectorType":{"description":"The type of detector used by the classifier to classify data.","type":"string","example":"DICTIONARY","enum":["PATTERN","DICTIONARY","SURROGATE","VALIDATOR","TEMPLATE","COMPLEX"],"readOnly":true},"isGlossaryTermChanged":{"description":"This flag indicates whether the glossary term association has changed.","type":"boolean","example":false,"readOnly":true},"lastModifiedDate":{"description":"The date and time when the classifier was last modified.","type":"string","format":"date-time","example":"2024-04-04T11:33:16.538+00:00","readOnly":true},"createdDate":{"description":"The date and time when the classifier was created.","type":"string","format":"date-time","example":"2024-04-04T11:33:16.538+00:00","readOnly":true},"createdBy":{"description":"The unique identifier of the user that created the classifier.","type":"string","format":"uuid","example":"a897fe47-a504-4dd4-8eda-52add1a397f1","readOnly":true},"lastModifiedBy":{"description":"The unique identifier of the user that last modified the classifier.","type":"string","format":"uuid","example":"e897fe47-a504-4dd4-8eda-52add1a397f0","readOnly":true},"version":{"description":"The version number used for optimistic locking.","type":"integer","format":"int64","example":1,"readOnly":true}},"required":["definition","isPII","name"]},"DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectionRule":{"type":"object","properties":{"type":{"description":"The type of detection rule applied to validate matches.","type":"string","example":"PATTERN","enum":["PATTERN","DICTIONARY","VALIDATOR"]},"name":{"description":"The name of the detection rule used for validation.","type":"string","example":"Check If The Finding Starts With 123"},"dictionary":{"description":"The dictionary configuration used in the detection rule.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DictionaryConfig"},"pattern":{"description":"The pattern configuration used in the detection rule.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_RegexPatternConfig"},"validator":{"description":"The validator configuration used in the detection rule.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_ValidatorConfig"},"inverse":{"description":"This flag indicates whether to return matches that meet or do not meet the detection rule criteria.","type":"boolean","default":"false"},"target":{"description":"The target option where the detection rule is applied.","type":"string","enum":["FINDING","CONTEXT","XPATH","OBJECT_NAME","OBJECT_PARENT","FILE_EXTENSION","FILE_NAME","COLUMN_NAME"]},"context":{"description":"The context configuration for the detection rule.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_ContextConfig"},"likelihoodAdjustment":{"description":"The likelihood adjustment configuration applied when detection rule criteria are met.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_LikelihoodAdjustment"},"includeExpand":{"description":"This flag indicates whether to include context that matches or does not match the detection rule criteria.","type":"boolean","default":"false"}},"required":["type"]},"DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorDefinition":{"type":"object","properties":{"name":{"description":"The name of the classifier definition.","type":"string","example":"Employee Id"},"otCode":{"description":"The OneTrust code assigned to the classifier definition.","type":"string","example":"system_address_es","readOnly":true},"isCustom":{"description":"This flag indicates whether the classifier definition is custom-created.","type":"boolean","example":false,"readOnly":true},"VERSION":{"description":"The version number of the classifier definition.","type":"integer","format":"int64","example":1,"readOnly":true},"SCHEMA_VERSION":{"description":"The schema version used for the classifier definition.","type":"string","example":"1.0.0","readOnly":true},"metadata":{"description":"The metadata information associated with the classifier definition.","example":{"displayName":"Politics","otDisplayName":"Politics","description":"This Classifier represents someone's political affiliation based on political parties and ideologies.","sensitivityLevel":"HIGH"},"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorMetadata"},"detections":{"description":"The list of detectors used to establish the best matching criteria.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_PotentialMatchRule"}},"detectionRules":{"description":"The list of detection rules used to validate and adjust the likelihood result.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectionRule"}},"evaluations":{"description":"The list of evaluation test cases used to validate the classifier.","type":"array","items":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_Evaluation"},"readOnly":true}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorMetadata":{"type":"object","properties":{"displayName":{"description":"The display name used for the classifier in user interfaces.","type":"string","example":"Credit Card Number"},"otDisplayName":{"description":"The OneTrust display name used for the classifier.","type":"string","example":"Uniform Resource Locator"},"description":{"description":"The description of the classifier metadata.","type":"string","example":"Detects credit card numbers in text using pattern matching."},"locations":{"description":"The list of geographic locations where the classifier applies.","type":"array","items":{"type":"string","description":"List of geographical locations relevant for the detector.","example":"[\"US\",\"EU\",\"APAC\"]"},"example":["US","EU","APAC"]},"languages":{"description":"The list of languages supported by the classifier.","type":"array","items":{"type":"string","description":"List of languages supported by this detector.","example":"[\"en\",\"fr\",\"de\"]"},"example":["en","fr","de"]},"industries":{"description":"The list of industries where the classifier is applicable.","type":"array","items":{"type":"string","description":"Industries where this detector is applicable.","example":"[\"Finance\",\"Healthcare\"]"},"example":["Finance","Healthcare"]},"categories":{"description":"The list of categories assigned to the classifier.","type":"array","items":{"type":"string","description":"Categories assigned to this detector for classification.","example":"[\"PII\",\"Financial\"]"},"example":["PII","Financial"]},"sensitivityLevel":{"description":"The sensitivity level assigned to the classifier data.","type":"string","example":"HIGH"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_DictionaryConfig":{"type":"object","properties":{"terms":{"description":"The list of terms or keywords used in the detection rule dictionary.","type":"array","items":{"type":"string"},"example":["hello","hello world"]},"ignoreCase":{"description":"This flag indicates whether the detection rule dictionary ignores case sensitivity.","type":"boolean","example":false,"default":"false"}},"required":["terms"]},"DataUseGovernance-DataDiscoveryCustomClassiferMana_Evaluation":{"type":"object","properties":{"text":{"description":"The sample text used for evaluation testing.","type":"string"},"match":{"description":"The list of expected matches for the evaluation test case.","type":"array","items":{"type":"string"}},"metadata":{"description":"The metadata information associated with the evaluation test case.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_Metadata"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_FilterFlags":{"type":"object","properties":{"ignoreCase":{"description":"This flag indicates whether word filtering ignores case sensitivity.","type":"boolean"},"inverse":{"description":"This flag indicates whether to apply inverse word filtering logic.","type":"boolean"},"startBoundary":{"description":"The boundary condition applied at the start of word filtering.","type":"string","enum":["ALWAYS","NEVER","IGNORE"]},"endBoundary":{"description":"The boundary condition applied at the end of word filtering.","type":"string","enum":["ALWAYS","NEVER","IGNORE"]}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_GlossaryTermDto":{"type":"object","properties":{"name":{"description":"The name of the glossary term associated with the classifier.","type":"string","example":"Company ID"},"id":{"description":"The unique identifier of the glossary term associated with the classifier.","type":"string","format":"uuid","example":"a787c869-4628-493b-9393-0007ff6d7494"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_LikelihoodAdjustment":{"type":"object","properties":{"adjustLikelihood":{"description":"The integer value used to adjust the likelihood level based on the current likelihood when detection rule criteria are met.","type":"integer","format":"int32","example":1},"setLikelihood":{"description":"The target likelihood level that is set when detection rule criteria are met regardless of the current level.","type":"string","example":"VERY_LIKELY","enum":["NO_MATCH","VERY_UNLIKELY","UNLIKELY","POSSIBLE","LIKELY","VERY_LIKELY"]},"type":{"description":"The strategy used to adjust the likelihood level when detection rule criteria are met.","type":"string","example":"SET"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_Metadata":{"type":"object","properties":{"XPATH":{"description":"The XPath expression used in the evaluation metadata.","type":"string"},"OBJECT_NAME":{"description":"The object name used in the evaluation metadata.","type":"string"},"OBJECT_PARENT":{"description":"The parent object name used in the evaluation metadata.","type":"string"},"xpath":{"description":"The XPath expression used in the evaluation metadata.","type":"string"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_PotentialMatchRule":{"type":"object","properties":{"type":{"description":"The type of detector used for pattern matching.","type":"string","example":"PATTERN","enum":["PATTERN","DICTIONARY","SURROGATE"]},"pattern":{"description":"The pattern configuration used for detection matching.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_RegexPatternConfig"},"dictionary":{"description":"The dictionary configuration used for detection matching.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DictionaryConfig"},"surrogate":{"description":"The surrogate configuration used when using a template from an existing detector.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_SurrogateConfig"},"likelihood":{"description":"The initial likelihood level assigned to the detector.","type":"string","example":"POSSIBLE","enum":["NO_MATCH","VERY_UNLIKELY","UNLIKELY","POSSIBLE","LIKELY","VERY_LIKELY"]},"description":{"description":"The description of the detector used for pattern matching.","type":"string","example":"This detection will find unformatted ID"},"name":{"description":"The name of the detector used for pattern matching.","type":"string","example":"Find Unformatted ID"},"prerequisite":{"description":"The prerequisite conditions that must be met before applying the detector.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_Prerequisite","readOnly":true}},"required":["name","type"]},"DataUseGovernance-DataDiscoveryCustomClassiferMana_Prerequisite":{"type":"object","properties":{"minLength":{"description":"The minimum length requirement for the detected data.","type":"integer","format":"int32"},"requirements":{"description":"The list of requirements that must be satisfied for the detector.","type":"array","items":{"type":"string"}},"wordFilter":{"description":"The list of words used to filter detection results.","type":"array","items":{"type":"string"}},"wordFilterFlags":{"description":"The flags that control how word filtering is applied.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_FilterFlags"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_RegexPatternConfig":{"type":"object","properties":{"regex":{"description":"The regular expression pattern used in the detection rule.","type":"string","example":"[0-9]{1,10}"},"flags":{"description":"The flags that control the regex pattern matching logic in the detection rule.","type":"string","example":"mi"},"groupIndexes":{"description":"The list of group indexes to extract from the detection rule regex match.","type":"array","items":{"type":"integer","format":"int32"},"example":[1,2]}},"required":["regex"]},"DataUseGovernance-DataDiscoveryCustomClassiferMana_SurrogateConfig":{"type":"object","properties":{"name":{"description":"The classifier code for the existing detector being used as the base classifier.","type":"string","example":"system_address_uk"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_ValidatorConfig":{"type":"object","properties":{"type":{"description":"The type of validator used in the detection rule.","type":"string","enum":["ABA_ROUTING_NUMBER","ACH_ROUTING_NUMBER","ALL_DIGITS_IN_SEQUENCE","ALL_DIGITS_SAME","ARGENTINA_CUIT_CUIL","AUSTRALIA_MEDICAL_ACCOUNT","AUSTRALIAN_ABN","AUSTRALIAN_ACN","AUSTRALIAN_TFN","AUSTRIA_SSN","AUSTRIA_TIN","BELGIUM_NATIONAL_NUMBER","BELGIUM_VAT","BRAZIL_CNH","BRAZIL_CNPJ","BRAZIL_CPF","BRAZIL_RG","CHILEAN_RUT","CDCCM_CODE","CDCPCS_CODE","CELL_CONTENT","CITY","CREDIT_CARD","CROATIA_OIB","CUSIP","CYPRUS_TIN","CZECH_SLOVAK_PERSONAL_ID","DATE","DEA_NUMBER","DENMARK_PERSONAL_ID","EAN13","FINLAND_NATIONAL_ID","FRANCE_INSEE","FRANCE_TIN","FRANCE_VAT","GERMAN_NATIONAL_ID_NUMBER","GERMAN_TIN","GERMAN_VAT","HONG_KONG_HKID","HUNGARY_PERSONAL_ID","HUNGARY_TIN","HUNGARY_TAJ","HUNGARY_VAT","IBAN_CODE","IF_CODE","IMSI","INDIA_GST","INDONESIA_KTP","IRELAND_PPSN","ISBN","ISIN","ISSN","ITALY_FISCAL_CODE","JAPAN_CORPORATE_NUMBER","JAPAN_INDIVIDUAL_NUMBER","KOREA_RRN","LITHUANIA_PERSONAL_CODE","LUHN","LUXEMBOURG_NATIONAL_ID","MEXICO_CURP","NETHERLANDS_BSN","NETHERLANDS_TIN","NETHERLANDS_VAT","NEW_ZEALAND_IRD","NEW_ZEALAND_NHI","NORWAY_IDENTIFICATION_NUMBER","NPI","PHONE_NUMBER","POLISH_ID_CARD","POLISH_PESEL","POLISH_TIN","PORTUGAL_CITIZEN_CARD","PORTUGAL_TIN","REGON_NUMBER","ROMANIA_CNP","SEDOL","SINGAPORE_NRIC","SLOVENIA_JMBG","SOUTH_AFRICAN_ID","SOUTH_AFRICAN_TIN","SPAIN_DNI","SPAIN_NIF","SPAIN_SSN","STRING_REQUIREMENTS","SWEDEN_NATIONAL_ID_NUMBER","SWIFT_CODE","SWISS_AHV","TAIWAN_UI","THAILAND_NATIONAL_ID_CODE","TURKEY_NATIONAL_ID","UAE_ID_CARD","UDI_GS1","UDI_HIBCC","UDI_ICCBBA","UK_NHS","UKNHS_NUMBER","US_VIN","VERHOEFF"]},"options":{"description":"The configuration options for the validator used in the detection rule.","type":"object","additionalProperties":{"type":"object"}}},"required":["type"]},"DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorSummaryDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the classifier.","type":"string","format":"uuid","readOnly":true},"code":{"description":"The system-generated code of the classifier.","type":"string","example":"custom_employee_id"},"name":{"description":"The name of the classifier.","type":"string","example":"Employee Id"},"custom":{"description":"This flag indicates whether the classifier is custom-created.","type":"boolean","example":true},"enabled":{"description":"This flag indicates whether the classifier is active.","type":"boolean","example":true},"detectorType":{"description":"The type of detector used by the classifier to classify data.","type":"string","example":"DICTIONARY","enum":["PATTERN","DICTIONARY","SURROGATE","VALIDATOR","TEMPLATE","COMPLEX"]},"glossaryTerm":{"description":"The details of the glossary term associated with the classifier.","type":"string","example":"ID"},"description":{"description":"The description of the classifier.","type":"string","example":"Detect Employee ID"}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorDto":{"type":"object","properties":{"name":{"description":"The name of the classifier.","type":"string","example":"Employee Id","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_\\- '\\(\\)]+$"},"description":{"description":"The description of the classifier.","type":"string","example":"Find Employee ID"},"code":{"description":"The system-generated code of the classifier.","type":"string","readOnly":true},"custom":{"description":"This flag indicates whether the classifier is custom-created.","type":"boolean","example":false,"readOnly":true},"enabled":{"description":"This flag indicates whether the classifier is active.","type":"boolean","example":true,"readOnly":true},"isPII":{"description":"This flag indicates whether the classifier contains personally identifiable information.","type":"boolean","example":false},"surrogateType":{"description":"The surrogate type associated with the classifier.","type":"string","readOnly":true},"detectorType":{"description":"The type of detector used by the classifier to classify data.","type":"string","example":"DICTIONARY","enum":["PATTERN","DICTIONARY","SURROGATE","VALIDATOR","TEMPLATE","COMPLEX"],"readOnly":true},"detectorVersion":{"description":"The version number of the classifier.","type":"integer","format":"int64","example":1,"readOnly":true},"definition":{"description":"The technical definition of the classifier.","example":{"detections":[{"name":"9 digit Employee ID ","type":"PATTERN","pattern":{"regex":"(?:^|\\b)\\d{9}(?:\\b|$)","flags":"gm"},"likelihood":"POSSIBLE"},{"name":"Known Short Special Employee ID","type":"DICTIONARY","dictionary":{"terms":["00001","10000"],"ignoreCase":true},"likelihood":"POSSIBLE"}],"detectionRules":[{"type":"PATTERN","name":"Invalid Column Name","inverse":false,"target":"COLUMN_NAME","includeExpand":false,"likelihoodAdjustment":{"type":"SET","setLikelihood":"NO_MATCH"},"pattern":{"regex":"license|key|code|security|passport|password|url|token","flags":"mi"}},{"type":"PATTERN","name":"Boost Likelihood for IDs Do Not Start with 123 (Example of Using Inverse)","inverse":true,"target":"FINDING","includeExpand":false,"likelihoodAdjustment":{"type":"ADJUST","adjustLikelihood":1},"pattern":{"regex":"^123","flags":"mi"}},{"type":"PATTERN","name":"Append 4 Digit Extension If Found (Example of Using includeExpand)","inverse":false,"target":"FINDING","includeExpand":true,"likelihoodAdjustment":{"type":"ADJUST","adjustLikelihood":0},"pattern":{"regex":"^[-_+][0-9]{4}","flags":"mi"}},{"name":"Deny List Context","type":"DICTIONARY","target":"CONTEXT","dictionary":{"ignoreCase":true,"terms":["telefon","telefax","telex","telephone"]},"context":{"windowBefore":15,"windowAfter":15},"likelihoodAdjustment":{"type":"SET","setLikelihood":"VERY_UNLIKELY"}},{"name":"Matches Context For Employee ID","type":"DICTIONARY","target":"CONTEXT","dictionary":{"ignoreCase":true,"terms":["Employee ID","Employee Identification"]},"context":{"windowBefore":10,"windowAfter":10},"likelihoodAdjustment":{"type":"ADJUST","adjustLikelihood":1}},{"name":"Matches Term Object Name (File/Column Name)","type":"DICTIONARY","dictionary":{"terms":["Employee","Employee_Id"],"ignoreCase":true},"target":"OBJECT_NAME","likelihoodAdjustment":{"type":"SET","setLikelihood":"VERY_LIKELY"}}]},"$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_DetectorDefinition"},"glossaryTerm":{"description":"The details of the glossary term associated with the classifier.","$ref":"#/components/schemas/DataUseGovernance-DataDiscoveryCustomClassiferMana_GlossaryTermDto"},"isGlossaryTermChanged":{"description":"This flag indicates whether the glossary term association has changed.","type":"boolean","example":false,"readOnly":true},"lastModifiedDate":{"description":"The date and time when the classifier was last modified.","type":"string","format":"date-time","example":"2024-04-04T11:33:16.538+00:00","readOnly":true},"createdDate":{"description":"The date and time when the classifier was created.","type":"string","format":"date-time","example":"2024-04-04T11:33:16.538+00:00","readOnly":true},"createdBy":{"description":"The unique identifier of the user that created the classifier.","type":"string","format":"uuid","example":"a897fe47-a504-4dd4-8eda-52add1a397f1","readOnly":true},"lastModifiedBy":{"description":"The unique identifier of the user that last modified the classifier.","type":"string","format":"uuid","example":"e897fe47-a504-4dd4-8eda-52add1a397f0","readOnly":true},"version":{"description":"The version number used for optimistic locking.","type":"integer","format":"int64","example":1,"readOnly":true},"id":{"description":"The unique identifier of the classifier.","type":"string","format":"uuid","example":"a997fe47-a504-4dd4-8eda-52add1a397f0","readOnly":true}},"required":["definition","isPII"]}},"securitySchemes":{"DataUseGovernance-DataDiscovery_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"DATA_DISCOVERY":"DATA_DISCOVERY scope for external systems"}}}},"DataUseGovernance-DataDiscoveryCustomClassiferMana_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"DATA_DISCOVERY":"DATA_DISCOVERY scope for external systems","INTEGRATION":"INTEGRATION scope for Integration service to invoke onetrust api"}}}}}}}