複数アプリへのレコード一括処理をする
複数のアプリに対して、同時に複数の API を実行します。
- この API では、次の API を実行できます。
- 最大で 20 件のリクエストを同時に処理できます。
- いずれかの API で処理が失敗した場合、それ以降の API は実行されず、すべての処理がロールバックされます。
- API トークン認証を使って複数アプリを操作する場合は、それぞれのアプリで発行した API トークンを指定してください。
複数の API トークンを指定する方法は、 APIトークン認証 を参照してください。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/bulkRequest.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/bulkRequest.json同じゲストスペース内のアプリに対してのみ、一括処理できます。
そのため、次の処理は実行できません。- ゲストスペース内のアプリと、別のゲストスペース内のアプリを一括で更新する。
- ゲストスペース内のアプリと、スペース内のアプリを一括で更新する。
- ゲストスペース内のアプリと、通常のアプリを一括で更新する。
HTTPメソッド
POST
必要なアクセス権
- 実行する API の必要なアクセス権
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
requests | 配列 | 必須 | 実行する API の一覧 最大で 20 件のリクエストを指定できます。 |
requests[].method | 文字列 | 必須 | 実行する API の HTTP メソッド |
requests[].api | 文字列 | 必須 | 実行する API の URL |
requests[].payload | オブジェクト | 必須 | 実行する API に渡すリクエストボディ |
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
results | 配列 | 各 API リクエストに対するレスポンス 要素の並び順は、リクエストパラメーターの requests 配列の並び順と同じです。いずれかの API で処理が失敗すると、失敗した API に対応する要素には、エラーの結果が入ります。 それ以外の要素には {} (空のオブジェクト)が入ります。 |
レスポンスの例
成功したとき
|
|
失敗したとき
リクエストの例における 2 つ目の PUT リクエストで、更新する id がない場合にエラーとなる例です。
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|