API ReferenceRisk

Create Risk Export

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

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequiredformat: "uuid"
The unique identifier of the Project for which to export Risks

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
namestring or nullOptional
the name used by the export
formatenumOptional

Format to export to, currently csv and excel are supported

Valid options are:

  • Csv
  • excel
Allowed values:
columnslist of stringsOptional
The list of column names to export, if blank all columns will be exported
orderByenumOptional
Which column should be used to order the data Valid options are: * name * createDate * assignees * dueDate * impact * level * likelihood * openClosed * priority * response * tags * description * resolution * type
orderDirectionenumOptional

Specifies the direction of the order. Valid values are “asc” and “desc”

Valid options are:

  • asc
  • desc
Allowed values:
timeZoneOffsetintegerOptional
Timezone offset in minutes
dueDateFilterobject or nullOptional
Specify the due date filter for the export. If left null, no due date filter will be applied
priorityFilterobject or nullOptional
Specify the priority filter for the export. If left null, no priority filter will be applied
progressFilterobject or nullOptional
Specify the progress filter for the export. If left null, no progress filter will be applied
assigneeslist of strings or nullOptional
A list of resourceIds to filter the risks by assignees. If left null or empty this will be ignored
tagslist of strings or nullOptional
A list of tagIds to filter the risks by tags. If left null or empty this will be ignored

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.
dataobject or null
Represents an export queue object. Use this ID to check the status of the export.

Errors