カーソルからレコードを取得する
カーソルからレコードを取得します。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/records/cursor.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/records/cursor.json
HTTP メソッド
GET
必要なアクセス権
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
リクエスト
パラメーター
パラメーター名 |
型 |
必須 |
説明 |
id |
文字列 |
必須 |
カーソル ID |
リクエストの例(URLにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/records/cursor.json?id=9a9716fe-1394-4677-a1c7-2199a5d28215
ヘッダー
1
2
3
|
{
"X-Cybozu-API-Token": "API_TOKEN"
}
|
リクエストヘッダーの詳細は
kintone REST API の共通仕様 を参照してください。
リクエストの例(リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/records/cursor.json
ヘッダー
1
2
3
4
|
{
"X-Cybozu-API-Token": "API_TOKEN",
"Content-Type": "application/json"
}
|
リクエストヘッダーの詳細は
kintone REST API の共通仕様 を参照してください。
ボディ
1
2
3
|
{
"id": "9a9716fe-1394-4677-a1c7-2199a5d28215"
}
|
レスポンス
プロパティ
プロパティ名 |
型 |
説明 |
records |
配列 |
レコードの一覧 フィールドの形式は
フィールド形式 を参照してください。 |
next |
真偽値 |
次のレコードがあるかどうかtrue :レコードがあるfalse :レコードがない
|
レスポンスの例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
{
"records": [
{
"レコード番号": {
"type": "RECORD_NUMBER",
"value": "1"
},
"作成者": {
"type": "CREATOR",
"value": {
"code": "Administrator",
"name": "Administrator"
}
},
"作成日時": {
"type": "CREATED_TIME",
"value": "2019-05-23T04:50:00Z"
}
}
],
"next": false
}
|
サンプルコード
curl を使ったリクエスト
1
2
3
4
5
6
|
curl -X GET 'https://sample.cybozu.com/k/v1/records/cursor.json' \
-H 'X-Cybozu-API-Token: API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"id": "9a9716fe-1394-4677-a1c7-2199a5d28215"
}'
|
1
2
3
4
5
|
const body = {
id: '9a9716fe-1394-4677-a1c7-2199a5d28215'
};
await kintone.api(kintone.api.url('/k/v1/records/cursor.json', true), 'GET', body);
|
制限事項
- カーソルから取得できるレコードは、カーソルを作成した時点で取得対象だったレコードです。
ただし、フィールドの値は、この API を実行した時点での値が返ります。
- カーソルを作成した後にアクセス権の設定が変更された場合、変更後の設定では絞り込み条件を満たさないはずのレコードを取得する場合があります。
ただし、閲覧権限がないフィールドの値は取得できません。
- カーソルを作成した後に API を実行するユーザーの言語設定を変更すると、多言語化されたフィールドが影響を受けます。
- カーソルから取得できるすべてのレコードを取得すると、そのカーソルは自動的に削除されます。
- レスポンスで
next
が true
になった場合でも、次のリクエストで records が空になることがあります。