获取批量读取任务明细

目的

用来获取之前执行的批量读取任务的详细信息。

请求 URL

https://www.zohoapis.com.cn/crm/bulk/v2/read/{job_id}

job_id - 批量读取任务的惟一ID

请求方法

GET

范围

scope=ZohoCRM.bulk.read
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称可能的操作类型
线索，客户，联系人，商机，市场活动，服务支持，解决方案，产品，供货商，价格表和自定义模块。ALL - 完全访问相关记录
READ - 获取批量读取任务

响应结构

属性数据类型描述
operation字符串指定API完成的操作类型。示例 - "operation" : "read”。
created_byJSON 对象指定发起批量读取任务的用户ID和名称。示例 - "created_by": { "id": "1000000031045", "name": "Patricia Boyle" },
created_timeISO8601指定初始化批量读取任务的时间段。
created_byJSON 对象指定发起批量读取任务的用户ID和名称。示例 - "created_by": { "id": "1000000031045", "name": "Patricia Boyle" },
state字符串指定批量读取任务的当前状态。示例："state": "ADDED" 或 "IN PROGRESS" 或 "COMPLETED"。
queryJSON 对象指定用户在创建批量读取任务时提供的“查询”。属性与请求JSON中相同，包含"modules", "fields", "criteria" 和 "page"。
id字符串指定批量读取任务的唯一标识符。 示例 - "id": "1000010760002"。
result 显示属性JSON 对象它只有在任务完成后才可用。有关“result”JSON对象的信息，请参考下表。

Result Properties

属性数据类型描述
page整型描述导出的记录数量的范围。如果"page"为1，那么记录的数量将在1 - 200,000条之间。如果是“2”，那么200,001 - 400,000的记录将被导出。
count整型指定导出记录的实际数量。示例 - "count": 14567
download_url字符串指定包含CSV文件的URL。用户可以发送一个GET请求，将您的api 域附加到下载URL以下载文件。示例 - "/crm/bulk/v2/read/2883756000001275012/result".
more_recordsBoolean响应中的“more_records”键可用于检测是否有任何其他记录。您可以更改附加导出任务的“page”键的值。
备注：

  • 要了解更多关于批量API限制的信息，点击这里。

Curl

示例请求


				curl "https://www.zohoapis.com.cn/crm/bulk/v2/read/1000000031045"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

示例响应：对于添加任务


				{
    "data": [
       {
            "operation": "read",
            "created_by": {
                "id": "1000000031045",
                "name": "Chakra"
            },
            "created_time": "2018-02-13T17:16:19+05:30",
            "state": "ADDED",
            "query": {
                "module": "Contacts",
                "fields": [
                    "Last_Name",
                    "First_Name"
                ],
                "criteria": {
                    "api_name": "Email",
                    "comparator": "contains",
                    "value": "@"
                },
                "page": 1
            },
            "id": "1000010760012"
        }
    ]
}

示例响应：对于进行中任务


				{
    "data": [
       {
            "operation": "read",
            "created_by": {
                "id": "1000000031037",
                "name": "p.boyle@zylker.com"
            },
            "created_time": "2018-01-24T19:07:43+05:30",
            "state": "IN PROGRESS",
            "query": {
                "module": "Accounts",
                "page": 3
            },
            "id": "1000000035013"
        }
    ]
}

示例响应：对于已完成任务


				{
    "data": [
       {
            "operation": "read",
            "created_by": {
                "id": "1000000031045",
                "name": "Chakra"
            },
            "created_time": "2018-02-13T17:12:15+05:30",
            "state": "COMPLETED",
            "query": {
                "module": "Contacts",
                "fields": [
                    "Last_Name",
                    "First_Name"
                ],
                "criteria": {
                    "api_name": "Email",
                    "comparator": "contains",
                    "value": "@"
                },
                "page": 1
            },
            "result": {
                "page": 1,
                "count": 200000,
                "download_url": "/crm/bulk/v2/read/1000010760010/result",
                "per_page": 200000,
                "more_records": true
            },
            "id": "1000010760010"
        }
    ]
}
       Sign up for free Access Zoho crm