Skip to main content

How can we retrieve or read the workflow status (running, success, or failed. Etc) using a GET API after triggering the workflow via an Http service?

Hi ​@srini,

There is workflowStatus REST API that allows to check workflow status based on the Instance ID

 

Get Workflow Execution Status

Use this HTTP request to check the status of a workflow execution by providing its instanceId.

Endpoint

GET http://server:port/workflowStatus

Request Parameters

Parameter Type Required Description
instanceId string Yes The ID of the workflow instance.

 

Example Request

GET http://server:port/workflowStatus?instanceId=1

 

Example Response

{
  "instanceId": "WorkflowInstanceId",
  "status": "FINISHED_OK"
}

Response Fields

Field Type Description
instanceId string The ID of the workflow execution instance.
status string The current status of the workflow execution. Possible values include: NOT_RUN, RUNNING, FINISHED_OK, FINISHED_FAILURE, FINISHED_STOP, etc.

 

Response Codes 

  • 200: The workflow status was successfully retrieved

  • 404: The workflow instance of the specified ID was not found.

  • 412: The request is missing required parameters or is otherwise invalid

 

 

thanks, AKislyakov , yes it helps.

Community Terms of Use & ConditionsCookie settings