JSON Builder ステップ
別のステップで使用する JSON ペイロードを作成します。値を入力するか、データピルを使用して動的ペイロードを生成します。このステップでは、ネストされた構造のオブジェクトやアレイなど、いくつかのデータタイプがサポートされています。
ロールと可用性
このステップには 統合ハブ のサブスクリプションが必要です。詳細については、「 法務スケジュール - 統合ハブ の概要」を参照してください。 必要なプラグインを有効化した後、ステップは [統合] の下に表示されます。
ワークフロースタジオ アクションステップとして利用可能です。action_designer ロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。
入力
アクションに必要な各入力の値を指定します。動的な値を追加するには、[データ] パネルからピルをドラッグアンドドロップすることも、ピルピッカーから選択することもできます。
- 名前
- データタイプ：String
名前と値のペアの名前の部分です。値を入力するか、データピルを使用して動的ペイロードを生成します。
- 値
- データタイプ：String
名前と値のペアの値の部分です。値を入力するか、データピルを使用して動的ペイロードを生成します。複合オブジェクトピルを使用して行にオブジェクトデータタイプを入力できますが、そうすると、複合オブジェクトピルに既に存在する子がすべて削除されます。
- タイプ
- データタイプ：Choice名前と値のペアのデータタイプです。名前または値にデータピルを使用する場合は、ピルのデータタイプがここで選択したデータタイプと一致していることを確認してください。オプションは次のとおりです。
- 文字列
- オブジェクト
- 番号
- ブール
- アレイ
アレイとオブジェクトの場合は、プラスアイコン (
) を使用して、アレイまたはオブジェクトに名前と値のペアを追加します。 - 空の値の場合
- データタイプ：Choice名前と値のペアの値が空または null の場合の処理を指定するオプションです。
- そのまま残す (Leave as is)：空または null 値を空の文字列として保持します。
- プロパティを省略 (Omit property)：値が空または null の場合、名前と値のペアを除外します。
- null として設定 (Set as null)：空または null 値を null データタイプとして返します。
- エラーをスロー：名前と値のペアの値が空または null 値の場合、エラーを返します。
- 外部の構造を含める
- データタイプ：True/False
トップレベルの JSON コンテナに中括弧を含めるオプションです。
- 空の構造を省略
- データタイプ：True/False
空のペイロードを省略するオプションです。名前と値のすべてのペアで [空の値の場合] フィールドの [プロパティを省略] を選択し、ペイロード内のすべての名前と値のペアが空の値を生成した場合に、空のペイロードが発生する可能性があります。
- 構造
- データタイプ：Structure
ステップによって生成される読み取り専用ペイロードです。
- このステップが失敗した場合
- データタイプ：Choice
次のステップの実行を続行するか、エラー評価に進むオプション。カスタムアクションのエラー条件のステップのステータスコードやメッセージを使用するには、「アクションエラー評価」を参照してください。
出力
これらの出力は [データ] パネルに表示されます。アクションの任意の場所で入力として使用できます。
- 出力
- データタイプ：String
文字列としての JSON ペイロードです。ペイロードをオブジェクトとして使用する場合は、JSON パーサーステップを使用して文字列を解析できます。
- ステップステータス
- データタイプ：Object
ステップに関するランタイムの詳細を含むオブジェクトデータピル。アクションの各ステップはステップステータスを返します。
- [ステップステータス] > [コード]
- データタイプ：Integer
ステップでエラーが発生したかどうかを示す整数データピルです。デフォルトでは、値 1 はステップでエラーが生成されたことを示します。値 0 は、ステップが正常に実行されたことを示します。これらのコードはカスタマイズできません。
- [ステップステータス] > [メッセージ]
- データタイプ：String
ステップまたはシステム操作によって生成されたエラーメッセージを含む文字列データピル。このメッセージはカスタマイズできません。
JSON ペイロードを生成
[ペイロードの JSON を追加 (Add JSON for Payload)] ボタンを使用して、JSON ペイロードを自動的に生成します。このボタンにより [ペイロードを追加 (Add Payload)] スクリプトエディターが開きます。そこで JSON ペイロードを入力すると、構造化入力に自動的に逆シリアル化できます。
- JSON に空のキーがある場合でも、ペイロードは引き続き生成されます。
- スクリプトエディターに重複するキーがある場合、オブジェクト内の最後のキーエントリによって、同じ名前の以前のキーの値が上書きされます。
- ルートオブジェクトがアレイの場合、ルートアレイはルートオブジェクトにラップされます。
- アレイに複数のオブジェクトが含まれている場合、オブジェクト内のすべてのキーが 1 つの親オブジェクトに結合されます。
- 空のペイロード
- 非複合オブジェクトタイプ
- 無効な JSON
- 空のルートオブジェクト (空のアレイなど)
- 65,000 バイトを超えるペイロード