テーブル内の全行の取得

説明

このAPIを使用すると、Data Store内の特定のテーブルからすべての行を取得できます。テーブルはIDまたは名前で参照できます。このAPIは、すべての行を取得するためにページネーションを組み込んでいます。ページネーションを使用すると、APIコールの反復を通じてレコードをページ単位で取得できます。

例えば、100件ずつのバッチで個別のページとして行を取得する場合、リクエストにmax_rowsパラメーターを含め、各ページで取得する最大行数を100と指定する必要があります。

さらに、各APIレスポンスには、次の行セットを取得するための次のAPIコールで渡すことができるトークンが含まれます。このトークンは、後続のデータ取得を認可します。前回のAPIコールのレスポンスで取得したトークン文字列を、リクエストのnext_tokenパラメーターで渡す必要があります。最初のAPIコールではnext_tokenパラメーターを渡す必要はありません。このようにして各反復でAPIコールを実行し、すべての行をページ単位で取得できます。

リクエスト詳細

リクエストURL

GET

{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row?next_token={token_string}&max_rows={number_of_rows}

copy

api-domain

URL

Catalyst APIにアクセスするためのDC固有のドメイン

project_id

Numerical

プロジェクトの一意のID

tableIdentifier

Numerical

テーブルの一意のIDまたはテーブル名

next_token

Numerical

（最初のAPIコールでは不要）ページネーションで次の行セットを取得するために渡す、前回のAPIコールから取得したトークン値

max_rows

Numerical

（任意）ページネーションで1ページに返される最大行数。この値が指定されない場合、APIはデフォルトで1ページあたり200行を返します。

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}

任意のヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.tables.rows.READ

注意: この操作は、Catalyst SDKを使用してCatalystユーザー認証権限でも実行できます。詳細については、Catalyst API前提条件セクションを参照してください。

レスポンス詳細

レスポンスには、指定したmax_rows値に基づいてページ単位でAPIコールを通じて取得された行が返されます。リクエストされた件数やmax_rowsの件数を超える行がある場合、次の行セットを取得するために渡す必要があるトークンがnext_tokenとしてレスポンスに含まれます。取得するレコードがこれ以上ない場合、レスポンスにトークンは含まれません。

リクエスト例
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/CustomerDetails/row?max_rows=4&next_token=*************  

-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”

レスポンス例（さらにレコードがある場合）
copy
{
    "status": "success",
    "data": [
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:16:41",
            "Department_ID": "IT148",
            "Department_Name": "Admin",
            "Employee_Name": "Eric Hyde",
            "CREATEDTIME": "2019-03-06 10:16:41",
            "ROWID": 56000000342025,
            "doubleDataType": null
        },
        {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:18:56",
            "Department_ID": "IT170",
            "Department_Name": "Sales",
            "Employee_Name": "Steven Kelso",
            "CREATEDTIME": "2019-03-06 10:18:56",
            "ROWID": 56000000342026,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:19:00",
            "Department_ID": "IT190",
            "Department_Name": "Marketing",
            "Employee_Name": "Micheal Forman",
            "CREATEDTIME": "2019-03-06 10:18:58",
            "ROWID": 56000000342027,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:45:11",
            "Department_ID": "IT111",
            "Department_Name": "Support",
            "Employee_Name": "Madeline Burkhart",
            "CREATEDTIME": "2019-03-06 10:18:34",
            "ROWID": 56000000342028,
            "doubleDataType": null
        },
    ],
"more_records" : true,
"next_token" : "{{token}}"
}

View more

レスポンス例（レコードがこれ以上ない場合）
copy
{
    "status": "success",
    "data": [
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:16:41",
            "Department_ID": "IT148",
            "Department_Name": "Admin",
            "Employee_Name": "Eric Hyde",
            "CREATEDTIME": "2019-03-06 10:16:41",
            "ROWID": 56000000342025,
            "doubleDataType": null
        },
        {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:18:56",
            "Department_ID": "IT170",
            "Department_Name": "Sales",
            "Employee_Name": "Steven Kelso",
            "CREATEDTIME": "2019-03-06 10:18:56",
            "ROWID": 56000000342026,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:19:00",
            "Department_ID": "IT190",
            "Department_Name": "Marketing",
            "Employee_Name": "Micheal Forman",
            "CREATEDTIME": "2019-03-06 10:18:58",
            "ROWID": 56000000342027,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:45:11",
            "Department_ID": "IT111",
            "Department_Name": "Support",
            "Employee_Name": "Madeline Burkhart",
            "CREATEDTIME": "2019-03-06 10:18:34",
            "ROWID": 56000000342028,
            "doubleDataType": null
        },
    ],
"more_records" : false
}

View more

Get Rows- Java SDK

Get Rows- Node.js SDK

Get Rows- Python SDK

Get Rows- Web SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit