v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Risk Management

Update Risk

Use this API to update an existing risk's details. This endpoint allows you to modify various attributes of a risk, including its name, description, owners, approvers, and other properties.

put/api/risk/v2/risks/{riskId}

Path parameters

riskIdstring uuid required

Unique identifier of the risk to update

Request body

level'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

risk level

descriptionstring

description

recommendationstring

recommendation

mitigationstring

mitigation

requestedExceptionstring

requested exception

riskOwnerIdstring uuid

risk owner id

riskOwnerstring

risk owner name

orgGroupIdstring uuid

organization group id

riskApproversIdstring[]

list of approver ids

deadlinestring date-time

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

reminderDaysinteger

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

risk action

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

attributeValuesobject

Custom Attributes

namestring

name

Result to set on Risk as part of approval

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

treatment status to set for Risk in Custom Workflows

resultIdstring uuid

treatmentStatusIdstring uuid

inherentLevelIdinteger

riskManagerstring[]

list of manager ids

Example request

{
  "level": "MEDIUM",
  "description": "This is a test risk ",
  "recommendation": "Implement the required controls ",
  "mitigation": "Implement security controls to mitigate the risk",
  "requestedException": "Requesting exception due to business impact",
  "riskOwnerId": "1c412288-b9fa-4fd6-98be-467b2824d33a",
  "riskOwner": "Maya Mohan",
  "riskOwners": [
    {
      "id": "1c412288-b9fa-4fd6-98be-467b2824d33a",
      "name": "Maya Mohan"
    }
  ],
  "orgGroupId": "b2dd4735-1347-4751-91c2-0b2d58174f9d",
  "riskApproversId": [
    "1c412288-b9fa-4fd6-98be-467b2824d33a"
  ],
  "deadline": "2021-04-13T04:00:00.000Z",
  "reminderDays": 2,
  "action": "RECOMMENDATION_ADDED",
  "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"
  ],
  "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 ",
  "result": "Accepted",
  "treatmentStatus": "InProgress"
}

Response

idstring uuid

Unique identifier for the risk

levelstring

Level for the risk

probabilityLevelstring

Probability Level for the risk

impactLevelstring

Impact Level for the risk

actionIdinteger

ActionId for the Risk

createdBystring uuid

UUId of the user who created the the risk

State of the risk

Previous State of the risk

Type of risk

typeRefIdsstring[]

Type ref Ids for the risk

Source Type for the risk

descriptionstring

Description for the risk

recommendationstring

Recommendation for the risk

remediationProposalstring

Remediation Proposal for the risk

riskOwnerIdstring uuid

Unique identifier of the risk owner

riskOwnerstring

Name of the risk owner

riskOwnersIdstring[]

List of unique identifiers of the risk owners

riskOwnersNamestring

Name of the risk owner

riskApproversIdstring[]

List of unique identifiers of the risk Approvers

requestedExceptionstring

Requested Exception of the risk

mitigationstring

Mitigation of the risk

justificationstring

Justification of the risk

deadlinestring date-time

deadline for the risk

mitigatedDatestring date-time

Mitigated date for the risk

createdUTCDateTimestring date-time

created timestamp for the risk

lastModifiedUTCDateTimestring date-time

last updated timestamp for the risk

probabilityLevelIdinteger

Probability Level Id of the risk

impactLevelIdinteger

Impact Level Id of the risk

riskScorenumber

Risk score

levelIdinteger

Level Id of the risk

levelDisplayNamestring

Level Name of the risk

viewOnlyboolean

numberinteger

Number of the risk, autogenerated

controlsIdentifierstring[]

List of Controls associated with the risk

creationTypestring

Creation Type of the risk

riskApproversstring

Name of the risk approver

treatmentstring

Treatment of the risk

resultstring

Result of the risk

treatmentStatusstring

Treatment Status of the risk

deleteType'SOFT' | 'ARCHIVE' | 'MIGRATED'

Delete type of the risk

dateClosedstring date-time

Date closed for the risk

attributeValuesobject

Custom Attributes

typeRefIdstring uuid

Type ref Id for the risk, deprecated in favour of typeRefIds

reminderDaysinteger

Duration in days after which a reminder will be sent

ruleRootVersionIdstring uuid

Unique identifier for the rule root version

namestring

Name of the risk

closedboolean

Indicates if the risk is closed

currentStageApproversCountinteger

The count of approvers of the current stage

migrationStatus'PENDING' | 'IN_PROGRESS' | 'IN_COMPLETE' | 'SUCCESS' | 'FAILED'

Migration status of the risk

ownersIdstring[]

Example response

