OneTrust Platform — Bulk Export

{"openapi":"3.1.0","info":{"title":"Platform - Bulk Export","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Bulk Export APIs are used to integrate external systems and extract specific data from Cookie Consent and Universal Consent & Preference Management in the OneTrust platform."},"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":"Bulk Export","description":"The Bulk Export APIs are used to extract large volumes of cookie receipts, consent receipts, and data subjects.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/665f23eeab28bc0024f024c1"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/ot-insights/v1/bulk-export-jobs":{"get":{"operationId":"getExportRunsGET","summary":"Get List of Bulk Exports","description":"Use this API to retrieve a list of bulk exports. The response will include the created date, ID, and status of each export.\n\n> 🗒 Things to Know\n> \n> - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation.","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/665f23eeab28bc0024f024c1"},"parameters":[{"name":"page","in":"query","description":"The page number of the results.","schema":{"description":"Results page to be retrieved (0..N). Example- '?page=1'","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"description":"Number of records per page (1..2000). Example- '?size=30'","type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"description":"The sort criteria that dictates the order of the results.","type":"string","default":"createdDate,desc","enum":["name,asc","name,desc","status,asc","status,desc","createdDate,asc","createdDate,desc","completedDate,asc","completedDate,desc","expiryDate,asc","expiryDate,desc"]},"example":"createdDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBulkExportListItem"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]},"post":{"operationId":"startExportRunPost","summary":"Create Bulk Export","description":"Use this API to create a bulk export based on the specified criteria.\n\n> 🗒 Things to Know\n> \n> - `COOKIE_RECEIPTS` exports are currently under Public Preview. Please contact OneTrust Support to request early access before running the export.\n> - All historic data is not available by default. `COOKIE_RECEIPTS` exports will become available once the feature is enabled. `CONSENT_RECEIPTS` exports are available from the OneTrust 202407.1.0 release or earlier if you had requested the feature while it was in preview.\n>\n> #### Usage Guidelines\n> \n> - **Bulk Export Limits & Lifecycle:**\n>   - Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. To increase your export limit, contact OneTrust Support.\n>   - The status of a bulk export will automatically change to `Expired` 10 days after its creation.\n> - **Data Volume & File Constraints:**\n>   - The maximum limit allowed is 1 million records, which is equivalent to approximately 8MB for `COOKIE_RECEIPTS` and `CONSENT_RECEIPTS` exports.\n>   - For bulk exports less than 1 million records, we recommend using a report to pull the list. As it cannot be guaranteed that the bulk export reaches this maximum, the results will be split across multiple files up to 1 million records.\n> - **Date & Time Constraints:**\n>   - The timespan for the `endDate` - `startDate` is limited to 180 days.\n>   - The `endDate` can be as recent as yesterday, but cannot be the current day.\n>   - If a value is not provided for the `dateType` parameter in `DATA_SUBJECTS` exports, this value will be set to `CREATED_DATE` by default.\n> - **Filtering:**\n>   - `CONSENT_RECEIPTS` and `COOKIE_RECEIPTS` only support filtering based on either `collectionPointGuid` or `purposeGuid`.  Both cannot be used at the same time.\n>   - Bulk export filters are case-sensitive.\n> - **Additional Information:**\n>   - For `DATA_SUBJECTS` exports, only data subjects with a recorded consent transaction will be included.\n>   - For `DATA_SUBJECTS_BULK_ACTIONS` exports, select `CSV` as the `exportFormat` for a compatible output with the Consent data subjects bulk actions import template in the OneTrust Platform. Once imported, related receipts will be deleted.\n```json Consent Receipts with Collection Point Filter\n{\n  \"exportType\": \"CONSENT_RECEIPTS\",\n  \"startDate\": \"2023-07-01\",\n  \"endDate\": \"2023-12-01\",\n  \"params\": [\n    {\n      \"name\": \"collectionPointGuid\",\n      \"values\": [\n        \"af01cad5-a39d-4585-9ee1-2062b1426bdd\"\n      ]\n    }\n  ]\n}\n```\n```json Cookie Receipts with Purpose Filter\n{\n  \"exportType\": \"COOKIE_RECEIPTS\",\n  \"startDate\": \"2023-11-01\",\n  \"endDate\": \"2023-12-01\",\n  \"params\": [\n    {\n      \"name\": \"purposeGuid\",\n      \"values\": [\n        \"af01cad5-a39d-4585-9ee1-2062b1426bdd\"\n      ]\n    }\n  ]\n}\n```\n```json Data Subjects with Filters\n{\n    \"exportType\": \"DATA_SUBJECTS\",\n    \"startDate\": \"2024-01-01\",\n    \"endDate\": \"2024-06-01\",\n    \"params\": [\n        {\n            \"name\": \"lastTransactionCollectionPointId\",\n            \"values\": [\n                \"c0431f94-664b-431e-bff3-3b341571c2af\"\n            ]\n        },\n        {\n            \"name\": \"purposeId\",\n            \"values\": [\n                \"514780d1-7797-4952-84e7-d6c70b018fed\",\n                \"fb1ec920-68cd-4c9a-99da-77b21bd5b9d5\",\n                \"55ede8d8-0aab-40b8-a6b7-6c5221b62aa7\"\n            ]\n        },\n        {\n            \"name\": \"status\",\n            \"values\": [\n                \"ACTIVE\"\n            ]\n        },\n        {\n            \"name\": \"dataElementName\",\n            \"values\":[\n                \"FirstName\"\n            ]\n        },\n                {\n            \"name\": \"dataElementValue\",\n            \"values\":[\n                \"George\"\n            ]\n        }\n    ]\n}\n```","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-bulk-export.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]}},"/api/ot-insights/v1/bulk-export-jobs/credits":{"get":{"operationId":"getCreditsInformationGET","summary":"Get Bulk Export Credit Details","description":"Use this API to retrieve bulk export credit details for the account. The response will include the total number of credits available for the account along with the number of credits remaining and the number of credits used.\n\n> 🗒 Things to Know\n> \n> - Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. Please contact OneTrust Support or your Customer Success Manager (CSM) to increase your export limit.","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-bulk-export.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportCreditsInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]}},"/api/ot-insights/v1/bulk-export-jobs/{id}":{"get":{"operationId":"getExportRunDetailsGet","summary":"Get Bulk Export Status","description":"Use this API to retrieve the current status and progress of a bulk export.\n\n> 🗒 Things to Know\n> \n> - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation.","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-bulk-export.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier for the bulk export.","required":true,"schema":{"description":"The unique identifier for the bulk export.","type":"string","format":"uuid","maxLength":36,"minLength":36},"example":"90f2241a-16d7-45e8-b913-1cb9951bb843"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]},"delete":{"operationId":"cancelBulkExportDELETE","summary":"Cancel Bulk Export","description":"Use this API to cancel a bulk export that has not been completed.","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-bulk-export.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier for the bulk export to cancel.","required":true,"schema":{"description":"The unique identifier for the bulk export to cancel.","type":"string","format":"uuid","maxLength":36,"minLength":36},"example":"90f2241a-16d7-45e8-b913-1cb9951bb843"}],"responses":{"200":{"description":"OK","content":{"application/json":{}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]}},"/api/ot-insights/v1/bulk-export-jobs/{id}/download":{"get":{"operationId":"getAttachmentDownloadCommandsGET","summary":"Get Bulk Export Download Details","description":"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:\n\n```curl\ncurl --header \"Authorization: Bearer <TOKEN_FROM_RESPONSE>\" --output \"<FILENAME_FROM_RESPONSE>\" -fL \"URL_FROM_RESPONSE\"\n```\n\n> 🗒 Things to Know\n> \n> - Your export may generate multiple files to preserve download speeds. Each file name and URL will contain a unique authorization token.","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-bulk-export.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier for the bulk export.","required":true,"schema":{"description":"The unique identifier for the bulk export.","type":"string","format":"uuid","maxLength":36,"minLength":36},"example":"90f2241a-16d7-45e8-b913-1cb9951bb843"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkExportDownloadResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]}},"/api/ot-insights/v1/bulk-export-jobs/{id}/download/pages":{"get":{"operationId":"getPaginatedAttachmentDownloadCommandsGET","summary":"Get List of Bulk Export Download Details","description":"Use this paginated 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:\n\n```curl\ncurl --header \"Authorization: Bearer <TOKEN_FROM_RESPONSE>\" --output \"<FILENAME_FROM_RESPONSE>\" -fL \"URL_FROM_RESPONSE\"\n```\n\n> 🗒 Things to Know\n> \n> - Your export may generate multiple files to preserve download speeds. Each file name and URL will contain a unique authorization token.","tags":["Bulk Export"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-bulk-export.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier for the bulk export.","required":true,"schema":{"description":"The unique identifier for the bulk export.","type":"string","format":"uuid"},"example":"90f2241a-16d7-45e8-b913-1cb9951bb843"},{"name":"continuationToken","in":"query","description":"The continuation token for retrieving the next set of records.","required":false,"schema":{"description":"Continuation Token for fetching the next set of records.","type":"string"},"example":112233},{"name":"size","in":"query","description":"The maximum number of records to be retrieved.","required":false,"schema":{"description":"Maximum number of records to be fetched.","type":"integer","format":"int32","maximum":500,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportDownloadPageResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["BULK_EXPORT"]}]}}},"components":{"schemas":{"BulkExportFormat":{"type":"string","example":"CSV","default":"CSV","enum":["CSV","JSON"]},"BulkExportRequest":{"type":"object","properties":{"name":{"description":"The name of the bulk export.","type":"string","example":"Monthly Consent Report - Q2 2023","maxLength":255,"minLength":1},"exportType":{"description":"The type of data to export. Different export types support different filtering parameters.","example":"CONSENT_RECEIPTS","enum":["CONSENT_RECEIPTS","COOKIE_RECEIPTS","DATA_SUBJECTS","DATA_SUBJECTS_BULK_ACTIONS","DATA_SUBJECTS_BULK_ADD_PURPOSE"],"$ref":"#/components/schemas/BulkExportType"},"startDate":{"description":"The start of a date range used to filter results. This parameter is required for the `CONSENT_RECEIPTS`, `COOKIE_RECEIPTS`, `DATA_SUBJECTS` and `DATA_SUBJECTS_BULK_ADD_PURPOSE` export types, and the timespan is limited to 180 days. This parameter is optional for the `DATA_SUBJECTS_BULK_ACTIONS` export type.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This parameter is required for the `CONSENT_RECEIPTS`, `COOKIE_RECEIPTS`, `DATA_SUBJECTS` and `DATA_SUBJECTS_BULK_ADD_PURPOSE` export types, and must be within 180 days from the `startDate`. This parameter is optional for the `DATA_SUBJECTS_BULK_ACTIONS` export type. The `endDate` can be as recent as yesterday, but cannot be the current day.","type":"string","format":"date","example":"2023-12-01"},"exportFormat":{"description":"The file format of the bulk export.","example":"CSV","default":"CSV","enum":["CSV","JSON"],"$ref":"#/components/schemas/BulkExportFormat"}},"discriminator":{"propertyName":"exportType","mapping":{"CONSENT_RECEIPTS":"#/components/schemas/ConsentReceiptsRequest","COOKIE_RECEIPTS":"#/components/schemas/CookieReceiptsRequest","DATA_SUBJECTS":"#/components/schemas/DataSubjectsRequest","DATA_SUBJECTS_BULK_ACTIONS":"#/components/schemas/DataSubjectsBulkActionsRequest","DATA_SUBJECTS_BULK_ADD_PURPOSE":"#/components/schemas/DataSubjectsBulkAddPurposeRequest"}},"oneOf":[{"$ref":"#/components/schemas/ConsentReceiptsRequest"},{"$ref":"#/components/schemas/CookieReceiptsRequest"},{"$ref":"#/components/schemas/DataSubjectsRequest"},{"$ref":"#/components/schemas/DataSubjectsBulkActionsRequest"},{"$ref":"#/components/schemas/DataSubjectsBulkAddPurposeRequest"}],"required":["exportType"]},"BulkExportType":{"type":"string","example":"CONSENT_RECEIPTS","enum":["CONSENT_RECEIPTS","COOKIE_RECEIPTS","DATA_SUBJECTS","DATA_SUBJECTS_BULK_ACTIONS","DATA_SUBJECTS_BULK_ADD_PURPOSE"]},"ConsentReceiptsParamSchema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ParamCollectionPointVersion"},{"$ref":"#/components/schemas/ParamCollectionPointGuid"},{"$ref":"#/components/schemas/ParamPurposeVersion"},{"$ref":"#/components/schemas/ParamPurposeGuid"}]},"ConsentReceiptsRequest":{"type":"object","properties":{"exportType":{"description":"The type of data to export.","type":"string","example":"CONSENT_RECEIPTS","enum":["CONSENT_RECEIPTS"]},"startDate":{"description":"The start of a date range used to filter results. This parameter is required for the `CONSENT_RECEIPTS` export type, and the timespan is limited to 180 days.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This parameter is required for the `CONSENT_RECEIPTS` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day.","type":"string","format":"date","example":"2023-12-01"},"params":{"description":"The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object.","type":"array","items":{"$ref":"#/components/schemas/ConsentReceiptsParamSchema"},"uniqueItems":true}},"required":["endDate","startDate"],"title":"Export: Consent Receipts"},"CookieReceiptsParamSchema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ParamCollectionPointVersion"},{"$ref":"#/components/schemas/ParamCollectionPointGuid"},{"$ref":"#/components/schemas/ParamPurposeVersion"},{"$ref":"#/components/schemas/ParamPurposeGuid"}]},"CookieReceiptsRequest":{"type":"object","properties":{"exportType":{"description":"The type of data to export.","type":"string","example":"COOKIE_RECEIPTS","enum":["COOKIE_RECEIPTS"]},"startDate":{"description":"The start of a date range used to filter results. This parameter is required for the `COOKIE_RECEIPTS` export type, and the timespan is limited to 180 days.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This parameter is required for the `COOKIE_RECEIPTS` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day.","type":"string","format":"date","example":"2023-12-01"},"params":{"description":"The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object.","type":"array","items":{"$ref":"#/components/schemas/CookieReceiptsParamSchema"},"uniqueItems":true}},"required":["endDate","startDate"],"title":"Export: Cookie Receipts"},"DataSubjectsBulkActionsParamSchema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ParamActionType"},{"$ref":"#/components/schemas/ParamTestDataSubject"},{"$ref":"#/components/schemas/ParamDateType"},{"$ref":"#/components/schemas/ParamOrganizationGroupId"},{"$ref":"#/components/schemas/ParamPurposeId"},{"$ref":"#/components/schemas/ParamLastTransactionCollectionPointId"},{"$ref":"#/components/schemas/ParamWithdrawalNotes"},{"$ref":"#/components/schemas/ParamPrimaryIdentifierType"},{"$ref":"#/components/schemas/ParamAdditionalIdentifierType"},{"$ref":"#/components/schemas/ParamDataElementName"},{"$ref":"#/components/schemas/ParamDataElementValue"},{"$ref":"#/components/schemas/ParamNewIdentifierType"}]},"DataSubjectsBulkActionsRequest":{"type":"object","properties":{"exportType":{"description":"The type of data to export.","type":"string","example":"DATA_SUBJECTS_BULK_ACTIONS","enum":["DATA_SUBJECTS_BULK_ACTIONS"]},"startDate":{"description":"The start of a date range used to filter results. This parameter is optional for the `DATA_SUBJECTS_BULK_ACTIONS` export type.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This parameter is optional for the `DATA_SUBJECTS_BULK_ACTIONS` export type.","type":"string","format":"date","example":"2023-12-01"},"params":{"description":"The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object.","type":"array","items":{"$ref":"#/components/schemas/DataSubjectsBulkActionsParamSchema"},"uniqueItems":true}},"title":"Bulk Action: Data Subjects"},"DataSubjectsBulkAddPurposeParamSchema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ParamLastTransactionCollectionPointId"},{"$ref":"#/components/schemas/ParamPurposeId"},{"$ref":"#/components/schemas/ParamStatus"},{"$ref":"#/components/schemas/ParamCustomPreferenceName"},{"$ref":"#/components/schemas/ParamCustomPreferenceValue"},{"$ref":"#/components/schemas/ParamDataElementName"},{"$ref":"#/components/schemas/ParamDataElementValue"},{"$ref":"#/components/schemas/ParamWithdrawalNotes"},{"$ref":"#/components/schemas/ParamIncludeTestDataSubject"},{"$ref":"#/components/schemas/ParamDateType"},{"$ref":"#/components/schemas/ParamPrimaryIdentifierType"},{"$ref":"#/components/schemas/ParamAdditionalIdentifierType"},{"$ref":"#/components/schemas/ParamOrganizationGroupId"},{"$ref":"#/components/schemas/ParamSourcePurposeGuid"},{"$ref":"#/components/schemas/ParamTargetPurposeGuid"},{"$ref":"#/components/schemas/ParamDefaultStatus"},{"$ref":"#/components/schemas/ParamCollectionPointJWT"}]},"DataSubjectsBulkAddPurposeRequest":{"type":"object","properties":{"exportType":{"description":"The type of data to export.","type":"string","example":"DATA_SUBJECTS_BULK_ADD_PURPOSE","enum":["DATA_SUBJECTS_BULK_ADD_PURPOSE"]},"startDate":{"description":"The start of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS_BULK_ADD_PURPOSE` export type, and the timespan is limited to 180 days.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS_BULK_ADD_PURPOSE` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day.","type":"string","format":"date","example":"2023-12-01"},"params":{"description":"The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object.","type":"array","items":{"$ref":"#/components/schemas/DataSubjectsBulkAddPurposeParamSchema"},"uniqueItems":true}},"required":["endDate","startDate"],"title":"Bulk Add Purpose: Data Subjects "},"DataSubjectsParamSchema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ParamLastTransactionCollectionPointId"},{"$ref":"#/components/schemas/ParamPurposeId"},{"$ref":"#/components/schemas/ParamStatus"},{"$ref":"#/components/schemas/ParamCustomPreferenceName"},{"$ref":"#/components/schemas/ParamCustomPreferenceValue"},{"$ref":"#/components/schemas/ParamDataElementName"},{"$ref":"#/components/schemas/ParamDataElementValue"},{"$ref":"#/components/schemas/ParamWithdrawalNotes"},{"$ref":"#/components/schemas/ParamIncludeTestDataSubject"},{"$ref":"#/components/schemas/ParamDateType"},{"$ref":"#/components/schemas/ParamPrimaryIdentifierType"},{"$ref":"#/components/schemas/ParamAdditionalIdentifierType"},{"$ref":"#/components/schemas/ParamOrganizationGroupId"}]},"DataSubjectsRequest":{"type":"object","properties":{"exportType":{"description":"The type of data to export.","type":"string","example":"DATA_SUBJECTS","enum":["DATA_SUBJECTS"]},"startDate":{"description":"The start of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS` export type, and the timespan is limited to 180 days.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day.","type":"string","format":"date","example":"2023-12-01"},"params":{"description":"The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object.","type":"array","items":{"$ref":"#/components/schemas/DataSubjectsParamSchema"},"uniqueItems":true}},"required":["endDate","startDate"],"title":"Export: Data Subjects"},"ParamActionType":{"type":"object","properties":{"name":{"description":"This parameter filters results by the bulk action type.","type":"string","default":"actionType","enum":["actionType"]},"values":{"description":"The bulk action type. Exactly 1 item is required. This is a mandatory filter.","type":"array","items":{"type":"string","enum":["DELETE","REMOVE_TEST_FLAG","CHANGE_IDENTIFIER_TYPE"]},"maxItems":1,"minItems":1}},"required":["name"],"title":"Action Type"},"ParamAdditionalIdentifierType":{"type":"object","properties":{"name":{"description":"This parameter filters results by a specific identifier type, such as email.","type":"string","default":"additionalIdentifierType","enum":["additionalIdentifierType"]},"values":{"description":"The type of data subject identifier used as an additional identifier.","type":"array","items":{"type":"string"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Additional Identifier Type"},"ParamCollectionPointGuid":{"type":"object","properties":{"name":{"description":"This parameter filters results by a specific collection point ID.","type":"string","default":"collectionPointGuid","enum":["collectionPointGuid"]},"values":{"description":"The unique identifier of the collection point.","type":"array","items":{"type":"string","format":"uuid","example":"a7c95f18-c0d6-4a19-8e7a-c2de93e58a52"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Collection Point Guid"},"ParamCollectionPointJWT":{"type":"object","properties":{"name":{"description":"This parameter filters results by the collection point JWT.","type":"string","default":"collectionPointJWT","enum":["collectionPointJWT"]},"values":{"description":"The collection point JWT to use for bulk import. Exactly 1 item is required.","type":"array","items":{"type":"string","format":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"},"maxItems":1,"minItems":1}},"required":["na

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-platform-bulk-export-openapi.json