创建批量读取任务（批量导出）

目的

用来创建批量读取任务以导出记录。

请求 URL

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

请求方法

POST

范围

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

 
可能的模块名称可能的操作类型
线索，客户，联系人，商机，市场活动，任务，服务支持，事件，通话，解决方案，产品，供货商，价格表，报价单，销售订单，采购订单，发货单和自定义模块ALL - 完全访问记录
READ - 获取批量读取任务

请求 JSON

属性数据类型必填描述
callback 显示属性JSON 对象否一个有效的URL，它应该允许HTTP Post方法。批量读取任务的详细信息在作业成功完成或作业失败时发布到此URL。示例 - "callback" : { "url": "https://sampledomain.com/getzohoresponse", "method": "post" }

Show Callback Properties

属性数据类型必填描述
url字符串(URL)是一个有效的URL，它应该允许HTTP POST方法。批量读取任务的详细信息在任务成功完成或任务失败时发布到此URL。
method字符串是指定回调url的HTTP方法。只支持HTTP POST方法，即允许的值“POST”。
query
显示属性		JSON 对象是有关查询JSON对象的信息，请参考下表。

Show Query Properties

属性数据类型必填描述
module字符串是指定要读取的模块API名称。例如： Leads, Contacts. 示例 - "module" : "Leads”。
fields数组否指定要获取的字段API名称。例如：First_Name, Last_Name, Email。示例 - "fields" : ["First_Name", "Last_Name", "Email”]。
page整型否page的默认值是1。page值“1”表示将导出与查询匹配的前200,000条记录。如果您想获取范围从200,001到400,000的记录，那么您应该将页面设置为“2”。
criteria 显示属性JSON 对象否过滤要导出的记录。例如：模块或字段的API名称，用于添加两个或多个标准的比较器，记录/模块/字段所属的组，等等。

Show criteria Properties

属性数据类型必填描述
api_name字符串是的，如果没有指定group 和 group_operator。要比较的字段API名称。例如：First_Name, Last_Name。
value字符串或数组是的，如果没有指定group 和 group_operator。只取正整数
group_operator字符串是的，如果没有指定api_name, comparator 和 value。逻辑运算符。支持的值 - and, or.
group数组（标准JSON对象）是的，如果没有指定api_name, comparator 和 value。标准对象数组。
comparator 显示属性字符串是的，如果没有指定group 和 group_operator。指定任何类型的比较器。例如：equal, greater_than。更多细节请参考下面的表格。

Show comparator Details

数据类型ComparatorValueLimits
Number (Integer)
Decimal/BigInteger/
Currency/Percent)		equal, not_equal, in, not_in, less_than, less_equal, greater_than, greater_equal任何数值或${EMPTY}为空值。长整数不超过19位，允许十进制和十进制值和货币字段。在启用多种货币的帐户中，只支持本国货币的值。
文本(电子邮件、电话、URL、选择列表、多选等)equal, not_equal, in, not_in, contains, not_contains, starts_with, ends_with.任何文本值或空值的${EMPTY}不超过255个字符。
Dateequal, not_equal, in, not_in, between, not_between.ISO 8601格式的任何日期值或空值的${EMPTY}。---
Date Timeequal, not_equal, in, not_in, between, not_between.任何ISO 8601格式的日期时间值，空值为${EMPTY}。不支持毫秒。
BooleanequalTrue / False---
Lookupequal, not_equal, in, not_in查找的长整型值或空值的${EMPTY}。不支持查找名称。
文本区域(多行)------不支持。

响应结构

属性数据类型描述
status字符串指定API调用的状态。示例 - "status": "success"。
message字符串指定任务的预定义注释。在任何错误发生的情况下有用。示例 - "message": "Added successfully."
details 显示属性JSON 对象有关“details”JSON对象的信息，请参考下表。
备注：

  • 在一个导出任务中最多可以导出20万条记录。 例如：“page”为“1”，页面中的记录为“200,000”。要了解更多关于批量API限制的信息，点击这里。

  • 如果“page”的值为“1”，则将获取匹配条件的前200,000条记录用于导出。

Curl

示例请求

在这个请求中，@inputData.json包含了示例输入数据。


				curl "https://www.zohoapis.com.cn/crm/bulk/v2/read"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@inputData.json"

示例输入


				{
    "query": {
        "module": "Accounts",
        "criteria": {
            "group_operator": "and",
            "group": [
               {
                    "api_name": "Company",
                    "comparator": "contains",
                    "value": "a"
                },
               {
                    "group_operator": "or",
                    "group": [
                       {
                            "api_name": "Last_Name",
                            "comparator": "equal",
                            "value": "Patricia"
                        },
                       {
                            "api_name": "Company",
                            "comparator": "equal",
                            "value": "Zylker"
                        }
                    ]
                }
            ]
        },
        "page": 3
    }
}

示例响应


				{
    "data": [
       {
            "status": "success",
            "code": "ADDED_SUCCESSFULLY",
            "message": "Added successfully.",
            "details": {
                "operation": "read",
                "created_by": {
                    "id": "1000000031045",
                    "name": "Patricia Boyle"
                },
                "created_time": "2018-02-13T16:05:17+05:30",
                "state": "ADDED",
                "id": "1000010760002"
            }
        }
    ]
}