Run a Workflow

You run a workflow through the vRealize Orchestrator REST API by creating a new runnable object for a particular workflow.

Procedure

  1. Retrieve the definition of the workflow that you want to run by making a GET request at the URL of the definition: 
    GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/
    You receive the definition of the workflow in the response body of the request. In the workflow definition, you can view the input parameters of the workflow, the workflow description, and other information.
  2. Make a POST request at the URL that holds the execution objects of the workflow: 
    POST https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/
  3. Provide values for the input parameters of the workflow in an execution-context element in the request body.
    If you provide an empty execution-context in the request body, the workflow runs with default values for its input parameters, if such values exist.

Results

If the POST request is successful, you receive the status code 202 with an empty response body and a link to the newly created execution object in the Location header.