Get Request Workflow Stages

This REST API allows users to retrieve the workflow stages of a request, ordered by stage number.

A submitted request returns the stages of its current workflow cycle with their status. A request that has not yet been submitted returns the workflow’s planned stages with wfCycleId = -1 and no status.

This API does not use paging; all stages are returned.

Endpoint Details

URL Structure

http(s)://<EPMWARE_URL>/service/api/request/get_wf_stages

Method

GET

Parameters

Parameter	Type	Required	Description
`requestId`	Query	Yes	Filter by request ID

Request Examples

Using curl

curl GET 'https://demo.epmwarecloud.com/service/api/request/get_wf_stages?requestId=1444' \
  -H 'Authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7'

Response Format

Successful Response

{
  "startIndex": 0,
  "totalCount": 3,
  "resultSize": 3,
  "vEWVRequestWorkflowStages": [
    {
      "wfCycleId": 3454,
      "requestId": 1444,
      "wfStageId": 664,
      "cycleStatus": "O",
      "wfId": 81,
      "stageNo": 10,
      "description": "Finance approval",
      "stageName": "Approval",
      "freezeFlag": false,
      "enforcedFlag": false,
      "actionCode": "A",
      "stageStatus": "A",
      "stageStatusMeaning": "Approved",
      "action": "Approve"
    },
    {
      "wfCycleId": 3454,
      "requestId": 1444,
      "wfStageId": 628,
      "cycleStatus": "O",
      "wfId": 81,
      "stageNo": 20,
      "description": null,
      "stageName": "UAT Deploy",
      "freezeFlag": false,
      "enforcedFlag": false,
      "actionCode": "D",
      "stageStatus": null,
      "stageStatusMeaning": null,
      "action": "Deploy"
    },
    {
      "wfCycleId": 3454,
      "requestId": 1444,
      "wfStageId": 661,
      "cycleStatus": "O",
      "wfId": 81,
      "stageNo": 30,
      "description": null,
      "stageName": "Admin Review",
      "freezeFlag": false,
      "enforcedFlag": false,
      "actionCode": "R",
      "stageStatus": null,
      "stageStatusMeaning": null,
      "action": "Review"
    }
  ]
}

Response Fields

Field	Type	Description
`wfCycleId`	Long	Workflow cycle ID; `-1` when the request is not yet submitted
`requestId`	Long	Request ID
`wfStageId`	Long	Workflow stage ID
`cycleStatus`	String	Workflow cycle status: `O` Open, `C` Closed; null when not submitted
`wfId`	Long	Workflow ID
`stageNo`	Integer	Stage number (sort order)
`description`	String	Stage description
`stageName`	String	Workflow stage name
`freezeFlag`	Boolean	True if the stage freezes the request
`enforcedFlag`	Boolean	True if the stage is enforced
`actionCode`	String	Stage action code: `A` Approve, `R` Review, `D` Deploy, `V` Validate, `N` Notify
`action`	String	Stage action name
`stageStatus`	String	Stage status code (e.g. A, C, R); null when the stage has not been reached
`stageStatusMeaning`	String	Stage status meaning (e.g. Approved, Completed, Reviewed)

← Get Request Notes | Get Request Workflow Action Users →