Agregar y configurar Enviar solicitud web

El paso Enviar solicitud Web le permite enviar solicitudes a los extremos REST para obtener datos o publicar actualizaciones. Si Workflow Manager tiene licencia con el rol ArcGIS Workflow Manager Server Advanced, puede configurar la respuesta del extremo REST como valores de salida personalizados, guardarla como un archivo y adjuntarla al trabajo. Los valores de salida personalizados se pueden utilizar para recuperar tokens para llamadas REST posteriores, determinar la ruta que sigue el flujo de trabajo o usarse como entradas para otros pasos del flujo de trabajo.

Cuando se ejecuta el paso, la solicitud web se envía al extremo REST definido en el paso.

El paso se puede finalizar haciendo clic en el botón Paso completo .

Configurar el paso

To configure the step, do the following:

Precaución:

Para reducir las vulnerabilidades de seguridad, configure el paso Enviar solicitud web solo para páginas y las aplicaciones web de confianza.

1. Create or edit a workflow diagram to access the Step Library panel.
2. Arrastre Enviar solicitud web desde el panel Biblioteca de pasos a una flecha de conexión de un paso en el lienzo del flujo de trabajo.

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
4. En la sección Argumentos, haga clic en Editar.
5. Haga clic en la flecha desplegable Dirección URL y seleccione el tipo de solicitud que desea enviar.
6. Escriba la dirección URL del extremo REST en el cuadro de texto Dirección URL.
7. Si lo desea, agregue variables de ruta a la dirección URL usando la siguiente sintaxis:

   https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/

   Las variables de ruta aparecen en la sección Variables de ruta.

8. Si ha agregado variables de ruta a la dirección URL, proporcione un valor para cada variable en la sección Variables de ruta.

   You can also use ArcGIS Arcade expressions to provide a dynamic value.

   Sugerencia:

   Click the This input supports Arcade Expressions button and choose an ArcGIS Arcade expression to add it to its associated text box.

9. Si lo desea, también puede agregar parámetros de consulta a la solicitud web.
   1. Haga clic en Agregar clave y valor en la sección Parámetros de consulta.
   2. Proporcione una clave en el cuadro de texto Clave.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   3. Proporcione un valor en el cuadro de texto Valor.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
10. Haga clic en la pestaña Autorización.
11. Elija el método de autenticación del extremo REST y proporcione información de autenticación según sea necesario.

    Precaución:

    La información de autenticación que proporciona en el paso no está cifrada. Para proteger la información, agregue una configuración definida por el usuario cifrada para almacenar la información y hacer referencia a ella en el paso utilizando propiedades de trabajo dinámicas.

    1. De manera opcional, si elige la opción Clave API o Token de portador,haga clic en Generar token alternativamente desde el extremo.

       Aparece el cuadro de diálogo Generar token desde el extremo.

    2. Configure los ajustes del token para generar un token para la solicitud web.
12. Si lo desea, haga clic en la pestaña Encabezados para agregar pares de clave y valor de encabezado personalizados a la solicitud web.
    1. Haga clic en Agregar clave y valor en la sección Encabezados personalizados.
    2. Proporcione una clave en el cuadro de texto Clave.

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

    3. Proporcione un valor en el cuadro de texto Valor.

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

    4. Deje la casilla de verificación Habilitado activada.
    5. Repita los subpasos a-d para agregar más pares de clave-valor.
13. Si lo desea, haga clic en la pestaña Cuerpo para agregar datos a la solicitud web.

    El cuerpo de la solicitud admite pares de clave-valor de datos de solicitud, pares de clave-valor codificados por URL y datos sin procesar en formato JSON o de texto sin formato.

    Sugerencia:

    También puede utilizar una expresión de ArcGIS Arcade para recuperar la configuración definida por el usuario o proporcionar valores dinámicos al texto del cuerpo.

14. Si lo desea, si tiene una licencia para ArcGIS Workflow Manager Server Advanced, configure los ajustes de salida del paso.
15. Si lo desea, haga clic en la pestaña Probar y luego en Probar respuesta para enviar la solicitud configurada y mostrar su respuesta.

    Si la solicitud web contiene expresiones de específicas del trabajo Arcade, debe activar Incluir Id. de trabajo y proporcionar un Id. de trabajo en el cuadro de texto Id. de trabajo para formatear correctamente la solicitud.

16. Haga clic en Guardar para cerrar el cuadro de diálogo Configurar solicitud web.
17. Click the Options tab.
18. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      Nota:

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

19. Optionally, provide help text for the step in the Step Help text box.

    You can also use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you'll need to format the text as follows:

    'For further assistance, please contact ' + JobCreator($Job) + '.'

20. Optionally, click the Style tab to change the shape and color of the step.
21. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Nota:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Configurar los ajustes de token

Si el extremo REST requiere un token para la autenticación, siga estos pasos para configurar el paso Enviar solicitud web y generar un token que se pueda utilizar para autenticar la solicitud web.

1. Haga clic en la flecha desplegable Dirección URL y seleccione el tipo de solicitud que desea enviar.
2. Escriba la dirección URL del extremo REST en el cuadro de texto Dirección URL.
3. Si lo desea, también puede agregar parámetros de consulta a la solicitud web.
   1. Haga clic en Agregar clave y valor en la sección Parámetros de consulta.
   2. Proporcione una clave en el cuadro de texto Clave.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   3. Proporcione un valor en el cuadro de texto Valor.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
