Respuesta

La actividad Respuesta finaliza un flujo de trabajo de API y envía una respuesta estructurada al solicitante. La respuesta suele incluir un estado y datos adicionales.

Utiliza la actividad Respuesta para:

• Devuelve siempre el estado y los detalles de respuesta correctos.
• Finalice los flujos de trabajo con un resultado claro y estructurado.
• Maneja los errores con gracia, especialmente cuando se combina con la actividad Intentar/Capturar .

La actividad Respuesta debe ser el paso final en un flujo de trabajo, para garantizar que el proceso proporcione la información deseada.

Nota:

Actualmente, la validación del esquema no se aplica, por lo que si los datos devueltos en la actividad Respuesta incluyen más o menos propiedades que las definidas en el esquema de salida, el flujo de trabajo no falla.

Mejores prácticas

• Configura siempre tu esquema de salida en el gestor de datos antes de añadir una actividad de respuesta . Cuando defines el esquema primero, el sistema sugiere automáticamente alinear tu actividad de Respuesta con él.
• Utiliza un paso de Respuesta cuando la parte que llama, como Maestro o un agente, espera una respuesta.
• Puedes omitir la adición de una Respuesta cuando estás creando integraciones de sistema a sistema o una automatización unattended.

Utilizar la actividad de respuesta

Para añadir una actividad de Respuesta a tu flujo de trabajo:

1. En el lienzo del diseñador de flujo de trabajo de la API, selecciona el icono más (+). Aparecerá el menú Añadir actividad .
2. Selecciona Respuesta.
3. En el panel Propiedades , configura los siguientes campos:
   • Marcar trabajo como fallido : activa esta opción para marcar todo el flujo de trabajo como fallido. Esto es útil para señalar explícitamente que se ha producido un error lógico, incluso si no se ha lanzado ninguna excepción técnica.
   • Respuesta : utiliza el editor de expresiones para definir un objeto JSON que contenga la información de respuesta deseada. También puedes proporcionar un valor estático o una variable.
4. Guarda la configuración.

Ejemplo de actividad de respuesta

El siguiente ejemplo recupera un trabajador de Workday y agrega detalles sobre su gestor y sus informes directos.

La siguiente imagen muestra el flujo de trabajo de ejemplo:

La respuesta de fallo

El flujo de trabajo devuelve un estado de Fallo con un mensaje de error si falla algún paso de recuperación.

Para lograrlo:

• Envuelve los pasos de recuperación dentro de un bloque Intentar/Capturar .
• Si se produce un error, el paso Respuesta de error en el flujo Capturar devuelve una respuesta de fallo estructurada.

Configura la respuesta con los siguientes detalles:

• Tipo : error
• Detalles : abre el editor de expresiones y escribe lo siguiente:

  ({
      "error_message": $context.outputs.Try_Catch_3.error.title,
      "status": $context.outputs.Try_Catch_3.error.status
  })

  Aquí, $context.outputs.Try_Catch_3.error proporciona una salida de error estructurada de la actividad Try-Catch . Cuando el flujo Intentar encuentra un error durante la ejecución, el flujo de trabajo devuelve el siguiente resultado:
  

La respuesta de éxito

El flujo de trabajo devuelve un estado de Éxito con la información agregada del trabajador. La actividad Buscar trabajadores por nombre o ID devuelve una matriz, incluso cuando solo hay una coincidencia. Allí, utilizamos una actividad Para cada para procesar cada resultado y luego consolidamos los datos utilizando una actividad de Script .

Configura la respuesta con los siguientes detalles:

• Tipo : Correcto
• Detalles : abre el editor de expresiones y escribe lo siguiente:

  ({
      "workers": $context.outputs.For_Each_2.results
  })

  Aquí, workers contiene la salida agregada del paso Script del bucle Para cada . El flujo de trabajo devuelve el siguiente resultado: