Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnIntVal
LOCAL lnDone
LOCAL lcNextRecordsUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("isPkChunkingEnabled","false")
loQueryParams.UpdateString("jobType","")
loQueryParams.UpdateString("concurrencyMode","")
loQueryParams.UpdateString("queryLocator","")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/jobs/query",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnDone = loJResp.BoolOf("done")
lcNextRecordsUrl = loJResp.StringOf("nextRecordsUrl")
i = 0
lnCount_i = loJResp.SizeOfArray("records")
DO WHILE i < lnCount_i
loJResp.I = i
lnIntVal = loJResp.IntOf("records[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
