Zoho crm Logo

获取已删除记录的相关记录

此API检索通过查找关系创建的已删除记录相关的记录。当父记录未被永久删除,即,它仍在回收站中时,您可以使用此API。

目的

获取与Zoho CRM中已删除的主记录相关联的相关记录。

端点

  • GET /{module_API_name}/deleted/{deleted_record_ID}/{related_list_API_name}

Request 详情

Request URL

{api-domain}/crm/{version}/{module_API_name}/deleted/{deleted_record_ID}/{related_list_API_name}

支持的关系

支持查找字段及其关系。

在 相关列表元数据API的响应中,href属性为您提供了获取模块相关列表记录的端点。请注意,只有查找字段关系才支持此API。 

范围

ZohoCRM.modules.ALL
(或者)
ZohoCRM.modules.{module_api_name}.{operation_type}

可能的模块名称

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

可能的操作类型

阅读 - 阅读相关记录 
全部 - 对相关记录的完全访问

参数

  • 字段字符串,必填

    指定您想要检索其详细信息的字段的API名称。

  • 页面整数,可选

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

  • per_page整数,可选

    指定每页在响应中包含的记录数。默认值和可能的最大值是200。
    可能的值:仅正整数。

注意

  • page 和 per_page 参数用于根据它们在CRM中的位置获取记录。单个API调用中可以获取的记录最大数量为200。要检索更多记录,必须进行多次API调用。例如,如果你需要获取400条记录,你可以通过将请求分为两个API调用来实现。在第一次调用中,设置 page=1 和 per_page=200 来检索 前200条记录。在第二次调用中,设置 page=2 和 per_page=200 来获取剩余的 200条记录。
  • 你只能从未在回收站中的关联模块中检索记录,但父记录不能被永久删除。

样本请求

Response JSON

  • 所有者JSON 对象

    代表记录所有者的名称,ID和电子邮件。

  • Modified_Timestring

    表示相关记录最后修改的日期和时间。

  • Created_Timestring

    代表相关记录创建的日期和时间。

  • $editable布尔值

    表示用户是否可以编辑特定的相关记录。
    true: 用户可以编辑当前的相关记录。
    false: 用户无法编辑当前的相关记录。

  • Modified_ByJSON 对象

    代表最后修改相关记录的用户的姓名,ID和电子邮件。

  • id字符串

    代表相关记录的唯一ID。

  • Created_ByJSON 对象

    代表创建相关记录的用户的姓名,ID和电子邮件。

注释

  • 请注意,响应JSON的内容会根据在字段参数中指定的字段而变化。上述列出的键对所有相关记录都是通用的。除了上述键之外,还可以检索与相关记录特定的字段。
  • 您可以从查找字段中获取记录,但不能从多选查找字段中获取。

样本回应

可能的错误

  • INVALID_MODULEHTTP 400

    给出的模块名称似乎无效 。
    解决方案:指定一个有效的模块API名称。

  • INVALID_DATAHTTP 400
    • 给出的关系名称似乎无效。

      解决方案:您指定的模块API名称无效,或者没有标签权限,或者该模块可能已从可用模块中移除。请指定一个有效的模块API名称。

    • 给出的记录ID似乎无效

      解决方案:请指定一个有效的记录ID。

  • INVALID_REQUEST_METHODHTTP 400

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

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限来读取相关记录的数据 
    解决方案:用户没有读取相关记录数据的权限。请联系您的系统管理员。

  • NOT_SUPPORTED HTTP 400

    给定的模块不受支持。;
    解决方案: 当前API不支持诸如文档和项目等模块。(一旦这些模块得到支持,此错误将不会显示)。请指定一个有效的模块API名称。

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少预期的参数之一 
    解决方案:指定必需的参数。有关更多详细信息,请参阅上面的参数部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用来进行此API调用的访问令牌没有所需的范围。
    解决方案:生成一个具有此API所需范围的新访问令牌。请参阅本页开头的范围部分,以获取所需范围的列表。

  • NO_PERMISSIONHTTP 403

    拒绝访问相关记录 
    解决方案:用户没有权限读取相关记录数据。请联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求URL不正确。
    解决方案:指定一个有效的请求URL。请参阅本页开头的请求URL部分以获取更多详细信息。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现意外且未处理的异常。请联系支持团队。