複数アプリへのレコード一括処理
複数のアプリに対して、同時に複数の APIをリクエストできます。
HTTP メソッド
POST
URI
https://(サブドメイン名).cybozu.com/k/v1/bulkRequest.json
ゲストスペース内のアプリの場合
https://(サブドメイン名).cybozu.com/k/guest/<スペースのID>/v1/bulkRequest.json
- 同じゲストスペース内のアプリへの一括更新のみ実行でき、次の処理は実行することができません。
- ゲストスペース内のアプリと、別のゲストスペース内のアプリへの一括更新
- ゲストスペース内のアプリと、スペース内のアプリへの一括更新
- ゲストスペース内のアプリと、通常のアプリへの一括更新
必要なアクセス権
実行するAPIの必要な権限に準ずる
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| requests | 配列 | 必須 | 一括で呼ぶリクエスト。最大20件。 |
| requests[].method | 文字列 | 必須 | 呼び出すAPIのメソッド |
| requests[].api | 文字列 | 必須 | 呼び出すAPIのパス
|
| requests[].payload | 必須 | APIに渡すパラメータ。 内容や型は呼び出すAPIに準ずる |
リクエストの例
リクエストヘッダ
POST /k/v1/bulkRequest.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
ボディ
レスポンス
resultsの配列にrequestsと同じインデックスの箇所に結果が入ります。
| パラメータ名 | 型 | 説明 |
|---|---|---|
| results | 配列 | 各APIリクエストに対するレスポンス。 requestsのArrayに並べた順番でレスポンスも並びます。 |
成功した例
失敗した例
2つ目のPUTリクエストで、更新する id がない場合にエラーとなる例です。 失敗したAPIがあればそのインデックスにのみ結果が入り、それ以降のAPIは実行されずに {} (空のObject) となります。
JavaScriptサンプル
XMLHttpRequest
的外れな質問であれば申し訳ありませんが、
記事タイトルにある「複数アプリへのレコード一括処理」とは、
「同一アプリへの複数レコード一括処理」もbulkRequestで実行可能と考えてよろしいのでしょうか？
h.egami 様
ご質問ありがとうございます。
cybozu developer network 事務局 でございます。
「同一アプリへの複数レコード一括処理」もbulkRequestで実行できると思います。
同一アプリの場合は、APIトークン認証での実行が可能です。
引き続きよろしくお願い致します。