Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *id;
const char *operation;
const char *v_object;
const char *createdById;
const char *createdDate;
const char *systemModstamp;
const char *state;
const char *concurrencyMode;
const char *contentType;
int apiVersion;
const char *lineEnding;
const char *columnDelimiter;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "operation": "query",
// "query": "SELECT fields FROM object WHERE filter",
// "contentType": "CSV",
// "columnDelimiter": "BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB",
// "lineEnding": "CRLF | LF"
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"operation","query");
CkJsonObject_UpdateString(json,"query","SELECT fields FROM object WHERE filter");
CkJsonObject_UpdateString(json,"contentType","CSV");
CkJsonObject_UpdateString(json,"columnDelimiter","BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB");
CkJsonObject_UpdateString(json,"lineEnding","CRLF | LF");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
resp = CkHttp_PostJson3(http,"https://domain.com/services/data/v{{version}}/jobs/query","application/json",json);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "750...",
// "operation": "query",
// "object": "Account",
// "createdById": "005...",
// "createdDate": "<datetime>",
// "systemModstamp": "<datetime>",
// "state": "UploadComplete",
// "concurrencyMode": "Parallel",
// "contentType": "CSV",
// "apiVersion": 58,
// "lineEnding": "LF",
// "columnDelimiter": "COMMA"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
id = CkJsonObject_stringOf(jResp,"id");
operation = CkJsonObject_stringOf(jResp,"operation");
v_object = CkJsonObject_stringOf(jResp,"object");
createdById = CkJsonObject_stringOf(jResp,"createdById");
createdDate = CkJsonObject_stringOf(jResp,"createdDate");
systemModstamp = CkJsonObject_stringOf(jResp,"systemModstamp");
state = CkJsonObject_stringOf(jResp,"state");
concurrencyMode = CkJsonObject_stringOf(jResp,"concurrencyMode");
contentType = CkJsonObject_stringOf(jResp,"contentType");
apiVersion = CkJsonObject_IntOf(jResp,"apiVersion");
lineEnding = CkJsonObject_stringOf(jResp,"lineEnding");
columnDelimiter = CkJsonObject_stringOf(jResp,"columnDelimiter");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"operation" : "query",
"query" : "SELECT fields FROM object WHERE filter",
"contentType" : "CSV",
"columnDelimiter" : "BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB",
"lineEnding" : "CRLF | LF"
}'
https://domain.com/services/data/v{{version}}/jobs/query
Postman Collection Item JSON
{
"name": "Successful Create job Query",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
"",
"const response = JSON.parse(pm.response.text())",
"context.set(\"_jobId\", response.id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\" : \"query\",\n \"query\" : \"SELECT fields FROM object WHERE filter\",\n \"contentType\" : \"CSV\",\n \"columnDelimiter\" : \"BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB\",\n \"lineEnding\" : \"CRLF | LF\"\n} "
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"jobs",
"query"
]
}
},
"response": [
{
"name": "Successful Create job Query",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\" : \"query\",\n \"query\" : \"SELECT Id FROM Account\",\n \"contentType\" : \"CSV\",\n \"columnDelimiter\" : \"COMMA\",\n \"lineEnding\" : \"LF\"\n} "
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"jobs",
"query"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:06: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=18/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 \"id\": \"750...\",\n \"operation\": \"query\",\n \"object\": \"Account\",\n \"createdById\": \"005...\",\n \"createdDate\": \"<datetime>\",\n \"systemModstamp\": \"<datetime>\",\n \"state\": \"UploadComplete\",\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"apiVersion\": 58,\n \"lineEnding\": \"LF\",\n \"columnDelimiter\": \"COMMA\"\n}"
}
]
}
