Zoho crm Logo

更新映射的依赖字段

目的

要在Zoho CRM模块的布局上更新地图依赖字段。

注意

  • 一个父字段可以有多个子字段,但一个子字段只能有一个父字段。
  • 映射依赖是特定于布局的。

端点

  • PUT /settings/layouts/{layout_ID}/map_dependency/{map_dependency_ID}?module={module_API_name}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/layouts/{layout_ID}/map_dependency/{map_dependency_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.map_dependency.UPDATE 
或 
ZohoCRM.settings.map_dependency.ALL

参数

  • module字符串,必填

    您想要更新映射依赖字段的模块的 API 名称。支持的模块有线索、Account、联系人、商机、市场活动、任务、工单、会议、电话、解决方案、产品、Vendors、价格表、报价、Sales Orders、采购Orders、Invoices、服务、预约及自定义模块。可通过 GET - 模块元数据 API 获取模块 API 名称。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/layouts/3652397000000091055/map_dependency/3652397000009835011?module=Leads"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

输入 JSON

在映射依赖关系时使用的所有键都可以通过此 API 进行更新。有关详细信息,请参阅 依赖关系映射 API 的“输入 JSON”部分。

若要删除子字段的选项列表值并撤销映射,请在相应选项列表值的 maps JSON 数组中指定键 "_delete":null。请参阅右侧示例。

示例输入

Copied{
    "map_dependency": [
        {
            "parent": {
                "api_name": "Lead_Status",
                "id": "3652397000000002611"
            },
            "pick_list_values": [
                {
                    "display_value": "-None-",
                    "maps": [
                        {
                            "display_value": "Cold Call",
                            "actual_value": "Cold Call",
                            "id": "3652397000000003389"
                        },
                        {
                            "display_value": "-None-",
                            "actual_value": "-None-",
                            "id": "3652397000000003391"
                            
                        }
                    ],
                    "actual_value": "-None-",
                    "id": "3652397000000003409"
                },
                {
                    "display_value": "Attempted to Contact",
                    "maps": [
                        {
                            "display_value": "Employee Referral",
                            "actual_value": "Employee Referral",
                            "id": "3652397000000003369"
                        },
                        {
                            "display_value": "Online Store",
                            "actual_value": "OnlineStore",
                            "id": "3652397000000003375"
                        }
                    ],
                    "actual_value": "Attempted to Contact",
                    "id": "3652397000000003405"
                },
                {
                    "display_value": "Contact in Future",
                    "maps": [
                        {
                            "display_value": "Facebook",
                            "actual_value": "Facebook",
                            "id": "3652397000000209013"
                        },
                        {
                            "display_value": "Twitter",
                            "actual_value": "Twitter",
                            "id": "3652397000000209017"
                        },
                        {
                            "display_value": "Google+",
                            "actual_value": "Google+",
                            "id": "3652397000000209021"
                        }
                    ],
                    "actual_value": "Contact in Future",
                    "id": "3652397000000003401"
                },
                {
                    "display_value": "Contacted",
                    "maps": [
                        {
                            "display_value": "Employee Referral",
                            "actual_value": "Employee Referral",
                            "id": "3652397000000003369"
                        },
                        {
                            "display_value": "External Referral",
                            "actual_value": "External Referral",
                            "id": "3652397000000003379"
                        },
                        {
                            "display_value": "ABC",
                            "actual_value": "ABC",
                            "id": "3652397000002244010",
                            "_delete":null
                        }
                    ],
                    "actual_value": "Contacted",
                    "id": "3652397000000003399"
                }
            ],
            "child": {
                "api_name": "Lead_Source",
                "id": "3652397000000002609"
            }
        }
    ]
}

可能的错误

  • REQUIRED_PARAM_MISSINGHTTP 400

    您未在请求URL中指定module参数。
    解决方法:模块名称是必填项,用于映射该模块的依赖字段。

  • INVALID_MODULE HTTP 400

    模块名称无效,或该模块在 API 中不受支持。
    解决方法:您必须使用正确的模块 API 名称。

  • INVALID_DATA HTTP 400

    原因:

    • 布局的ID无效。
    • 布局已被停用。
    • 父字段和子字段为同一字段。
    • 父字段、子字段或选项值的ID无效。
    • 子字段、父字段或选项值的API名称无效。
    • 您尝试为多个选项字段/父字段映射依赖关系,即根键 "map_dependency" 拥有多个JSON对象。

    解决方法:请参考响应中的 "details" 键获取具体错误信息,并进行相应修正。请注意,每次API调用只能为一个父选项字段映射依赖字段。

  • MAPPING_EXISTS HTTP 400

    所选父字段和子字段已经在此布局中由另一个映射依赖关联。
    解决方法:请为其他字段创建映射依赖。

  • NOT_ALLOWED HTTP 400

    原因:

    • 父字段和子字段的映射造成了循环,即父字段的值被用作子字段的依赖值。
    • 父字段或子字段位于布局的未使用部分。
    • 沙盒未刷新。
    • 父字段或子字段之一被关联到了布局规则中。
    • 您无法更新内部映射依赖。内部映射依赖指的是在审批流程、电话模块等中使用的字段及其依赖字段。

    解决方法:请查看响应中的 "details" 键获取具体错误信息,并据此进行修正。

  • MANDATORY_NOT_FOUND HTTP 400

    您未在输入中指定 maps 键或 picklist_values 键。
    解决方法: 请参阅响应中的 "details" 键,以了解缺少哪些内容,并将其包含在输入中。

  • AMBIGUITY_DURING_PROCESSING HTTP 400

    API 名称和 ID 不属于同一个父项或子项。
    解决方法:请指定正确的父字段和子字段的 API 名称和 ID。详情请参阅 字段元数据 API。

  • OAUTH_SCOPE_MISMATCH HTTP 401

    未授权
    解决方法:您没有 ZohoCRM.settings.map_dependency.CREATE 的权限范围。请使用有效的权限范围创建新的令牌。请参阅上面的权限范围部分。

  • INVALID_URL_PATTERN HTTP 404

    请检查要访问的URL是否正确
    解决方法:请求的URL不正确。请指定一个有效的请求URL。请参考上方的请求URL部分。

示例响应

Copied{
    "map_dependency": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000009835011"
            },
            "message": "map dependency updated",
            "status": "success"
        }
    ]
}