Chilkat Online Tools

Swift3 / Zoho CRM REST APIs / Get Bulk Read Job Details

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // Adds the "Authorization: Bearer {{access-token}}" header.
    http.authToken = "{{access-token}}"

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://www.zohoapis.com/crm/bulk/v2.1/read/{{job_id}}", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

    // 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

    var id: String?
    var operation: String?
    var state: String?
    var Page: Int
    var Per_page: Int
    var Count: Int
    var Download_url: String?
    var More_records: Bool
    var Id: String?
    var Api_name: String?
    var Group_operator: String?
    var queryPage: Int
    var Cvid: String?
    var created_byId: String?
    var Name: String?
    var created_time: String?
    var file_type: String?
    var j: Int
    var count_j: Int
    var strVal: String?
    var fieldId: String?
    var fieldApi_name: String?
    var comparator: String?
    var value: Bool
    var group_operator: String?
    var k: Int
    var count_k: Int
    var value_str: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "data[i].id")
        operation = jResp.string(of: "data[i].operation")
        state = jResp.string(of: "data[i].state")
        Page = jResp.int(of: "data[i].result.page").intValue
        Per_page = jResp.int(of: "data[i].result.per_page").intValue
        Count = jResp.int(of: "data[i].result.count").intValue
        Download_url = jResp.string(of: "data[i].result.download_url")
        More_records = jResp.bool(of: "data[i].result.more_records")
        Id = jResp.string(of: "data[i].query.module.id")
        Api_name = jResp.string(of: "data[i].query.module.api_name")
        Group_operator = jResp.string(of: "data[i].query.criteria.group_operator")
        queryPage = jResp.int(of: "data[i].query.page").intValue
        Cvid = jResp.string(of: "data[i].query.cvid")
        created_byId = jResp.string(of: "data[i].created_by.id")
        Name = jResp.string(of: "data[i].created_by.name")
        created_time = jResp.string(of: "data[i].created_time")
        file_type = jResp.string(of: "data[i].file_type")
        j = 0
        count_j = jResp.size(ofArray: "data[i].query.fields").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "data[i].query.fields[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "data[i].query.criteria.group").intValue
        while j < count_j {
            jResp.j = j
            fieldId = jResp.string(of: "data[i].query.criteria.group[j].field.id")
            fieldApi_name = jResp.string(of: "data[i].query.criteria.group[j].field.api_name")
            comparator = jResp.string(of: "data[i].query.criteria.group[j].comparator")
            value = jResp.bool(of: "data[i].query.criteria.group[j].value")
            group_operator = jResp.string(of: "data[i].query.criteria.group[j].group_operator")
            k = 0
            count_k = jResp.size(ofArray: "data[i].query.criteria.group[j].group").intValue
            while k < count_k {
                jResp.k = k
                fieldId = jResp.string(of: "data[i].query.criteria.group[j].group[k].field.id")
                fieldApi_name = jResp.string(of: "data[i].query.criteria.group[j].group[k].field.api_name")
                comparator = jResp.string(of: "data[i].query.criteria.group[j].group[k].comparator")
                value_str = jResp.string(of: "data[i].query.criteria.group[j].group[k].value")
                k = k + 1
            }

            j = j + 1
        }

        i = i + 1
    }


}

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}"
    }
  ]
}