Crear un flujo de trabajo que llama a una API externa - Data360_Govern - Más reciente

Paso 1: construya el flujo de trabajo

En este ejemplo se asume que ya ha creado un tipo de acción en el que desea basar el flujo de trabajo. Para obtener más información sobre tipos de acciones, consulte Definición de tipos de acciones.

1. Vaya a Configuración > Flujos de trabajo.
2. Haga clic en el botón Añadir en el panel Tipos de flujos de trabajo para crear un nuevo flujo de trabajo.
3. Introduzca un Nombre para el flujo de trabajo, por ejemplo, la "creación de un ticket Jira".
4. En la lista Cambiar tipo, seleccione Elemento agregado.
5. En la lista Tipo de objeto, seleccione su tipo de acción de calidad de datos, por ejemplo Tipo de acción :: Informar del problema de calidad de datos.
6. Haga clic en Siguiente.
7. Construya el flujo de trabajo arrastrando las actividades requeridas de la parte izquierda de la pantalla hacia el área de edición del flujo de trabajo. Por ejemplo:

   

Paso 2: configure la actividad Solicitud HTTP

Configure la actividad Solicitud HTTP para enviar una solicitud POST a Jira para crear un nuevo ticket.

Las configuraciones exactas necesarias para configurar la actividad de solicitud HTTP variarán según la API externa a la que se esté conectando. El siguiente ejemplo muestra cómo configurar esta actividad de flujo de trabajo para conectarse a la API de Jira.

1. Seleccione la actividad Solicitud de HTTP en el flujo de trabajo que construyó en el paso anterior.
2. Agregue la siguiente solicitud Encabezados:

   Clave	Valor
   Autorización	Basic <Dirección de correo electrónico codificada base64: clave de API>
   Tipo de contenido	application/json

   También puede utilizar un token de flujo de trabajo en el campo Valor del encabezado. No obstante, no se pueden utilizar en el campo Clave. Para incluir un token, realice lo siguiente:

   • Introdúzcalo manualmente o:
   • Cópielo de otro lugar y péguelo en el campo Valor.

   Cuando se ejecuta el flujo de trabajo, las muestras se reemplazan por su valor.

   Para crear su valor del encabezado de autorización: combine la dirección de correo electrónico que utiliza para conectarse a Jira con su clave de API de Jira, en el siguiente formato: <email_address>:<API_key> A continuación, codifique este valor en base64. Utilice el valor codificado en base64 y agregue esto a la columna del valor del encabezado de autorización, precedido de la palabra Basic y un espacio, por ejemplo:

   Basic FG5vYmxlQGluZm7mbXguY30uOmD5S3QoEjAnejKLUYpWZ2Y1enlvPLMxOQ==

   Para obtener información sobre cómo obtener su clave de API de Jira, consulte la documentación de Jira, por ejemplo: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

   Nota: Si utiliza cualquiera de los siguientes encabezados de contenido, también debe especificar un valor en el campo Cuerpo: "Content-Type", "Content-MD5", "Content-Encoding" y "Content-Length". Si utiliza uno de estos encabezados sin un valor de cuerpo, el paso del flujo de trabajo de la solicitud HTTP no se completará.
3. Seleccione el Método. Elija entre GET, POST, PUT o DELETE. En este caso, seleccione POST.
4. Introduzca la URL del punto de conexión de la API externa; por ejemplo, https://example.atlassian.net/rest/api/2/issue
   Consejo: Puede utilizar los tokens Adjuntar valor de campo en la URL copiando y pegando el valor del token del campo Cuerpo. Consulte Configuración de notificaciones de correo electrónico para ver ejemplos de tokens.
5. Introduzca el cuerpo de la solicitud. Por ejemplo, para crear un nuevo ticket en Jira, puede utilizar JSON para hacer referencia a la clave y los campos del proyecto de Jira:

   {   "fields": {       "project":       {         "key": "TEST"       },       "summary": "Data quality issue",       "description": "A data quality issue has been raised in Data360 Govern.",       "issuetype": {         "name": "Bug"       }   } }

   Esto crea un nuevo error en Jira en el proyecto "TEST", cuyo resumen y descripción coinciden con la información incluida en el cuerpo de la solicitud:

   

6. Defina el periodo de Tiempo de espera de solicitud requerido, hasta un máximo de 600 segundos. El valor predeterminado es 90 segundos.

