Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

特定のカラムのメタデータの取得

説明

このAPIを使用すると、Data Store内のテーブルの特定のカラムのメタデータを取得できます。テーブルは一意のIDまたは名前で参照され、カラムはカラムIDで参照されます。

リクエスト詳細

リクエストURL

GET

{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/column/{column_id}

copy

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

project_id
Numerical
プロジェクトの一意のID

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

column_id
Numerical
カラムの一意のID

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}

任意のヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.tables.columns.READ

レスポンス詳細

レスポンスには、column_id、column_name、data_typeなどの特定のカラムのメタデータが返されます。

リクエスト例
copy

curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/column/4000000042018
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”

レスポンス例
copy
{
    "status": "success",
    "data": {
        "table_id": 56000000118,
        "column_sequence": 3,
        "column_id": 4000000042018,
        "column_name": "Department",
        "category": 2,
        "data_type": "text",
        "is_read_only": false,
        "max_length": 100,
        "is_mandatory": true,
        "default_value": "Admin",
        "is_unique": false,
        "search_index_enabled": false
    }
}