Chilkat Online Tools

Swift / Salesforce Platform APIs / Get All Query Jobs

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

    let queryParams = CkoJsonObject()!
    queryParams.update("isPkChunkingEnabled", value: "false")
    queryParams.update("jobType", value: "")
    queryParams.update("concurrencyMode", value: "")
    queryParams.update("queryLocator", value: "")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://domain.com/services/data/v{{version}}/jobs/query", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

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

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

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "done": true,
    //   "nextRecordsUrl": null,
    //   "records": [
    //     {
    //       "id": "750...",
    //       "operation": "insert",
    //       "object": "Account",
    //       "createdById": "005...",
    //       "createdDate": "<datetime>",
    //       "systemModstamp": "<datetime>",
    //       "state": "Open",
    //       "concurrencyMode": "Parallel",
    //       "contentType": "CSV",
    //       "apiVersion": 58,
    //       "jobType": "Classic"
    //     },
    //     ...
    //   ]
    // }

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

    var intVal: Int

    var done: Bool = jResp.bool(of: "done")
    var nextRecordsUrl: String? = jResp.string(of: "nextRecordsUrl")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "records").intValue
    while i < count_i {
        jResp.i = i
        intVal = jResp.int(of: "records[i]").intValue
        i = i + 1
    }


}

Curl Command

curl -G -d "isPkChunkingEnabled=false"
	-d "jobType="
	-d "concurrencyMode="
	-d "queryLocator="
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/jobs/query

Postman Collection Item JSON

{
  "name": "Get All Query Jobs",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query?isPkChunkingEnabled=false&jobType&concurrencyMode&queryLocator",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "jobs",
        "query"
      ],
      "query": [
        {
          "key": "isPkChunkingEnabled",
          "value": "false",
          "description": "If set to true, the request only returns information about jobs where PK Chunking is enabled"
        },
        {
          "key": "jobType",
          "value": null,
          "description": "BigObjectIngest Classic V2Query"
        },
        {
          "key": "concurrencyMode",
          "value": null,
          "description": "serial parallel"
        },
        {
          "key": "queryLocator",
          "value": null,
          "description": "use the value from the nextRecordsUrl from the previous set"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Get All Query Jobs",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query?isPkChunkingEnabled=false&jobType&concurrencyMode&queryLocator",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "jobs",
            "query"
          ],
          "query": [
            {
              "key": "isPkChunkingEnabled",
              "value": "false",
              "description": "If set to true, the request only returns information about jobs where PK Chunking is enabled"
            },
            {
              "key": "jobType",
              "value": null,
              "description": "BigObjectIngest Classic V2Query"
            },
            {
              "key": "concurrencyMode",
              "value": null,
              "description": "serial parallel"
            },
            {
              "key": "queryLocator",
              "value": null,
              "description": "use the value from the nextRecordsUrl from the previous set"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 17 Nov 2023 16:25:06 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=4/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"done\": true,\n    \"nextRecordsUrl\": null,\n    \"records\": [\n        {\n            \"id\": \"750...\",\n            \"operation\": \"insert\",\n            \"object\": \"Account\",\n            \"createdById\": \"005...\",\n            \"createdDate\": \"<datetime>\",\n            \"systemModstamp\": \"<datetime>\",\n            \"state\": \"Open\",\n            \"concurrencyMode\": \"Parallel\",\n            \"contentType\": \"CSV\",\n            \"apiVersion\": 58,\n            \"jobType\": \"Classic\"\n        },...\n    ]\n}"
    }
  ]
}