OpenAPI-/Postman-Schritt

Für den JSON-Ausgabeantworttext erstellt das System ein komplexes Datenobjekt, das aus der OpenAPI-Spezifikation oder der Postman-Sammlungausgegeben wird.

Hinweis:

OpenAPI-/Postman-Schritt ist im Basissystem nicht verfügbar und erfordert das -Abonnement ServiceNow® IntegrationHub. Nachdem das erforderliche Plugin aktiviert wurde, wird der Schritt unter Integrationen angezeigt.

Rollen und Verfügbarkeit

Verfügbar als Aktionsdesigner-Aktionsschritt. Benutzer 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	Aliasdatensatz für Verbindungen und Anmeldeinformationen, den das System zum Ausführen 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. Ebenso müssen Sie Ihre anwenderdefinierte Aktion nicht aktualisieren, wenn sich die Verbindungsinformationen ändern. 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 im Feld API-Quelle bereitgestellt.
Als Anhang 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	Zur Verarbeitung der Anforderung verwendete HTTP-Methode. 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, fügt Workflow-Studio der Anforderung die Abfrageparameter in der 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 der von Ihnen definierten Reihenfolge gesendet. 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 als Eingabevariable definieren. Erstellen Sie sie mithilfe der APIs JSONStreamingBuilder und XMLStreamingBuilder im Schritt Skript. Hinweis: Dieses Feld ist verfügbar, wenn Sie in der Liste Anforderungstyp die Option Binär auswählen.
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.

Fehlerbewertung der Aktion

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

Fehlerbewertung der Aktion

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

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 zusätzlicheEigenschaften oder keine Eigenschaften aufweist.

OpenAPI 3.0-Komponenten

OpenAPI 3.0 fügt zu „Swaiger 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: zusätzlicheEigenschaften
Unterscheidungsmerkmalobjekt
Info-Objekt: „termsOfService“, „Kontakt“, „Lizenz“-Felder
Beispielobjekt
Link-Objekt
Rückrufobjekt
Sicherheitsschemaobjekt
Sicherheitsanforderungsobjekt
Tag-Objekt
Externes Dokumentationsobjekt
Serverobjekt
Spezifikationserweiterungen
Rekursive Verweise

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

Maximale Anzahl der unterstützten Vorgänge

Die Anzahl der API-Vorgänge ist standardmäßig auf 500 beschränkt. Mit der Systemeigenschaft glide.rest.openapi.max_operation_limitkönnen Sie jedoch eine Anzahl von Vorgängen zwischen 1 und 1000 konfigurieren.