Skip to main content
Solved

read MDM workflow status using API in v15.4


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?

Best answer by AKislyakov

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

 

 

View original

Forum|alt.badge.img+2

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

 

 


  • Universe Traveller
  • May 26, 2025

thanks, AKislyakov , yes it helps.


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings