映射依赖性
目的
在Zoho CRM的模块布局中映射依赖字段。
注意
- 一个父级可以有多个子字段,但一个子级只能有一个父级。
- 映射依赖性是特定于布局的。
端点
- POST /settings/layouts/{layout_ID}/map_dependency?module={module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/layouts/{layout_ID}/map_dependency
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.map_dependency.CREATE
或
ZohoCRM.settings.map_dependency.ALL
参数
- module string,mandatory
您想要映射依赖字段的模块的API名称。支持的模块有潜在客户,Account,联系人,交易,活动,任务,案例,会议,电话,解决方案,产品,Vendors,价格书,报价,Sales Orders,采购 Orders,Invoices,服务,预约和自定义模块。使用GET - 模块元数据API检索模块API名称。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/layouts/3652397000000091055/map_dependency?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST在这个例子中,“Lead_Status”是父字段,“Lead_Source”是子字段。根据Lead Status的值,Lead Source的值将根据您在输入中提供的映射进行填充。
输入 JSON
在这个例子中,“Lead_Status”是父字段,“Lead_Source”是子字段。根据Lead Status的值,Lead Source的值将根据您在输入中提供的映射进行填充。
- parentJSON object,必填
您希望在该模块中映射为父级的字段的 API 名称和 ID。依赖字段中的值将根据此字段的值而变化。使用 布局元数据 API 获取模块中选项列表字段的 API 名称和 ID。
- childJSON object,必填
您想要与父字段映射的字段的 API 名称和 ID。此选择列表中的值将根据父字段中的值而变化。使用 布局元数据 API 获取模块中选择列表字段的 API 名称和 ID。
- pick_list_valuesJSON array,必填
此数组中的每个 JSON 对象对应父字段中的一个特定选项值,并包含以下键:
- display_value - 字符串,可选 - 父字段选项值的显示名称。
- actual_value - 字符串,可选 - 父字段选项值的实际名称。
- id - 字符串,必填 - 父字段选项值的唯一ID。
- maps - JSON 数组,必填 - 应与父字段映射的子字段选项值的 display_value、actual_value 和 id。
示例输入
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"
}
],
"actual_value": "Contacted",
"id": "3652397000000003399"
}
],
"child": {
"api_name": "Lead_Source",
"id": "3652397000000002609"
}
}
]
}可能的错误
- REQUIRED_PARAM_MISSINGHTTP 400
您没有在请求URL中指定模块参数。
解决方案:模块名称是映射该模块的依赖字段所必需的。 - INVALID_MODULEHTTP 400
模块名称无效或API不支持该模块。
解决方法:您必须使用正确的模块API名称。 - INVALID_DATAHTTP 400
原因:
- 布局的ID无效。
- 布局已被停用。
- 父字段和子字段是相同的字段。
- 父字段、子字段或选项值的ID无效。
- 子字段、父字段或选项值的API名称无效。
- 您尝试为多个选项/父字段映射依赖关系,即根键 "map_dependency" 有多个JSON对象。
解决方案:请参阅响应中的 "details" 键以获取确切错误并相应地进行修正。请注意,每次API调用只能为一个父选项字段映射依赖字段。
- MAPPING_EXISTSHTTP 400
给定的父字段和子字段已经在此布局中创建的另一个映射依赖关系中关联。
解决方案:为其他字段创建映射依赖关系。 - NOT_ALLOWEDHTTP 400
原因:
- 父字段和子字段的映射创建了一个循环,即父字段的值作为子字段中的依赖值。
- 父字段或子字段在布局的未使用部分中。
- 沙盒未刷新。
- 父字段或子字段与布局规则相关联。
解决方法:请参阅响应中的 "details" 键以获取确切错误并相应地进行修正。
- MANDATORY_NOT_FOUNDHTTP 400
您未在输入中指定maps键或picklist_values键。
解决方案:请参阅响应中的“details”键以了解缺少的内容,并将其包含在输入中。 - AMBIGUITY_DURING_PROCESSINGHTTP 400
API 名称和 ID 不属于同一个父级或子级。
解决方法:指定正确的父级和子级字段的 API 名称和 ID。详情请参阅 字段元数据 API。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方法: 您没有ZohoCRM.settings.map_dependency.CREATE权限。请创建具有有效权限的新令牌。请参阅上面的权限部分。
示例响应
Copied{
"map_dependency": [
{
"code": "SUCCESS",
"details": {
"id": "3652397000009835011"
},
"message": "map dependency created",
"status": "success"
}
]
}