Zoho crm Logo

全局选择列表字段关联

目的

要检索与全局选择列表关联的字段、模块和布局的信息。

端点

  • GET /settings/global_picklists/{global_picklist_id}/actions/associations

请求详情

请求 URL

{api-domain}/crm/{version}/settings/global_picklists/{global_picklist_ID}/actions/associations

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

支持的模块

潜在客户、联系人、Account、活动、案例、Invoices、交易、价格表、产品、Purchase Orders、报价、Sales Orders、解决方案、Vendors、电话、任务、事件、Users、交易历史、报价Items、Order项目、采购Items、Invoice项目、访问、服务、预约和自定义模块。

参数

  • Pageinteger,optional

    获取相应页面的记录列表。默认值:1
    可能的值:仅正整数值。

  • per_pageinteger,optional

    获取每页可用的记录列表。默认值和最大可能值为200。
    可能的值:仅正整数值。

  • include_inner_detailsstring, optional

    指定是否在 API 响应中包含额外的详细信息,例如布局状态和模块复数标签。可能的值有:

    • layout.statusstring, optional

      包含使用全局选项列表的布局状态。

    • module.plural_labelstring, optional

      包含使用全局选项列表的模块的复数标签。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/global_picklists/2423488000000492003/actions/associations"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

响应 JSON 

  • 字段JSON object

    它表示与请求的全局选项列表相关联的字段详细信息。

  • 模块JSON object

    它表示与之相关联的模块的详细信息。

  • 布局JSON object

    它表示使用全局选项列表的布局的详细信息。

可能的错误

  • INVALID_DATAHTTP 400

    给定的ID似乎无效

    解决方案: 指定一个有效的ID。  使用GET Global Picklist API来检索全局选项列表的唯一ID。

  • INVALID_REQUEST_METHODHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方法:客户端没有有效的范围来获取全局选项列表字段关联。请创建一个具有所需范围的有效令牌。请参阅范围部分。

  • Authentication_FAILUREHTTP 401

    Authentication 失败
    解决方法: 在API调用的请求头中传递访问令牌。

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

示例响应

Copied{
    "associations": [
        {
            "field": {
                "api_name": "Pick_List_1",
                "id": "2423488000000680001"
            },
            "module": {
                "plural_label": "Leads",
                "api_name": "Leads",
                "id": "2423488000000000125"
            },
            "layouts": [
                {
                    "name": "Standard",
                    "id": "2423488000000095055",
                    "status": "active"
                }
            ]
        },
        {
            "field": {
                "api_name": "Pick_List_1",
                "id": "2423488000000680069"
            },
            "module": {
                "plural_label": "Contacts",
                "api_name": "Contacts",
                "id": "2423488000000000129"
            },
            "layouts": [
                {
                    "name": "Standard",
                    "id": "2423488000000095059",
                    "status": "active"
                }
            ]
        }
    ],
.
.
.
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}