Answer to a Waiting User Interaction

You can answer to a waiting user interaction of a workflow run by using the vRealize Orchestrator REST API.

Procedure

  1. Retrieve the list of all user interaction objects by making a GET request at the URL that holds the available user interaction objects, or by filtering only the waiting user interactions:
    URLDescription
    https://{orchestrator_fqdn}/vco/api/catalog/System/UserInteractionHolds the available user interaction objects in vRealize Orchestrator.
    https://{orchestrator_fqdn}/vco/api/catalog/System/UserInteraction?status=0Filters only the waiting user interaction objects.
    You receive a list of the available user interaction objects. User interactions that are waiting have a variable with the name state and a waiting value.
  2. Make a GET request at the URL that holds the inventory item of the waiting user interaction to which you want to answer:
    GET https://{orchestrator_fqdn}/vco/api/catalog/System/UserInteraction/{userInteractionID}/
    The inventory item contains a link to the user interaction instance. The user interaction instance is associated with a particular workflow run.
  3. Make a POST request at the URL of the user interaction instance for the particular workflow execution:
    POST https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
  4. Provide values for the input parameters of the user interaction in an execution-context element in the request body.

Results

The REST API returns a 204 status when you answer to a user interaction successfully.