Get Workflow Run Objects and Check the Workflow Status
You can get information about the runs of a workflow, such as the start and end dates, the state of the run, and the values for the input parameters. You can also get logs that are generated for a workflow run.
Procedure
-
Retrieve the definition
of the workflow whose status you want to check by making a
GET
request at the URL of the workflow:
GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/
You receive the definition of the workflow in the response body of the request. The workflow definition contains a link to the execution instances of the workflow. -
Retrieve the available
execution instances of the workflow by making a
GET
request at their URL:
GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/
The response body of the request lists the available execution instances of the workflow where you can view the start and end dates of every workflow run as well their status and initiator. - (Optional)
To get more details
about a particular run of the workflow, make a
GET
request at the URL of that run:
GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/{executionID}/
In the response body of the request, you receive the XML representation of the particular workflow run. You can check the values of the input parameters that are passed for this run, the user who initiated the run, the start and end dates, as well as the state of the run. - (Optional)
To retrieve the logs
that are generated for the workflow run, make a
GET
request at the URL that holds the logs:
GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/{executionID}/logs/
- (Optional)
To retrieve additional
information about the state of the run, make a
GET
request at the URL that holds the state of the workflow:
GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/{executionID}/state/