Zoho crm Logo

获取全球选项列表

全局集或全局下拉列表用于管理跨模块的常见下拉列表值。请参阅全局集概述以了解更多关于全局下拉列表的信息。

目的

检索在您的Zoho CRM账户中配置的全局选项列表的详细信息。

端点

  • GET /settings/global_picklists
  • GET /settings/global_picklists/{global_picklist_ID}

Request 详情

Request URLs

检索所有全局选项列表:

{api-domain}/crm/{version}/settings/global_picklists

检索特定的全局选项列表:

{api-domain}/crm/{version}/settings/global_picklists/{global_pick_list_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.global_picklist.READ 
(or)
ZohoCRM.settings.global_picklist.ALL

支持的模块

潜在客户,联系人,账户,活动,案例,发票,交易,价格书,产品,采购订单,报价,销售订单,解决方案,供应商,电话,任务,事件,用户,交易历史,报价项目,订购项目,采购项目,开票项目,访问,服务,预约,以及自定义模块。

参数

  • include字符串,可选

    用于检索与全局选项列表关联的模块列表。 
    可能的值: 

    • used_in_modules - 检索全局选项列表使用的模块的详细信息。
    • pick_list_values - 检索全局选项列表的所有选项的详细信息。在执行批量检索时,使用此值检索全局选项列表中的所有可用选项。
    • associated_fields_count -  表示全局选项列表关联的字段数量。
  • include_inner_details字符串,可选

    用于检索有关与全局选项列表关联的模块的额外详细信息。 

    可能的值: 

    • used_in_modules.plural_label - 用于获取模块名称的复数标签。

获取批量全球选项列表的样本请求

可能的错误

  • NO_CONTENTHTTP 204

    您在RequestURL中传递的全局集ID无效,或者您的帐户中没有配置全局集。

    解决方案:检查您的帐户中是否配置了全局选项列表。如果是,请指定有效的选项列表ID。参考Request URL部分以获取所有可用全局集字段的ID。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP的请求方法类型无效
    解决方案:您指定了无效的HTTP方法来访问API URL。
    指定一个有效的请求方法。请参考端点部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有有效的范围来创建全局选项列表。创建一个带有所需范围的有效令牌。请参考范围部分。

  • AUTHENTICATION_FAILUREHTTP 401

    身份验证失败
    解决方案:在API调用的请求头中传递访问令牌。

  • INVALID_URL_PATTERNHTTP 404

    请检查试图访问的URL是否正确
    解决方案:指定的RequestURL不正确。请指定一个有效的RequestURL。请参考RequestURL 部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现意外且未处理的异常。请联系支持团队。

示例回应

获取单个全局选项列表的样本请求

示例回应