Skip to navigation

Create a bulk export task

Beta

Create a bulk export task that will export data from the requested list of models into data files. The data files would be in serialized JSON format matching v3 api response spec of the models. The task will run asynchronously and the results can be retrieved using the bulk-export task ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
modelsmap from strings to maps from strings to anyRequired

Response

Task started
pollingUristringOptional
taskIdstringOptional

Errors

400
Bulk Export Create Request Bad Request Error
403
Bulk Export Create Request Forbidden Error
404
Bulk Export Create Request Not Found Error
429
Bulk Export Create Request Too Many Requests Error
500
Bulk Export Create Request Internal Server Error