OpenAPI/Postman-Schritt

Für den JSON-Ausgabeantworttext erstellt das System eine komplexe Datenobjektausgabe aus der OpenAPI-Spezifikation oder Postman-Sammlung .

Hinweis:

OpenAPI/Postman-Schritt Ist im Basissystem nicht verfügbar und erfordert ServiceNow® IntegrationHubAbonnement. Nachdem das erforderliche Plugin aktiviert wurde, ist der Schritt unter Integrationen sichtbar.

Rollen und Verfügbarkeit

Verfügbar als Aktionsdesigner-Aktionsschritt. Anwender mit den Rollen „action_Designer“ und „Open_api_admin“ oder „admin“ können eine anwenderdefinierte Aktion mit einem oder mehreren Aktionsschritten erstellen.

Felder


Feld	Beschreibung
Verbindungsalias	Alias-Datensatz für Verbindungen und Anmeldeinformationen, den das System zur Ausführung des Aktionsschritts verwendet. Benutzer mit den Rollen „action_Designer“ und „connection_admin“ oder „admin“ können einen zugehörigen Verbindungsalias-Datensatz auswählen. Wenn Sie einen Alias verwenden, müssen Sie nicht mehrere Anmeldeinformations- und Verbindungsinformationsprofile konfigurieren, wenn Sie eine Aktion in mehreren Umgebungen verwenden. Wenn sich die Verbindungsinformationen ändern, müssen Sie Ihre anwenderdefinierte Aktion nicht aktualisieren. Weitere Informationen zu Verbindungen und Anmeldeinformationen finden Sie unter Anmeldeinformationen, Verbindungen und Aliasnamen.
Basis-URL	Basis-URL aus dem Verbindungsalias für die REST-Anforderung.
Erweiterte Ansicht ein/aus	Option zum Anzeigen oder Ausblenden der Anforderungsdetails. Wenn diese Option aktiviert ist, können Sie den Ressourcenpfad, die HTTP-Methode, Abfrageparameter, Header und Aktionsausgaben der Anforderung anzeigen und konfigurieren.
API-Quelle	Option zum Auswählen einer API aus der Liste der verfügbaren importierten APIs.
Importspezifikation	Option, mit der Sie eine OpenAPI-Spezifikation (v2.0 oder v3.0) oder eine Postman-Sammlung (Version 2.0.0 oder 2,1.0) importieren können. Sie können eine OpenAPI-Spezifikation oder eine Postman-Sammlung importieren, indem Sie eine URL und Anmeldeinformationen für die Spezifikation oder Sammlung angeben oder JSON-Inhalte manuell kopieren und einfügen.
API-Vorgang	Option zum Auswählen eines Vorgangs aus der Liste. Verfügbare Vorgänge werden von der OpenAPI-Spezifikation oder der Postman-Sammlung in bereitgestellt API-Quelle Feld.
Als Anlage speichern	Option zum Festlegen, ob die Antwort als Datensatz in der Tabelle „Anhang“ [sys_attachment] gespeichert werden soll.
Ressourcenpfad	Pfad für die Ressource.
HTTP-Methode	HTTP-Methode, die zur Verarbeitung der Anforderung verwendet wird. GET POST PUT PATCH LÖSCHEN
Abfrageparameter	Name-Wert-Paare, die an den REST-Endpunkt übergeben werden sollen. Sie können diese Parameter manuell erstellen oder Eingabevariablen in die Parameterfelder ziehen und dann einen Wert zuweisen. Unterstützen Sie REST-Schrittanforderungen, die doppelte Abfrageparameternamen enthalten. Wenn Sie eine REST-Anforderung erstellen, die doppelte Abfrageparameternamen enthält, Workflow-StudioFügt der Anforderung die Abfrageparameter in derselben Reihenfolge hinzu, in der Sie sie definiert haben. Hinweis: Beim Importieren einer OpenAPI-Spezifikation fügt das System dem REST-Schritt alle in der Spezifikation enthaltenen Parameter und Header hinzu. Überprüfen Sie die endgültigen REST-Schrittwerte, und entfernen Sie Parameter, die Sie in der Anforderung nicht senden möchten. Wenn die API beispielsweise Inhaltstypheader für JSON und XML akzeptiert, fügt das System beide Header dem REST-Schritt hinzu. Entfernen Sie je nach Inhaltstyp, den Sie in der Antwort erhalten möchten, einen der Header.
Header	Header, die mit der Anforderung gesendet werden sollen. Sie können Header manuell erstellen oder Eingabevariablen in die Parameterfelder ziehen und dann einen Wert zuweisen. Unterstützen Sie REST-Schrittanforderungen, die doppelte Anforderungsheader enthalten. Wenn Sie eine REST-Anforderung erstellen, die doppelte Anforderungsheader enthält, werden die Header in derselben Reihenfolge gesendet, in der Sie sie definiert haben. Hinweis: Beim Importieren einer OpenAPI-Spezifikation fügt das System dem REST-Schritt alle in der Spezifikation enthaltenen Parameter und Header hinzu. Überprüfen Sie die endgültigen REST-Schrittwerte, und entfernen Sie Parameter, die Sie in der Anforderung nicht senden möchten. Wenn die API beispielsweise Inhaltstypheader für JSON und XML akzeptiert, fügt das System beide Header dem REST-Schritt hinzu. Entfernen Sie je nach Inhaltstyp, den Sie in der Antwort erhalten möchten, einen der Header.
Anhang	Anhangsdatensatz, der die Anforderung enthält. Sie können diesen Datensatz in einem vorherigen Schritt suchen oder erstellen und ihn als Eingabevariable definieren. Erstellen Sie es mit JSONStreamingBuilder Und XMLStreamingBuilder APIs im Skriptschritt. Hinweis: Dieses Feld ist verfügbar, wenn Sie auswählen Binär Aus der Liste Anforderungstyp.
Wiederholungsrichtlinie aktivieren	Option zum Aktivieren der Wiederholungsrichtlinie. Weitere Informationen finden Sie unter Wiederholungsrichtlinie.
Standardrichtlinie für Alias überschreiben	Option zum Überschreiben der Standardwiederholungsrichtlinie. Dieses Kontrollkästchen ist nicht verfügbar, wenn in der Verbindungsliste die Option Verbindung inline definieren ausgewählt ist.
Wiederholungsrichtlinie	Standardwiederholungsrichtlinie, die dem Verbindungsalias zugeordnet ist. Wenn Standardrichtlinie für Alias überschreiben ausgewählt ist, können Sie die Standardwiederholungsrichtlinie überschreiben und eine andere vorhandene Neuversuchsrichtlinie basierend auf Ihrer Anforderung auswählen.

