Réponse

L’activité Réponse termine un workflow d’API et envoie une réponse structurée au demandeur. La réponse comprend généralement un statut et des données supplémentaires.

Utilisez l’activité Réponse pour :

• Renvoyez toujours les bons détails de statut et de réponse.
• Terminez les workflows avec un résultat clair et structuré.
• Handle errors gracefully, especially when combined with the Try/Catch activity.

L'activité Réponse doit être la dernière étape d'un workflow pour s'assurer que le processus fournit les informations prévues.

Remarque :

Currently, schema validation is not enforced, so if the data returned in the Response activity includes more or fewer properties than those defined in the output schema, the workflow does not fail.

Meilleures pratiques

• Always configure your Output schema in the Data manager before adding a Response activity. When you define the schema first, the system automatically suggests aligning your Response activity with it.
• Use a Response step when your calling party, such as Maestro or an agent, expects a response.
• You can skip adding a Response when you are building system-to-system integrations or an unattended automation.

Utilisation de l'activité Response

Pour ajouter une activité Response à votre flux de travail :

1. Sur votre canevas de conception de workflow d'API, sélectionnez l'icône plus (+). Le menu Ajouter une activité s'affiche.
2. Sélectionnez Réponse.
3. Dans le panneau Propriétés , configurez les champs suivants :
   • Marquer la tâche comme ayant échoué : activez cette option pour marquer l'ensemble du workflow comme ayant échoué. Ceci est utile pour signaler explicitement qu'une erreur logique s'est produite, même si aucune exception technique n'a été levée.
   • Response : utilisez l' éditeur d'expressions pour définir un objet JSON contenant les informations de réponse souhaitées. Vous pouvez également fournir une valeur statique ou une variable.
4. Enregistrez la configuration.

Exemple d’activité de réponse

L'exemple suivant récupère un travailleur à partir de Workday et regroupe les détails sur son responsable et ses rapports directs.

L'image suivante montre l'exemple de workflow :

La réponse d'échec

Le workflow renvoie un statut Échec avec un message d'erreur si une étape de récupération échoue.

Pour ce faire :

• Wrap the retrieval steps inside a Try/Catch block.
• Si une erreur se produit, l'étape Réponse d'erreur du flux de capture renvoie une réponse d'échec structurée.

Configurez la réponse avec les détails suivants :

• Type—Échec
• Détails : ouvrez l’éditeur d’expressions et écrivez ce qui suit :

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

  Ici, $context.outputs.Try_Catch_3.error fournit une sortie d'erreur structurée de l'activité Essayer de capturer . Lorsque le flux Essayer rencontre une erreur lors de l’exécution, le workflow renvoie la sortie suivante :
  

La réponse de réussite

Le workflow renvoie un statut Réussite avec les informations agrégées sur le travailleur. L'activité Rechercher des travailleurs par nom ou ID renvoie un tableau, même lorsqu'il n'y a qu'une seule correspondance. Là, nous utilisons une activité Pour chaque pour traiter chaque résultat, puis consolidons les données à l’aide d’une activité Script .

Configurez la réponse avec les détails suivants :

• Type—Réussite
• Détails : ouvrez l’éditeur d’expressions et écrivez ce qui suit :

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

  Ici, workers contient la sortie agrégée de l'étape Script de la boucle For Each . Le workflow renvoie la sortie suivante :