Chilkat Online Tools

C++ / Salesforce Platform APIs / Bulk Close Job

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    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"
    // }

    CkJsonObject json;
    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");

    CkHttpResponse *resp = http.PostJson3("https://domain.com/services/async/{{version}}/job/{{_jobId}}","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    int apexProcessingTime = jResp.IntOf("apexProcessingTime");
    int apiActiveProcessingTime = jResp.IntOf("apiActiveProcessingTime");
    int apiVersion = jResp.IntOf("apiVersion");
    const char *assignmentRuleId = jResp.stringOf("assignmentRuleId");
    const char *concurrencyMode = jResp.stringOf("concurrencyMode");
    const char *contentType = jResp.stringOf("contentType");
    const char *createdById = jResp.stringOf("createdById");
    const char *createdDate = jResp.stringOf("createdDate");
    const char *externalIdFieldName = jResp.stringOf("externalIdFieldName");
    bool fastPathEnabled = jResp.BoolOf("fastPathEnabled");
    const char *id = jResp.stringOf("id");
    int numberBatchesCompleted = jResp.IntOf("numberBatchesCompleted");
    int numberBatchesFailed = jResp.IntOf("numberBatchesFailed");
    int numberBatchesInProgress = jResp.IntOf("numberBatchesInProgress");
    int numberBatchesQueued = jResp.IntOf("numberBatchesQueued");
    int numberBatchesTotal = jResp.IntOf("numberBatchesTotal");
    int numberRecordsFailed = jResp.IntOf("numberRecordsFailed");
    int numberRecordsProcessed = jResp.IntOf("numberRecordsProcessed");
    int numberRetries = jResp.IntOf("numberRetries");
    const char *v_object = jResp.stringOf("object");
    const char *operation = jResp.stringOf("operation");
    const char *state = jResp.stringOf("state");
    const char *systemModstamp = jResp.stringOf("systemModstamp");
    int 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}"
    }
  ]
}