自定义视图元数据
目的
要获取 Zoho CRM 中某个模块的自定义视图元数据。
端点
- GET /settings/custom_views?module={module_API_name}
- GET /settings/custom_views/{custom_view_ID}?module={module_API_name}
请求详细信息
请求 URL
要获取某个模块的所有自定义视图的元数据:
{api-domain}/crm/{version}/settings/custom_views?module={module_API_name}
要获取某个模块的特定自定义视图的元数据:
{api-domain}/crm/{version}/settings/custom_views/{custom_view_ID}?module={module_API_name}
支持的模块
线索, Account, 联系人, 商机, 营销活动, 任务, 客户服务单, 事件, 通话, 解决方案, 产品, Vendors, 价目表, 报价单, Sales Orders, 采购 Orders, Invoices, 预约, 服务, 任务, 通话, 会议, 以及自定义模块
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.custom_views.READ
(或)
ZohoCRM.settings.custom_views.ALL
(或)
ZohoCRM.settings.ALL
参数
- module字符串,必填
指定所需模块的 API 名称。例如,Leads、Contacts、Account、Deals 等。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/custom_views?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"响应 JSON
- display_valuestring
表示当前自定义视图的显示名称。
- created_timestring
表示自定义视图创建的日期和时间,采用 ISO 8601 格式。
- defaultBoolean
表示当前自定义视图是否为默认视图。
可能的取值:true: 当前自定义视图是默认视图。
false: 当前自定义视图不是默认视图。 - modified_timestring
表示自定义视图被修改的日期和时间。当自定义视图未被修改时,该键的值为 null。
- system_namestring
表示当前自定义视图的系统引用名称。
- system_definedBoolean
表示当前自定义视图是否为系统定义的视图。
true:当前自定义视图是系统定义的视图。
false:当前自定义视图不是系统定义的视图。 - namestring
表示当前自定义视图的名称。
- modified_byJSON object
表示修改该自定义视图的用户的姓名和 ID。当自定义视图未被修改时,此键的值为 null。
- idstring
表示当前自定义视图的唯一 ID。
- categorystring
Represents the category of the current custom view. The value can be: public_views, other_users_views, shared_with_me, or created_by_me.
- last_accessed_timestring
表示自定义视图上次被访问的日期和时间。此键的值在自定义视图被访问之前为 null。
- lockedBoolean
表示当前自定义视图是否被锁定以进行编辑。当自定义视图被锁定时,只有Admin和创建者可以修改它。
- 收藏整数
表示用户在该模块中对收藏的自定义视图的偏好排序。如果没有自定义视图被标记为收藏,则该值为 null。
- created_byJSON object
表示创建该自定义视图的用户的名称和 ID。对于系统定义的自定义视图,此键的值将为 null。
- infoJSON 对象
info JSON 对象包含以下详细信息。
- per_page: 表示在一次 API 调用中可获取的最大记录数。
- default: 表示默认自定义视图的 ID。
- count: 表示该模块中自定义视图记录的总数。
- page: 表示页码。
- more_records: 表示是否还有更多记录可获取。
可能的错误
- REQUIRED_PARAM_MISSINGHTTP 400
错误请求
解决方案:您尚未指定必需的 paRAMeter。请参阅上述 paRAMeters 部分。 - INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方案:您指定了无效的模块名称,或者没有选项卡权限,或者该模块已从可用模块中移除。请指定有效的模块 API 名称。 - INVALID_MODULEHTTP 400
给定的模块在 API 中不受支持
解决方案:当前 API 不支持诸如 Documents 和 Projects 等模块。(一旦这些模块得到支持,将不再显示此错误。)请指定有效的模块 API 名称。 - INVALID_REQUEST_METHODHTTP 400
HTTP 请求方法类型无效
解决方案:您为访问 API URL 指定了无效的 HTTP 方法。请指定有效的请求方法。请参阅上面的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限读取自定义视图数据
解决方案:该用户没有权限获取自定义视图数据。请联系系统管理员。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于发起此 API 调用的访问令牌不具备所需的作用域。
解决方案:为此 API 生成包含所需作用域的新访问令牌。有关所需作用域的列表,请参阅本页开头的作用域部分。 - NO_PERMISSIONHTTP 403
读取权限被拒绝
解决方法: 用户没有权限读取自定义视图数据。请联系系统管理员。 - 无效_URL_模式HTTP 404
请求 URL 不正确。
解决方法: 请指定有效的请求 URL。有关详细信息,请参阅本页开头的请求 URL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案: 服务器中出现了意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"custom_views": [
{
"display_value": "All Leads",
"created_time": null,
"system_name": "ALLVIEWS",
"created_by": null,
"default": false,
"modified_time": "2020-04-13T11:52:02+05:30",
"name": "All Open Leads",
"system_defined": true,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000000087501",
"category": "public_views",
"last_accessed_time": "2022-12-20T13:52:45+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Co-Owner Leads",
"created_time": null,
"system_name": "COOWNERVIEW",
"created_by": null,
"default": false,
"modified_time": "2019-05-09T11:39:20+05:30",
"name": "Co-Owner Leads",
"system_defined": true,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000281001"
},
"id": "3652397000000747007",
"category": "public_views",
"last_accessed_time": "2022-11-21T09:44:18+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Converted Leads",
"created_time": null,
"system_name": "CONVERTEDVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Converted Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000089005",
"category": "public_views",
"last_accessed_time": "2022-11-21T22:48:08+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Email Opt Out",
"created_time": "2019-02-14T17:32:37+05:30",
"system_name": null,
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"default": false,
"modified_time": "2019-02-19T12:03:07+05:30",
"name": "Email Opt Out",
"system_defined": false,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000000538003",
"category": "created_by_me",
"last_accessed_time": "2022-09-14T10:18:25+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Junk Leads",
"created_time": null,
"system_name": "JUNKLEADVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Junk Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000149020",
"category": "public_views",
"last_accessed_time": "2019-12-31T15:52:00+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Leads in Review",
"created_time": null,
"system_name": "REVIEWPROCESS LEADS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Leads in Review",
"system_defined": true,
"modified_by": null,
"id": "3652397000001424014",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Mailing Labels",
"created_time": null,
"system_name": "ALLVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Mailing Labels",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087503",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Leads Shared by Me",
"created_time": null,
"system_name": "LEADSSHAREDBYME",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Module Shared by Me",
"system_defined": true,
"modified_by": null,
"id": "3652397000001615027",
"category": "public_views",
"last_accessed_time": "2022-06-13T15:18:11+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Leads Shared to Me",
"created_time": null,
"system_name": "LEADSSHAREDTOME",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Module Shared to Me",
"system_defined": true,
"modified_by": null,
"id": "3652397000001615021",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "My Converted Leads",
"created_time": null,
"system_name": "MYCONVERTEDVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "My Converted Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000089007",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "My Leads",
"created_time": null,
"system_name": "MYVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "My Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087563",
"category": "public_views",
"last_accessed_time": "2021-02-16T14:45:44+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Not Qualified Leads",
"created_time": null,
"system_name": "NOTQUALIFIEDLEADVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Not Qualified Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000149031",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Open Leads",
"created_time": null,
"system_name": "OPENLEADVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Open Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000149042",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Recently Created Leads",
"created_time": null,
"system_name": "RECENTLYCREATED",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Recently Created Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087509",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Recently Modified Leads",
"created_time": null,
"system_name": "RECENTLYMODIFIED",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Recently Modified Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087511",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Today's Leads",
"created_time": null,
"system_name": "today",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Todays Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087507",
"category": "public_views",
"last_accessed_time": "2019-03-21T17:51:43+05:30",
"locked": false,
"favorite": null
},
{
"display_value": "Unread Leads",
"created_time": null,
"system_name": "UNREADVIEWS",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Unread Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087505",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
},
{
"display_value": "Unsubscribed Leads",
"created_time": null,
"system_name": "UNSUBSCRIBED",
"created_by": null,
"default": false,
"modified_time": null,
"name": "Unsubscribed Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000002569003",
"category": "public_views",
"last_accessed_time": null,
"locked": false,
"favorite": null
}
],
"info": {
"per_page": 22,
"default": "3652397000010185003",
"count": 22,
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
},
"page": 1,
"more_records": false
}
}