Zoho crm Logo

使用外部ID获取相关记录

目的

使用外部ID获取相关的列表记录。

请求详情

Request URL

{api-domain}/crm/{version}/{module_api_name}/{external_value}/{related_list_api_name}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

X-EXTERNAL: {module_API_name}.{external_field_API_name}

范围

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称

潜在客户,交易,联系人,账户,产品,活动,预约,服务和价格手册

可能的操作类型

ALL - 完全访问相关记录
WRITE - 编辑相关记录
GET - 从模块中获取相关记录

参数

  • fields string, mandatory

    指定您希望在响应中接收其详细信息的字段的API名称。

  • page integer, optional

    获取相应页面的记录列表。页码的默认值为 1。
    可能的值: 只能是正整数。

  • per_page integer,optional

    获取每页可用记录的列表。默认值和可能的最大值是200。
    可能的值:仅正整数值。

端点

  • GET /{module_API_name}/{external_value}/{related_list_API_name}
在联系人模块中获取所有相关交易
  • 在这个例子中,extcontact3是联系人模块中外部字段External_Contact_ID的值。我们将引用这个字段的值来获取与这个联系人相关的交易。

样本请求

样本回应

通过相关记录的外部字段的值获取相关记录
  • 在这个例子中,externaldeal3是Deals模块中External_Deal_ID外部字段的值。我们将引用这个值从其外部值为extcontact3的联系人中获取这个相关的交易。

可能的错误

  • NO_CONTENTHTTP 204

    在请求URL中,您给出的值没有记录。
    解决方案:在请求URL中指定正确的外部字段值。

  • INVALID_DATAHTTP 400

    您为基础模块指定了无效的外部ID。
    解决方案: 输入正确的外部ID。

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少预期的参数之一。
    解决方案:在请求URL中指定fields参数。

  • INVALID_REQUEST_METHODHTTP 400

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

  • AUTHORIZATION_FAILEDHTTP 400

    您没有足够的权限获取相关记录。
    解决方案:联系您的系统管理员。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用来进行此API调用的访问令牌没有所需的范围。
    解决方案:生成一个新的访问令牌,其范围在范围部分中有所提及。

  • NO_PERMISSIONHTTP 403

    您没有权限获取相关记录的数据。
    解决方案:联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

样本请求

样本回应