Antwort

Die Aktivität Response beendet einen API-Workflow und sendet eine strukturierte Antwort an den Anforderer. Die Antwort enthält in der Regel einen Status und zusätzliche Daten.

Verwenden Sie die Aktivität Response für Folgendes:

• Status und Antwortdetails immer zurückgeben.
• Beenden Sie Workflows mit einem klaren und strukturierten Ergebnis.
• Korrektes Behandeln von Fehlern, insbesondere in Kombination mit der Try-Catch -Aktivität.

Die Aktivität Response sollte der letzte Schritt in einem Workflow sein, um sicherzustellen, dass der Prozess die beabsichtigten Informationen bereitstellt.

Wichtig: Wenn Sie keine Antwort- Aktivität hinzufügen, gibt der Workflow die Antwort von der zuletzt ausgeführten Anforderung zurück. Wenn ein Fehler auftritt, gibt der Workflow stattdessen die Fehlerdetails zurück.

Antwortaktivität wird verwendet

So fügen Sie Ihrem Workflow eine Response -Aktivität hinzu:

1. Wählen Sie auf der Arbeitsfläche Ihres API-Workflow-Designers das Pluszeichen (+) aus. Das Menü Aktivität hinzufügen wird angezeigt.
2. Wählen Sie Antwort aus.
3. Konfigurieren Sie im Eigenschaftenbereich die folgenden Felder:
   • Auftrag als fehlgeschlagen markieren– Aktivieren Sie diese Option, um den gesamten Workflow als fehlgeschlagen zu markieren. Dies ist nützlich, um explizit zu signalisieren, dass ein logischer Fehler aufgetreten ist, auch wenn keine technische Ausnahme ausgelöst wurde.
   • Antwort– Verwenden Sie den Ausdrucks-Editor, um ein JSON-Objekt zu definieren, das die gewünschten Antwortinformationen enthält. Sie können auch einen statischen Wert oder eine Variable angeben.
4. Speichern Sie die Konfiguration.

Beispiel für eine Response-Aktivität

Im folgenden Beispiel wird eine Arbeitskraft von Workday abgerufen und Details über ihren Vorgesetzten und seine direkten Vorgesetzten aggregiert.

Die folgende Abbildung zeigt den Beispiel-Workflow:

Die Fehlerantwort

Der Workflow gibt den Status Fehler mit einer Fehlermeldung zurück, wenn ein Abrufschritt fehlschlägt.

Um dies zu erreichen:

• Binden Sie die Abrufschritte in einen Try-Catch -Block.
• Wenn ein Fehler auftritt, gibt der Schritt Fehlerantwort im Catch -Flow eine strukturierte Fehlerantwort zurück.

Konfigurieren Sie die Antwort mit den folgenden Details:

• Typ– Fehler
• Details– Öffnen Sie den Ausdruckseditor und schreiben Sie Folgendes:

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

  Hier stellt $context.outputs.Try_Catch_3.error eine strukturierte Fehlerausgabe der Try-Catch -Aktivität bereit. Wenn beim Try- Flow während der Ausführung ein Fehler auftritt, gibt der Workflow die folgende Ausgabe zurück:
  

Die Success-Antwort

Der Workflow gibt den Status Erfolg mit den aggregierten Arbeitsinformationen zurück. Die Aktivität Search Workers by Name or ID gibt ein Array zurück, auch wenn es nur eine Übereinstimmung gibt. Dort verwenden wir eine For Each- Aktivität, um jedes Ergebnis zu verarbeiten, und konsolidieren die Daten dann mithilfe einer Script -Aktivität.

Konfigurieren Sie die Antwort mit den folgenden Details:

• Typ– Erfolg
• Details– Öffnen Sie den Ausdruckseditor und schreiben Sie Folgendes:

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

  Hier enthält workers die aggregierte Ausgabe aus dem Schritt Skript der For Each- Schleife. Der Workflow gibt die folgende Ausgabe zurück: