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.
; {
; "state": "Closed"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"state","Closed")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"X-SFDC-Session","{{_accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept-Encoding","gzip")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"charset","UTF-8")
CkHttp::ckSetRequestHeader(http,"Content-Encoding","gzip")
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://domain.com/services/async/{{version}}/job/{{_jobId}}",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
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."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "apexProcessingTime": 64,
; "apiActiveProcessingTime": 225,
; "apiVersion": 58,
; "assignmentRuleId": null,
; "concurrencyMode": "Parallel",
; "contentType": "CSV",
; "createdById": "005...",
; "createdDate": "<date_time>",
; "externalIdFieldName": null,
; "fastPathEnabled": false,
; "id": "750...",
; "numberBatchesCompleted": 1,
; "numberBatchesFailed": 0,
; "numberBatchesInProgress": 0,
; "numberBatchesQueued": 0,
; "numberBatchesTotal": 1,
; "numberRecordsFailed": 0,
; "numberRecordsProcessed": 1,
; "numberRetries": 0,
; "object": "<Object>",
; "operation": "insert",
; "state": "Closed",
; "systemModstamp": "<date_time>",
; "totalProcessingTime": 403
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
apexProcessingTime.i = CkJsonObject::ckIntOf(jResp,"apexProcessingTime")
apiActiveProcessingTime.i = CkJsonObject::ckIntOf(jResp,"apiActiveProcessingTime")
apiVersion.i = CkJsonObject::ckIntOf(jResp,"apiVersion")
assignmentRuleId.s = CkJsonObject::ckStringOf(jResp,"assignmentRuleId")
concurrencyMode.s = CkJsonObject::ckStringOf(jResp,"concurrencyMode")
contentType.s = CkJsonObject::ckStringOf(jResp,"contentType")
createdById.s = CkJsonObject::ckStringOf(jResp,"createdById")
createdDate.s = CkJsonObject::ckStringOf(jResp,"createdDate")
externalIdFieldName.s = CkJsonObject::ckStringOf(jResp,"externalIdFieldName")
fastPathEnabled.i = CkJsonObject::ckBoolOf(jResp,"fastPathEnabled")
id.s = CkJsonObject::ckStringOf(jResp,"id")
numberBatchesCompleted.i = CkJsonObject::ckIntOf(jResp,"numberBatchesCompleted")
numberBatchesFailed.i = CkJsonObject::ckIntOf(jResp,"numberBatchesFailed")
numberBatchesInProgress.i = CkJsonObject::ckIntOf(jResp,"numberBatchesInProgress")
numberBatchesQueued.i = CkJsonObject::ckIntOf(jResp,"numberBatchesQueued")
numberBatchesTotal.i = CkJsonObject::ckIntOf(jResp,"numberBatchesTotal")
numberRecordsFailed.i = CkJsonObject::ckIntOf(jResp,"numberRecordsFailed")
numberRecordsProcessed.i = CkJsonObject::ckIntOf(jResp,"numberRecordsProcessed")
numberRetries.i = CkJsonObject::ckIntOf(jResp,"numberRetries")
v_object.s = CkJsonObject::ckStringOf(jResp,"object")
operation.s = CkJsonObject::ckStringOf(jResp,"operation")
state.s = CkJsonObject::ckStringOf(jResp,"state")
systemModstamp.s = CkJsonObject::ckStringOf(jResp,"systemModstamp")
totalProcessingTime.i = CkJsonObject::ckIntOf(jResp,"totalProcessingTime")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-SFDC-Session: {{_accessToken}}"
-H "Content-Type: application/json"
-H "charset: UTF-8"
-H "Accept-Encoding: gzip"
-H "Content-Encoding: gzip"
-d '{
"state" : "Closed"
}'
https://domain.com/services/async/{{version}}/job/{{_jobId}}
Postman Collection Item JSON
{
"name": "Bulk Close Job",
"request": {
"method": "POST",
"header": [
{
"key": "X-SFDC-Session",
"value": "{{_accessToken}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "Accept-Encoding",
"value": "gzip",
"disabled": true
},
{
"key": "Content-Encoding",
"value": "gzip",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"state\" : \"Closed\"\n}"
},
"url": {
"raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"async",
"{{version}}",
"job",
"{{_jobId}}"
]
}
},
"response": [
{
"name": "Successful Bulk Close Job",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-SFDC-Session",
"value": "{{_accessToken}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "Accept-Encoding",
"value": "gzip",
"disabled": true
},
{
"key": "Content-Encoding",
"value": "gzip",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"state\" : \"Closed\"\n}"
},
"url": {
"raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"async",
"{{version}}",
"job",
"{{_jobId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 16:23:52 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": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"apexProcessingTime\": 64,\n \"apiActiveProcessingTime\": 225,\n \"apiVersion\": 58,\n \"assignmentRuleId\": null,\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"createdById\": \"005...\",\n \"createdDate\": \"<date_time>\",\n \"externalIdFieldName\": null,\n \"fastPathEnabled\": false,\n \"id\": \"750...\",\n \"numberBatchesCompleted\": 1,\n \"numberBatchesFailed\": 0,\n \"numberBatchesInProgress\": 0,\n \"numberBatchesQueued\": 0,\n \"numberBatchesTotal\": 1,\n \"numberRecordsFailed\": 0,\n \"numberRecordsProcessed\": 1,\n \"numberRetries\": 0,\n \"object\": \"<Object>\",\n \"operation\": \"insert\",\n \"state\": \"Closed\",\n \"systemModstamp\": \"<date_time>\",\n \"totalProcessingTime\": 403\n}"
}
]
}
