Zoho crm Logo

选择列表值

注意

要更新选择列表选项,请使用PATCH - 自定义字段 API。

目的

要检索有关选择列表字段中值的详细信息,包括显示值、参考值、颜色代码、实际值、ID、类型和关联布局,在您的Zoho CRM帐户中的特定模块内。 

端点

  • GET /settings/fields/{picklist_field_ID}/pick_list_values?module={module_API_name}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/fields/{picklist_field_ID}/pick_list_values

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

参数

  • modulestring, mandatory

    指定选项列表字段所属的模块。

    支持的模块:潜在客户,Account,联系人,交易,活动,任务,案例,事件,通话,解决方案,产品,Vendors,价格书,报价单,Sales Orders,采购Orders,Invoices,自定义,预约和服务。

示例请求

Copied"https://www.zohoapis.com/crm/v8/settings/fields/2423488000000000573/pick_list_values?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

响应 JSON 

  • sequence_numberinteger

    表示选项列表值字段在布局中的位置。

  • display_valuestring

    表示选择列表选项的显示值。

  • reference_valuestring

    表示选项列表中选项的参考值。

  • colour_codestring

    表示用于选择列表选项的十六进制颜色代码。

  • actual_valuestring

    表示选项列表的实际值。

  • idinteger

    表示选项列表中选项的唯一ID。

  • typestring

    表示选项列表的类型。

    可能的值:

    • used
    • unused
  • layout_associationsstring

    表示与选择列表选项关联的布局详细信息。

    • api_namestring

      表示布局的 API 名称。

    • namestring

      表示布局的名称。

    • idinteger

      表示布局的唯一 ID。

可能的错误

  • INVALID_DATAHTTP 400

    给定的ID似乎无效 
    解决方案: 指定一个有效的选项列表字段ID。使用获取字段元数据API来检索选项列表字段ID。

  • INVALID_MODULEHTTP 400

    给定的模块似乎无效
    解决方法:指定一个有效的模块 API 名称。使用 GET Modules Metadata API 来检索模块 API 名称。
    支持的模块:Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Appointments, and Service.

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少必需的参数
    解决方案:为模块参数指定一个值。请参阅本页开头的参数部分。

  • INVALID_REQUEST_METHODHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有有效的范围来检索选项列表详情。创建一个具有有效范围的新令牌。请参阅范围部分。

  • Authentication_FAILUREHTTP 401

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

  • NO_PERMISSIONHTTP 403

    没有权限
    解决方法:用户没有权限查看选项列表关联。

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

示例响应

Copied{
    "pick_list_values": [
        {
            "sequence_number": 1,
            "display_value": "Referral",
            "reference_value": "Referral",
            "colour_code": null,
            "actual_value": "Referral",
            "id": "2423488000000002313",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 2,
            "display_value": "Advertisement",
            "reference_value": "Advertisement",
            "colour_code": null,
            "actual_value": "Advertisement",
            "id": "2423488000000002315",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                }
            ]
        },
        {
            "sequence_number": 3,
            "display_value": "Cold Call",
            "reference_value": "Cold Call",
            "colour_code": null,
            "actual_value": "Cold Call",
            "id": "2423488000000002317",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 4,
            "display_value": "Employee Referral",
            "reference_value": "Employee Referral",
            "colour_code": null,
            "actual_value": "Employee Referral",
            "id": "2423488000000002319",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 5,
            "display_value": "External Referral",
            "reference_value": "External Referral",
            "colour_code": null,
            "actual_value": "External Referral",
            "id": "2423488000000002321",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 6,
            "display_value": "Online Store",
            "reference_value": "Online Store",
            "colour_code": null,
            "actual_value": "OnlineStore",
            "id": "2423488000000172095",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        .
        .
        .
        
    ]
}