Oracle Cloud Infrastructure-Dokumentation

Abschlusskriterien angeben

Geben Sie die Bedingung an, die die Kriterien für einen erfolgreichen Abschluss der REST-Ausführung festlegt.

Eine Erfolgsbedingung ist erforderlich, um einen REST-Aufruf abzuschließen, unabhängig davon, ob die API einen Vorgang mit kurzer oder langer Ausführungszeit aufruft.

Informationen zum Definieren des Abschlusses des REST-Aufrufs für einen Vorgang mit langer Ausführungszeit über Polling finden Sie unter Abschlusskriterien durch Polling angeben.

Funktionen in Bedingungen verwenden

Einfache Zeichenfolgen- und Operatorfunktionen werden in Erfolgs- und Polling-Bedingungen unterstützt.

Der Ausdruck für eine Erfolgs- oder Polling-Bedingung kann nur die Funktionen enthalten, die im folgenden Abschnitt dargestellt sind. Um Werte aus JSON-Strukturen zu extrahieren, verwenden Sie die Funktion json_path.

Einfache arithmetische Funktionen

+

-

*

. usw.
Einfache boolesche Funktionen

AND

OR

NOT
Einfache Vergleichsfunktionen

>

<

!=
Einfache Nullfunktionen

IS NULL

IS NOT NULL

NVL
Einfache Zeichenfolgenfunktionen

CONCAT

LENGTH

UPPER

LOWER
Einfache Datums-/Uhrzeitfunktionen

DATE_ADD
json_path-Funktion

Informationen zu JSONPath-Syntaxelementen finden Sie unter:

http://goessner.net/articles/JsonPath/

Beispiel: Um den aktuellen Statuswert aus der folgenden Antwort abzurufen, verwenden Sie die Syntax: $.status.current-status.

