Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Risk Management

Update Risk Stage

Use this API to assign a risk to a stage in a workflow.

🗒 Things to Know

  • This API will move the risk to the specified stage in the workflow.
  • The risk must be in a valid stage to be moved to the target stage.
post/api/risk/v2/risks/{id}/assign-stage

Path parameters

idstring uuid required

Risk unique Identifier

Request body

nextStageIdstring uuid

Next stage ID - Only required if the navigation direction is Specific

direction'First' | 'Next' | 'Previous' | 'Last' | 'Specific' required

Navigation direction

parametersobject

Additional parameters for workflow navigation customization

commentstring

Comment describing the stage change

Example request

{
  "nextStageId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "Specific",
  "parameters": {
    "forceTransition": false,
    "notifyUsers": true,
    "reason": "Security incident triage complete",
    "skipValidation": true,
    "urgency": "high"
  },
  "comment": "Moving to investigation stage due to new evidence found during initial triage"
}

Response

Risk stage changed successfully

idstring uuid required

Workflow Stage Identifier

namestring required

Workflow Stage Name

nameKeystring

Workflow Stage Name Key for translation purposes

descriptionstring

Workflow Stage Description

descriptionKeystring

Workflow Stage Description Key for translation purposes

sequenceinteger required

Workflow Stage Sequence number

allowDeletionboolean

Indicates if Workflow Stage can be deleted

badgeColorstring

Workflow Stage Badge Color for UI purposes

approvalStageboolean

Indicates if the stage is an approval stage

exceptionStageboolean

Indicates if the stage is an exception approval stage

autoAdvanceOnApprovalboolean

Can Workflow Stage Auto-Advance on Approval?

customFieldsobject

Custom fields

additionalFieldsobject

Additional fields associated with Workflow Stage

advanceStageActionEnabledboolean

Does Workflow Stage has advance stage action enabled?

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Investigation",
  "nameKey": "workflow.stage.investigation",
  "description": "Investigation stage for incident workflow",
  "descriptionKey": "workflow.stage.investigation.description",
  "sequence": 2,
  "allowDeletion": true,
  "badgeColor": "blue",
  "approvalStage": true,
  "exceptionStage": false,
  "autoAdvanceOnApproval": true,
  "customFields": {
    "priority": "high",
    "category": "security"
  },
  "stageApprovers": [
    {
      "id": "abc-123",
      "name": "Security Approver"
    }
  ],
  "additionalFields": {
    "notificationEnabled": true
  },
  "advanceStageActionEnabled": true,
  "advanceStageActions": [
    {
      "id": "def-456",
      "name": "Approve"
    }
  ],
  "stageExceptionConfiguration": {
    "enabled": true,
    "approverCount": 2
  }
}