4. Si lo desea, haga clic en la pestaña Encabezados para agregar pares de clave y valor de encabezado personalizados a la solicitud web.
   1. Haga clic en Agregar clave y valor en la sección Encabezados personalizados.
   2. Proporcione una clave en el cuadro de texto Clave.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   3. Proporcione un valor en el cuadro de texto Valor.

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
5. Si lo desea, haga clic en la pestaña Cuerpo para agregar datos a la solicitud web.

   El cuerpo de la solicitud admite pares de clave-valor de datos de solicitud, pares de clave-valor codificados por URL y datos sin procesar en formato JSON o de texto sin formato.

   Sugerencia:

   También puede utilizar una expresión de ArcGIS Arcade para recuperar la configuración definida por el usuario o proporcionar valores dinámicos al texto del cuerpo.

6. Haga clic en la pestaña Token.
7. Haga clic en el botón de alternancia Modo de prueba en la sección Token.
8. Pegue un ejemplo de la respuesta del extremo REST en el cuadro de texto Respuesta de muestra.

   Ejemplo de respuesta en formato JSON:

   {"access_token": "12345abcde",
   "expires_in":7199,
   "spatialReference": {
     "wkid": 4326,
     "latestWkid": 4326
   },
   "locations": [
     {
       "name": "380 New York Street",
       "extent": {
         "xmin": -117.196701,
         "ymin": 34.055489
       }
     }
   ]}

9. Proporcione un nombre para el token en el cuadro de texto Valor de salida.

   Este es el nombre que se utiliza en el paso para hacer referencia al token generado.

10. Proporcionar una expresión JSONPath en notación de puntos o notación entre corchetes analiza la respuesta y devuelve el token generado.

    Ejemplo de JSONPath en notación de puntos:

    $.access_token

    Ejemplo de JSONPath en notación entre corchetes:

    $['access_token']

    El valor aparece en la columna Resultado de muestra.

11. Haga clic en Volver a la configuración del paso para seguir configurando el paso.

Configurar los ajustes de salida

Licencia:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

El rol de ArcGIS Workflow Manager Server Advanced le permite guardar la respuesta del extremo REST como un archivo , adjuntarla al trabajo y configurarla como valores de salida personalizados. Los valores de salida se pueden utilizar para determinar la ruta que sigue el flujo de trabajo o usarse como entradas para otros pasos del flujo de trabajo. Si no se configura un valor de salida para el paso, el código de estado HTTP se almacena como el valor de salida del paso. Para configurar los ajustes de salida del paso, haga lo siguiente:

1. Haga clic en la pestaña Salida en el cuadro de diálogo Configurar solicitud web.

   Si el cuadro de diálogo Configurar solicitud web no está disponible, haga clic en el paso Enviar solicitud web en el lienzo del flujo de trabajo y luego en Editar en la sección Argumentos del panel Detalles del paso.

2. Si lo desea, haga clic en el botón de alternancia Habilitado de la sección Adjuntar respuesta para guardar la respuesta del extremo REST como un archivo y adjuntarla al trabajo.
3. Si lo desea, siga estos pasos para configurar el nombre del adjunto y la carpeta en la que se almacenará:
   1. Proporcione el nombre de la carpeta en la que se almacenará el adjunto en el cuadro de texto Nombre de carpeta.

      El nombre de la carpeta no puede contener una ruta de sistema de archivos ni caracteres especiales. Si no se proporciona un nombre de carpeta, se crea automáticamente una carpeta denominada General.

      Nota:

      La carpeta está contenida dentro del elemento de flujo de trabajo y no es una ruta de sistema de archivos.

   2. Seleccione una de las siguientes opciones de Nombre de adjunto:
      • Generado automáticamente: nombra automáticamente el adjunto con la siguiente sintaxis: <StepName>_<RunDate>_<RunTime>.
      • Personalizado: permite proporcionar un nombre de adjunto personalizado.
4. Si lo desea, siga estos pasos para configurar valores de salida personalizados para la respuesta del extremo REST:
   1. Haga clic en el botón de alternancia Modo de prueba en la sección Valores de salida.
   2. Pegue un ejemplo de la respuesta del extremo REST en el cuadro de texto Respuesta de muestra.

      Ejemplo de respuesta en formato JSON:

      {"access_token": "",
      "expires_in":7199,
      "spatialReference": {
        "wkid": 4326,
        "latestWkid": 4326
      },
      "locations": [
        {
          "name": "380 New York Street",
          "extent": {
            "xmin": -117.196701,
            "ymin": 34.055489
          }
        }
      ]}

   3. Haga clic en Agregar salida y ruta.
   4. Proporcione un nombre para el valor de salida en el cuadro de texto Valor de salida.

      Este es el nombre del valor que se utiliza para obtener el valor de salida personalizado.

   5. Proporcione una expresión JSONPath en notación de puntos o notación entre corchetes para el valor que desea almacenar en el cuadro de texto Ruta de extracción.

      Ejemplo de JSONPath en notación de puntos:

      $.locations.0.name

      Ejemplo de JSONPath en notación entre corchetes:

      $['locations'][0]['name']

      El valor aparece en la columna Resultado de muestra.

   6. Si lo desea, repita los subpasos c-e para agregar más valores de salida personalizados.
5. Haga clic en Guardar para cerrar el cuadro de diálogo Configurar solicitud web.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

Valores de salida

Licencia:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

Salida	Descripción
Estado	Devuelve el código de respuesta HTTP si no hay ningún valor de salida configurado para este paso.
<CustomOutputValue>	Devuelve el valor de salida personalizado que configuró para el paso.