Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("isPkChunkingEnabled","false")
queryParams.UpdateString("jobType","")
queryParams.UpdateString("concurrencyMode","")
queryParams.UpdateString("queryLocator","")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/jobs/query",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim id As String
Dim operation As String
Dim v_object As String
Dim createdById As String
Dim createdDate As String
Dim systemModstamp As String
Dim state As String
Dim concurrencyMode As String
Dim contentType As String
Dim apiVersion As Integer
Dim jobType As String
Dim done As Boolean = jResp.BoolOf("done")
Dim nextRecordsUrl As String = jResp.StringOf("nextRecordsUrl")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("records")
While i < count_i
jResp.I = i
id = jResp.StringOf("records[i].id")
operation = jResp.StringOf("records[i].operation")
v_object = jResp.StringOf("records[i].object")
createdById = jResp.StringOf("records[i].createdById")
createdDate = jResp.StringOf("records[i].createdDate")
systemModstamp = jResp.StringOf("records[i].systemModstamp")
state = jResp.StringOf("records[i].state")
concurrencyMode = jResp.StringOf("records[i].concurrencyMode")
contentType = jResp.StringOf("records[i].contentType")
apiVersion = jResp.IntOf("records[i].apiVersion")
jobType = jResp.StringOf("records[i].jobType")
i = i + 1
End While
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": "Successful 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": "Mon, 20 Nov 2023 15:07:54 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=23/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}"
}
]
}