{
  "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
  "level": "Low",
  "probabilityLevel": "Low",
  "impactLevel": "Low",
  "actionId": 1,
  "createdBy": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
  "state": "REDUCED",
  "previousState": "REDUCED",
  "type": "ASSETS",
  "riskType": {
    "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
    "label": "Inventory",
    "translationKey": "OBJ.Objective",
    "riskType": true,
    "moduleName": "Objective"
  },
  "typeRefIds": [
    "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
    "d1622fad-2186-4ed6-8133-33e3fde47759"
  ],
  "sourceType": "PIA",
  "riskSourceType": {
    "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
    "label": "Inventory",
    "translationKey": "OBJ.Objective",
    "riskType": true,
    "moduleName": "Objective"
  },
  "source": {
    "id": "d974c78a-c2f0-480a-aa27-4d40c44bb890",
    "type": "PIA",
    "sourceType": {
      "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
      "label": "Inventory",
      "translationKey": "OBJ.Objective",
      "riskType": true,
      "moduleName": "Objective"
    },
    "name": "Raw Materials and Sales Inventory"
  },
  "description": "Ability to obtain sufficient liquidity for funding capacity",
  "recommendation": "Establish a Liquidity Buffer",
  "remediationProposal": "Develop a Liquidity Management Policy",
  "riskOwnerId": "54a5730b-205b-4256-a9cf-59a7808ccb79",
  "riskOwner": "John Doe",
  "riskOwnersId": [
    "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
    "d1622fad-2186-4ed6-8133-33e3fde47759"
  ],
  "riskOwnersName": "John Doe",
  "orgGroup": {
    "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
    "name": "Acme Corp, John Doe"
  },
  "riskApproversId": [
    "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
    "1622fad-2186-4ed6-8133-33e3fde47759"
  ],
  "requestedException": "Established, undrawn committed credit facilities",
  "mitigation": "Funding diversification efforts are ongoing ",
  "justification": "Efforts to improve working capital management",
  "deadline": "2025-07-10T14:30:45.123Z",
  "mitigatedDate": "2025-07-10T14:30:45.123Z",
  "references": [
    {
      "referenceType": {
        "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
        "label": "Inventory",
        "translationKey": "OBJ.Objective",
        "riskType": true,
        "moduleName": "Objective"
      }
    }
  ],
  "createdUTCDateTime": "2025-07-10T14:30:45.123Z",
  "lastModifiedUTCDateTime": "2025-07-10T14:30:45.123Z",
  "updatedBy": {
    "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
    "name": "Acme Corp, John Doe"
  },
  "probabilityLevelId": 2,
  "impactLevelId": 2,
  "riskScore": 2,
  "levelId": 2,
  "levelDisplayName": "Low",
  "number": 2,
  "controlsIdentifier": [
    "1.0.0",
    "1.0"
  ],
  "categories": [
    {
      "id": "46c58be9-4ab9-42ca-8f49-29fec6a5fb6e",
      "name": "Financial",
      "nameKey": "RiskCategory.Financial"
    }
  ],
  "associatedInventories": [
    {
      "inventoryId": "57a87cd3-0a1f-4439-bd5b-917e1d23eb5c",
      "inventoryName": "Raw Materials Inventory",
      "inventoryType": "VENDORS",
      "sourceType": {
        "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
        "label": "Inventory",
        "translationKey": "OBJ.Objective",
        "riskType": true,
        "moduleName": "Objective"
      },
      "softInherited": true,
      "organizationId": "f8583fd1-21cb-4c7c-a337-2982246418e5"
    }
  ],
  "riskApprovers": "John Doe",
  "treatment": "Mitigation",
  "result": "Approved",
  "treatmentStatus": "In Progress",
  "resultDetails": {
    "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
    "value": "Text Value",
    "valueKey": "attribute.option.valueKey",
    "colorCode": "red",
    "optionSelectionValue": "3.5",
    "displayLabel": "United State | San Francisco",
    "associatedAttributeValueInformation": [
      {
        "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
        "value": "Text Value",
        "valueKey": "attribute.option.valueKey",
        "colorCode": "red"
      }
    ]
  },
  "treatmentStatusDetails": {
    "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
    "value": "Text Value",
    "valueKey": "attribute.option.valueKey",
    "colorCode": "red",
    "optionSelectionValue": "3.5",
    "displayLabel": "United State | San Francisco",
    "associatedAttributeValueInformation": [
      {
        "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
        "value": "Text Value",
        "valueKey": "attribute.option.valueKey",
        "colorCode": "red"
      }
    ]
  },
  "workflow": {
    "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
    "name": "Acme Corp, John Doe",
    "nameKey": "entity.detail",
    "badgeColor": "New"
  },
  "stage": {
    "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
    "name": "Acme Corp, John Doe",
    "currentStageApprovers": [
      {
        "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
        "firstName": "John",
        "lastName": "Doe",
        "approvedTimeStamp": "32025-07-12T14:52:30.123Z",
        "status": "Accepted"
      }
    ],
    "nameKey": "entity.detail",
    "badgeColor": "New"
  },
  "deleteType": "SOFT",
  "dateClosed": "2025-07-10T14:30:45.123Z",
  "threat": {
    "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
    "name": "Malware",
    "identifier": "THRT123456"
  },
  "vulnerabilities": [
    {
      "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
      "name": "Cross-Site Scripting (XSS)",
      "identifier": "VULN123456"
    }
  ],
  "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": []
  },
  "typeRefId": "92b48b97-c212-4b6c-9c47-2ebdc18da455",
  "reminderDays": 4,
  "ruleRootVersionId": "5c91cf60-c6d1-4f7d-ba74-e4f1601b54fa",
  "riskTemplate": {
    "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
    "name": "Acme Corp, John Doe"
  },
  "owners": [
    {
      "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
      "name": "Acme Corp, John Doe"
    }
  ],
  "approvers": [
    {
      "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
      "name": "Acme Corp, John Doe"
    }
  ],
  "name": "Financial Risk",
  "closed": true,
  "currentStageApproversCount": 1,
  "migrationStatus": "IN_PROGRESS",
  "riskManager": [
    {
      "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
      "name": "Acme Corp, John Doe"
    }
  ]
}