API-Zugriff auf Workflow-Studio Flows

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer

    • Anwendungsentwickler können über-APIs für Abläufe, Unterabläufe und Aktionen auf die Workflow-Studio-Funktionalität zugreifen. Flow-Autoren können festlegen, dass einzelne Flows, Subflows und Aktionen während des Designs vom Client aufgerufen werden können.

    Verfügbar Workflow-Studio Flow-APIs

    Lösen Sie Flows, Subflows und Aktionen mit diesen APIs aus Server- oder Client-Skripts aus.

    Serverseite
    FlowAPI : Löst einen Flow, Subflow oder eine Aktion mit synchronen oder asynchronen Methoden mit oder ohne Ausführungsdetails aus.
    Client-Seite
    GlideFlow : Führen Sie clientseitige Interaktionen mit Aktionen, Flows und Subflows durch. Flow-Designer müssen den Aufruf eines Flows, eines Subflows und einer Aktion vom Client aktivieren.

    FlowAPI-Schnellmethoden

    Verwenden Sie Schnellmethoden in FlowAPI Klasse zum Ausführen einer Aktion, eines Flows oder eines Subflows aus einem serverseitigen Skript, ohne Ausführungsdetails oder andere zugehörige Datensätze zu erstellen. Verwenden Sie diese Methoden, um die Geschwindigkeit der Verarbeitung hoher Volumina in einer Produktionsumgebung zu erhöhen und die Leistung zu verbessern, indem der Aufwand bei der Datensatzführung beseitigt wird. Zu den Methoden gehören:

    • ExecuteActionQuick() , ExecuteFlowQuick() , ExecuteSubflowQuick() : Führt eine Aktion, einen Flow oder einen Subflow aus einem serverseitigen Skript synchron aus der aktuellen Anwendersitzung aus.
    • StartActionQuick() , StartFlowQuick() , StartSubflowQuick() : Führt eine Aktion, einen Flow oder einen Subflow asynchron aus einem serverseitigen Skript aus.

    XML- und JSON-Streaming-APIs

    Erstellt eine große JSON- oder XML-Nutzlast für Streaming oder nicht-Streaming, die in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API verwendet werden kann. Sie können diese APIs beispielsweise verwenden, um eine JSON-Nutzlast in zu erstellen Workflow-Studio Skriptschritt und übergeben Sie den zurückgegebenen Wert an den REST-Schritt, um die Anforderung an einen Drittparteiservice zu senden. Weitere Informationen finden Sie unter JSONStreamingBuilder Und XMLStreamingBuilder .

    Vom Client aufrufbare APIs

    Standardmäßig können die Abläufe, Unterabläufe und Aktionen nur von der FlowAPI in einem Serverskript aufgerufen werden. Flow- und Aktionsdesigner können einzelne Flows, Subflows oder Aktionen für Client-Aufrufe verfügbar machen, indem sie aktiviert haben Vom Client aufrufbar Option während des Designprozesses.

    Als Support ausführen

    Flows und Subflows können entweder als Systemanwender oder als Anwender ausgeführt werden, der die Sitzung initiiert. Legen Sie dieses Verhalten über fest Flow-Eigenschaften . Alle API-Schnellmethoden ignorieren die Eigenschaft „Ausführen als“ und werden immer als Systemanwender ausgeführt.

    Aktionen werden immer als der Anwender ausgeführt, der die Sitzung initiiert.

    Code-Fragmente

    Anwendungsentwickler können eine JavaScript-Funktion generieren, die einen bestimmten Flow, Subflow oder eine bestimmte Aktion mit aufruft Code-Fragment Option. Verwenden Sie das Code-Fragment in Skripts wie Business-Regeln oder Skripts: Backgound Modul, das spezifisch aufgerufen werden soll Workflow-Studio Elemente. Das System generiert nur Codefragmente für veröffentlichte Flows, Subflows und Aktionen. Workflow-Studio Elemente im Status „Entwurf“ oder „geändert“ generieren keine Codefragmente.