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

Para configurar el paso, haga lo siguiente:

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. Cree o edite un diagrama de flujo de trabajo para acceder al panel Biblioteca de pasos.
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.

   Más información sobre cómo agregar pasos a un diagrama de flujo de trabajo

   Aparece el panel Detalles del paso.

3. Proporcione un nombre para el paso en el cuadro de texto Nombre de paso.
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 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.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

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

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
9. Si ha agregado variables de ruta a la dirección URL, proporcione un valor para cada variable en la sección Variables de ruta.

   También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   Sugerencia:

   Haga clic en La entrada admite expresiones de Arcade y elija una expresión de ArcGIS Arcade para agregarla su cuadro de texto asociado.

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.

    Nota:

    La opción Token federado le permite autenticar solicitudes web como el usuario que realiza el paso. La opción Token federado solo es compatible con los servicios publicados en el mismo sitio de Enterprise que Workflow Manager.

    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.

       También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

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

       También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

    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 Arcade específicas del trabajo, 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. Haga clic en la pestaña Opciones.
18. Configure Opciones de pasos según sea necesario.
    • Manual: el paso se ejecuta manualmente.
      • Opcional: se permite finalizar el paso sin haberlo ejecutado.
    • Automático: el paso se ejecuta tan pronto como se activa.

      Nota:

      Si el diagrama del flujo de trabajo se configura para que se ejecute automáticamente una secuencia de pasos que incluya el paso Evaluar calidad de datos o Ejecutar servicio GP, los pasos que se intenten ejecutar después de que caduque el token de usuario que inició la secuencia de pasos no se ejecutarán de forma automática. Debe tener una licencia para que el rol de ArcGIS Workflow Manager Server Advanced siga ejecutando pasos automáticos adicionales sin intervención manual.

    • Ejecutar según programa: ejecute el paso según un programa establecido.

      Más información sobre las opciones de programación

19. Como opción, proporcione un texto de ayuda para el paso en el cuadro de texto Ayuda de paso.

    También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico para la ayuda del paso. Si la ayuda de paso contiene texto sin formato y expresiones de Arcade, tendrá que formatear el texto del siguiente modo:

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

20. También puede hacer clic en la pestaña Estilo para cambiar la forma y el color del paso.
21. Si lo desea, haga clic en la pestaña Acerca de y proporcione una descripción para el paso en el cuadro de texto Descripción del paso.

    Sugerencia:

    La pestaña Acerca de también contiene un Id. del paso que puede utilizarse con propiedades del paso dinámico para obtener una salida del paso. Haga clic en Copiar Id. del paso para copiar el Id. del paso en el portapapeles.

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, 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.

4. 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.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

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

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   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 ha agregado variables de ruta a la dirección URL, proporcione un valor para cada variable en la sección Variables de ruta.

   También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   Sugerencia:

   Haga clic en La entrada admite expresiones de Arcade y elija una expresión de ArcGIS Arcade para agregarla su cuadro de texto asociado.

6. 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.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

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

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
7. 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.

8. Haga clic en la pestaña Token.
9. Haga clic en el botón de alternancia Modo de prueba en la sección Token.
10. 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
        }
      }
    ]}

11. 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.

12. Proporcione una expresión JSONPath en notación de punto o notación entre corchetes en el cuadro de texto Ruta de extracción para analizar la respuesta y devolver 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.

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

Configurar los ajustes de salida

Licencia:

Esta funcionalidad requiere una licencia para el rol de ArcGIS Workflow Manager Server Advanced.

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.

Valor de retorno

Cuando el paso se completa, el valor de retorno se almacena para indicar el resultado del paso. El valor de retorno puede evaluarse de inmediato utilizando rutas para determinar los pasos siguientes del flujo de trabajo. También puede recuperar el valor de retorno correspondiente a los pasos completados por medio del flujo de trabajo utilizando las expresiones de ArcGIS Arcade. En la tabla siguiente figuran los valores de retorno del paso:

Valor de retorno	Descripción
S000001	El paso se ha completado correctamente.
F000001	El paso no ha podido completarse correctamente.

Valor de salida

Licencia:

Esta funcionalidad requiere una licencia para el rol de ArcGIS Workflow Manager Server Advanced.

Cuando el paso se completa, su valor de salida se almacena y se puede utilizar para determinar la ruta que sigue el flujo de trabajo o puede usarse como entradas para otros pasos del flujo de trabajo. En la tabla siguiente se muestra el valor de salida del paso:

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.
attachmentId	Devuelve un conjunto de Id. de adjunto agregados al paso.