Ask me anything
How can I help you with Catalyst today?
Get the Metadata of a Specific Table
Description
This API enables you to retrieve the metadata of a specific table from the Data Store, by referring to the table’s unique ID or name.
Request Details
Request URL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}
Request Headers
Authorization: Zoho-oauthtoken {oauth_token}
Optional Headers
CATALYST-ORG: {org_id}
Environment: Development
Scope
ZohoCatalyst.tables.READ
Response Details
The response will return the metadata of the table which will include the table details such as the table_id and table_name, and the metadata of all the columns in it such as the column_id, column_name, and data_type of each column.
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"table_id": 56000000111778,
"project_id": {
"id": 4000000006007,
"project_name": "HRApp"
},
"table_name": "EmpDetails",
"modified_by": {
"is_confirmed":true,
"zuid": 1019540152,
"user_id": 671930455,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"modified_time": "2019-02-19T02:45:16+05:30",
"column_details": [
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091030,
"column_name": "ROWID",
"category": 1,
"data_type": "bigint",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": false
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091031,
"column_name": "CREATORID",
"category": 1,
"data_type": "bigint",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091032,
"column_name": "CREATEDTIME",
"category": 1,
"data_type": "datetime",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091033,
"column_name": "MODIFIEDTIME",
"category": 1,
"data_type": "datetime",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091034,
"column_name": "EmpID",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 6,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": true,
"search_index_enabled": true
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091035,
"column_name": "EmpName",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 30,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": false,
"search_index_enabled": false
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091036,
"column_name": "DeptName",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 30,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": false,
"search_index_enabled": false
}
],
"table_scope": "ORG"
}
}
Yes
No
Thank you for your feedback!
Send your feedback to us