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": "insert",
; "object": "Account",
; "contentType": "CSV"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"operation","insert")
CkJsonObject::ckUpdateString(json,"object","Account")
CkJsonObject::ckUpdateString(json,"contentType","CSV")
CkHttp::ckSetRequestHeader(http,"Accept-Encoding","gzip")
CkHttp::ckSetRequestHeader(http,"Sforce-Enable-PKChunking","FALSE")
CkHttp::ckSetRequestHeader(http,"chunkSize","10000")
CkHttp::ckSetRequestHeader(http,"charset","UTF-8")
CkHttp::ckSetRequestHeader(http,"X-SFDC-Session","{{_accessToken}}")
CkHttp::ckSetRequestHeader(http,"Sforce-Disable-Batch-Retry","FALSE")
CkHttp::ckSetRequestHeader(http,"Sforce-Line-Ending","CRLF")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Content-Encoding","gzip")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/async/{{version}}/job","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)
; {
; "apexProcessingTime": 0,
; "apiActiveProcessingTime": 0,
; "apiVersion": 58,
; "assignmentRuleId": null,
; "concurrencyMode": "Parallel",
; "contentType": "CSV",
; "createdById": "005...",
; "createdDate": "<date_time>",
; "externalIdFieldName": null,
; "fastPathEnabled": false,
; "id": "750...",
; "numberBatchesCompleted": 0,
; "numberBatchesFailed": 0,
; "numberBatchesInProgress": 0,
; "numberBatchesQueued": 0,
; "numberBatchesTotal": 0,
; "numberRecordsFailed": 0,
; "numberRecordsProcessed": 0,
; "numberRetries": 0,
; "object": "<Object>",
; "operation": "insert",
; "state": "Open",
; "systemModstamp": "<date_time>",
; "totalProcessingTime": 0
; }
; 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)
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 "Sforce-Disable-Batch-Retry: FALSE"
-H "Sforce-Line-Ending: CRLF"
-H "Sforce-Enable-PKChunking: FALSE"
-H "chunkSize: 10000"
-H "Accept-Encoding: gzip"
-H "Content-Encoding: gzip"
-d '{
"operation": "insert",
"object": "Account",
"contentType": "CSV"
}'
https://domain.com/services/async/{{version}}/job
Postman Collection Item JSON
{
"name": "Bulk Create Job",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
"",
"const contentType = pm.response.headers.get(\"Content-Type\");",
"if (contentType.indexOf(\"xml\") !== -1) {",
" const jsonData = xml2Json(pm.response.text());",
" context.set(\"_jobId\", jsonData['jobInfo']['id']); ",
"}",
"else if (contentType.indexOf(\"json\") !== -1) {",
" const jsonData = pm.response.json();",
" context.set(\"_jobId\", jsonData.id);",
"}",
"",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "X-SFDC-Session",
"value": "{{_accessToken}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "Sforce-Disable-Batch-Retry",
"value": "FALSE",
"disabled": true
},
{
"key": "Sforce-Line-Ending",
"value": "CRLF",
"disabled": true
},
{
"key": "Sforce-Enable-PKChunking",
"value": "FALSE",
"disabled": true
},
{
"key": "chunkSize",
"value": "10000",
"type": "text",
"disabled": true
},
{
"key": "Accept-Encoding",
"value": "gzip",
"disabled": true
},
{
"key": "Content-Encoding",
"value": "gzip",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\": \"insert\",\n \"object\": \"Account\",\n \"contentType\": \"CSV\"\n}"
},
"url": {
"raw": "{{_endpoint}}/services/async/{{version}}/job",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"async",
"{{version}}",
"job"
]
}
},
"response": [
{
"name": "Successful Bulk Create Job",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-SFDC-Session",
"value": "{{_accessToken}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "Sforce-Disable-Batch-Retry",
"value": "FALSE",
"disabled": true
},
{
"key": "Sforce-Line-Ending",
"value": "CRLF",
"disabled": true
},
{
"key": "Sforce-Enable-PKChunking",
"value": "FALSE",
"disabled": true
},
{
"key": "chunkSize",
"value": "10000",
"disabled": true
},
{
"key": "Accept-Encoding",
"value": "gzip",
"disabled": true
},
{
"key": "Content-Encoding",
"value": "gzip",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\" : \"insert\",\n \"object\" : \"Account\",\n \"contentType\" : \"CSV\"\n}"
},
"url": {
"raw": "{{_endpoint}}/services/async/{{version}}/job",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"async",
"{{version}}",
"job"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 16:07:11 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": "Location",
"value": "/services/async/58.0/job/7502o00000kjNCsAAM"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"apexProcessingTime\": 0,\n \"apiActiveProcessingTime\": 0,\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\": 0,\n \"numberBatchesFailed\": 0,\n \"numberBatchesInProgress\": 0,\n \"numberBatchesQueued\": 0,\n \"numberBatchesTotal\": 0,\n \"numberRecordsFailed\": 0,\n \"numberRecordsProcessed\": 0,\n \"numberRetries\": 0,\n \"object\": \"<Object>\",\n \"operation\": \"insert\",\n \"state\": \"Open\",\n \"systemModstamp\": \"<date_time>\",\n \"totalProcessingTime\": 0\n}"
}
]
}
