Find a Workflow and Retrieve Its Definition

To perform any kind of operation with a workflow, you must find that workflow in the vRealize Orchestrator inventory and retrieve its definition. The definition lists the workflow input and output parameters, and contains links to the available workflow runs, the workflow input form schema, and other objects.

Procedure

  1. Find the inventory item of the workflow.
    • If you have the full name of the workflow or a key word from the name, make a GET request at the URL of the Workflow service by applying a filter:
      GET https://{orchestrator_fqdn}/vco/api/workflows?conditions=name={workflowFullName}
      
      GET https://{orchestrator_fqdn}/vco/api/workflows?conditions=name~{keyWord}
    • Search for the workflow through the Catalog or the Inventory service by making a GET request at the URL that is an entry point for the workflow inventory items:
      GET https://{orchestrator_fqdn}/vco/api/catalog/System/Workflow/
      
      GET https://{orchestrator_fqdn}/vco/api/inventory/System/Workflows/
  2. Retrieve the inventory item of the workflow by making a GET request at its URL:
    GET https://{orchestrator_fqdn}/vco/api/catalog/System/Workflow/{workflowID}/
  3. Retrieve the definition of the workflow by making a GET request at the URL of the definition:
    GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/