Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"operation","query")
CkJsonObject::ckUpdateString(json,"query","SELECT fields FROM object WHERE filter")
CkJsonObject::ckUpdateString(json,"contentType","CSV")
CkJsonObject::ckUpdateString(json,"columnDelimiter","BACKQUOTE | CARET | COMMA | PIPE | SEMICOLON | TAB")
CkJsonObject::ckUpdateString(json,"lineEnding","CRLF | LF")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/jobs/query","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
id.s = CkJsonObject::ckStringOf(jResp,"id")
operation.s = CkJsonObject::ckStringOf(jResp,"operation")
v_object.s = CkJsonObject::ckStringOf(jResp,"object")
createdById.s = CkJsonObject::ckStringOf(jResp,"createdById")
createdDate.s = CkJsonObject::ckStringOf(jResp,"createdDate")
systemModstamp.s = CkJsonObject::ckStringOf(jResp,"systemModstamp")
state.s = CkJsonObject::ckStringOf(jResp,"state")
concurrencyMode.s = CkJsonObject::ckStringOf(jResp,"concurrencyMode")
contentType.s = CkJsonObject::ckStringOf(jResp,"contentType")
apiVersion.i = CkJsonObject::ckIntOf(jResp,"apiVersion")
lineEnding.s = CkJsonObject::ckStringOf(jResp,"lineEnding")
columnDelimiter.s = CkJsonObject::ckStringOf(jResp,"columnDelimiter")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
