Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_type
string ls_Module
string ls_Code
integer j
integer li_Count_j
string ls_Api_name
integer li_Index
string ls_Format
string ls_Find_by
string ls_Default_value
string ls_Status
string ls_Id
string ls_V_Url
string ls_Method
string ls_Id
string ls_Name
integer li_Ignore_empty
string ls_Operation
string ls_Created_time
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://domain.com/crm/bulk/v2/write/{{job_id}}",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "status": "INPROGRESS",
// "resource": [
// {
// "status": "INPROGRESS",
// "type": "data",
// "module": "Leads",
// "field_mappings": [
// {
// "api_name": "Owner",
// "index": 1,
// "format": null,
// "find_by": null,
// "module": null,
// "default_value": null
// },
// {
// "api_name": "Date_3",
// "index": 2,
// "format": "yyyy/MM/dd",
// "find_by": null,
// "module": null,
// "default_value": null
// },
// {
// "api_name": "Last_Name",
// "index": 0,
// "format": null,
// "find_by": null,
// "module": null,
// "default_value": null
// },
// {
// "api_name": "Layout",
// "index": 4,
// "format": null,
// "find_by": null,
// "module": null,
// "default_value": null
// },
// {
// "api_name": "Mobile",
// "index": 3,
// "format": null,
// "find_by": null,
// "module": null,
// "default_value": null
// }
// ],
// "code": "INPROGRESS"
// }
// ],
// "id": "4150868000005392002",
// "callback": {
// "url": "https://www.zoho.com/in/crm/",
// "method": "post"
// },
// "created_by": {
// "id": "4150868000000225013",
// "name": "Patricia Boyle"
// },
// "ignore_empty": true,
// "operation": "insert",
// "created_time": "2021-05-13T11:00:58+05:30"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Status = loo_JResp.StringOf("status")
ls_Id = loo_JResp.StringOf("id")
ls_V_Url = loo_JResp.StringOf("callback.url")
ls_Method = loo_JResp.StringOf("callback.method")
ls_Id = loo_JResp.StringOf("created_by.id")
ls_Name = loo_JResp.StringOf("created_by.name")
li_Ignore_empty = loo_JResp.BoolOf("ignore_empty")
ls_Operation = loo_JResp.StringOf("operation")
ls_Created_time = loo_JResp.StringOf("created_time")
i = 0
li_Count_i = loo_JResp.SizeOfArray("resource")
do while i < li_Count_i
loo_JResp.I = i
ls_Status = loo_JResp.StringOf("resource[i].status")
ls_V_type = loo_JResp.StringOf("resource[i].type")
ls_Module = loo_JResp.StringOf("resource[i].module")
ls_Code = loo_JResp.StringOf("resource[i].code")
j = 0
li_Count_j = loo_JResp.SizeOfArray("resource[i].field_mappings")
do while j < li_Count_j
loo_JResp.J = j
ls_Api_name = loo_JResp.StringOf("resource[i].field_mappings[j].api_name")
li_Index = loo_JResp.IntOf("resource[i].field_mappings[j].index")
ls_Format = loo_JResp.StringOf("resource[i].field_mappings[j].format")
ls_Find_by = loo_JResp.StringOf("resource[i].field_mappings[j].find_by")
ls_Module = loo_JResp.StringOf("resource[i].field_mappings[j].module")
ls_Default_value = loo_JResp.StringOf("resource[i].field_mappings[j].default_value")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/bulk/v2/write/{{job_id}}
Postman Collection Item JSON
{
"name": "Job Details",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write/{{job_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write",
"{{job_id}}"
]
},
"description": "To get the details of a bulk write job performed previously."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write/4150868000005392002",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write",
"4150868000005392002"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:33:49 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-13T12:00:55+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"status\": \"INPROGRESS\",\n \"resource\": [\n {\n \"status\": \"INPROGRESS\",\n \"type\": \"data\",\n \"module\": \"Leads\",\n \"field_mappings\": [\n {\n \"api_name\": \"Owner\",\n \"index\": 1,\n \"format\": null,\n \"find_by\": null,\n \"module\": null,\n \"default_value\": null\n },\n {\n \"api_name\": \"Date_3\",\n \"index\": 2,\n \"format\": \"yyyy/MM/dd\",\n \"find_by\": null,\n \"module\": null,\n \"default_value\": null\n },\n {\n \"api_name\": \"Last_Name\",\n \"index\": 0,\n \"format\": null,\n \"find_by\": null,\n \"module\": null,\n \"default_value\": null\n },\n {\n \"api_name\": \"Layout\",\n \"index\": 4,\n \"format\": null,\n \"find_by\": null,\n \"module\": null,\n \"default_value\": null\n },\n {\n \"api_name\": \"Mobile\",\n \"index\": 3,\n \"format\": null,\n \"find_by\": null,\n \"module\": null,\n \"default_value\": null\n }\n ],\n \"code\": \"INPROGRESS\"\n }\n ],\n \"id\": \"4150868000005392002\",\n \"callback\": {\n \"url\": \"https://www.zoho.com/in/crm/\",\n \"method\": \"post\"\n },\n \"created_by\": {\n \"id\": \"4150868000000225013\",\n \"name\": \"Patricia Boyle\"\n },\n \"ignore_empty\": true,\n \"operation\": \"insert\",\n \"created_time\": \"2021-05-13T11:00:58+05:30\"\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/writ/4150868000005392002",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"writ",
"4150868000005392002"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:34:11 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": [
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write/4150868000005392002",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write",
"4150868000005392002"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:34:36 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": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write/4150868000005392002",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write",
"4150868000005392002"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:34:55 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"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\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "RESOURCE_NOT_FOUND",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write/415086800000539200",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write",
"415086800000539200"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:35:14 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-13T12:00:55+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}"
}
]
}
