kintone API ドキュメント

1 件のレコードを登録する

目次

1 件のレコードを登録する

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

1 件のレコードを登録します。

URL

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

通常のアプリ
https://sample.cybozu.com/k/v1/record.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/record.json

HTTP メソッド

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

POST

必要なアクセス権

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

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

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

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

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
record オブジェクト 省略可 レコードの情報（フィールドコードとフィールドの値）
フィールドの種類によって、指定できる値が異なります。
詳細は フィールド形式 を確認してください。
省略すると、すべてのフィールドの値は初期値で登録されます。
存在しないフィールドコードを指定した場合、そのフィールドは無視されてレコードが登録されます。
リクエストの例
ヘッダー
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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{
  "app": 1,
  "record": {
    "文字列1行": {
      "value": "テスト"
    },
    "文字列複数行": {
      "value": "テスト\nテスト2"
    },
    "数値": {
      "value": "20"
    },
    "日時": {
      "value": "2014-02-16T08:57:00Z"
    },
    "チェックボックス": {
      "value": ["sample1", "sample2"]
    },
    "ユーザー選択": {
      "value": [
        {
          "code": "sato"
        }
      ]
    },
    "ドロップダウン": {
      "value": "sample1"
    },
    "リンク_ウェブ": {
      "value": "https://www.cybozu.com"
    },
    "テーブル": {
      "value": [
        {
          "value": {
            "テーブル文字列": {
              "value": "テスト"
            }
          }
        }
      ]
    }
  }
}

レスポンス

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

プロパティ
プロパティ名 型 説明
id 文字列 登録したレコードのレコード ID
revision 文字列 登録したレコードのリビジョン番号
レスポンスの例
1
2
3
4

{
  "id": "100",
  "revision": "1"
}

サンプルコード

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

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

curl -X POST 'https://sample.cybozu.com/k/v1/record.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "record": {
      "文字列1行": {
        "value": "ABC"
      }
    }
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

const body = {
  app: kintone.app.getId(),
  record: {
    文字列1行: {
      value: 'ABC'
    }
  }
};

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