Chilkat Online Tools

Go / Zoho CRM REST APIs / Job Details

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global_Ref.html">Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    var success bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.SetAuthToken("<access_token>")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/crm/bulk/v2.1/write/{{job_id}}",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "status": "COMPLETED",
    //   "character_encoding": "UTF-8",
    //   "resource": [
    //     {
    //       "status": "COMPLETED",
    //       "type": "data",
    //       "module": {
    //         "id": "4150868000000002175",
    //         "api_name": "Leads"
    //       },
    //       "field_mappings": [
    //         {
    //           "api_name": "Owner",
    //           "index": 2,
    //           "format": null,
    //           "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": "Mobile",
    //           "index": 1,
    //           "format": null,
    //           "find_by": null,
    //           "module": null,
    //           "default_value": null
    //         }
    //       ],
    //       "file": {
    //         "status": "COMPLETED",
    //         "name": "Fil2.csv",
    //         "added_count": 9,
    //         "skipped_count": 2,
    //         "updated_count": 0,
    //         "total_count": 11
    //       },
    //       "code": "COMPLETED"
    //     }
    //   ],
    //   "id": "4150868000005350003",
    //   "callback": {
    //     "url": "https://www.zoho.com/",
    //     "method": "post"
    //   },
    //   "result": {
    //     "download_url": "https://download-accl.zoho.com/v2/crm/694902309/bulk-write/4150868000005350003/4150868000005350003.zip"
    //   },
    //   "created_by": {
    //     "id": "4150868000000225013",
    //     "name": "Patricia Boyle"
    //   },
    //   "ignore_empty": true,
    //   "operation": "insert",
    //   "created_time": "2021-05-11T12:38:29+05:30"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var v_type *string = new(string)
    var moduleId *string = new(string)
    var Api_name *string = new(string)
    var Status *string = new(string)
file
    var Added_count int
    var Skipped_count int
    var Updated_count int
    var Total_count int
    var code *string = new(string)
    var j int
    var count_j int
    var api_name *string = new(string)
    var index int
    var format *string = new(string)
    var find_by *string = new(string)
    var module *string = new(string)
    var default_value *string = new(string)

    status := jResp.StringOf("status")
    character_encoding := jResp.StringOf("character_encoding")
    id := jResp.StringOf("id")
    v_Url_Ref.html">Url := jResp.StringOf("callback.url")
    Method := jResp.StringOf("callback.method")
    Download_url := jResp.StringOf("result.download_url")
    Id := jResp.StringOf("created_by.id")
    Name := jResp.StringOf("created_by.name")
    ignore_empty := jResp.BoolOf("ignore_empty")
    operation := jResp.StringOf("operation")
    created_time := jResp.StringOf("created_time")
    i := 0
    count_i := jResp.SizeOfArray("resource")
    for i < count_i {
        jResp.SetI(i)
        status = jResp.StringOf("resource[i].status")
        v_type = jResp.StringOf("resource[i].type")
        moduleId = jResp.StringOf("resource[i].module.id")
        Api_name = jResp.StringOf("resource[i].module.api_name")
        Status = jResp.StringOf("resource[i].file.status")
        fileName = jResp.StringOf("resource[i].file.name")
        Added_count = jResp.IntOf("resource[i].file.added_count")
        Skipped_count = jResp.IntOf("resource[i].file.skipped_count")
        Updated_count = jResp.IntOf("resource[i].file.updated_count")
        Total_count = jResp.IntOf("resource[i].file.total_count")
        code = jResp.StringOf("resource[i].code")
        j = 0
        count_j = jResp.SizeOfArray("resource[i].field_mappings")
        for j < count_j {
            jResp.SetJ(j)
            api_name = jResp.StringOf("resource[i].field_mappings[j].api_name")
            index = jResp.IntOf("resource[i].field_mappings[j].index")
            format = jResp.StringOf("resource[i].field_mappings[j].format")
            find_by = jResp.StringOf("resource[i].field_mappings[j].find_by")
            module = jResp.StringOf("resource[i].field_mappings[j].module")
            default_value = jResp.StringOf("resource[i].field_mappings[j].default_value")
            j = j + 1
        }

        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/bulk/v2.1/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.1/write/{{job_id}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "bulk",
        "v2.1",
        "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.1/write/4150868000005350003",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "bulk",
            "v2.1",
            "write",
            "4150868000005350003"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 07:21:37 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-11T12:57:31+05:30"
        },
        {
          "key": "vary",
          "value": "accept-encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"status\": \"COMPLETED\",\n    \"character_encoding\": \"UTF-8\",\n    \"resource\": [\n        {\n            \"status\": \"COMPLETED\",\n            \"type\": \"data\",\n            \"module\": {\n                \"id\": \"4150868000000002175\",\n                \"api_name\": \"Leads\"\n            },\n            \"field_mappings\": [\n                {\n                    \"api_name\": \"Owner\",\n                    \"index\": 2,\n                    \"format\": null,\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\": \"Mobile\",\n                    \"index\": 1,\n                    \"format\": null,\n                    \"find_by\": null,\n                    \"module\": null,\n                    \"default_value\": null\n                }\n            ],\n            \"file\": {\n                \"status\": \"COMPLETED\",\n                \"name\": \"Fil2.csv\",\n                \"added_count\": 9,\n                \"skipped_count\": 2,\n                \"updated_count\": 0,\n                \"total_count\": 11\n            },\n            \"code\": \"COMPLETED\"\n        }\n    ],\n    \"id\": \"4150868000005350003\",\n    \"callback\": {\n        \"url\": \"https://www.zoho.com/\",\n        \"method\": \"post\"\n    },\n    \"result\": {\n        \"download_url\": \"https://download-accl.zoho.com/v2/crm/694902309/bulk-write/4150868000005350003/4150868000005350003.zip\"\n    },\n    \"created_by\": {\n        \"id\": \"4150868000000225013\",\n        \"name\": \"Patricia Boyle\"\n    },\n    \"ignore_empty\": true,\n    \"operation\": \"insert\",\n    \"created_time\": \"2021-05-11T12:38:29+05:30\"\n}"
    },
    {
      "name": "INVALID_URL_PATTERN",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/bulk/v2.1/writ/4150868000005350003",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "bulk",
            "v2.1",
            "writ",
            "4150868000005350003"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 07:29:26 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": "PUT",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/bulk/v2.1/write/4150868000005350003",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "bulk",
            "v2.1",
            "write",
            "4150868000005350003"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 07:29:51 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.1/write/4150868000005350003",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "bulk",
            "v2.1",
            "write",
            "4150868000005350003"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 07:30:07 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.1/write/415086800000535000",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "bulk",
            "v2.1",
            "write",
            "415086800000535000"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 07:30:33 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-11T14:00:30+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}"
    },
    {
      "name": "OAUTH_SCOPE_MISMATCH",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{api-domain}}/crm/bulk/v2.1/write/4150868000005350003",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "bulk",
            "v2.1",
            "write",
            "4150868000005350003"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Thu, 13 May 2021 08:24:50 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}"
    }
  ]
}