Zoho crm Logo

获取映射依赖字段

映射依赖字段

在一个模块中,有些字段的值取决于另一个字段的值。这可以被定义为父子关系。例如,假设在您的潜在客户模块中有两个字段 - 国家和州。州字段的值将取决于您从国家字段中选择的国家。在Zoho CRM中,您可以定义基于父字段值的适用于子字段的值。这被称为映射依赖字段。

注意

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

目的

获取模块配置的父字段和子字段的详细信息。

端点

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

Request 详细信息

Request URL

获取特定映射依赖性详细信息:
{api-domain}/crm/{version}/settings/layouts/{layout_ID}/map_dependency/{map_dependency_ID}

获取所有映射依赖性详细信息:
{api-domain}/crm/{version}/settings/layouts/{layout_ID}/map_dependency 

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

参数

  • 模块字符串,必填

    您想要从中获取映射依赖字段的模块的API名称。使用GET - 模块元数据API检索模块API名称。

样本请求

Response JSON 

  • parentJSON 对象

    在该模块中映射为父级的字段的API名称和ID。

  • sub_moduleJSON object

    该字段的API名称和ID被映射为模块子表单中的父项。对于非子表单,此值为null。只有在获取模块中的所有映射依赖项时,此键才存在。

  • activeboolean

    表示地图依赖是否处于活动状态。

  • 源整数

    表示依赖项从何处映射的。默认值1表示依赖项是在CRM UI中映射的。

  • 类别整数

    表示字段是管道还是地图依赖项。0代表地图依赖项,而1代表管道。

  • pick_list_valuesJSON array

    为您提供父字段和映射子字段的详细信息。只有在获取特定映射依赖项详细信息时,此键才在响应中可用。

  • 子项JSON 对象

    映射为该模块中子项的字段的API名称和ID。

可能的错误

  • REQUIRED_PARAM_MISSINGHTTP 400

    您没有在请求URL中指定模块参数。
    解决方案:必须提供模块名称才能从该模块获取映射依赖字段。

  • INVALID_MODULEHTTP 400

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

  • INVALID_DATAHTTP 400

    原因:

    • 布局的ID无效。
    • 布局已被停用。
    • 在"filters"参数中,子表单的API名称,其字段,或字段的值无效。

    解决方案:请参考响应中的"details"键以获取确切的错误并相应地进行纠正。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:您没有ZohoCRM.settings.map_dependency.READ范围。创建具有有效范围的新令牌。请参阅上面的范围部分。

  • INVALID_URL_PATTERNHTTP 404

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

样本回应