ペイロードビルダーステップ

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：3分

    • アクションデザイナーが JSON および XML ペイロードで動的データを使用して名前/値ペアを簡単に作成できるようにします。

    ロールと可用性

    ワークフロースタジオ アクションステップとして利用可能です。action_designer ロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。
    注:
    JSON の場合、このステップは廃止され、JSON Builder ステップに置き換えられました。

    フィールド

    フィールド 説明
    名前と値のペア

    ペイロードに含める名前と値のペア。名前と値のペアを追加するには、プラスアイコンをクリックします。データピルをいずれかのフィールドにドラッグし、動的ペイロードを生成します。

    [名前] は JSON ではキーとなり、XML では要素になります。たとえば、次の名前と値のペアを作成するとします。
    • 名前：short_description
    • 値：[action]->[short_description]
    名前と値のペアが JSON として書式設定される場合は、次のようになります。
    "short_description": "[action]->[short_description]"

    名前と値のペアが XML として書式設定される場合は、次のようになります。

    <short_description>[action]->[short_description]</short_description>
    空の場合省略 値が空または null である場合、名前と値のペアを除外するためのオプション。
    注:
    このフィールドが表示されるのは、下向き矢印をクリックして詳細オプションを表示した後のみです。
    出力の形式 ペイロードのファイル形式。
    • JSON：JSON ドキュメントとしてペイロードを書式設定します。
    • XML：XML ドキュメントとしてペイロードを書式設定します。
    名前空間 各要素に適用する XML 名前空間。たとえば、名前空間をインシデントに設定すると、次のようになります。
    <incident:short_description>[action]->[short_description]</incident:short_description>
    注:
    このフィールドは、[出力形式] が [XML] に設定されている場合にのみ表示されます。
    外部の構造を含める

    出力形式に適したトップレベルコンテナを含めるか除外するオプション。[出力形式] が JSON であるとき、中かっこで名前と値のペアを囲みます。[出力形式] が XML であるとき、指定した XML 要素に名前と値のペアが含まれます。

    たとえば、名前と値のペアが JSON として書式設定される場合は、次のようになります。

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

    名前と値のペアが XML として書式設定される場合は、次のようになります。

    <xml>
  <short_description>[action]->[short_description]</short_description>
</xml>
    空の構造を送信

    ペイロードが空の場合、有効な JSON 構造または XML 構造を送信するオプション。ペイロードに JSON または XML の構造テキストを含めるには、このオプションを有効にします。

    たとえば、空の構造が JSON として書式設定される場合は、次のようになります。
    {}

    空の構造が XML として書式設定される場合は、次のようになります。

    <xml></xml>

    空のペイロードを生成するには、このオプションを無効にします。

    名前と値のすべてのペアに [空の場合省略] オプションを選択すると、空のペイロードが発生することがあり、ペイロードの名前と値のすべてのペアによって空の値が生成されます。
    親ノード 名前と値のペアを含む XML 要素の名前。デフォルトの親ノード要素は xml です。
    注:
    このフィールドが表示されるのは、[出力形式] を [XML] に設定し、[外部の構造を含める] のオプションを有効にしたときのみです。
    プレビュー ステップによって生成される読み取り専用ペイロード。

    アクションエラー評価

    このステップが失敗した場合
    データタイプ：Choice

    次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「アクションエラー評価」を参照してください。