{"openapi":"3.1.0","info":{"title":"Platform - Bulk Export","version":"202603.1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.kyoto-u.idm.oclc.org/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.kyoto-u.idm.oclc.org/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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/openapi/665f23eeab28bc0024f024c1"},"parameters":[{"name":"page","in":"query","description":"Results page to be retrieved (0..N). Example- '?page=1'","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":"Number of records per page (1..2000). Example- '?size=30'","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.kyoto-u.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":[{"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> - For `COOKIE_RECEIPTS` exports, please reach out to your OneTrust representative or production support before running. \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.\n> - The timespan for endDate-startDate is limited to 6 months. \n> - `endDate` can be as recent as yesterday, but cannot be the current day.\n> - `CONSENT_RECEIPTS` and `COOKIE_RECEIPTS` only support  filtering based on`collectionPointGuid` or `purposeGuid`.  Both cannot be used at the same time.\n> - `CONSENT_RECEIPTS` and `COOKIE_RECEIPTS` exports will become available once the feature is enabled.\n> - For `DATA_SUBJECTS` exports, only data subjects with a recorded consent transaction will be included.\n> - If a value is not provided for the `dateType` parameter in `DATA_SUBJECTS` exports, this will be set to `CREATED_DATE` by default.\n> - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation.\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> - The maximum limit allowed is 1 million records, which is equivalent to approximately 8MB for `COOKIE_RECEIPTS` and `CONSENT_RECEIPTS` exports.\n\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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/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.kyoto-u.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":[{"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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/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.kyoto-u.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":[{"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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/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.kyoto-u.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":[{"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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/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.kyoto-u.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":[{"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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/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.kyoto-u.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":[{"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":{"release-status":"Public Preview","release-status-link":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/onetrust/changelog/onetrust-20240710-released","spec-label":"https://developer-onetrust-com.kyoto-u.idm.oclc.org/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":"Continuation Token for fetching 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":"Maximum number of records to be fetched.","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.kyoto-u.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":[{"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 is based on the `consentCreationDate`, which represents when the receipt was received by OneTrust.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This is based on the `consentCreationDate`, which represents when the receipt was received by OneTrust.","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. Required for CONSENT_RECEIPTS export type (timespan limited to 180 days).","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. Required for CONSENT_RECEIPTS export type (must be within 180 days from startDate). Cannot be the current day - the most recent allowed date is yesterday.","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. Required for COOKIE_RECEIPTS export type (timespan limited to 180 days).","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. Required for COOKIE_RECEIPTS export type (must be within 180 days from startDate). Cannot be the current day - the most recent allowed date is yesterday.","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"}]},"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 field is optional for 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 field is optional for DATA_SUBJECTS_BULK_ACTIONS export type.","type":"string","format":"date","example":"2023-12-01"},"params":{"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. Required for DATA_SUBJECTS_BULK_ADD_PURPOSE export type (timespan limited to 180 days).","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. Required for DATA_SUBJECTS_BULK_ADD_PURPOSE export type (must be within 180 days from startDate). Cannot be the current day - the most recent allowed date is yesterday.","type":"string","format":"date","example":"2023-12-01"},"params":{"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. Required for DATA_SUBJECTS export type (timespan limited to 180 days).","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. Required for DATA_SUBJECTS export type (must be within 180 days from startDate). Cannot be the current day - the most recent allowed date is yesterday.","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":"The name of the parameter used to specify the bulk action type. Exactly 1 item required. This is a mandatory filter.","type":"string","default":"actionType","enum":["actionType"]},"values":{"type":"array","items":{"type":"string","enum":["DELETE","REMOVE_TEST_FLAG"]},"maxItems":1,"minItems":1}},"required":["name"],"title":"Action Type"},"ParamAdditionalIdentifierType":{"type":"object","properties":{"name":{"description":"This parameter filters results by types of identifiers that can be used as additional identifiers.","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 collection point IDs.","type":"string","default":"collectionPointGuid","enum":["collectionPointGuid"]},"values":{"description":"The unique identifier of a 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":"The collection point JWT to use for bulk import. Exactly 1 item required.","type":"string","default":"collectionPointJWT","enum":["collectionPointJWT"]},"values":{"type":"array","items":{"type":"string","format":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Collection Point JWT"},"ParamCollectionPointVersion":{"type":"object","properties":{"name":{"description":"This parameter filters results by collection point versions.","type":"string","default":"collectionPointVersion","enum":["collectionPointVersion"]},"values":{"description":"The version number of a collection point.","type":"array","items":{"type":"integer","format":"int32","minimum":0},"maxItems":20,"minItems":1}},"required":["name"],"title":"Collection Point Version"},"ParamCustomPreferenceName":{"type":"object","properties":{"name":{"description":"This parameter filters results by purpose preference names.","type":"string","default":"customPreferenceName","enum":["customPreferenceName"]},"values":{"description":"The name of a purpose preference.","type":"array","items":{"type":"string"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Custom Preference Name"},"ParamCustomPreferenceValue":{"type":"object","properties":{"name":{"description":"This parameter filters results by purpose preference options.","type":"string","default":"customPreferenceValue","enum":["customPreferenceValue"]},"values":{"description":"The name of an option for a purpose preference.","type":"array","items":{"type":"string"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Custom Preference Value"},"ParamDataElementName":{"type":"object","properties":{"name":{"description":"This parameter filters results by data element names.","type":"string","default":"dataElementName","enum":["dataElementName"]},"values":{"description":"The name of a data element.","type":"array","items":{"type":"string"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Data Element Name"},"ParamDataElementValue":{"type":"object","properties":{"name":{"description":"This parameter filters results by data element values.","type":"string","default":"dataElementValue","enum":["dataElementValue"]},"values":{"description":"The value of a data element.","type":"array","items":{"type":"string"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Data Element Value"},"ParamDateType":{"type":"object","properties":{"name":{"description":"This parameter filters results by various dates recorded for a data subject.","type":"string","default":"dateType","enum":["dateType"]},"values":{"description":"The type of date used to filter results. The `CREATED_DATE` value filters results by data subjects' `FirstTransactionDate`. The `LAST_MODIFIED_DATE` value filters results by data subjects' `LastTransactionDate`. The LAST_INTERACTION_DATE value filters results by data subjects' `LastInteractionDate`.","type":"array","items":{"type":"string","enum":["CREATED_DATE","LAST_MODIFIED_DATE","LAST_INTERACTION_DATE"]},"maxItems":1,"minItems":1}},"required":["name"],"title":"Date Type"},"ParamDefaultStatus":{"type":"object","properties":{"name":{"description":"The target purpose status when source purpose not found. Exactly 1 item required.","type":"string","default":"defaultStatus","enum":["defaultStatus"]},"values":{"type":"array","items":{"type":"string","format":"string","enum":["PENDING","CONFIRMED","WITHDRAWN","IMPLICIT","EXPIRED","NOTGIVEN","OPT_OUT","NO_CHOICE","HARD_OPT_OUT","EXTEND","OPT_IN","NO_OPT_OUT"],"example":"CONFIRMED"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Default Status"},"ParamIncludeTestDataSubject":{"type":"object","properties":{"name":{"description":"This parameter filters results by the Test label.","type":"string","default":"includeTestDataSubject","enum":["includeTestDataSubject"]},"values":{"description":"This flag indicates whether to include or exclude test data subjects.","type":"array","items":{"type":"string","enum":["true","false"]},"maxItems":1,"minItems":1}},"required":["name"],"title":"Include Test Data Subject"},"ParamLastTransactionCollectionPointId":{"type":"object","properties":{"name":{"description":"This parameter filters results by collection point IDs that recorded a data subject's last transaction.","type":"string","default":"lastTransactionCollectionPointId","enum":["lastTransactionCollectionPointId"]},"values":{"description":"The unique identifier of a collection point that recorded a data subject's last transaction.","type":"array","items":{"type":"string"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Last Transaction Collection Point Id"},"ParamOrganizationGroupId":{"type":"object","properties":{"name":{"description":"This parameter filters results by organization IDs.","type":"string","default":"organizationGroupId","enum":["organizationGroupId"]},"values":{"description":"The unique identifier of an organization linked to a purpose.","type":"array","items":{"type":"string","format":"uuid","example":"e5f93c7a-2b48-4d19-ae67-f81b24c09d35"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Organization Group Id"},"ParamPrimaryIdentifierType":{"type":"object","properties":{"name":{"description":"This parameter filters results by types of identifiers that can be used as parent identifiers.","type":"string","default":"primaryIdentifierType","enum":["primaryIdentifierType"]},"values":{"description":"The type of data subject identifier used as a primary identifier.","type":"array","items":{"type":"string"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Primary Identifier Type"},"ParamPurposeGuid":{"type":"object","properties":{"name":{"description":"This parameter filters results by purpose IDs.","type":"string","default":"purposeGuid","enum":["purposeGuid"]},"values":{"description":"The unique identifier of a purpose.","type":"array","items":{"type":"string","format":"uuid","example":"c4f82e3d-1a76-48e7-91d5-7f9c0e56a8b3"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Purpose Guid"},"ParamPurposeId":{"type":"object","properties":{"name":{"description":"This parameter filters results by purpose IDs.","type":"string","default":"purposeId","enum":["purposeId"]},"values":{"description":"The unique identifier of a purpose.","type":"array","items":{"type":"string"},"maxItems":20,"minItems":1}},"required":["name"],"title":"Purpose Id"},"ParamPurposeVersion":{"type":"object","properties":{"name":{"description":"This parameter filters results by purpose versions.","type":"string","default":"purposeVersion","enum":["purposeVersion"]},"values":{"description":"The version of a purpose.","type":"array","items":{"type":"integer","format":"int32","minimum":0},"maxItems":20,"minItems":1}},"required":["name"],"title":"Purpose Version"},"ParamSourcePurposeGuid":{"type":"object","properties":{"name":{"description":"The source purpose GUID from which to copy status. Exactly 1 item required.","type":"string","default":"sourcePurposeGuid","enum":["sourcePurposeGuid"]},"values":{"type":"array","items":{"type":"string","format":"uuid","example":"c4f82e3d-1a76-48e7-91d5-7f9c0e56a8b3"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Source Purpose Guid"},"ParamStatus":{"type":"object","properties":{"name":{"description":"This parameter filters results by purpose status. For more information, see [Data Subject Purpose Statuses.](https://my-onetrust-com.kyoto-u.idm.oclc.org/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?language=en_US#UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f_section-idm46212287084304)","type":"string","default":"status","enum":["status"]},"values":{"description":"The purpose status for a data subject profile.","type":"array","items":{"type":"string","enum":["DRAFT","ACTIVE","RETIRED"]},"maxItems":20,"minItems":1}},"required":["name"],"title":"Status"},"ParamTargetPurposeGuid":{"type":"object","properties":{"name":{"description":"The target purpose GUID to which to copy status. Exactly 1 item required.","type":"string","default":"targetPurposeGuid","enum":["targetPurposeGuid"]},"values":{"type":"array","items":{"type":"string","format":"uuid","example":"c4f82e3d-1a76-48e7-91d5-7f9c0e56a8b3"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Target Purpose Guid"},"ParamTestDataSubject":{"type":"object","properties":{"name":{"description":"The name of the parameter used to filter test data subjects. Exactly 1 item required.","type":"string","default":"testDataSubject","enum":["testDataSubject"]},"values":{"type":"array","items":{"type":"string","enum":["true","false"]},"maxItems":1,"minItems":1}},"required":["name"],"title":"Test Data Subject"},"ParamWithdrawalNotes":{"type":"object","properties":{"name":{"description":"This parameter filters results by withdrawal notes.","type":"string","default":"withdrawalNotes","enum":["withdrawalNotes"]},"values":{"description":"The reason notes that explain why consent was withdrawn.","type":"array","items":{"type":"string"},"maxItems":1,"minItems":1}},"required":["name"],"title":"Withdrawal Notes"},"AttributeValueInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the user who initiated the bulk export.","type":"string","format":"uuid"},"value":{"description":"The name of the user who initiated the bulk export.","type":"string"},"valueKey":{"description":"This value will always be null.","type":"string"},"colorCode":{"description":"The attribute option color code.","type":"string"},"optionSelectionValue":{"description":"The attribute option selection value.","type":"string"},"displayLabel":{"description":"The Display Label for the Option value.","type":"string"},"disabled":{"description":"This flag indicates whether the user is inactive.","type":"boolean"}}},"BulkExportParam":{"type":"object","properties":{"name":{"description":"The name of the parameter used to filter results. Available parameters depend on exportType.","type":"string","example":"collectionPointGuid","enum":["collectionPointVersion","purposeVersion","collectionPointGuid","purposeGuid","lastTransactionCollectionPointId","purposeId","status","customPreferenceName","customPreferenceValue","dataElementName","dataElementValue","withdrawalNotes","includeTestDataSubject","dateType","primaryIdentifierType","additionalIdentifierType","organizationGroupId"]},"values":{"description":"The values of the parameter used to filter results. Max items depend on parameter name and exportType.\n\n- For CONSENT_RECEIPTS and COOKIE_RECEIPTS: All parameters accept up to 20 values.\n- For DATA_SUBJECTS: Most parameters accept up to 20 values, except customPreferenceName, customPreferenceValue, dataElementName, dataElementValue, withdrawalNotes, includeTestDataSubject, and dateType which accept only 1 value.","type":"array","items":{"type":"string","description":"The values of the parameter used to filter results. Max items depend on parameter name and exportType.\n\n- For CONSENT_RECEIPTS and COOKIE_RECEIPTS: All parameters accept up to 20 values.\n- For DATA_SUBJECTS: Most parameters accept up to 20 values, except customPreferenceName, customPreferenceValue, dataElementName, dataElementValue, withdrawalNotes, includeTestDataSubject, and dateType which accept only 1 value.","example":"[\"af01cad5-a39d-4585-9ee1-2062b1426bdd\"]"},"example":["af01cad5-a39d-4585-9ee1-2062b1426bdd"]}},"example":[{"name":"primaryIdentifierType","values":["email"]}],"discriminator":{"propertyName":"name","mapping":{"collectionPointVersion":"#/components/schemas/ParamCollectionPointVersion","collectionPointGuid":"#/components/schemas/ParamCollectionPointGuid","purposeVersion":"#/components/schemas/ParamPurposeVersion","purposeGuid":"#/components/schemas/ParamPurposeGuid","lastTransactionCollectionPointId":"#/components/schemas/ParamLastTransactionCollectionPointId","purposeId":"#/components/schemas/ParamPurposeId","status":"#/components/schemas/ParamStatus","customPreferenceName":"#/components/schemas/ParamCustomPreferenceName","customPreferenceValue":"#/components/schemas/ParamCustomPreferenceValue","dataElementName":"#/components/schemas/ParamDataElementName","dataElementValue":"#/components/schemas/ParamDataElementValue","withdrawalNotes":"#/components/schemas/ParamWithdrawalNotes","includeTestDataSubject":"#/components/schemas/ParamIncludeTestDataSubject","dateType":"#/components/schemas/ParamDateType","primaryIdentifierType":"#/components/schemas/ParamPrimaryIdentifierType","additionalIdentifierType":"#/components/schemas/ParamAdditionalIdentifierType","organizationGroupId":"#/components/schemas/ParamOrganizationGroupId"}},"oneOf":[{"$ref":"#/components/schemas/ParamCollectionPointVersion"},{"$ref":"#/components/schemas/ParamCollectionPointGuid"},{"$ref":"#/components/schemas/ParamPurposeVersion"},{"$ref":"#/components/schemas/ParamPurposeGuid"},{"$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"}]},"BulkExportResponse":{"type":"object","properties":{"runId":{"description":"The unique identifier for the bulk export.","type":"string","format":"uuid","example":"90f2241a-16d7-45e8-b913-1cb9951bb843"},"name":{"description":"The name of the bulk export.","type":"string","example":"Bulk Export","maxLength":255},"status":{"description":"The current status of the bulk export.","type":"string","example":"EXPORT_IN_PROGRESS","enum":["EXPORT_IN_PROGRESS","COMPLETED","FAILED","CANCELLED"]},"createdDate":{"description":"The date and time that the bulk export was initiated.","type":"string","format":"date-time","example":"2024-11-24 22:20:30"},"createdBy":{"description":"The details of the user who initiated the bulk export.","type":"object","$ref":"#/components/schemas/AttributeValueInformation"},"exportType":{"description":"The type of data to export.","type":"string","example":"Data Subjects","enum":["Consent Receipts","Cookie Receipts","Data Subjects"]},"fileFormat":{"description":"The file format of the bulk export.","type":"string","example":"csv","enum":["csv","json"]},"completionDate":{"description":"The date and time that the bulk export was completed.","type":"string","format":"date-time","example":"2024-11-24 22:20:30"},"expiryDate":{"description":"The date and time that the bulk export file expires.","type":"string","format":"date-time","example":"2024-11-24 22:20:30"},"progressPercentage":{"description":"The percent progress of completion for the bulk export.","type":"number","format":"double","example":90.5,"maximum":100,"minimum":0},"availableCredit":{"description":"The number of remaining bulk exports for the account.","type":"integer","format":"int32","example":6,"minimum":0},"recordCount":{"description":"The number of records included within the bulk export.","type":"integer","format":"int64","example":1000000,"minimum":0},"startDate":{"description":"The start of a date range used to filter results. This is based on the `consentCreationDate`, which represents when the receipt was received by OneTrust.","type":"string","format":"date","example":"2023-07-01"},"endDate":{"description":"The end of a date range used to filter results. This is based on the `consentCreationDate`, which represents when the receipt was received by OneTrust.","type":"string","format":"date","example":"2023-12-01"},"params":{"description":"The parameters used to filter results. ","type":"array","items":{"$ref":"#/components/schemas/BulkExportParam"},"example":[{"name":"primaryIdentifierType","values":["email"]}],"uniqueItems":true}}},"BulkExportListItem":{"type":"object","properties":{"runId":{"description":"The unique identifier for the Bulk Export.","type":"string","format":"uuid","example":"90f2241a-16d7-45e8-b913-1cb9951bb843"},"name":{"description":"Name of the Bulk Export","type":"string","example":"Bulk Export","maxLength":255},"status":{"description":"Current Bulk Export status.","type":"string","example":"EXPORT_IN_PROGRESS","enum":["EXPORT_IN_PROGRESS","COMPLETED","FAILED","CANCELLED"]},"createdDate":{"description":"Bulk Export created date.","type":"string","format":"date-time","example":"2024-11-24 22:20:30"},"createdBy":{"description":"User who initiated the Bulk Export.","$ref":"#/components/schemas/AttributeValueInformation"},"exportType":{"description":"Bulk Export type.","type":"string","example":"Data Subjects","enum":["Consent Receipts","Cookie Receipts","Data Subjects"]},"fileFormat":{"description":"Bulk Export output file format.","type":"string","example":"csv","enum":["csv","json"]},"completionDate":{"description":"Bulk Export completion date.","type":"string","format":"date-time","example":"2024-11-24 22:20:30"},"expiryDate":{"description":"Bulk Export expiry date.","type":"string","format":"date-time","example":"2024-11-24 22:20:30"}}},"PageBulkExportListItem":{"type":"object","properties":{"content":{"description":"The data of the returned objects.","items":{"$ref":"#/components/schemas/BulkExportListItem"},"type":"array"},"pageable":{"description":"The configuration parameters of the page.","$ref":"#/components/schemas/PageableObject"},"last":{"description":"This flag indicates whether the current page is the last page of the list.","type":"boolean"},"totalElements":{"description":"The total number of results in the list.","type":"integer","format":"int64"},"totalPages":{"description":"The total number of pages in the list.","type":"integer","format":"int32"},"size":{"description":"The number of results per page.","type":"integer","format":"int32"},"number":{"description":"The page number of the results.","type":"integer","format":"int32"},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/SortObject"},"first":{"description":"This flag indicates whether the current page is the first page of the list.","type":"boolean"},"numberOfElements":{"description":"The number of results on the current page.","type":"integer","format":"int32"},"empty":{"description":"This flag indicates whether no results exist on the page.","type":"boolean"}}},"PageableObject":{"type":"object","properties":{"offset":{"description":"The number of results to exclude from the start of the list.","type":"integer","format":"int64"},"sort":{"description":"The sort criteria that dictates the order of the results.","$ref":"#/components/schemas/SortObject"},"paged":{"description":"This flag indicates whether the results were paged.","type":"boolean"},"pageSize":{"description":"The number of results per page.","type":"integer","format":"int32"},"pageNumber":{"description":"The page number of the results.","type":"integer","format":"int32"},"unpaged":{"description":"This flag indicates whether the results were not paged.","type":"boolean"}}},"SortObject":{"type":"object","properties":{"empty":{"description":"This flag indicates whether sort criteria was left undefined.","type":"boolean"},"sorted":{"description":"This flag indicates whether the results were sorted.","type":"boolean"},"unsorted":{"description":"This flag indicates whether the results were not sorted.","type":"boolean"}}},"BulkExportDownloadResponse":{"type":"object","properties":{"id":{"description":"The unique identifier of the exported file to download.","type":"string","format":"uuid","example":"90f2241a-16d7-45e8-b913-1cb9951bb843"},"headers":{"description":"The authorization bearer token required to access the bulk export.","example":{"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"$ref":"#/components/schemas/HeadersSchema"},"url":{"description":"The URL of the exported file to download.","type":"string","format":"uri","example":"https://app-onetrust-com.kyoto-u.idm.oclc.org/api/document-gateway/72e2a55b-a271-4469-aeb0-cee19d1f37d7"},"fileName":{"description":"The system-generated name of the exported file to download.","type":"string","example":"72e2a55b-a271-4469-aeb0-cee19d1f37d7.csv.gz"}}},"HeadersSchema":{"type":"object","properties":{"Authorization":{"description":"The authorization bearer token required to access the bulk export.","type":"string","example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}},"example":{"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}},"BulkExportDownloadPageResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkExportDownloadResponse"}},"continuationToken":{"description":"Continuation Token","type":"string","example":112233},"hasNext":{"description":"Boolean value which denotes whether there are more values to be fetched","type":"boolean","example":true}}},"BulkExportCreditsInformation":{"type":"object","properties":{"totalCredits":{"description":"The total number of credits available for the account.","type":"integer","format":"int32","example":6,"minimum":0},"creditsRemaining":{"description":"The number of credits remaining for the account.","type":"integer","format":"int32","example":5,"minimum":0},"creditsUsed":{"description":"The number of credits used for the account.","type":"integer","format":"int32","example":1,"minimum":0,"readOnly":true}}}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"BULK_EXPORT":"Core Scope gives the user access to create/cancel/view bulk export jobs"}}}}}}}