La presentación de una interacción del usuario podría definir restricciones para los valores que se pueden transferir a los parámetros de entrada del flujo de trabajo. Cuando responde a una interacción del usuario, puede validar los valores que se transfieren a los parámetros de entrada con las restricciones definidas en la presentación de la interacción del usuario.

Antes de empezar

Compruebe que haya importado el paquete de ejemplo de flujos de trabajo a Orchestrator. El paquete se incluye en el archivo ZIP de aplicaciones de ejemplo de Orchestrator que puede descargarse desde la página de documentación de Orchestrator.

Procedimiento

  1. Recupere la lista de todos los objetos de interacción del usuario; para ello, realice una solicitud GET en la URL que contiene los objetos de interacción del usuario disponibles o bien filtre únicamente las interacciones del usuario que están en espera:

    URL

    Descripción

    https://host_orchestrator:puerto/vco/api/catalog/System/UserInteraction

    Contiene los objetos de interacción del usuario disponibles en Orchestrator.

    https://host_orchestrator:puerto/vco/api/catalog/System/UserInteraction?status=0

    Filtra solo los objetos de interacción del usuario que están en espera.

    Recibe una lista de los objetos de interacción del usuario disponibles. Las interacciones del usuario que están en espera tienen un atributo con el nombre state y el valor waiting.

  2. Realice una solicitud GET en la URL que contiene el elemento de inventario de la interacción del usuario en espera a la que se desea responder:
    GET https://{host_orchestrator}:{puerto}/vco/api/catalog/System/UserInteraction/{ID_interacción_usuario}/

    El cuerpo de la respuesta contiene un vínculo a la instancia de interacción del usuario. La instancia de interacción del usuario está asociada con la ejecución de un determinado flujo de trabajo.

  3. Realice una solicitud GET en la dirección URL de la instancia de interacción del usuario:
    GET https://{host_orchestrator}:{puerto}/vco/api/workflows/{ID_flujo_trabajo}/executions/{ID_ejecución}/interaction/

    En el cuerpo de la respuesta, se incluye un vínculo a la presentación de la interacción del usuario.

  4. Haga una solicitud GET en la dirección URL de la presentación de la interacción del usuario:
    GET https://{host_orchestrator}:{puerto}/vco/api/workflows/{ID_flujo_trabajo}/executions/{ID_ejecución}/interaction/presentation/

    Recibe la definición de la presentación de la interacción del usuario en el cuerpo de la respuesta.

  5. En la definición de la presentación, compruebe las restricciones de los valores que puede transferir a los parámetros de entrada.
  6. Ejecute la presentación de la interacción del usuario realizando una solicitud POST en la URL en la que se encuentran las instancias de la presentación:
    POST https://{host_orchestrator}:{puerto}/vco/api/workflows/{ID_flujo_trabajo}/executions/{ID_ejecución}/interaction/presentation/instances/
  7. En el cuerpo de la solicitud, proporcione valores para los parámetros de entrada en un elemento execution-context.

    En el cuerpo de la respuesta, recibe la instancia de la presentación de la interacción del usuario. Si los valores que ha transferido a los parámetros de entrada son válidos, encuentra un atributo valid="true" en el elemento execution. En el elemento output-parameters, se encuentran los valores válidos para los parámetros de entrada que puede utilizar para responder a la interacción del usuario.

  8. Responda a la interacción del usuario realizando una solicitud POST en la URL en la que se encuentra la instancia de interacción del usuario:
    POST https://{host_orchestrator}:{puerto}/vco/api/workflows/{ID_flujo_trabajo}/executions/{ID_ejecución}/interaction/
  9. En el cuerpo de la solicitud, transfiera un contexto execution-context con los valores para los parámetros de entrada.

    Puede utilizar el mismo cuerpo de solicitud que el de la solicitud POST que realizó en la URL para la presentación de la interacción del usuario.

Resultados

Si la última solicitud fue correcta, recibe un código de estado 204 y un cuerpo de respuesta vacío.

Responder a la interacción del usuario del flujo de trabajo interactivo "Hola a todos" validando los parámetros de entrada

Puede responder a la interacción del usuario del flujo de trabajo interactivo "Hola a todos" validando los valores de los parámetros de entrada con las restricciones definidas en la presentación de la interacción del usuario.

  1. Busque las interacciones del usuario en espera del flujo de trabajo; para ello, realice una solicitud GET en el endpoint de los objetos de interacción de usuario del servicio del catálogo:

    GET https://localhost:8281/vco/api/catalog/System/UserInteraction?status=0
  2. Localice el objeto de inventario de interacción del usuario para el flujo de trabajo interactivo "Hola a todos" y realice una solicitud GET como URL:

    GET https://localhost:8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A8080800132145338690643f66a027ec/
  3. Realice una solicitud GET en la dirección URL de la instancia de interacción del usuario:

    GET https://localhost:8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A8080800132145338690643f66a027ec/interaction/
  4. Realice una solicitud GET en la URL de la presentación de interacción del usuario:

    GET https://localhost:8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A8080800132145338690643f66a027ec/interaction/presentation/

    La presentación define el parámetro de entrada como obligatorio y contiene una restricción para la longitud de la cadena que se puede transferir.

  5. Realice una solicitud POST en la URL que contiene las instancias de la presentación de interacción del usuario:

    POST https://localhost:8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A8080800132145338690643f66a027ec/interaction/presentation/instances/

    Proporcione un valor del parámetro de entrada en el cuerpo de la solicitud:

    <execution-context xmlns="http://www.vmware.com/vco">
       <parameters>
         <parameter name="name" type="string">
           <string>John Smith</string>
         </parameter>
       </parameters>
    </execution-context>

    El elemento execution del cuerpo de respuesta contiene un atributo valid="true", que indica que el valor del parámetro de entrada es válido respecto a las restricciones en la presentación de la interacción del usuario. El valor válido se enumera en el elemento output-parameters:

    ............
    <output-parameters>
      <parameter name="name" type="string">
         <string>John Smith</string>
       </parameter>
    </output-parameters>
    ............

  6. Realice una solicitud POST en la URL de la instancia de interacción del usuario transfiriendo el mismo cuerpo de solicitud que en la solicitud POST del paso 5.

    POST https://localhost:8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A8080800132145338690643f66a027ec/interaction/