Nutzlastgenerator-Schritt

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Ermöglichen Sie Aktionsdesignern, Name-/Wert-Paare mit dynamischen Daten einfach in JSON- und XML-Nutzlasten zu erstellen.

    Rollen und Verfügbarkeit

    Verfügbar als Workflow-Studio-Aktionsschritt. Benutzer mit der Rolle „action_designer“ können eine anwenderdefinierte Aktion mit einem oder mehreren Aktionsschritten erstellen.
    Hinweis:
    Für JSON ist dieser Schritt veraltet und wird durch JSON Builder-Schrittersetzt.

    Felder

    Felder Beschreibung
    Name/Wert-Paare

    Die Name-Wert-Paare, die in die Nutzlast aufgenommen werden sollen. Klicken Sie auf das Plus-Symbol, um Name/Wert-Paare hinzuzufügen. Ziehen Sie Datenpillen in eines der Felder, um dynamische Nutzlasten zu erzeugen.

    Der Name wird zu einem Schlüssel in JSON und einem Element in XML. Angenommen, Sie erstellen dieses Name/Wert-Paar.
    • Name: short_description
    • Wert: [action]->[short_description]
    Wenn das System das Name-Wert-Paar als JSON formatiert:
    "short_description": "[action]->[short_description]"

    Wenn das System das Name-Wert-Paar als XML formatiert:

    <short_description>[action]->[short_description]</short_description>
    Wenn leer, auslassen Die Option zum Ausschließen eines Name-Wert-Paares, wenn der Wert leer oder null ist.
    Hinweis:
    Dieses Feld ist erst sichtbar, nachdem Sie auf den Abwärtspfeil geklickt haben, um erweiterte Optionen anzuzeigen.
    Ausgabeformat Das Nutzlastdateiformat.
    • JSON: Wählen Sie diese Option aus, um die Nutzlast als JSON-Dokument zu formatieren.
    • XML: Wählen Sie diese Option aus, um die Nutzlast als XML-Dokument zu formatieren.
    Namespace Der auf jedes Element anzuwendende XML-Namespace. Beispiel: Wenn der Namespace auf Incidentfestgelegt ist:
    <incident:short_description>[action]->[short_description]</incident:short_description>
    Hinweis:
    Dieses Feld ist nur sichtbar, wenn das Ausgabeformat auf XMLfestgelegt ist.
    Äußere Struktur einschließen

    Die Option zum Ein- oder Ausschließen eines Containers der obersten Ebene, der dem Ausgabeformat entspricht. Wenn das Ausgabeformat JSON lautet, enthalten geschweifte Klammern die Name/Wert-Paare. Wenn XML als Ausgabeformat ausgewählt ist, enthält ein angegebenes XML-Element die Name/Wert-Paare.

    Beispiel: Wenn das System das Name-Wert-Paar als JSON formatiert:

    {
      "short_description": "[action]->[short_description]"
    }

    Wenn das System das Name-Wert-Paar als XML formatiert:

    <xml>
      <short_description>[action]->[short_description]</short_description>
    </xml>
    Leere Struktur senden

    Die Option zum Senden gültiger JSON- oder XML-Strukturen, wenn die Nutzlast leer ist. Aktivieren Sie diese Option, um JSON- oder XML-Strukturtext in die Nutzlast einzubeziehen.

    Beispiel: Wenn das System eine leere Struktur als JSON formatiert:
    {}

    Wenn das System eine leere Struktur als XML formatiert:

    <xml></xml>

    Deaktivieren Sie diese Option, um eine leere Nutzlast zu erstellen.

    Leere Nutzlasten können auftreten, wenn Sie für jedes Name/Wert-Paar die Option Auslassen wenn leer auswählen und alle Name/Wert-Paare in der Nutzlast leere Werte erzeugen.

    Übergeordneter Knoten Der Name des XML-Elements, das die Name/Wert-Paare enthält. Das standardmäßige übergeordnete Knotenelement ist XML.
    Hinweis:
    Dieses Feld ist nur sichtbar, wenn das Ausgabeformat auf XML festgelegt und die Option zum Einbeziehen der äußeren Struktur aktiviert ist.
    Vorschau Die schreibgeschützte Nutzlast, die der Schritt erzeugt.

    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.