カーソルからレコードを取得します。

通常のアプリ

https://sample.cybozu.com/k/v1/records/cursor.json

ゲストスペースのアプリ

https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/records/cursor.json

GET

• アプリのレコード閲覧権限
• 値を取得するレコードの閲覧権限
• 値を取得するフィールドの閲覧権限

パラメーター

リクエストの例（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"
}

プロパティ

レスポンスの例

 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を使ったリクエスト

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

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"
  }'

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

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

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トークン認証：「Administrator」の表示言語
  • それ以外の認証方式：APIを実行したユーザーの表示言語

  言語設定が「Webブラウザーの設定に従う」の場合、リクエストヘッダーの「Accept-Language」の有無によって、取得する言語が変わります。
  リクエストヘッダー

  • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
  • ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語
    ロケールの設定

• カーソルから取得できるレコードは、カーソルを作成した時点で取得対象だったレコードです。
  ただし、フィールドの値は、このAPIを実行した時点での値が返ります。
• カーソルを作成した後にアクセス権の設定が変更された場合、変更後の設定では絞り込み条件を満たさないはずのレコードを取得する場合があります。
  ただし、閲覧権限がないフィールドの値は取得できません。
• カーソルを作成した後にAPIを実行するユーザーの言語設定を変更すると、多言語化されたフィールドが影響を受けます。
• カーソルから取得できるすべてのレコードを取得すると、そのカーソルは自動的に削除されます。
• レスポンスでnextがtrueになった場合でも、次のリクエストのrecordsが空で返されることがあります。