Answer to a User Interaction After Validating Input Parameters

The input form presentation of a user interaction might define constraints for the values that you can pass to the input parameters of the workflow. When you answer a user interaction, you can validate the values that you pass to the input parameters against the constraints that are defined in the input form presentation of the user interaction.

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 the waiting value.
  2. Make a GET request at the URL that holds the inventory item of the waiting user interaction that you want to answer:
    GET https://{orchestrator_fqdn}/vco/api/catalog/System/UserInteraction/{userInteractionID}/
    The response body contains a link to the user interaction instance. The user interaction instance is associated with a particular workflow run.
  3. Make a GET request at the URL of the user interaction instance:
    GET https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
    In the response body, you find a down link to the input form presentation of the user interaction.
  4. Answer to the user interaction by making a POST request at the URL where the user interaction instance resides:
    POST https://{orchestrator_fqdn}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
  5. In the request body, pass an execution-context context with the values for the input parameters.
    You can use the same request body as the one for the POST request that you made at the URL for the user interaction input form presentation.

Results

If the last request is successful, you receive a status code 204 and an empty response body.