Modify Risk

patch

https://{hostname}/api/risk/v2/risks/{riskId}

Use this API to partially modify an existing risk in the Risk Register.

🗒
Things to Know

The Managing organization assignment for risks setting must be enabled in the OneTrust Platform to pass values for the orgGroupId parameter using this API. If this setting is disabled, any values passed for the orgGroupId parameter will be ignored. This setting can be found on the Global Settings > Risk, Controls & Evidence > General screen.

Path Params

riskId

uuid

required

Unique identifier of the risk to patch

Body Params

description

string

description

recommendation

string

recommendation

deadline

date-time

deadline, format - YYYY-MM-DDTHH:MM:SS.FFFZ

reminderDays

int64

number of days before the deadline when the reminder will be sent

probabilityLevelId

int64

probability level id

impactLevelId

int64

impact level id

riskScore

number

risk score

levelId

int64

risk level Id, replacement for level field

categoryIds

array of uuids

List of Category Ids

categoryIds

inherentRiskLevel

object

Inherent risk level details

targetRiskLevel

object

Target risk level details

treatment

string

AKA remediation in current workflow

threatId

uuid

Threat id

vulnerabilityIds

array of uuids

List of vulnerabilityIds

vulnerabilityIds

orgGroupId

uuid

organization group id

attributeValues

object

Custom Attributes

name

string

length between 0 and 300

name

treatmentStatus

string

enum

treatment status to set for Risk in Custom Workflows

Allowed:

treatmentStatusId

uuid

result

string

enum

Result to set on Risk as part of approval

Allowed:

resultId

uuid

result Id

inherentLevelId

int64

riskManager

array of uuids

list of manager ids

riskManager

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

429Too Many Requests. For more information, see API Rate Limits.