複数のレコードを登録する

固定リンクがコピーされました

複数のレコードを登録します。

HTTPメソッド	POST
URL	https://sample.cybozu.com/k/v1/records.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/records.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID
records	配列（オブジェクト）	必須	登録するレコードの一覧フィールドの種類によって、指定できる値が異なります。詳細は次のページを確認してください。フィールド形式空配列を指定した場合は、すべてのフィールドの値は初期値で登録されます。存在しないフィールドコードを指定した場合、そのフィールドは無視されてレコードが登録されます。

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
ids	配列（文字列）	登録したレコードのレコードID
revisions	配列（文字列）	登録したレコードのリビジョン番号

レコードIDの順序はリクエストに指定したレコードの順序と対応します。

必要なアクセス権

固定リンクがコピーされました

アプリのレコード追加権限
値を登録するフィールドの編集権限

次のフィールドに値を登録する場合、アプリ管理権限が必要です。

作成者
更新者
作成日時
更新日時

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストヘッダー

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "app": 1,
  "records": [
    {
      "文字列1行_0": {
        "value": "ABC"
      },
      "文字列1行_1": {
        "value": "ABC"
      }
    },
    {
      "文字列1行_0": {
        "value": "EFG"
      },
      "文字列1行_1": {
        "value": "EFG"
      }
    }
  ]
}

サンプルレスポンス

1
2
3
4


{
  "ids": ["100", "101"],
  "revisions": ["1", "1"]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


const body = {
  app: kintone.app.getId(),
  records: [
    {
      文字列1行_0: {
        value: 'ABC'
      },
      文字列1行_1: {
        value: 'ABC'
      }
    },
    {
      文字列1行_0: {
        value: 'EFG'
      },
      文字列1行_1: {
        value: 'EFG'
      }
    }
  ]
};

await kintone.api(kintone.api.url('/k/v1/records.json', true), 'POST', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


curl -X POST 'https://sample.cybozu.com/k/v1/records.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "records": [
      {
        "文字列1行_0": {
          "value": "ABC"
        },
        "文字列1行_1": {
          "value": "ABC"
        }
      },
      {
        "文字列1行_0": {
          "value": "EFG"
        },
        "文字列1行_1": {
          "value": "EFG"
        }
      }
    ]
  }'

補足

固定リンクがコピーされました

一度に登録できるレコードは100件までです。
必須項目が設定されている場合には、その値をリクエストに含めてください。
リクエストパラメーターのrecordsに指定した順番でレコードを登録します。
処理に失敗すると、リクエストに指定したレコードの登録はすべてキャンセルされます。

制限事項

固定リンクがコピーされました

次のフィールドは、値を登録できません。
- ルックアップ元からコピーされるフィールド
- ステータス
- カテゴリー
- 計算
- 作業者
- 自動計算が設定されている文字列1行フィールド

kintone API

kintone APIドキュメント

複数のレコードを登録する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足

制限事項