API ReferenceProject

Create Project Export

Initiates a new Export action for Projects. Returns the identifier of this Projects Export.

Authentication

AuthorizationBearer

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

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The settings to use for this export action
typestringOptional
Format to export to, currently csv and excel are supported
includeClosedbooleanOptional
Include closed projects to export
columnsmap from strings to booleansOptional
The list of column names to export
filtersobjectOptional
Export filters
orderlist of stringsOptional
Order of columns to export

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
dataobjectOptional
Represents an export queue object. Use this ID to check the status of the export.