Create Assessment Risk

post

https://customer-my-onetrust-com.ezproxy.utas.edu.au/api/assessment-v2/v2/assessments/{assessmentId}/risks

Use this API to create a risk on an assessment. This API will return the risk owner, risk approver and target risk level in the response. The risk will be flagged on the assessment and assigned to the respective risk owners with the details defined in the API request body.

🗒
Things to Know

This API can be used for assessments in Under Review and Completed stage.

Risks must have an assigned risk owner before you can send a recommendation. Once an approver has identified a risk, they can send the risk owner a recommendation that helps to rectify and minimize the risk.

If risk heatmaps are used by your organization, the available risk level options will be based on the heatmap set up for your organization. If risk heatmaps are not used, the available risk level options will be Low, Medium, High, and Very High.

Path Params

assessmentId

uuid

required

ID of the assessment. The assessmentId can be retrieved by calling the Get List of Assessments API

Body Params

Assessment Risk Create Request which consist of sectionId, questionId and riskCreateRequest. The attribute id and value key is null in case of text Attributes. riskTemplate will be required when we create risk using library.

sectionId

uuid

required

ID of the section in the assessment to which the risk was flagged. This value is obtained from the Get Assessment API.

questionId

uuid

required

ID of the question in the assessment to which the risk was flagged. This value is obtained from the Get Assessment API.

parentQuestionResponseDetailId

uuid

Assessment Detail Id of Parent Question's Response. This Id is required only
when creating a risk to Attribute question belonging to a multiselect parent/domain question.

riskCreateRequest

object

required

The required fields for the request body are levelId, typeId and sourceTypeId. Standard values for levelId are 0 - ZERO, 1 - LOW, 2 - MEDIUM, 3 - HIGH and 4 - VERY HIGH. The value for sourceTypeId and typeId should be 10 since it is being created on an assessment.

Responses

400

Bad Request

Possible reasons:

Risk is being created on a Not Started or In Progress assessment.

401

Unauthorized

403

Forbidden

404

Not Found

201Risk successfully created

Possible reasons: