Android / Zoho CRM REST APIs / Create Bulk Read Job (ICS)
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "callback": {
// "url": "https://www.example.com/callback",
// "method": "post"
// },
// "query": {
// "module": "Contacts",
// "fields": [
// "Last_Name",
// "Owner",
// "Owner.last_name",
// "Account_Name.Account_Name",
// "Account_Name.Phone",
// "Lead_Source",
// "Created_Time"
// ],
// "criteria": {
// "group_operator": "or",
// "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"
// }
// ]
// },
// "page": 1
// }
// }
CkJsonObject json = new CkJsonObject();
json.UpdateString("callback.url","https://www.example.com/callback");
json.UpdateString("callback.method","post");
json.UpdateString("query.module","Contacts");
json.UpdateString("query.fields[0]","Last_Name");
json.UpdateString("query.fields[1]","Owner");
json.UpdateString("query.fields[2]","Owner.last_name");
json.UpdateString("query.fields[3]","Account_Name.Account_Name");
json.UpdateString("query.fields[4]","Account_Name.Phone");
json.UpdateString("query.fields[5]","Lead_Source");
json.UpdateString("query.fields[6]","Created_Time");
json.UpdateString("query.criteria.group_operator","or");
json.UpdateString("query.criteria.group[0].api_name","Lead_Source");
json.UpdateString("query.criteria.group[0].comparator","equal");
json.UpdateString("query.criteria.group[0].value","Advertisement");
json.UpdateString("query.criteria.group[1].api_name","Owner.last_name");
json.UpdateString("query.criteria.group[1].comparator","equal");
json.UpdateString("query.criteria.group[1].value","Boyle");
json.UpdateString("query.criteria.group[2].api_name","Account_Name.Phone");
json.UpdateString("query.criteria.group[2].comparator","contains");
json.UpdateString("query.criteria.group[2].value","5");
json.UpdateInt("query.page",1);
// Adds the "Authorization: Bearer {{access-token}}" header.
http.put_AuthToken("{{access-token}}");
http.SetRequestHeader("Content-Type","application/json");
CkHttpResponse resp = http.PostJson3("https://domain.com/crm/bulk/v2/read","application/json",json);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "status": "success",
// "code": "ADDED_SUCCESSFULLY",
// "message": "Added successfully.",
// "details": {
// "id": "738964000002152095",
// "operation": "read",
// "state": "ADDED",
// "created_by": {
// "id": "738964000000291009",
// "name": "Patricia Boyle"
// },
// "created_time": "2021-05-12T06:54:24+00:00"
// }
// }
// ],
// "info": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
String status;
String code;
String message;
String Id;
String Operation;
String State;
String Created_byId;
String Name;
String Created_time;
int i = 0;
int count_i = jResp.SizeOfArray("data");
while (i < count_i) {
jResp.put_I(i);
status = jResp.stringOf("data[i].status");
code = jResp.stringOf("data[i].code");
message = jResp.stringOf("data[i].message");
Id = jResp.stringOf("data[i].details.id");
Operation = jResp.stringOf("data[i].details.operation");
State = jResp.stringOf("data[i].details.state");
Created_byId = jResp.stringOf("data[i].details.created_by.id");
Name = jResp.stringOf("data[i].details.created_by.name");
Created_time = jResp.stringOf("data[i].details.created_time");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Authorization: Bearer {{access-token}}"
-H "Content-Type: application/json"
-d '{
"callback": {
"url": "https://www.example.com/callback",
"method": "post"
},
"query": {
"module": "Contacts",
"fields": [
"Last_Name",
"Owner",
"Owner.last_name",
"Account_Name.Account_Name",
"Account_Name.Phone",
"Lead_Source",
"Created_Time"
],
"criteria": {
"group_operator": "or",
"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"
}
]
},
"page": 1
}
}'
https://domain.com/crm/bulk/v2/read
Postman Collection Item JSON
{
"name": "Create Bulk Read Job (ICS)",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"warning": "This is a duplicate header and will be overridden by the Authorization header generated by Postman.",
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"callback\": {\n \"url\": \"https://www.example.com/callback\",\n \"method\": \"post\"\n },\n \"query\": {\n \"module\": \"Contacts\",\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 \"criteria\": {\n \"group_operator\": \"or\",\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 },\n \"page\": 1\n }\n}"
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/read",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"read"
]
},
"description": "To create a bulk read job to export records."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
{
"warning": "This is a duplicate header and will be overridden by the Authorization header generated by Postman.",
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"callback\": {\n \"url\": \"https://www.example.com/callback\",\n \"method\": \"post\"\n },\n \"query\": {\n \"module\": \"Contacts\",\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 \"criteria\": {\n \"group_operator\": \"or\",\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 },\n \"page\": 1\n }\n}"
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/read",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"read"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 06:54:24 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "282"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:15:06+00:00"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"status\": \"success\",\n \"code\": \"ADDED_SUCCESSFULLY\",\n \"message\": \"Added successfully.\",\n \"details\": {\n \"id\": \"738964000002152095\",\n \"operation\": \"read\",\n \"state\": \"ADDED\",\n \"created_by\": {\n \"id\": \"738964000000291009\",\n \"name\": \"Patricia Boyle\"\n },\n \"created_time\": \"2021-05-12T06:54:24+00:00\"\n }\n }\n ],\n \"info\": {}\n}"
},
{
"name": "MEDIA_TYPE_SUPPORTED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"callback\": {\n \"url\": \"https://www.example.com/callback\",\n \"method\": \"post\"\n },\n \"query\": {\n \"module\": \"Contacts\",\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 \"criteria\": {\n \"group_operator\": \"or\",\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 },\n \"page\": 1\n }\n}"
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/read",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"read"
]
}
},
"status": "Unsupported Media Type",
"code": 415,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 06:55:32 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "124"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:15:06+00:00"
}
],
"cookie": [
],
"body": "{\n \"status\": \"error\",\n \"code\": \"MEDIA_TYPE_NOT_SUPPORTED\",\n \"message\": \"Media type is not supported.\",\n \"details\": [\n \"application/json\"\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{access-token}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"callback\": {\n \"url\": \"https://www.example.com/callback\",\n \"method\": \"post\"\n },\n \"query\": {\n \"module\": \"Contacts\",\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 \"criteria\": {\n \"group_operator\": \"or\",\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 },\n \"page\": 1\n }\n}"
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/rea",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"rea"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 06:56:01 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"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"callback\": {\n \"url\": \"https://www.example.com/callback\",\n \"method\": \"post\"\n },\n \"query\": {\n \"module\": \"Contacts\",\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 \"criteria\": {\n \"group_operator\": \"or\",\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 },\n \"page\": 1\n }\n}"
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/read",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"read"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 06:56:19 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}"
}
]
}
