ONonetrust
Risk Management

Modify Risk

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.
patch/api/risk/v2/risks/{riskId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/risk/v2/risks/{riskId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INTEGRATION, RISK

Path parameters

riskIdstring uuid required

Unique identifier of the risk to patch

Request body

descriptionstring

description

recommendationstring

recommendation

deadlinestring date-time

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

reminderDaysinteger

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

probabilityLevelIdinteger

probability level id

impactLevelIdinteger

impact level id

riskScorenumber

risk score

levelIdinteger

risk level Id, replacement for level field

categoryIdsstring[]

List of Category Ids

treatmentstring

AKA remediation in current workflow

threatIdstring uuid

Threat id

vulnerabilityIdsstring[]

List of vulnerabilityIds

orgGroupIdstring uuid

organization group id

attributeValuesobject

Custom Attributes

namestring

name

treatmentStatus'InProgress' | 'UnderReview' | 'ExceptionRequested' | 'Approved' | 'ExceptionGranted'

treatment status to set for Risk in Custom Workflows

treatmentStatusIdstring uuid
result'Accepted' | 'Avoided' | 'Reduced' | 'Rejected' | 'Transferred' | 'Ignored'

Result to set on Risk as part of approval

resultIdstring uuid

result Id

inherentLevelIdinteger
riskManagerstring[]

list of manager ids

Example request

{
  "description": "This is a test risk ",
  "recommendation": "Implement the required controls ",
  "deadline": "2021-04-13T04:00:00.000Z",
  "reminderDays": 2,
  "probabilityLevelId": 3,
  "impactLevelId": 1,
  "riskScore": 4,
  "levelId": 2,
  "categoryIds": [
    "5d83f96b-ffb8-444e-b440-248a3103c663"
  ],
  "treatment": "Implement security controls",
  "threatId": "1e235192-9987-4bae-b553-a3e3ca19d020",
  "vulnerabilityIds": [
    "bedb4c52-eb7c-4633-8e4d-264fe57b79a1"
  ],
  "orgGroupId": "b2dd4735-1347-4751-91c2-0b2d58174f9d",
  "attributeValues": {
    "attributeSingleSelectValue.value1": [
      {
        "id": "0d2455f5-0a3d-463c-831a-671b620f5d8c",
        "value": "1",
        "valueKey": "Risk.Attributes.44cc7a47-fc22-4339-a4f9-8bba492eba7f"
      }
    ],
    "attributeSingleSelectValue.value2": [],
    "attributeSingleSelectValue.value11": [],
    "attributeSingleSelectValue.value12": [],
    "attributeSingleSelectValue.value18": []
  },
  "name": "risk name for a test risk ",
  "treatmentStatus": "InProgress",
  "result": "Accepted",
  "resultId": "edrf4735-1347-re51-65c2-0b2d58174f90"
}

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.