バッチ要求の構文

バッチ要求呼び出しの構文

バッチ要求呼び出しの構文は次のとおりです。

POST <applicationURL>/rest/<apiWithVersion>/batch

例えば、ローカルマシン上で ClaimCenter のインスタンスからクレーム API バッチを実行している場合、呼び出しは次のようになります。

POST http://localhost:8080/cc/rest/claim/v1/batch

バッチ要求ペイロードの構文

バッチ要求ペイロードの基本構文は次のとおりです。

{
  "requests": [
    {
      "method": "<method>",
      "path": "<path>",
      "query": "<queryParameters>",
      "data":
        {
          "attributes": {
            "<field1>": "<value1>",
            "<field2>": "<value2>",
            ...
          }
        }
    },
    {
      "method": "<method>",
      "path": "<path>",
      "query": "<queryParameters>",
      "data":
        {
          "attributes": {
            "<field1>": "<value1>",
            "<field2>": "<value2>",
            ...
          }
        }
    },
    ...
  ]
}

ここで：

• <method> は、メソッドであり、「get」、「post」、「patch」、または「delete」など小文字で指定します。
• <path> はエンドポイントのパスです。
  • このパスは、API パス（「/v1」などのメジャーバージョンを含む）の直後に続きます。例えば、分離して実行する場合のコマンドのパスが次のようになるとします。http://localhost:8080/cc/rest/claim/v1/claims/cc:22/activities/cc:55。バッチ内のパスは次のとおりです。 /claims/cc:22/activities/cc:55
• <queryParmaters> は、クエリパラメータのオプションの文字列です。この文字列の先頭には「?」を使用しません。
• <field1/<value> は要求の本文のフィールドと値のペアです。

後続のセクションに、この構文の使用方法の例を示します。