Chilkat Online Tools

Objective-C / Salesforce Platform APIs / Bulk Close Job

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"state" value: @"Closed"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"X-SFDC-Session" value: @"{{_accessToken}}"];
[http SetRequestHeader: @"Accept-Encoding" value: @"gzip"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"charset" value: @"UTF-8"];
[http SetRequestHeader: @"Content-Encoding" value: @"gzip"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/services/async/{{version}}/job/{{_jobId}}" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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

int apexProcessingTime = [[jResp IntOf: @"apexProcessingTime"] intValue];
int apiActiveProcessingTime = [[jResp IntOf: @"apiActiveProcessingTime"] intValue];
int apiVersion = [[jResp IntOf: @"apiVersion"] intValue];
NSString *assignmentRuleId = [jResp StringOf: @"assignmentRuleId"];
NSString *concurrencyMode = [jResp StringOf: @"concurrencyMode"];
NSString *contentType = [jResp StringOf: @"contentType"];
NSString *createdById = [jResp StringOf: @"createdById"];
NSString *createdDate = [jResp StringOf: @"createdDate"];
NSString *externalIdFieldName = [jResp StringOf: @"externalIdFieldName"];
BOOL fastPathEnabled = [jResp BoolOf: @"fastPathEnabled"];
NSString *id = [jResp StringOf: @"id"];
int numberBatchesCompleted = [[jResp IntOf: @"numberBatchesCompleted"] intValue];
int numberBatchesFailed = [[jResp IntOf: @"numberBatchesFailed"] intValue];
int numberBatchesInProgress = [[jResp IntOf: @"numberBatchesInProgress"] intValue];
int numberBatchesQueued = [[jResp IntOf: @"numberBatchesQueued"] intValue];
int numberBatchesTotal = [[jResp IntOf: @"numberBatchesTotal"] intValue];
int numberRecordsFailed = [[jResp IntOf: @"numberRecordsFailed"] intValue];
int numberRecordsProcessed = [[jResp IntOf: @"numberRecordsProcessed"] intValue];
int numberRetries = [[jResp IntOf: @"numberRetries"] intValue];
NSString *v_object = [jResp StringOf: @"object"];
NSString *operation = [jResp StringOf: @"operation"];
NSString *state = [jResp StringOf: @"state"];
NSString *systemModstamp = [jResp StringOf: @"systemModstamp"];
int totalProcessingTime = [[jResp IntOf: @"totalProcessingTime"] intValue];

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}"
    }
  ]
}