Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("state","Closed")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "X-SFDC-Session","{{_accessToken}}"
$oHttp.SetRequestHeader "Accept-Encoding","gzip"
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "charset","UTF-8"
$oHttp.SetRequestHeader "Content-Encoding","gzip"
Local $oResp = $oHttp.PostJson3("https://domain.com/services/async/{{version}}/job/{{_jobId}}","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
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
Local $iApexProcessingTime = $oJResp.IntOf("apexProcessingTime")
Local $iApiActiveProcessingTime = $oJResp.IntOf("apiActiveProcessingTime")
Local $iApiVersion = $oJResp.IntOf("apiVersion")
Local $sAssignmentRuleId = $oJResp.StringOf("assignmentRuleId")
Local $sConcurrencyMode = $oJResp.StringOf("concurrencyMode")
Local $sContentType = $oJResp.StringOf("contentType")
Local $sCreatedById = $oJResp.StringOf("createdById")
Local $sCreatedDate = $oJResp.StringOf("createdDate")
Local $sExternalIdFieldName = $oJResp.StringOf("externalIdFieldName")
Local $bFastPathEnabled = $oJResp.BoolOf("fastPathEnabled")
Local $sId = $oJResp.StringOf("id")
Local $iNumberBatchesCompleted = $oJResp.IntOf("numberBatchesCompleted")
Local $iNumberBatchesFailed = $oJResp.IntOf("numberBatchesFailed")
Local $iNumberBatchesInProgress = $oJResp.IntOf("numberBatchesInProgress")
Local $iNumberBatchesQueued = $oJResp.IntOf("numberBatchesQueued")
Local $iNumberBatchesTotal = $oJResp.IntOf("numberBatchesTotal")
Local $iNumberRecordsFailed = $oJResp.IntOf("numberRecordsFailed")
Local $iNumberRecordsProcessed = $oJResp.IntOf("numberRecordsProcessed")
Local $iNumberRetries = $oJResp.IntOf("numberRetries")
Local $sV_object = $oJResp.StringOf("object")
Local $sOperation = $oJResp.StringOf("operation")
Local $state = $oJResp.StringOf("state")
Local $systemModstamp = $oJResp.StringOf("systemModstamp")
Local $iTotalProcessingTime = $oJResp.IntOf("totalProcessingTime")
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}"
}
]
}
