Zoho crm Logo

获取已删除记录的列表

目的

获取已删除记录的列表。

端点

  • GET /{module_api_name}/deleted

Request 详情

Request URL

{api-domain}/crm/{version}/{module_api_name}/deleted

支持的模块

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
If-Modified-Since:使用此头获取最近修改的记录列表。示例:2019-07-25T15:26:49+05:30

范围

scope=ZohoCRM.modules.ALL
(或者)
scope=ZohoCRM.modules.{模块名称}.{操作类型}

可能的模块名称

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

可能的操作类型

ALL - 对记录的完全访问
READ - 获取模块中的记录

参数

  • type字符串,可选

    指定您想要检索的已删除记录的类型。
    可能的值 -

    • all:获取所有已删除记录的列表。这是默认值。
    • recycle:从回收站获取已删除记录的列表。
    • permanent:获取永久删除的记录列表。

       

  • page整数,可选

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

  • per_page整数,可选

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

注意

  • page和per_page参数用于根据它们在CRM中的位置获取记录。假设用户需要获取400条记录。一个API调用可以获取的最大记录数是200。因此,对于超过200的位置的记录,无法获取。通过使用页面(1,2)和每页(200)参数,用户可以使用2个API调用获取所有400条记录。
  • 使用此API,您可以获取已被临时删除或移至回收站的记录,最长可达删除日期后的60天。同样,已被永久删除的记录可以在删除日期后的120天内检索。

样本请求

响应 JSON 键

  • deleted_byJSON 对象

    代表删除当前记录的用户的名称和ID。

  • idstring

    代表已删除记录的唯一ID。

  • display_namestring

    代表已删除记录的显示名称。

  • typestring

    代表已删除记录的类型。值可以是:全部,回收,或永久。

  • created_byJSON 对象

    代表创建当前记录的用户的名称和ID。

  • deleted_timestring

    表示记录被删除的日期和时间。

可能的错误

  • INVALID_MODULEHTTP 400

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

  • INVALID_MODULEHTTP 400

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

  • INVALID_URL_PATTERNHTTP 404

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有ZohoCRM.modules.{module_name}.READ。创建一个具有有效范围的新客户端。请参考上述范围部分。

  • NO_PERMISSIONHTTP 403

    拒绝访问权限
    解决方案:用户没有权限检索已删除的记录。请联系您的系统管理员。

  • INTERNAL_ERRORHTTP 500

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

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上面的端点部分。

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限来读取记录
    解决方案: 用户没有权限检索已删除的记录。请联系您的系统管理员。

  • PATTERN_NOT_MATCHEDHTTP 400

    请检查输入值是否正确
    解决方案:为'type'参数指定的值不正确。请参考上述参数部分并指定一个有效的参数值。

  • No ContentHTTP 204

    无内容
    解决方案:没有可用的记录。请参考注释部分查看检索已删除记录的时间范围限制。

示例回应