Zoho crm Logo

获取回收站记录

目的

要在您的CRM账户中获取回收站中的记录。您可以在一次API调用中获取最多200条记录。

端点

  • GET /settings/recycle_bin
  • GET /settings/recycle_bin/{record_ID}

Request 详情

Request URL

获取所有记录:
{api-domain}/crm/{version}/settings/recycle_bin

通过ID获取特定记录:
{api-domain}/crm/{version}/settings/recycle_bin/{record_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.recycle_bin.READ
 

样本请求

参数
  • sort_by字符串,可选

    根据给定字段对可用的记录列表进行排序。
    可能的值: 
    display_name - 根据记录的显示名称进行排序
    deleted_time - 根据记录的删除时间进行排序。这是默认值。
     deleted_by - 根据记录的deleted_by值进行排序

  • sort_order字符串,可选

    对可用的记录列表进行升序或降序排序。
    可能的值: 
    asc - 升序排序
    desc - 降序排序。这是默认值。
     

  • ids字符串,可选

    根据其唯一ID检索特定记录。
    可能的值: 记录的有效唯一ID。例如:4150868000001944196

  • pageinteger

    获取各个页面的记录列表。 
    可能的值:仅限正整数。
    默认值:1

  • per_pageinteger

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

  • filtersJSON object, optional

    要指定从回收站检索记录的条件,可以使用逻辑运算符和比较器按照显示名称、模块、删除者和删除时间等字段进行过滤。

    注意: 在进行API调用之前,确保对过滤器参数值进行编码。

    • group_operator 字符串,可选

      定义如何组合多个条件。唯一支持的 group_operator 是 AND。

    • groupJSON array, mandatory

      一个过滤条件数组,其中每个条件指定字段,比较器和值。

      • fieldJSON object

        表示应过滤的字段。请参阅过滤属性部分以了解可能的值。

      • comparatorstring

        表示比较运算符,如等于,不等于,包含等。请参阅过滤属性部分以了解每个字段的可能值。

      • valuestring/JSON object

        表示要与字段进行比较的值。这可以是字符串或JSON对象,具体取决于字段。有关更多详细信息,请参阅示例部分。

    过滤属性:

    • display_name

      记录的显示名称。可以应用于display_name的条件包括等于,不等于,包含,不包含,以...开始和以...结束。

    • 模块

      模块的API名称。将从此模块中获取回收站中的记录。可以应用于模块的条件是等于和不等于

    • deleted_by

      删除记录的用户名称。可以应用于deleted_by的条件包括等于,不等于,包含,不包含,以...开始,和以...结束。

    • deleted_time

      记录被删除的日期和时间,以ISO 8601 DateTime格式。可以应用于deleted_time的条件有等于,不等于,大于,和小于。

注意

  • 当你在URL中包含记录id时,它将优先于ids和过滤器参数。如果URL中包含了记录ID,任何过滤器或ids参数都将被忽略。
  • ids参数优先于过滤器参数。如果同时包含了ids和过滤器,只有ids参数会被考虑。
  • 你可以在一次API调用中检索最多200条记录。如果回收站中有超过200条记录,使用页面参数来检索它们。
  • 如果还有更多的记录可用,超出了当前响应中返回的内容,那么响应中的more_records键将被设置为true。在这种情况下,使用页面参数以批量检索它们。

示例过滤参数值

Response JSON 键

  • ownerJSON 对象

    记录的所有者详细信息。这包括所有者的名称和id。

  • moduleJSON 对象

    已删除记录的父模块的详细信息。

  • deleted_byJSON 对象

    删除记录的用户的详细信息。

  • id字符串

    记录的唯一ID。

  • display_name字符串

    记录的显示名称。

  • deleted_time字符串

    记录的删除时间。

注意

  • 在以下情况下,你将收到无内容(204)的响应:
    • 回收站为空。
    • 指定了无效的记录ID。
    • 记录不在回收站中。

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

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

  • INVALID_DATAHTTP 400
    • 不支持给定的组操作符。只支持 'AND' 操作符 
      解决方案: 使用 AND 组操作符构造 filters 参数值。

    • 给定的API名称似乎无效 
      解决方案: 在 filters 参数中为字段指定有效的API名称。

  • OAUTH_SCOPE_MISMATCHHTTP 401

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

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

样本回应