Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// 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 = new CkJsonObject();
$json->UpdateString('state','Closed');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-SFDC-Session','{{_accessToken}}');
$http->SetRequestHeader('Accept-Encoding','gzip');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('charset','UTF-8');
$http->SetRequestHeader('Content-Encoding','gzip');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/services/async/{{version}}/job/{{_jobId}}','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// 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 = $jResp->IntOf('apexProcessingTime');
$apiActiveProcessingTime = $jResp->IntOf('apiActiveProcessingTime');
$apiVersion = $jResp->IntOf('apiVersion');
$assignmentRuleId = $jResp->stringOf('assignmentRuleId');
$concurrencyMode = $jResp->stringOf('concurrencyMode');
$contentType = $jResp->stringOf('contentType');
$createdById = $jResp->stringOf('createdById');
$createdDate = $jResp->stringOf('createdDate');
$externalIdFieldName = $jResp->stringOf('externalIdFieldName');
$fastPathEnabled = $jResp->BoolOf('fastPathEnabled');
$id = $jResp->stringOf('id');
$numberBatchesCompleted = $jResp->IntOf('numberBatchesCompleted');
$numberBatchesFailed = $jResp->IntOf('numberBatchesFailed');
$numberBatchesInProgress = $jResp->IntOf('numberBatchesInProgress');
$numberBatchesQueued = $jResp->IntOf('numberBatchesQueued');
$numberBatchesTotal = $jResp->IntOf('numberBatchesTotal');
$numberRecordsFailed = $jResp->IntOf('numberRecordsFailed');
$numberRecordsProcessed = $jResp->IntOf('numberRecordsProcessed');
$numberRetries = $jResp->IntOf('numberRetries');
$v_object = $jResp->stringOf('object');
$operation = $jResp->stringOf('operation');
$state = $jResp->stringOf('state');
$systemModstamp = $jResp->stringOf('systemModstamp');
$totalProcessingTime = $jResp->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}"
}
]
}
