Nutzlastgenerator-Schritt

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 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 Aktionsdesigner-Aktionsschritt. Benutzer mit der Rolle „action_designer“ können eine benutzerdefinierte Aktion mit einem oder mehreren Aktionsschritten erstellen.
    Hinweis:
    Für JSON ist dieser Schritt veraltet und wird durch JSON-Generator-Schrittersetzt.

    Felder

    Felder Beschreibung
    Name/Wert-Paare

    Die in die Nutzlast einzubeziehenden Name/Wert-Paare. Klicken Sie auf das Pluszeichen, um Name/Wert-Paare hinzuzufügen. Ziehen Sie Datenpillen in eines der beiden 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 Möglichkeit, ein Name/Wert-Paar auszuschließen, wenn der Wert leer oder null ist.
    Hinweis:
    Dieses Feld wird nur angezeigt, nachdem Sie auf den Abwärtspfeil geklickt haben, um erweiterte Optionen anzuzeigen.
    Ausgabeformat Das Nutzlast-Dateiformat.
    • 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 Auf die einzelnen Elemente anzuwendender XML-Namespace. Beispielsweise wenn der Namespace auf incident festgelegt 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 Einbeziehen oder Ausschließen eines Containers auf oberster Ebene entsprechend dem Ausgabeformat. Wenn das Ausgabeformat JSON ist, enthalten geschweifte Klammern die Name-Wert-Paare. Wenn das Ausgabeformat XML ist, enthält ein angegebenes XML-Element die Name-Wert-Paare.

    Wenn das System das Name/Wert-Paar z. B. 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, gültige JSON- oder XML-Strukturen zu senden, wenn die Nutzlast leer ist. Aktivieren Sie diese Option, um strukturellen JSON- oder XML-Text in die Nutzlast aufzunehmen.

    Wenn das System z. B. eine leere Struktur im JSON-Format formatiert:
    {}

    Wenn das System eine leere Struktur im XML-Format formatiert:

    <xml></xml>

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

    Leere Nutzlasten können auftreten, wenn Sie die Option Auslassen, wenn leer für jedes Name-Wert-Paar 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 Outer Structure einbeziehen aktiviert ist.
    Vorschau Die schreibgeschützte Nutzlast, die der Schritt erzeugt.

    Felder für Aktionsfehlerauswertung

    Feld Beschreibung
    Wenn dieser Schritt fehlschlägt Option, um mit der Ausführung des nächsten Schritts fortzufahren oder zur Fehlerauswertung zu wechseln. Informationen zur Verwendung des Schrittstatuscodes oder der Meldung für eine Fehlerbedingung für eine benutzerdefinierte Aktion finden Sie unter Aktionsfehlerbewertung.