REST-API-Auslöser

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Starten Sie einen Flow über einen eingehenden API-Aufruf oder einen Webhook über ein externes System. Konfigurieren Sie die Startbedingungen des Auslösers, ohne anwenderdefinierten Code schreiben oder verwalten zu müssen.

    Sie können beispielsweise einen Flow erstellen, der startet, wenn ein IT-Ticketnachverfolgungssystem einer Drittpartei eine eingehende Anforderung an die Instanz sendet. Sie können dann die Daten aus der eingehenden REST-Anforderung in ein komplexes Datenobjekt analysieren und die Werte verwenden, um einen Incident in Ihrer Instanz zu öffnen.

    Sobald Sie den Flow aktiviert haben, wird der von Ihnen erstellte Endpunkt im API-Explorer unter dem von Ihnen erstellten Namespace angezeigt. Sie können diese Seite verwenden, um den Webhook in Ihrem Drittparteisystem zu definieren und Ihren Flow zu testen.

    Weitere Informationen zu Flow-Auslösern finden Sie unter Workflow-Studio Auslösertypenan.

    Hinweis:
    • Verwenden Sie den REST-API-Auslöser, um Flows aus REST-Aufrufen aus externen Systemen zu starten. Um einen Flow über ein Skript oder einen API-Aufruf aus derselben Instanz zu starten, verwenden Sie einen Subflow, ein Codefragment oder Workflow-StudioAPI. Siehe API-Zugriff auf Workflow-Studio Und Erstellen Sie Codefragmente für Flows, Subflows und Aktionen .

    • ServiceNow hat eine Partnerschaft mit geschlossen BoomiZu liefern Boomi API Management, Eine cloudbasierte Plattform, mit der Kunden ihre APIs erkennen, verwalten, sichern und monetarisieren können. BoomiUnterstützt das API-Management des gesamten Lebenszyklus, einschließlich Governance, Analytics und API-Sicherheit.

      BoomiStellt bereit Dokumentation Über ihr eigenes Portal und Kunden, die Support bei anfordern Boomi API ManagementWird Kontakt aufnehmen BoomiSupport über ihre Standardkanäle.

      Informationen zu den ersten Schritten finden Sie unter Boomi API ManagementAuflistung auf ServiceNow® Store, Das Informationen zu Berechtigungen und erforderlichen Plugins sowie einen Link zu enthält Boomi API Management Dokumentationan.

    Verfügbare Datenpillen

    Je nachdem, wie Sie den Endpunkt konfigurieren, haben Flow Designer über den Auslöser Zugriff auf diese Datenpillen:

    Pfadparameter
    Ein Objekt, das Pfadparameter in der eingehenden Anforderung enthält.
    Abfrageparameter
    Ein Objekt, das Abfrageparameter in der eingehenden Anforderung enthält.
    Anforderungsheader
    Ein Objekt, das Header in der eingehenden Anforderung enthält.
    Anforderungstext
    Komplexes Datenobjekt, das die Textstruktur der eingehenden Anforderung definiert. Weitere Informationen zu komplexen Objekten finden Sie unter Complex data.

    Definieren Sie beim Einrichten des Auslösers, wie die eingehenden Daten aussehen. Sie können dann die zugehörigen Datenpillen innerhalb der Aktionen in Ihrem Flow verwenden. Wenn das System eine eingehende Anforderung empfängt, die den Flow startet, verwendet es die in der Anforderung gesendeten Laufzeitwerte.

    Erstellen Sie einen Flow mit dem REST API-Auslöser

    Erstellen Sie einen Flow, der startet, wenn ein Drittparteisystem eine REST-Anforderung an Ihre Instanz sendet.

    Vorbereitungen

    Erforderliche Rolle: Flow_Designer oder admin.

    Diese Funktion erfordert IntegrationHubAbonnement. Weitere Informationen finden Sie unter Rechtliche Zeitpläne: IntegrationHub-Übersicht .

    Prozedur

    1. Offen Workflow-StudioUnd erstellen Sie einen Flow.

      Siehe Erstellen Sie einen Flow .

      Beachten Sie, dass der Umfang Ihres Flows in dem von Ihnen erstellten REST-Endpunkt enthalten ist.

    2. In AUSLÖSER Wählen Sie den Abschnitt aus REST-API: Asynchron Auslöser.
    3. In HTTP-Methode Feld, legen Sie die HTTP-Methode für den Endpunkt fest.
      Optionen umfassen:
      • POST
      • GET
      • LÖSCHEN
      • PUT
      • PATCH
    4. Erstellen Sie alle Pfadparameter, die für den Endpunkt erforderlich sind, und fügen Sie sie dem relativen Pfad in hinzu Pfad Feld.
      Der relative Pfad zum Endpunkt hat das Format /api/<flow-application-scope>/<flow-name>/<path-parameters> .

      Sie können auf klicken Kopieren Zum Kopieren des vollständigen Pfads zum Endpunkt. Verwenden Sie diesen Pfad, wenn Sie den Endpunkt für den REST-Aufruf in Ihrem Drittparteisystem konfigurieren.

      1. Erstellen Sie Variablen in Pfadparameter Abschnitt.
      2. Ziehen Sie die Datenpille, die den Pfadparameter darstellt, in die leere Eingabe in Pfad Feld.

        Dieses Feld akzeptiert nur Datenpillen aus Pfadparameter Abschnitt.

    5. Wählen Sie Aus Erfordert Authentifizierung Dient dazu, Authentifizierungsheader in der eingehenden REST-Anforderung anzufordern.
    6. Wenn Erfordert Authentifizierung Ist ausgewählt, fügen Sie die Rollen hinzu, die zum Autorisieren der Anforderung erforderlich sind, in Erfordert Rollen Feld.
    7. In Textkörper Feld unter Inhalt Anfordern Erstellen Sie ein komplexes Datenobjekt, das die Textstruktur der eingehenden Anforderung definiert.

      Weitere Informationen zum Erstellen eines komplexen Objekts finden Sie unter Komplexe Daten .

      Hinweis:
      Die Inhalt Anfordern Abschnitt wird nur angezeigt, wenn HTTP-Methode Ist „POST“, „PUT“ oder „PATCH“.

      Dieser Beispieltext sucht das Feld „Beschreibung“ in einer eingehenden Nutzlast, die Ticketinformationen aus einem Ticketnachverfolgungssystem einer Drittpartei enthält.

    8. In Header Feld, definieren Sie die Header, die in der eingehenden Anforderung gesendet werden sollen.
      Sie können auswählen Erforderlich Um anzufordern, dass die eingehende Anforderung sie enthält.
    9. In Abfrageparameter Feld, definieren Sie die Abfrageparameter, die in der eingehenden Anforderung gesendet werden sollen.
      Sie können auswählen Erforderlich Um anzufordern, dass die eingehende Anforderung sie enthält.
    10. Fügen Sie Ihrem Flow Aktionen hinzu, die ausgeführt werden, wenn der Endpunkt aufgerufen wird.

      Sie können die Datenpillen aus dem REST-API-Auslöser in Ihren Flow-Aktionen verwenden.

      Mit dieser Aktion wird ein Incident-Datensatz erstellt und die Felder „Beschreibung“ und „Zuweisungsgruppe“ aus der eingehenden Nutzlast dem Incident zugeordnet.

    11. Testen und aktivieren Sie den Flow.
      Weitere Informationen finden Sie unter Testen Sie einen Flow Und Aktivieren Sie einen Flow .

      Nach der Aktivierung wird der Endpunkt im REST-API-Explorer angezeigt. Sie können diese Seite verwenden, um Ihren Endpunkt weiter zu testen oder die Anforderung von Ihrem Drittparteisystem zu konfigurieren.

    12. Konfigurieren Sie die REST-Anforderung aus Ihrem Drittparteisystem.
      Sie können beispielsweise diese Curl-Anforderung senden, um den in den vorherigen Schritten definierten Flow auszulösen.
      curl "https:your-instance.servicenow.com/api/snc/create_incident_from_external_event/assignment_group/287ebd7da9fe198100f92cc8d1d2154e" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
fields: {
   description: \"Major outage with data loss\"
   }
}" \
--user 'username':'password'

    Ergebnisse

    Der Flow wird ausgeführt, und die REST-Anforderung gibt die Ausführungs-ID zurück.
    {
  "result": {
    "executionId": "ndoxeRhshDSezldeGfbYlviFSeFnBjCO"
  }
}

    Nächste Maßnahme

    Kopieren Sie die Ausführungs-ID im Ergebnis, und navigieren Sie zur Registerkarte „Ausführungen“ im Flow Designer. Sie können nach Ausführungs-ID filtern, um die Ausführungsdetails zu suchen und den Status der Ausführung anzuzeigen.

    Zur Behebung von Problemen können Sie die REST-Abfrage debuggen oder die Flow-Ausführungsdetails überprüfen. Siehe Debuggen von REST-Abfragen Und Flow-Ausführungsdetails .