批量写作工作详情
目的
获取以前执行的批量写入作业的详细信息。
端点
- GET /write/{job_id}
Request 详情
Request URL
{api-domain}/crm/bulk/{version}/write/{job_id}
其中 job_id 是批量写入作业的唯一ID。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.bulk.CREATE
(或)
scope=ZohoCRM.bulk.ALL
样本请求
Response 结构
- 状态字符串
指定批量写入作业的当前状态。例如:"状态": "已添加" 或 "进行中" 或 "已完成"。
- character_encodingstring
指定批量写入作业的字符编码。系统会自动检测字符编码。然而,如果你指定,它将优先。
- id字符串
指定批量写入作业的唯一标识符。
- 结果JSON 对象
download_url: 表示批量写入任务成功完成后,您可以从其中下载结果(CSV 文件)的下载URL。
- created_byJSON 对象
指定启动批量读取作业的用户的ID和名称。
- 操作字符串
指定执行的批量写入操作类型。示例:"operation": "insert"。
- created_timeISO8601
指定了初始化批量写作作业的日期和时间。
- 资源JSON 对象
包含有关所选模块的详细信息,字段映射以及用于此任务的文件的ID。
- 状态,字符串 - 该模块的批量写入任务的状态。例如:"status": "已添加", "进行中", "已完成", "已跳过" 或 "失败"。
- 类型,字符串 - 您已导入的模块的类型。值为 数据。
- 模块字符串 - 您已从中导入记录的模块的API名称。
- 字段映射,JSON 对象 - 包含以下键:
- api_name,字符串 - 您想要导入的Zoho模块对象中字段的API名称。
- find_by,字符串 - 模块中唯一字段或主字段(记录ID)的API名称。系统使用此API名称查找CRM中的现有记录。
- 索引,整数 - 您想要映射到CRM字段的字段的列索引。
- 默认值JSON 对象 - 系统用该默认值替换CSV文件中的任何部分或空文件列。
- 文件JSON 对象
包含以下关于导入的详细信息:
- 状态,字符串 - 该模块的批量写入作业的状态。例如:"status": "已添加", "进行中", "已完成", "已跳过" 或 "失败"。
- 名称,字符串 - 将要下载的 CSV 文件的名称。
- 模块,字符串 - 您从中导入记录的模块的API名称。
- 添加计数,整数 - 添加或导入的记录数。
- 跳过计数,整数 - 由于某些问题而跳过的记录数。错误列在CSV文件中将有关于记录在导入过程中为何被跳过的详细信息。
- 更新计数,整数 - 在批量更新期间更新的记录数。
- 总计数,整数 - 在批量导入期间插入、更新或跳过的记录总数。
注意
要了解批量写入API的限制,请点击这里。
可能的错误
- INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参考上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.bulk.CREATE。创建一个具有有效范围的新客户端。请参考上面的范围部分。 - NO_PERMISSIONHTTP 403
拒绝访问权限
解决方案:用户没有权限获取批量写入作业的详细信息。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上述端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限进行读取。
解决方案:用户没有获取批量写入作业详细信息的权限。请联系您的系统管理员。 - RESOURCE_NOT_FOUNDHTTP 404
请求的资源不存在。
解决方案:指定的工作ID无效。请指定一个有效的工作ID。