ONonetrust
Bulk Export

Get Bulk Export Download Details

Use this API to retrieve the download details for a bulk export. The response will include the authorization token (expires after 1 hour), file name, and URL that you can include within the following cURL command to download the export files:

curl --header "Authorization: Bearer <TOKEN_FROM_RESPONSE>" --output "<FILENAME_FROM_RESPONSE>" -fL "URL_FROM_RESPONSE"

🗒 Things to Know

  • Your export may generate multiple files to preserve download speeds. Each file name and URL will contain a unique authorization token.
get/api/ot-insights/v1/bulk-export-jobs/{id}/download

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/ot-insights/v1/bulk-export-jobs/{id}/download
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: BULK_EXPORT

Path parameters

idstring uuid required

The unique identifier for the bulk export.

Response

OK

idstring uuid

The unique identifier of the exported file to download.

urlstring uri

The URL of the exported file to download.

fileNamestring

The system-generated name of the exported file to download.

Example response

[
  {
    "id": "90f2241a-16d7-45e8-b913-1cb9951bb843",
    "headers": {
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    "url": "https://app.onetrust.com/api/document-gateway/72e2a55b-a271-4469-aeb0-cee19d1f37d7",
    "fileName": "72e2a55b-a271-4469-aeb0-cee19d1f37d7.csv.gz"
  }
]

Changes

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