API ReferenceRisk

Create Risk Export

Initiates a new Export action for Risks.

Returns the identifier of this Risk Export.

Path parameters

projectIdstringRequiredformat: "uuid"

The unique identifier of the Project for which to export Risks

Headers

AuthorizationstringRequired

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

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Request

The settings to use for this export action

columnslist of stringsRequired

The list of column names to export

assigneeslist of stringsOptional

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

dueDateFilterobjectOptional

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

formatenumOptional

Format to export to, currently csv and excel are supported

Valid options are:

  • Csv
  • excel
Allowed values:
namestringOptional

the name used by the export

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
orderDirectionenumOptional

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

Valid options are:

  • asc
  • desc
Allowed values:
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

tagslist of stringsOptional

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

timeZoneOffsetintegerOptional

Timezone offset in minutes

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.

statusCodeobjectOptional

The HTTP code of the response.

dataobjectOptional

Represents an export queue object. Use this ID to check the status of the export.