Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
operation: PWideChar;
v_object: PWideChar;
createdById: PWideChar;
createdDate: PWideChar;
systemModstamp: PWideChar;
state: PWideChar;
concurrencyMode: PWideChar;
contentType: PWideChar;
apiVersion: Integer;
jobType: PWideChar;
done: Boolean;
nextRecordsUrl: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'isPkChunkingEnabled','false');
CkJsonObject_UpdateString(queryParams,'jobType','');
CkJsonObject_UpdateString(queryParams,'concurrencyMode','');
CkJsonObject_UpdateString(queryParams,'queryLocator','');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://domain.com/services/data/v{{version}}/jobs/query',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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
done := CkJsonObject_BoolOf(jResp,'done');
nextRecordsUrl := CkJsonObject__stringOf(jResp,'nextRecordsUrl');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'records');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'records[i].id');
operation := CkJsonObject__stringOf(jResp,'records[i].operation');
v_object := CkJsonObject__stringOf(jResp,'records[i].object');
createdById := CkJsonObject__stringOf(jResp,'records[i].createdById');
createdDate := CkJsonObject__stringOf(jResp,'records[i].createdDate');
systemModstamp := CkJsonObject__stringOf(jResp,'records[i].systemModstamp');
state := CkJsonObject__stringOf(jResp,'records[i].state');
concurrencyMode := CkJsonObject__stringOf(jResp,'records[i].concurrencyMode');
contentType := CkJsonObject__stringOf(jResp,'records[i].contentType');
apiVersion := CkJsonObject_IntOf(jResp,'records[i].apiVersion');
jobType := CkJsonObject__stringOf(jResp,'records[i].jobType');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
