API ReferenceProjectsExports

Create new export snapshot

Create a new export request to start a background task and generate an export file for a specific project by ID.

Path parameters

idintegerRequired
A unique integer value identifying this project.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
annotation_filter_optionsobjectOptional
converted_formatslist of objectsOptional
countersanyOptional
created_byobjectOptional
A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
finished_atdatetimeOptional
Complete or fail time
md5stringOptional>=1 character<=128 characters
serialization_optionsobjectOptional
statusenumOptional
  • created - Created
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
Allowed values:
task_filter_optionsobjectOptional
titlestringOptional<=2048 characters

Response

created_atdatetime
Creation time
idinteger
annotation_filter_optionsobject or null
converted_formatslist of objects or null
countersany or null
created_byobject or null
A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
finished_atdatetime or null
Complete or fail time
md5string or null<=128 characters
serialization_optionsobject or null
statusenum or null
  • created - Created
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
Allowed values:
task_filter_optionsobject or null
titlestring or null<=2048 characters