Zoho crm Logo

获取记录的相关记录数量

目的

获取模块中记录的相关记录的计数。

端点

  • POST /{module_API_name}/{record_ID}/actions/get_related_records_count

请求详情

Request URL

{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/get_related_records_count

头部

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.modules.ALL
(or)
ZohoCRM.{module_name}.{operation_type}

可能的模块名称

潜在客户,账户,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,自定义,预约,预约重新安排历史,和服务

可能的操作类型

ALL - 对记录的完全访问
READ - 获取记录数据

注意

  • 您可以获取系统定义的相关列表(如调查、桌面、项目、访问、费用、发票和订阅)的数量,通过查找、多选查找、多模块查找字段创建的自定义相关列表,以及在下拉列表中启用历史跟踪时创建的相关列表。

样本请求

Input JSON

  • related_listJSON 对象,必填

    包含以下键:

    • id字符串,如果不包含 "api_name" 则必填

      您想获取其记录数量的相关列表的 ID。例如,如果您想获取 Leads 模块中特定记录的注释数量,您必须为此键提供 Notes 相关列表的 ID。使用 获取相关记录 API 来获取键 id 中的相关列表的 ID。

    • api_name字符串,如果不包含 "id" 则必填

      您想获取其记录数量的相关列表的 API 名称。例如,如果您想获取 Leads 模块中特定记录的附件数量,您必须为此键提供 Attachments 相关列表的 ID。使用 获取相关记录 API 来获取键 api_name 中的相关列表的 API 名称。

注意

您可以在输入中指定多达20个JSON对象。也就是说,您可以获取多达20个相关列表记录的计数。

样本输入

Response JSON 键
  • count integer

    与请求中指定的记录相关联的相关记录的数量。

  • related_listJSON 对象

    包含以下键:

    • id string

      您获取的相关列表的记录计数的ID。

    • api_name string

      您获取的相关列表的记录计数的API名称。

可能的错误

  • INVALID_DATAHTTP 400

    请求URL中的记录ID无效,或者您没有查看记录的权限。
    解决方案:指定一个有效的记录ID。使用获取记录API获取记录ID。对于权限问题,请联系您的系统管理员

  • INVALID_DATAHTTP 400

    请求体中的相关列表的ID或API名称无效。
    解决方案:在"related_list" JSON对象中指定一个有效的ID和API名称。使用获取相关记录API获取相关列表的ID和API名称。

  • MANDATORY_NOT_FOUNDHTTP 400

    您没有在请求体中包含 "related_list" JSON 对象。
    解决方案:请参考 输入 JSON 部分,了解输入中的必填和可选键。

  • INVALID_MODULEHTTP 400

    请求URL中的模块API名称无效。
    解决方案:指定一个有效的模块API名称。使用获取模块元数据API来获取模块API名称。

  • EXPECTED_FIELD_MISSINGHTTP 400

    您在请求体中没有指定相关列表的“id”或“api_name”。
    解决方案:您必须在输入中包含相关列表的“id”或“api_name”。请参阅示例输入部分以获取详细信息。

  • AMBIGUITY_DURING_PROCESSINGHTTP 400

    相关列表的ID和API名称不匹配。 
    解决方案:确保指定正确的API名称和相关列表的ID。使用获取相关记录API获取相关列表的ID和API名称。

  • AUTHORIZATION_FAILEDHTTP 400

    您没有足够的权限来读取模块记录。
    解决方案:联系您的系统管理员。

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方案: 使用 HTTP POST 方法来进行此API调用。任何其他请求方法都会导致此错误。

  • AUTHENTICATION_FAILUREHTTP 401

    您没有使用有效的访问令牌验证API调用。
    解决方案:在请求头中包含有效的访问令牌以验证API调用。

  • INVALID_TOKENHTTP 401

    您的访问令牌已过期。
    解决方案:生成具有所需范围的新访问令牌,并进行此API调用。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用来进行此API调用的访问令牌没有所需的范围。
    解决方案:生成一个新的访问令牌,其中包含在ZohoCRM.modules.{module_name}.{operation_type}中提到的范围。请参阅范围部分以获取详细信息。

  • NO_PERMISSIONHTTP 403

    您没有权限从模块中读取记录。
    解决方案:联系您的系统管理员。

  • NOT_ALLOWEDHTTP 403

    您没有权限从模块中读取相关记录。
    解决方案:联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    Request URL不正确。
    解决方案:指定一个有效的Request URL。请参考Request URL部分以获取正确的URL。

  • INTERNAL_ERRORHTTP 500

    服务器中出现意外且未处理的异常。 
    解决方案:联系support@zohocrm.com的支持团队。

样本回应