Para obtener más información sobre la implementación de este ejemplo, consulte la documentación de Jira, por ejemplo: https://developer.atlassian.com/server/jira/platform/jira-rest-api-examples/

Paso 3: configure las transiciones condicionales

Utilice transiciones condicionales para determinar qué correo electrónico (fallido o correcto) se envía al iniciador del flujo de trabajo.

1. En la transición que conduce a una actividad de Notificación de correo electrónico correcta, agregue la siguiente condición:

   Campo	Operador	Valor
   Solicitud HTTP :: Código de estado	<	299

   Esto especifica que se enviará un correo electrónico que indique que la solicitud HTTP es correcta si el código de estado de respuesta HTTP es inferior a 299.

2. En la transición que conduce a una actividad de Notificación de correo electrónico fallida, agregue la siguiente condición:

   Campo	Operador	Valor
   Solicitud HTTP :: Código de estado	>	299

   Esto especifica que se enviará un correo electrónico que indique que la solicitud HTTP falló si el código de estado de respuesta HTTP es superior a 299.

Paso 4: configure las actividades de notificación de correo electrónico

1. Seleccione la actividad Notificación de correo electrónico correcta y escriba un Nombre, como "Solicitud POST correcta".
2. En el Tipo de destinatario, seleccione Iniciador.
3. Escriba un asunto y un cuerpo para el correo electrónico. Por ejemplo, el cuerpo podría ser:

   Se ha creado un nuevo ticket Jira para hacer un seguimiento de un problema de calidad de datos. El código de estado de la respuesta HTTP es: [HTTPREQUEST|365|statusCode]El cuerpo de respuesta es: [HTTPREQUEST|365|responseBody]

   En este ejemplo se utilizan los tokens HTTP Request :: Status Code y HTTP Request :: Response Body, que se reemplazarán por los valores de respuesta de la API en el correo electrónico que se envía al iniciador; por ejemplo:

   

   En el correo electrónico, el cuerpo de respuesta proporciona el número de ticket del nuevo error que se ha creado en Jira.

4. Seleccione la actividad de Notificación de correo electrónico fallida y escriba un Nombre, como por ejemplo "Fallo en la solicitud POST".
5. En el Tipo de destinatario, seleccione Iniciador.
6. Escriba un asunto y un cuerpo para el correo electrónico. Por ejemplo, el cuerpo podría ser:

   Se ha producido un error que impidió la creación de un nuevo ticket Jira. El código de estado de la respuesta HTTP es: [HTTPREQUEST|365|statusCode] El cuerpo de respuesta es: [HTTPREQUEST|365|responseBody]

   En este ejemplo se utilizan los tokens HTTP Request :: Status Code y HTTP Request :: Response Body, que se reemplazarán por los valores de respuesta de la API en el correo electrónico que se envía al iniciador; por ejemplo:

   

   El correo electrónico proporciona detalles del error en el cuerpo de respuesta así como el código de estado de respuesta, lo que le permite solucionar el problema.

Paso 5. Añadir una tarea de respuesta HTTP

Se puede agregar una tarea de respuesta HTTP a un flujo de trabajo de solicitud HTTP para permitir que los pasos posteriores extraigan propiedades basadas en JSON de la API pertinente.

1. Cree una nueva tarea de flujo de trabajo respuesta HTTP.

2. Utilizando la ficha Editar del panel del editor de la tarea de respuesta HTTP, seleccione la tarea de solicitud HTTP ascendente adecuada para conectarse a la entrada.

3. En Salidas, haga clic en el botón Agregar (+) para mostrar los campos de la configuración de salida e introduzca:

   1. Un Nombre reconocible de su elección. Por ejemplo, "Clave Jira".
   2. La Ruta JSON correcta y válida.
   Nota: Si la ruta no es válida o la respuesta no contiene la propiedad de destino de la ruta (por ejemplo, si la solicitud falla), el valor será una cadena vacía.

   Por ejemplo, si la Ruta JSON se establece en "clave", la respuesta de la API puede ser similar a la siguiente:

   {

   "id":"1234",

   "key":"GOV-16569",

   "self":"http://localhost:8080/rest/api/2/issue/1234"

   }

Otros pasos del flujo de trabajo ahora pueden utilizar los valores de salida de la respuesta. Por ejemplo, en tokens de correo electrónico o en un paso de cambio de campo.