Antwortschemas für Anforderungen

Das Ergebnis, das wir durch die Verwendung asynchroner APIs erhalten, kann verarbeitet werden, erfolgreich sein oder zu Fehlern führen. Auf dieser Seite werden die häufig zurückgegebenen Schemata für beide Situationen beschrieben, wenn ein getResult-Aufruf erfolgt. Diese Ergebnisse entschlüsseln zu können ist der Schlüssel für eine erfolgreiche API-Verwaltung und Fehlerbehebung.

Verarbeitung

Während der Verarbeitung gibt der Aufruf getResult ein Schema mit den folgenden Details zurück:

• status: Der aktuelle Status der Anforderung. In diesem Fall ist der Status Running.
• createdAt: Datum und Uhrzeit, wann die Anforderung initiiert wurde.
• lastUpdatedAt: Datum und Uhrzeit, wann die Anforderung zuletzt aktualisiert wurde.

Erfolgreich

Wenn die Anfrage erfolgreich ist, gibt der getResult-Aufruf ein Schema mit den folgenden Details zurück:

• status: Der aktuelle Status der Anforderung. In diesem Fall ist der Status Succeeded.
• createdAt: Datum und Uhrzeit, wann die Anforderung initiiert wurde.
• lastUpdatedAt: Datum und Uhrzeit, wann die Anforderung zuletzt aktualisiert wurde.
• result: Das Ergebnis der Anforderung, z. B. das Extraktionsergebnis (angezeigt als extractionResult).

Fehlgeschlagen (Failed)

Wenn die Anfrage fehlschlägt, gibt der Aufruf getResult ein Schema mit den folgenden Details zurück:

• status: Der aktuelle Status der Anforderung. In diesem Fall ist der Status Failed.
• createdAt: Datum und Uhrzeit, wann die Anforderung initiiert wurde.
• lastUpdatedAt: Datum und Uhrzeit, wann die Anforderung zuletzt aktualisiert wurde.
• error: Die Ursache von Fehlern mit den folgenden Details:
  • message: Detaillierte Erklärung mit Beschreibung, worum es bei dem Fehler geht, z. B. "Internal Server Error. Please contact the UiPath support team."
  • severity: Der Schweregrad des Fehlers. In diesem Fall ist der Schweregrad meistens Error.
  • code: Spezifischer Code, der den Fehlertyp identifiziert, z. B. [UnexpectedInternalServerError].
  • parameters: Enthält ggf. zusätzliche fehlerbezogene Informationen.