获取批量读取任务的状态
目的
获取以前执行的批量读取作业的详细信息。
端点
- GET /read/{job_id}
Request 详细信息
Request URL
{api-domain}/crm/bulk/{version}/read/{job_id}
其中 job_id 是批量读取任务的唯一 ID。
标题
授权：Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.bulk.read
(或者)
scope=ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
潜在客户，账户，联系人，交易，活动，任务，案例，事件，电话，解决方案，产品，供应商，价格表，报价，销售订单，采购订单，发票，以及自定义
可能的操作类型
ALL - 完全访问相关记录
READ - 获取批量读取任务
样本请求
样本回应：已添加工作
样本回应：作业已排队
样本回应：工作进行中
样本回应：对于任务已完成
Response 结构
- 操作字符串
指定API完成的操作类型。示例 - "operation" : "read”。
- created_byJSON 对象
指定启动批量读取作业的用户的ID和名称。示例 - "created_by": { "id": "1000000031045", "name": "Patricia Boyle" },
- created_timeISO8601
指定了批量读取作业初始化的时间段。
- statestring
指定批量读取作业的当前状态。例如："state": "ADDED", "QUEUED", "IN PROGRESS", 或 "COMPLETED"。
- queryJSON 对象
指定用户在创建批量读取作业时提供的“查询”。属性与Request JSON中的相同，包括"modules"，"cvid"，"fields"，"criteria"和"page"。
- id字符串
指定批量读取作业的唯一标识符。示例 - "id": "1000010760002"。
- 结果JSON 对象
只有在工作完成后才可用。请参考下面的部分以获取有关 "结果" JSON 对象的信息。
"result" 属性
- 页码整数
描述了导出记录数量的范围。如果"页码"是一，那么记录的数量将在1 - 200,000之间。如果是"二"，那么将会导出200,001 - 400,000的记录。
- page_token字符串
用于获取结果下一页的令牌。您可以使用"page"键来获取最多200,000条记录，无需"page_token"。要获取超过200,000条记录，您必须在请求体中包含"page_token"键。
- count整数
指定导出的实际记录数。示例 - "count": 14567
- download_urlString
指定包含CSV文件的url。用户可以发送一个带有您的api域名的GET请求到下载URL以下载文件。示例 - "/crm/bulk/v7/read/2883756000001275012/result"。
- more_recordsboolean
"more_records"键在响应中可以用来检测是否还有更多的记录。您可以更改"page"键的值以进行额外的导出任务。
注意
要了解批量读取API的限制，请点击这里。
可能的错误
- INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案：指定的请求URL不正确。请指定一个有效的请求URL。请参考上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案：客户端没有ZohoCRM.bulk.read或ZohoCRM.modules.{module_name}.READ。创建一个具有有效范围的新客户端。请参考上面的范围部分。 - NO_PERMISSIONHTTP 403
读取权限被拒绝
解决方案：用户没有读取记录的权限。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案：服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案：您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上面的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限进行阅读。
解决方案：用户没有阅读记录的权限。请联系您的系统管理员。 - RESOURCE_NOT_FOUNDHTTP 404
请求的资源不存在。
解决方案：指定的工作ID无效。请指定一个有效的工作ID。