Targeted Data Discovery

Add Targeted Data Discovery Results Summary to Request

Use this API to add Targeted Data Discovery results to a request.

🗒 Things to Know

  • This is an asynchronous operation. The results may take some time to reflect.
post/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DSAR, DSAR_WRITE

Path parameters

requestQueueRefIdstring required

Request queue reference Id

Request body

systemstring

Name or identifier of the system from which this data is sourced. This will be displayed on the Results Summary.

resultsobject

Dataset that includes list of data groups with nested name-value-pairs to capture structured data.

Example request

{
  "system": "Office365",
  "unstructuredResults": [
    {
      "type": "document",
      "status": "processed",
      "key": "contract_2023",
      "value": "https://storage.example.com/documents/contract_2023.pdf",
      "isRedact": true
    }
  ],
  "attachments": [
    {
      "fileName": "receipt.pdf",
      "fileId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.