繰り返し (コレクションの各要素)

[繰り返し (コレクションの各要素)] アクティビティは、配列を反復処理し、配列要素ごとに定義された一連のステップを実行します。[ 繰り返し (コレクションの各 要素)] アクティビティは、個別の処理が必要なユーザー、注文、レコードのリストなどのオブジェクト配列を含む API 応答を処理する場合に使用します。

配列にデータを集約する方法

[繰り返し (コレクションの各要素)] アクティビティの一般的なユース ケースは、[スクリプト] アクティビティを使用して、複数の API 呼び出しのデータを構造化された配列に集約する処理です。

[繰り返し (コレクションの各要素)] アクティビティは、[本文] フロー内の最後のアクティビティの出力を自動的に収集し、独自の出力で利用可能な配列にコンパイルします。

[繰り返し (コレクションの各要素)] アクティビティの使用

ワークフローに [繰り返し (コレクションの各要素 )] アクティビティを追加するには、以下の手順を実行します。

1. API ワークフロー デザイナー キャンバスで、プラス (+) アイコンを選択します。[ アクティビティを追加 ] メニューが表示されます。
2. [ ループ]、[繰り返し ( コレクションの各要素)] の順に選択します。
3. [ プロパティ ] パネルで、次のフィールドを設定します。
   • [入力] - [式エディター] を使用して、反復処理する配列を指定します。通常、この配列は前の API 応答から取得されます。
   • 項目名 - 配列要素に参照名を割り当てます (デフォルトは currentItem)。この参照を使用して、反復処理中に各項目にアクセスします。
4. ForEach ループの 本体 に、配列項目を処理するアクティビティを追加します。
5. 必要に応じて、[ Then ] 分岐と [Else ] 分岐にアクティビティを追加します。
6. ワークフローをデバッグしてアクティビティを実行し、後で使用する出力フィールドを生成します。

[繰り返し (コレクションの各要素)] アクティビティの例

次の例では、従業員オブジェクトの配列を反復処理し、各従業員の姓と名を結合して、集計結果を構造化された応答で返します。

[Debug configuration] ウィンドウを開き、次の JSON 構文を貼り付けて保存します。

{
    "employees": [
        {
            "first_name": "Bobbie",
            "last_name": "Draper",
            "position": "administration",
            "email": "[e-mail]"
        },
                {
            "first_name": "James",
            "last_name": "Holden",
            "position": "manager",
            "email": "[e-mail]"
        }
    ]
}

1. API ワークフロー デザイナー キャンバスで、[ 繰り返し (コレクションの各要素 )] アクティビティを追加します。
2. [繰り返し (コレクションの各要素)] フィールドを次のように設定します。
   • 次のコレクション内の各要素 - [式エディター] を使用して、実行コンフィギュレーションから employees 配列を参照します。

     $workflow.input.employees

   • 項目名 - 配列要素に参照名を割り当てます (デフォルトは currentItem)。この参照を使用して、反復処理中に各項目にアクセスします。
3. [繰り返し (コレクションの各要素)] ループの[本体] に、[ スクリプト] アクティビティを追加します。
4. [スクリプト] アクティビティでは、[式エディター] を使用して、first_name プロパティと last_name プロパティを 1 つのオブジェクトに結合する JSON を作成します。

   return {
       "name": $currentItem.first_name + " " + $currentItem.last_name
   }

5. 設定を保存します。
6. ワークフローの最後に [ 応答 ] アクティビティを追加します。
7. 応答を次のように設定します。
   • タイプ - 成功
   • [詳細] - [式エディター] を開き、以下を書き込みます。

     $context.outputs.For_Each_2

   この手順では、ワークフローの最初に検証を追加し、処理前に有効なトランザクションが存在することを確認します。
8. ワークフローをデバッグしてアクティビティを実行します。
9. [出力] パネルで応答を確認します。