Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Incidents

Update Incident Stage

Use this API to update the workflow stage for a specific incident by its unique identifier.

post/incident/v1/assignments/entities/{entityId}/stage

Path parameters

entityIdstring uuid required

Incident ID

Request body

nextStageNamestring required

Name of the next stage to navigate to

parametersobject

Additional parameters for workflow navigation customization

Example request

{
  "nextStageName": "Investigation",
  "parameters": {
    "notifyUsers": false,
    "priority": "high",
    "reason": "Critical security incident",
    "skipValidation": true
  }
}

Response

Successfully assigned the workflow stage.

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
  }
}