DataFlex / Zoho CRM REST APIs / Get Bulk Read Job Details
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sOperation
String sState
Integer iPage
Integer iPer_page
Integer iCount
String sDownload_url
Boolean iMore_records
String sModule
String sGroup_operator
Integer iQueryPage
String sId
String sName
String sCreated_time
String sFile_type
Integer j
Integer iCount_j
String sStrVal
String sApi_name
String sComparator
String sValue
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer {{access-token}}" header.
Set ComAuthToken Of hoHttp To "{{access-token}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://www.zohoapis.com/crm/bulk/v2/read/{{job_id}}" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "id": "4150868000005376042",
// "operation": "read",
// "state": "COMPLETED",
// "result": {
// "page": 1,
// "per_page": 200000,
// "count": 96,
// "download_url": "/crm/bulk/v2/read/4150868000005376042/result",
// "more_records": false
// },
// "query": {
// "fields": [
// "Last_Name",
// "Owner",
// "Owner.last_name",
// "Account_Name.Account_Name",
// "Account_Name.Phone",
// "Lead_Source",
// "Created_Time"
// ],
// "module": "Contacts",
// "criteria": {
// "group": [
// {
// "api_name": "Lead_Source",
// "comparator": "equal",
// "value": "Advertisement"
// },
// {
// "api_name": "Owner.last_name",
// "comparator": "equal",
// "value": "Boyle"
// },
// {
// "api_name": "Account_Name.Phone",
// "comparator": "contains",
// "value": "5"
// }
// ],
// "group_operator": "or"
// },
// "page": 1
// },
// "created_by": {
// "id": "4150868000000225013",
// "name": "Patricia Boyle"
// },
// "created_time": "2021-05-12T17:25:29+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
Move 0 To i
Get ComSizeOfArray Of hoJResp "data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data[i].id" To sId
Get ComStringOf Of hoJResp "data[i].operation" To sOperation
Get ComStringOf Of hoJResp "data[i].state" To sState
Get ComIntOf Of hoJResp "data[i].result.page" To iPage
Get ComIntOf Of hoJResp "data[i].result.per_page" To iPer_page
Get ComIntOf Of hoJResp "data[i].result.count" To iCount
Get ComStringOf Of hoJResp "data[i].result.download_url" To sDownload_url
Get ComBoolOf Of hoJResp "data[i].result.more_records" To iMore_records
Get ComStringOf Of hoJResp "data[i].query.module" To sModule
Get ComStringOf Of hoJResp "data[i].query.criteria.group_operator" To sGroup_operator
Get ComIntOf Of hoJResp "data[i].query.page" To iQueryPage
Get ComStringOf Of hoJResp "data[i].created_by.id" To sId
Get ComStringOf Of hoJResp "data[i].created_by.name" To sName
Get ComStringOf Of hoJResp "data[i].created_time" To sCreated_time
Get ComStringOf Of hoJResp "data[i].file_type" To sFile_type
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].query.fields" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "data[i].query.fields[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].query.criteria.group" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "data[i].query.criteria.group[j].api_name" To sApi_name
Get ComStringOf Of hoJResp "data[i].query.criteria.group[j].comparator" To sComparator
Get ComStringOf Of hoJResp "data[i].query.criteria.group[j].value" To sValue
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: Bearer {{access-token}}"
https://www.zohoapis.com/crm/bulk/v2/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/read/{{job_id}}",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2",
"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/read/4150868000005376042",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2",
"read",
"4150868000005376042"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:55:44 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-12T17:36:34+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\": \"4150868000005376042\",\n \"operation\": \"read\",\n \"state\": \"COMPLETED\",\n \"result\": {\n \"page\": 1,\n \"per_page\": 200000,\n \"count\": 96,\n \"download_url\": \"/crm/bulk/v2/read/4150868000005376042/result\",\n \"more_records\": false\n },\n \"query\": {\n \"fields\": [\n \"Last_Name\",\n \"Owner\",\n \"Owner.last_name\",\n \"Account_Name.Account_Name\",\n \"Account_Name.Phone\",\n \"Lead_Source\",\n \"Created_Time\"\n ],\n \"module\": \"Contacts\",\n \"criteria\": {\n \"group\": [\n {\n \"api_name\": \"Lead_Source\",\n \"comparator\": \"equal\",\n \"value\": \"Advertisement\"\n },\n {\n \"api_name\": \"Owner.last_name\",\n \"comparator\": \"equal\",\n \"value\": \"Boyle\"\n },\n {\n \"api_name\": \"Account_Name.Phone\",\n \"comparator\": \"contains\",\n \"value\": \"5\"\n }\n ],\n \"group_operator\": \"or\"\n },\n \"page\": 1\n },\n \"created_by\": {\n \"id\": \"4150868000000225013\",\n \"name\": \"Patricia Boyle\"\n },\n \"created_time\": \"2021-05-12T17:25:29+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/rea/4150868000005376042",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2",
"rea",
"4150868000005376042"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:56:44 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": "COPY",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
}
],
"url": {
"raw": "https://www.zohoapis.com/crm/bulk/v2/read/4150868000005376042",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2",
"read",
"4150868000005376042"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:57:14 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/read/415086800000537604",
"protocol": "https",
"host": [
"www",
"zohoapis",
"com"
],
"path": [
"crm",
"bulk",
"v2",
"read",
"415086800000537604"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:57:44 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-12T17:36:34+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\": \"415086800000537604\"\n }\n}"
}
]
}
