Skip to navigation
API ReferenceRisk

Create Risk

Creates a new Risk within the specified Project.

The Risk will inherit Project context such as access permissions and workspace ownership. Validation is applied to ensure the Project exists and the caller has permission to create Risks.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequiredformat: "uuid"
The id of the project

Headers

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

Request

The data used to create the Risk
namestringRequired>=1 character
The common name of this Risk.
descriptionstring or nullOptional
A description of the work to be performed in this Risk.
percentCompleteintegerOptional

The numerical percentage, from 0-100, representing the percentage completion for this risk. Any numbers below zero or above 100 will be clamped to the minimum or maximum value.

priorityinteger or nullOptional

Indicates the level of importance assigned to a risk, with 500 being standard priority; the higher the number, the higher the priority.

impactinteger or nullOptional
The potential effect of the risk.
likelihoodinteger or nullOptional
Probability or chance of the risk occurring.
responseIdinteger or nullOptional
The planned or implemented response to address the identified risk. Avoid, Mitigate, Transfer, Accept
resolutionstring or nullOptional
The actions or strategy planned or taken to mitigate or eliminate the risk.
assigneeslist of strings or nullOptional
A list of unique identifiers of Assignees to be assigned to this Risk
riskTypeIdinteger or nullOptional

The type of risk. Risk = 1 Assumption = 2 Issue = 3 Dependency = 4 Change = 5

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 a potential threat or uncertainty that could impact a project, system, or process. Contains information such as its likelihood, impact, response, and resolution details.

Errors

400
Bad Request Error