レコードの登録(POST)

フォローする

Index

レコードの登録(1件)

レコードの追加権限のあるユーザーが、1件のレコードを登録できます。

  • 必須項目が設定されている場合には、その値をリクエストに含めてください。

HTTP メソッド

POST

URI

https://(サブドメイン名).cybozu.com/k/v1/record.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/record.json 

アクセス権

  • APIの実行には、次の権限が必要です。
    • レコードの追加権限
    • 値を登録するフィールドの編集権限
  • 次のフィールドに値を登録する場合、APIの実行には、アプリの管理権限が必要です。
    • 作成者
    • 更新者
    • 作成日時
    • 更新日時

リクエストプロパティ

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須 アプリの ID を指定します。
record Object 省略可 レコードの情報(フィールドコードとフィールドの値)をオブジェクトで指定します。
  • フィールド値の仕様についてはフィールドの形式により異なります。 詳細については フィールド形式をご確認ください。
  • 省略した場合は、全フィールドの値が初期値で登録されます。
  • 存在しないフィールドコードを指定した場合、その部分は無視されます。
リクエストボディの構造

リクエストの例

リクエストヘッダ

POST /k/v1/record.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 が解釈できないため、実行時エラーとなります。

ボディ

アプリ番号「1972」のアプリに以下のレコード追加する場合

フィールドの形式 フィールドコード
文字列(1行) 文字列__1行 テスト
文字列(複数行) 文字列__複数行 テスト\nテスト2
数値 数値 20
日時 日時 2014-02-16T08:57:00Z
チェックボックス チェックボックス sample1、sample2
ユーザー選択 ユーザー選択 sato ※ログイン名を指定
ドロップダウン ドロップダウン Sample1
リンク リンク_ウェブ https://www.cybozu.com
テーブル Table  
テーブル内の 文字列1行 テーブル文字列 テスト

レスポンスの例

登録したレコードのレコードIDとリビジョンが返されます。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

レコードの一括登録

レコードの追加権限のあるユーザーが、複数のレコードを一括で登録できます。

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

HTTP メソッド

POST

URI

https://(サブドメイン名).cybozu.com/k/v1/records.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/records.json 

アクセス権

  • APIの実行には、次の権限が必要です。
    • レコードの追加権限
    • 値を登録するフィールドの編集権限
  • 次のフィールドに値を登録する場合、APIの実行には、アプリの管理権限が必要です。
    • 作成者
    • 更新者
    • 作成日時
    • 更新日時

リクエスト

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須 アプリのIDを指定します。
records 配列
(Object)
必須 登録するレコードの情報を指定します。 本パラメータの値には、recordオブジェクトの配列を記述します。
配列の中にレコードの情報(フィールドコードとフィールドの値)をオブジェクトで指定します。
  • フィールド値の仕様についてはフィールドの形式により異なります。 詳細については フィールド形式をご確認ください。
  • 省略した場合は、全フィールドの値が初期値で登録されます。
  • 存在しないフィールドコードを指定した場合、その部分は無視されます。
リクエストボディの構造(※n件のレコードを登録する場合)

リクエストの例

ボディ

アプリID「1972」のアプリに以下の2件のレコード追加する場合

1件目

フィールドの形式 フィールドコード
リッチエディタ rich_editor test1
ユーザー選択 user_select ログイン名:sato

2件目

フィールドの形式 フィールドコード
リッチエディタ rich_editor test2
ユーザー選択 user_select ログイン名:kato

レスポンスの例

登録したレコードのレコードIDとリビジョンが返されます。
レコードIDの順序はリクエストに指定したレコードの順序と対応します。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

制限事項

  • 次のフィールドは、値を登録できません。
    • ルックアップフィールドによって値が入力されるフィールド
    • ステータス
    • カテゴリー
    • 計算
    • 作業者

その他につきましては、制限事項 をご確認ください。

関連Tips

コメント

Avatar
Sugawara Genki

些細な指摘で恐縮ですが、サンプルのJSONがフォーマットエラーのようです

Avatar
cybozu Development team

Sugawara Genkiさん

cybozu.com developer network事務局です。
JSONフォーマットエラーになる箇所の修正を致しております。
ご確認ください。

Avatar
kunyanist

サンプルのJSONでCB_IJ01が返ってくる部分がありましたので報告します。

//エラー
"ユーザー選択": {
"value":
{
"code": "sato"
}
},

//成功
"ユーザー選択": {
"value":
[
{
"code": "sato"
}
]
},

Avatar
渡邊

ユーザー選択の箇所は陳腐化していて、
下記のリンクが正しいようなので、ご参考ください。

■フィールド形式 – cybozu.com developer network
https://cybozudev.zendesk.com/hc/ja/articles/202166330

ログインしてコメントを残してください。
Powered by Zendesk