Create Risk Export

POST

Initiates a new Export action for Risks.

Returns the identifier of this Risk Export.

Path parameters

projectIdstringRequired

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

This endpoint expects an object.
columnslist of stringsRequired

The list of column names to export

namestringOptional

the name used by the export

format"Csv" or "excel"Optional
Allowed values: Csvexcel

Format to export to, currently csv and excel are supported

Valid options are:

  • Csv
  • excel
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
orderDirection"asc" or "desc"Optional
Allowed values: ascdesc

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

Valid options are:

  • asc
  • desc
timeZoneOffsetintegerOptional

Timezone offset in minutes

dueDateFilterobjectOptional

Specify the due date filter for the export. If left null, no due date filter will be applied

priorityFilterobjectOptional

Specify the priority filter for the export. If left null, no priority filter will be applied

progressFilterobjectOptional

Specify the progress filter for the export. If left null, no progress filter will be applied

assigneeslist of stringsOptional

A list of resourceIds to filter the risks by assignees. If left null or empty this will be ignored

tagslist of stringsOptional

A list of tagIds to filter the risks by tags. If left null or empty this will be ignored

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

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.