{
   "processName": "createCustomer",
   "region" : "usa-1",
   "status" : {
      "current-status": "accepted",
      "id" : "usa1h3l4ewrt0989"
}
Abschlusskriterien angeben (Erfolgsbedingung)

Die Erfolgsbedingung in einer REST-Aufgabe ist ein Ausdruck, der den erfolgreichen Abschluss des REST-API-Aufrufs bestimmt. Polling wird gestoppt, wenn die Erfolgsbedingung erfüllt ist.

Standardmäßig stellt Data Integration eine Erfolgsbedingung für eine REST-Aufgabe bereit. Die Standarderfolgsbedingung ist ein HTTP-Statuscode von 200 oder höher, aber kleiner als 300, der als der folgende Ausdruck geschrieben wird:

SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300

Der Ausdruck für die Erfolgsbedingung referenziert die Ausgabe in der JSON-Antwort, die von der im Ausführungsschritt definierten REST-Anforderung empfangen wird.

Sie können die Standarderfolgsbedingung verwenden oder einen Bedingungsausdruck mit Systemausgaben oder extrahierten JSON-Eigenschaftenwerten aus der Antwort schreiben.

So bearbeiten Sie die Erfolgsbedingung:

  1. Gehen Sie auf der Seite REST-API-Details konfigurieren zum Schritt Abschlusskriterien angeben.
  2. Wenn die REST-API einen Vorgang mit langer Ausführungszeit aufruft, aktivieren Sie das Kontrollkästchen Polling- und Beendigungsbedingung für einen REST-Aufruf konfigurieren.
  3. Wählen Sie im Block Bedingungen neben Erfolgsbedingung die Option Bearbeiten aus.
  4. Geben Sie im Bereich Erfolgsbedingung bearbeiten einen Ausdruck ein, der die Ausgabe aus der Antwort der REST-Anforderung verwendet.

    Der Bedingungsausdruck kann die folgenden Elemente enthalten:

    • Eingehend: Sie können die eingehenden Antwortausgaben verwenden (Beispiel: SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Parameter: Sie können jeden Parameter verwenden, der im Geltungsbereich dieser REST-Aufgabe definiert ist. Siehe Parameter in einer REST-Aufgabe anzeigen und verwalten.

    • Funktionen: Sie können einfache Zeichenfolgen- und Operatordatenintegrationsfunktionen verwenden. Mit der json_path-Funktion, die sich unter "Zeichenfolge" befindet, können Sie Eigenschaftswerte aus der Antwort mit JSONPath-Syntaxelementen im Format json_path(json_string, json_filter_path) extrahieren.

      Beispiel: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

    Nicht alle Funktionen werden in einem Ausdruck für Erfolgsbedingungen unterstützt. Sie finden die unterstützten Funktionen in dieser Liste.

    (Bei Vorgängen mit langer Ausführungszeit) Wenn Sie das Kontrollkästchen Polling- und Beendigungsbedingung für einen REST-Aufruf ohne Warten konfigurieren aktiviert haben, ist die Erfolgsbedingung ein Ausdruck, der anhand der Antwort der Polling-Anforderung geschrieben wird. Sie können Ausdrücke erstellen, die die API-Antwort aus dem Ausführungsschritt verwenden, und dann die benannten Ausdrücke aufnehmen, um die Erfolgsbedingung zu erstellen.

  5. Um der Erfolgsbedingung einen Aufgabenparameter zuzuweisen, wählen Sie Parameter zuweisen aus. Siehe Erfolgsbedingung parametrisieren.
Erfolgsbedingung parametrisieren

Sie können der Erfolgsbedingung in einer REST-Aufgabe einen Aufgabenparameter zuweisen.

Mit der folgenden Prozedur können Sie auch eine Polling-Bedingung parametrisieren.

So parametrisieren Sie eine Bedingung:

  1. Gehen Sie auf der Seite REST-API-Details konfigurieren zum Schritt Abschlusskriterien angeben.

    Um die Polling-Bedingung zu parametrisieren, gehen Sie zum Schritt Abschlusskriterien angeben, und wählen Sie die Registerkarte Polling aus. Beachten Sie, dass die Registerkarte Polling nur angezeigt wird, wenn das Kontrollkästchen Polling- und Beendigungsbedingung für einen REST-Aufruf ohne Wartezeiten konfigurieren aktiviert ist.

  2. Wählen Sie im Block Bedingungen die Option Parameter zuweisen neben der Bedingung aus.
  3. Geben Sie im Bereich Parameter hinzufügen einen Namen für den Parameter ein, oder verwenden Sie den Standardwert.

    Der Parametername muss in der REST-Aufgabe eindeutig sein. Eine aktuelle Liste der Parameter in der Aufgabe finden Sie mit den Schritten unter Alle Parameter in einer REST-Aufgabe anzeigen.

  4. (Optional) Geben Sie eine Beschreibung ein, damit andere Benutzer den Zweck des Parameters erkennen können.
  5. Der Typ des Parameters ist Ausdruck, der nicht geändert werden kann.
  6. Wählen Sie im Bedingungsbuilder den Standardbedingungsausdruck für diesen Parameter aus. Diese Standardbedingung wird zur Laufzeit verwendet, es sei denn, Sie ändern den Wert zu einem späteren Zeitpunkt (zur Entwurfs- oder Laufzeit).

    Der Bedingungsausdruck kann die folgenden Elemente enthalten:

    • Eingehend: Eingehende Antwortausgaben (Beispiel: SYS.RESPONSE_PAYLOAD_JSON, SYS.RESPONSE_HEADERS_JSON, SYS.RESPONSE_STATUS).

    • Parameter: Parameter, die im Geltungsbereich dieser REST-Aufgabe definiert sind. Siehe Parameter in einer REST-Aufgabe anzeigen und verwalten.

    • Funktionen: Basisfunktionen für die Integration von Zeichenfolgen und Operatordaten. Mit der json_path-Funktion, die sich unter "Zeichenfolge" befindet, können Sie Eigenschaftswerte aus der Antwort mit JSONPath-Syntaxelementen im Format json_path(json_string, json_filter_path) extrahieren.

      Beispiel: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')

  7. Wählen Sie Hinzufügen aus.
    Der Parametername wird neben der Bedingung hinzugefügt.
Parameter für Erfolgsbedingung bearbeiten

Sie können die Beschreibung und den Standardwert des Aufgabenparameters für die Erfolgsbedingung ändern.

Mit der folgenden Prozedur können Sie auch den Parameter für die Polling-Bedingung bearbeiten.

So bearbeiten Sie die parametrisierte Bedingung:

  1. Gehen Sie auf der Seite REST-API-Details konfigurieren zum Schritt Abschlusskriterien angeben.

    Um die parametrisierte Polling-Bedingung zu bearbeiten, gehen Sie zum Schritt Abschlusskriterien angeben, und wählen Sie die Registerkarte Polling aus. Beachten Sie, dass die Registerkarte Polling nur angezeigt wird, wenn das Kontrollkästchen Polling- und Beendigungsbedingung für einen REST-Aufruf ohne Wartezeiten konfigurieren aktiviert ist.

  2. Wählen Sie im Block Bedingungen die Option Parameter bearbeiten aus.
  3. Bearbeiten Sie im Bereich Parameter bearbeiten nur die Beschreibung und den Bedingungsausdruck. Sie können die ID (Name) und den Datentyp nicht ändern.
  4. Wählen Sie Änderungen speichern aus.
Parameter für Erfolgsbedingung entfernen

Wenn Sie den Bedingungsparameter entfernen, wird nur die Verknüpfung des Parameters mit der für die REST-Aufgabe angegebenen Erfolgsbedingung entfernt.

Mit der folgenden Prozedur können Sie auch den Parameter für die Polling-Bedingung entfernen.

So heben Sie die Zuweisung des Parameters zur Bedingung auf:

  1. Gehen Sie auf der Seite REST-API-Details konfigurieren zum Schritt Abschlusskriterien angeben.

    Um die Zuweisung des Parameters zur Polling-Bedingung aufzuheben, gehen Sie zum Schritt Abschlusskriterien angeben, und wählen Sie die Registerkarte Polling aus. Beachten Sie, dass die Registerkarte Polling nur angezeigt wird, wenn das Kontrollkästchen Polling- und Beendigungsbedingung für einen REST-Aufruf ohne Wartezeiten konfigurieren aktiviert ist.

  2. Wählen Sie im Block Bedingungen die Option Parameter entfernen aus.
  3. Wählen Sie im Dialogfeld Parameter entfernen die Option Entfernen aus.

    Die Zuweisung des Parameters zur Bedingung wird aufgehoben. Der dem Parameter zugewiesene Bedingungsausdruck wird zur Standardbedingung.

    Hinweis

    Der Parameter wird nicht aus der REST-Aufgabe gelöscht. Informationen zum Löschen des Parameters finden Sie unter REST-Aufgabenparameter löschen.