Auswertung des Aktionsfehlers

Wenn dieser Schritt fehlschlägt: Datentyp: Choice
Option, um den nächsten Schritt fortzusetzen oder zur Fehlerauswertung zu wechseln. Informationen zur Verwendung des Schrittstatuscodes oder der Meldung für eine anwenderdefinierte Aktionsfehlerbedingung finden Sie unter .

Auswertung des Aktionsfehlers

Wenn dieser Schritt fehlschlägt: Datentyp: Choice
Option, um den nächsten Schritt fortzusetzen oder zur Fehlerauswertung zu wechseln. Informationen zur Verwendung des Schrittstatuscodes oder der Meldung für eine anwenderdefinierte Aktionsfehlerbedingung finden Sie unter .

Bekannte Einschränkungen

Erstellen Sie einen OpenAPI-Schritt aus einer OpenAPI-Spezifikation mit diesen Einschränkungen.

Medientypen des Anforderungstexts

Der Anforderungstext unterstützt nur JSON-Medientypen.

Hinweis:

Ein Ausgabeobjekt vom Typ Zeichenfolge wird erstellt, wenn das OpenAPI-Schema über additionalProperties oder keine Eigenschaften verfügt.

OpenAPI 3,0-Komponenten

OpenAPI 3,0 fügt Swagger 2,0 neue Komponenten hinzu, um eine API detaillierter zu beschreiben. Die OpenAPI-Unterstützung im OpenAPI-Schritt unterstützt einige, aber nicht alle dieser Komponenten. Der OpenAPI-Schritt unterstützt diese Komponenten derzeit nicht.

Schemaobjekt: AdditionalProperties-Eigenschaften
Unterscheiderobjekt
Informationsobjekt: TermsOfService, Kontakt, Lizenzfelder
Beispielobjekt
Objekt Verknüpfen
Rückrufobjekt
Sicherheitsschemaobjekt
Sicherheitsanforderungsobjekt
Tag-Objekt
Externes Dokumentationsobjekt
Serverobjekt
Spezifikationserweiterungen
Rekursive Referenzen

Weitere Informationen zu diesen Komponenten finden Sie in der OpenAPI-Dokumentation. Siehe OpenAPI-Spezifikation .

Maximale Anzahl unterstützter Vorgänge

Die Anzahl der API-Vorgänge ist standardmäßig auf 500 beschränkt. Verwenden Sie jedoch die Systemeigenschaft glide.rest.openapi.max_operation_limit, Sie können die Anzahl der Vorgänge von 1 bis 1000 konfigurieren.