Get Workflow Status

Once the program has been set up and a workflow created, statuses of the various workflow runs can be obtained.

To check the status of a single workflow run:

curl -X 'GET' \
  'http://${API_SERVICE_URL}:${API_SERVICE_PORT}/api/v1/workflow-run/${WORKFLOW_RUN_ID}' \
  -H 'accept: */*'

Where:

  • API_SERVICE_URL is the endpoint of the service. If running locally, this will likely be localhost

  • API_SERVICE_PORT is the port exposed for the service. The default port is 8081.

  • WORKFLOW_RUN_ID is the ID of the specific run of a workflow to get the status of.

If the service is up and running correctly, and the workflow ID is correct, you should receive a 200 status with the body containing information like:

{
  "workflow_run_id": 0,
  "workflow_run_status": "QUEUED",
  "start_date": "2022-04-01T14:43:16.282Z",
  "end_date": "2022-04-01T14:43:16.282Z",
  "user_id": 0
}

To check the status of all runs of a particular workflow:

curl -X 'GET' \
  'http://${API_SERVICE_URL}:${API_SERVICE_PORT}/api/v1/workflow/${WORKFLOW_ID}/runs' \
  -H 'accept: */*'

Where:

  • API_SERVICE_URL is the endpoint of the service. If running locally, this will likely be localhost

  • API_SERVICE_PORT is the port exposed for the service. The default port is 8081.

  • WORKFLOW_ID is the ID of the single workflow (which may have been run multiple times) to get the statuses of.

If the service is up and running correctly, and the workflow ID is correct, you should receive a 200 status with the body containing information like:

[
  {
    "workflow_run_id": 0,
    "workflow_run_status": "QUEUED",
    "start_date": "2022-04-01T14:49:00.019Z",
    "end_date": "2022-04-01T14:49:00.019Z",
    "user_id": 0
  },
  {
      "workflow_run_id": 2,
      "workflow_run_status": "QUEUED",
      "start_date": "2022-04-01T15:22:02.191Z",
      "end_date": "2022-04-01T15:22:02.191Z",
      "user_id": 0
    }
]