JSON Builder-Schritt

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

    • Erstellen Sie eine JSON-Nutzlast, die in einem anderen Schritt verwendet werden soll. Geben Sie Werte ein, oder verwenden Sie Datenpillen, um eine dynamische Nutzlast zu erstellen. Dieser Schritt unterstützt mehrere Datentypen, einschließlich Objekte und Arrays für geschachtelte Strukturen.

    Rollen und Verfügbarkeit

    Dieser Schritt erfordert ein IntegrationHub-Abonnement. Weitere Informationen finden Sie unter Gesetzliche Zeitpläne – IntegrationHub Übersicht. Nachdem das erforderliche Plugin aktiviert wurde, wird der Schritt unter Integrationen angezeigt.

    Verfügbar als Workflow-Studio-Aktionsschritt. Benutzer mit der Rolle „action_designer“ können eine anwenderdefinierte Aktion mit einem oder mehreren Aktionsschritten erstellen.

    Eingaben

    Geben Sie einen Wert für jede Eingabe an, die Ihre Aktion benötigt. Um dynamische Werte hinzuzufügen, können Sie auch Pillen aus dem Datenbereich ziehen oder in der Pillenauswahl auswählen.

    Name
    Datentyp: String

    Namensteil eines Name-Wert-Paares. Geben Sie einen Wert ein, oder verwenden Sie eine Datenpille, um eine dynamische Nutzlast zu erstellen.

    Wert
    Datentyp: String

    Wertteil eines Name-Wert-Paares. Geben Sie einen Wert ein, oder verwenden Sie eine Datenpille, um eine dynamische Nutzlast zu erstellen. Sie können eine komplexe Objektpille verwenden, um eine Zeile mit einem Objektdatentyp zu füllen. Dadurch werden jedoch alle untergeordneten Elemente gelöscht, die die komplexe Objektpille bereits enthält.

    Typ
    Datentyp: Choice
    Datentyp für das Name-Wert-Paar. Wenn Sie eine Datenpille für den Namen oder Wert verwenden, stellen Sie sicher, dass der Datentyp für die Pille mit dem hier ausgewählten Datentyp übereinstimmt. Die Optionen sind:
    • Zeichenfolge
    • Objekt
    • Nummer
    • Boolean
    • Array

    Verwenden Sie für Arrays und Objekte das Plus-Symbol ( Plus-Symbol), um dem Array oder Objekt Name/Wert-Paare hinzuzufügen.

    Wenn der Wert leer ist
    Datentyp: Choice
    Option zum Festlegen der Aktion, wenn ein Name-Wert-Paar einen leeren oder NULL-Wert hat.
    • Unverändert lassen: Behält den leeren oder Null-Wert als leere Zeichenfolge bei.
    • Eigenschaft auslassen: Schließt ein Name-Wert-Paar aus, wenn der Wert leer oder null ist.
    • Als NULL festlegen: Gibt einen leeren oder NULL-Wert als NULL-Datentyp zurück.
    • Fehler auslösen: Gibt einen Fehler zurück, wenn ein Name-Wert-Paar einen leeren oder Null-Wert hat.
    Äußere Struktur einschließen
    Datentyp: True/False

    Option zum Einschließen der geschweiften Klammern für einen JSON-Container der obersten Ebene.

    Leere Struktur auslassen
    Datentyp: True/False

    Option zum Auslassen einer leeren Nutzlast. Leere Nutzlasten können auftreten, wenn Sie die Eigenschaft Auslassen für die Option Im Falle einer leeren Werteingabe für jedes Name-Wert-Paar auswählen, und alle Name-Wert-Paare in der Nutzlast erzeugen leere Werte.

    Struktur
    Datentyp: Structure

    Schreibgeschützte Nutzlast, die der Schritt erzeugt.

    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 Fehlerbewertung der Aktion.

    Ausgaben

    Diese Ausgaben werden im Datenbereich angezeigt. Sie können sie an anderer Stelle in Ihrer Aktion als Eingaben verwenden.

    Ausgabe
    Datentyp: String

    JSON-Nutzlast als Zeichenfolge. Wenn Sie die Nutzlast als Objekt verwenden möchten, können Sie den JSON-Parser-Schritt verwenden, um die Zeichenfolge zu analysieren.

    Schrittstatus
    Datentyp: Object

    Objektdatenpille, die Laufzeitdetails zum Schritt enthält. Jeder Schritt in einer Aktion gibt einen Schrittstatus zurück.

    Schrittstatus > Code
    Datentyp: Integer

    Ganzzahlige Datenpille, die angibt, ob bei dem Schritt ein Fehler aufgetreten ist. Standardmäßig gibt der Wert 1 an, dass bei dem Schritt ein Fehler aufgetreten ist. Der Wert 0 zeigt an, dass der Schritt erfolgreich ausgeführt wurde. Sie können diese Codes nicht anpassen.

    Schrittstatus > Nachricht
    Datentyp: String

    Zeichenfolgendatenpille, die die vom Schritt oder Systemvorgang erzeugte Fehlermeldung enthält. Sie können diese Nachricht nicht anpassen.

    Generieren Sie eine JSON-Payload

    Generiert automatisch eine JSON-Payload mit der Schaltfläche JSON für Payload hinzufügen. Diese Schaltfläche öffnet den Skript-Editor zum Hinzufügen von Nutzlast, in dem Sie eine JSON-Nutzlast eingeben können, die automatisch in eine strukturierte Eingabe deserialisiert werden soll.

    Bei der Verwendung des JSON-Nutzlastgenerators sind einige Details zu beachten.
    • Wenn die JSON leere Schlüssel enthält, wird die Nutzlast trotzdem generiert.
    • Wenn im Skript-Editor doppelte Schlüssel vorhanden sind, überschreibt der letzte Schlüsseleintrag im Objekt den Wert aller vorherigen Schlüssel mit demselben Namen.
    • Wenn das Stammobjekt ein Array ist, wird das Stamm-Array in ein Stammobjekt eingeschlossen.
    • Wenn ein Array mehrere Objekte enthält, werden alle Schlüssel in den Objekten zu einem übergeordneten Objekt zusammengefügt.
    Der JSON-Nutzlastgenerator unterstützt Folgendes nicht.
    • leere Nutzlasten
    • nicht komplexe Objekttypen
    • ungültiges JSON
    • leere Stammobjekte, z. B. ein leeres Array
    • Nutzlasten größer als 65.000 Byte
    Hinweis:
    Durch das Generieren einer JSON-Payload werden vorhandene Strukturen im JSON Builder-Schritt überschrieben.