レコードを取得する
レコードIDを指定して1件のレコード内容を取得します。
| HTTPメソッド | GET |
|---|---|
| URL | https://sample.cybozu.com/k/v1/record.json |
| URL(ゲストスペース) | https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/record.json |
| 認証 | パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証 |
| Content-Type | application/json(URLにパラメーターを含める場合は不要) |
リクエストパラメーター
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| app | 数値または文字列 | 必須 | アプリID |
| id | 数値または文字列 | 必須 | レコードID |
レスポンスプロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| record | オブジェクト | 取得したレコードの情報 フィールドの形式は次のページを参照してください。 フィールド形式 |
必要なアクセス権
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
サンプル
|
|
|
|
リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様
|
|
|
|
リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様
|
|
kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する
|
|
ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行
|
|
補足
-
複数のレコードを取得する場合は次のAPIを参照してください。
レコードを複数取得する -
レコードのデータの言語は認証方式によって決まります。
- APIトークン認証:「Administrator」の表示言語
- それ以外の認証方式:APIを実行したユーザーの表示言語
言語設定が「Webブラウザーの設定に従う」の場合、リクエストヘッダーの「Accept-Language」の有無によって、取得する言語が変わります。
リクエストヘッダー- ヘッダーあり:「Accept-Language」ヘッダーで指定した言語
- ヘッダーなし:cybozu.com共通管理のロケールの設定で設定した言語
ロケールの設定
-
「GET」リクエストの使い方の中、最も一般的な方法は「URLにパラメーターを含める」です。
その他のリクエストの方法や、詳細は次のページを参考にしてください。
REST APIでGETを使う3つの方法とその使い分けについて
