获取批量更新状态
目的
获取之前安排的批量更新任务的状态。
端点
- GET /{module_API_name}/actions/mass_update?job_id={job_ID}
请求详情
请求 URL
{api-domain}/crm/{version}/{module_API_name}/actions/mass_update?job_id={job_ID}
支持的模块
潜在客户,Account,联系人,交易,活动,任务,电话,会议,解决方案,产品,Vendors,价格表,报价,Sales Orders,采购Orders,Invoices,以及自定义
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.mass_update.READ
(或)
ZohoCRM.mass_update.{module_name}.READ
可能的模块名称
线索、账户、联系人、交易、活动、任务、电话、会议、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票和自定义
参数
- job_idstring, mandatory
表示在批量Update记录的响应中获得的批量Update作业的唯一ID。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Accounts/actions/mass_update?job_id=554023000000506003"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/Accounts/actions/mass_update?job_id= 554023000000506003s"
type: GET
connection:"crm_oauth_connection"
];
info response;响应 JSON 键
- Statusstring
指示批量Status的Update。可能的值是 "已完成"、"已安排"、"运行中" 和 "失败"。
- Failed_Countinteger
指定批量Update失败的记录数。
- Updated_Countinteger
指定成功批量Update的记录数。
- Not_Updated_Countinteger
指定尚未Update的记录数。
- Total_Countinteger
指定计划批量Update的记录总数。
可能的错误
- INVALID_MODULEHTTP 400
您指定了无效的模块 API 名称,或者没有标签权限,或者该模块已从可用模块列表中移除。
解决方法:使用模块 API获取模块的 API 名称。如果您没有标签权限或模块已被移除,请联系您的系统管理员。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持。
解决方案:目前,诸如文档和项目等模块在API中不受支持。一旦这些模块得到支持,此错误将不会显示。 - INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP GET 方法来进行此 API 调用。使用其他请求方法将导致此错误。 - AUTHORIZATION_FAILEDHTTP 400
您没有足够的权限批量更新记录或获取状态。
解决方案:请联系您的系统管理员。 - MANDATORY_NOT_FOUNDHTTP 400
您在请求中未包含 "job_id" 参数。
解决方法: 在请求 URL 中包含必需的参数 "job_id"。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于进行此 API 调用的访问令牌没有所需的范围。
解决方案:生成一个具有范围 ZohoCRM.mass_update.{module_name}.READ 的新访问令牌。请参阅可能的模块名称和可能的操作类型部分以获取详细信息。 - NO_PERMISSIONHTTP 403
您没有权限检索批量更新状态。
解决方案:请联系您的系统管理员。 - NOT_FOUNDHTTP 404
指定的 "job_id" 未找到或无效。
解决方法:请指定一个有效的 job_id。您可以从 批量 Delete API 的响应中获取 job_id。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定一个有效的请求URL。请参阅请求URL部分以获取正确的URL。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方法:请联系支持团队,邮箱地址为 support@zohocrm.com。
样本响应:工作完成
CopiedFor Job Completed
{
"data": [
{
"Status": "COMPLETED",
"Failed_Count": 0,
"Updated_Count": 50,
"Not_Updated_Count": 0,
"Total_Count": 50
}
]
}
For Job Failed
{
"data": [
{
"Status": "FAILED",
"Failed_Count": 50,
"Updated_Count": 0,
"Not_Updated_Count": 0,
"Total_Count": 50
}
]
}
For Job Scheduled
{
"data": [
{
"Status": "SCHEDULED",
"Failed_Count": 0,
"Updated_Count": 0,
"Not_Updated_Count": 50,
"Total_Count": 50
}
]
}
For Job In Progress
{
"data": [
{
"Status": "RUNNING",
"Failed_Count": 0,
"Updated_Count": 30,
"Not_Updated_Count": 20,
"Total_Count": 50
}
]
}