Classic ASP / Zoho CRM REST APIs / Get Bulk Read Job Details
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
set http = Server.CreateObject("Chilkat_9_5_0.Http")
' Adds the "Authorization: Bearer {{access-token}}" header.
http.AuthToken = "{{access-token}}"
set sbResponseBody = Server.CreateObject("Chilkat_9_5_0.StringBuilder")
success = http.QuickGetSb("https://www.zohoapis.com/crm/bulk/v2.1/read/{{job_id}}",sbResponseBody)
If (success = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
set jResp = Server.CreateObject("Chilkat_9_5_0.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
respStatusCode = http.LastStatus
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( http.LastHeader) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "data": [
' {
' "id": "4150868000005277059",
' "operation": "read",
' "state": "COMPLETED",
' "result": {
' "page": 1,
' "per_page": 200000,
' "count": 0,
' "download_url": "/crm/bulk/v2.1/read/4150868000005277059/result",
' "more_records": false
' },
' "query": {
' "fields": [
' "Last_Name",
' "Owner",
' "Owner.last_name",
' "$converted",
' "Lead_Source",
' "Lead_Status",
' "Company",
' "Email",
' "Mobile",
' "Created_Time"
' ],
' "module": {
' "id": "4150868000000002175",
' "api_name": "Leads"
' },
' "criteria": {
' "group": [
' {
' "field": {
' "id": null,
' "api_name": "$converted"
' },
' "comparator": "equal",
' "value": false
' },
' {
' "group": [
' {
' "field": {
' "id": "4150868000000002595",
' "api_name": "Last_Name"
' },
' "comparator": "equal",
' "value": "Patricia"
' },
' {
' "field": {
' "id": "4150868000000002599",
' "api_name": "Email"
' },
' "comparator": "equal",
' "value": "patricia.b@zylker.com"
' }
' ],
' "group_operator": "and"
' }
' ],
' "group_operator": "and"
' },
' "page": 1,
' "cvid": "4150868000000087501"
' },
' "created_by": {
' "id": "4150868000000225013",
' "name": "Patricia Boyle"
' },
' "created_time": "2021-05-03T18:32:25+05:30",
' "file_type": "csv"
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
count_i = jResp.SizeOfArray("data")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("data[i].id")
operation = jResp.StringOf("data[i].operation")
state = jResp.StringOf("data[i].state")
Page = jResp.IntOf("data[i].result.page")
Per_page = jResp.IntOf("data[i].result.per_page")
Count = jResp.IntOf("data[i].result.count")
Download_url = jResp.StringOf("data[i].result.download_url")
More_records = jResp.BoolOf("data[i].result.more_records")
Id = jResp.StringOf("data[i].query.module.id")
Api_name = jResp.StringOf("data[i].query.module.api_name")
Group_operator = jResp.StringOf("data[i].query.criteria.group_operator")
queryPage = jResp.IntOf("data[i].query.page")
Cvid = jResp.StringOf("data[i].query.cvid")
created_byId = jResp.StringOf("data[i].created_by.id")
Name = jResp.StringOf("data[i].created_by.name")
created_time = jResp.StringOf("data[i].created_time")
file_type = jResp.StringOf("data[i].file_type")
j = 0
count_j = jResp.SizeOfArray("data[i].query.fields")
Do While j < count_j
jResp.J = j
strVal = jResp.StringOf("data[i].query.fields[j]")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("data[i].query.criteria.group")
Do While j < count_j
jResp.J = j
fieldId = jResp.StringOf("data[i].query.criteria.group[j].field.id")
fieldApi_name = jResp.StringOf("data[i].query.criteria.group[j].field.api_name")
comparator = jResp.StringOf("data[i].query.criteria.group[j].comparator")
value = jResp.BoolOf("data[i].query.criteria.group[j].value")
group_operator = jResp.StringOf("data[i].query.criteria.group[j].group_operator")
k = 0
count_k = jResp.SizeOfArray("data[i].query.criteria.group[j].group")
Do While k < count_k
jResp.K = k
fieldId = jResp.StringOf("data[i].query.criteria.group[j].group[k].field.id")
fieldApi_name = jResp.StringOf("data[i].query.criteria.group[j].group[k].field.api_name")
comparator = jResp.StringOf("data[i].query.criteria.group[j].group[k].comparator")
value_str = jResp.StringOf("data[i].query.criteria.group[j].group[k].value")
k = k + 1
Loop
j = j + 1
Loop
i = i + 1
Loop
%>
</body>
</html>
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: Bearer {{access-token}}"
https://www.zohoapis.com/crm/bulk/v2.1/read/{{job_id}}
Postman Collection Item JSON
{
"name": "Get Bulk Read Job Details",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "https://www.zohoapis.com/crm/bulk/v2.1/read/{{job_id}}",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2.1",
"read",
"{{job_id}}"
]
},
"description": "To get the details of a bulk read job performed previously.\n\n"
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "https://www.zohoapis.com/crm/bulk/v2.1/read/4150868000005277059",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2.1",
"read",
"4150868000005277059"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 11:25:24 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-04T17:55:19+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"4150868000005277059\",\n \"operation\": \"read\",\n \"state\": \"COMPLETED\",\n \"result\": {\n \"page\": 1,\n \"per_page\": 200000,\n \"count\": 0,\n \"download_url\": \"/crm/bulk/v2.1/read/4150868000005277059/result\",\n \"more_records\": false\n },\n \"query\": {\n \"fields\": [\n \"Last_Name\",\n \"Owner\",\n \"Owner.last_name\",\n \"$converted\",\n \"Lead_Source\",\n \"Lead_Status\",\n \"Company\",\n \"Email\",\n \"Mobile\",\n \"Created_Time\"\n ],\n \"module\": {\n \"id\": \"4150868000000002175\",\n \"api_name\": \"Leads\"\n },\n \"criteria\": {\n \"group\": [\n {\n \"field\": {\n \"id\": null,\n \"api_name\": \"$converted\"\n },\n \"comparator\": \"equal\",\n \"value\": false\n },\n {\n \"group\": [\n {\n \"field\": {\n \"id\": \"4150868000000002595\",\n \"api_name\": \"Last_Name\"\n },\n \"comparator\": \"equal\",\n \"value\": \"Patricia\"\n },\n {\n \"field\": {\n \"id\": \"4150868000000002599\",\n \"api_name\": \"Email\"\n },\n \"comparator\": \"equal\",\n \"value\": \"patricia.b@zylker.com\"\n }\n ],\n \"group_operator\": \"and\"\n }\n ],\n \"group_operator\": \"and\"\n },\n \"page\": 1,\n \"cvid\": \"4150868000000087501\"\n },\n \"created_by\": {\n \"id\": \"4150868000000225013\",\n \"name\": \"Patricia Boyle\"\n },\n \"created_time\": \"2021-05-03T18:32:25+05:30\",\n \"file_type\": \"csv\"\n }\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "https://www.zohoapis.com/crm/bulk/v2.1/read4150868000005277059",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2.1",
"read4150868000005277059"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 11:26:53 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "https://www.zohoapis.com/crm/bulk/v2.1/read/4150868000005277059",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2.1",
"read",
"4150868000005277059"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 11:27:28 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "RESOURCE_NOT_FOUND",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "https://www.zohoapis.com/crm/bulk/v2.1/read/415086800000527705",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2.1",
"read",
"415086800000527705"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 11:27:58 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-04T17:55:19+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"status\": \"error\",\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"The requested resource doesn't exist.\",\n \"details\": {\n \"resource\": \"415086800000527705\"\n }\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2.1/read/4150868000005277059",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2.1",
"read",
"4150868000005277059"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 13:36:09 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
