Chilkat Online Tools

C / Salesforce Platform APIs / Bulk Close Job

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    int apexProcessingTime;
    int apiActiveProcessingTime;
    int apiVersion;
    const char *assignmentRuleId;
    const char *concurrencyMode;
    const char *contentType;
    const char *createdById;
    const char *createdDate;
    const char *externalIdFieldName;
    BOOL fastPathEnabled;
    const char *id;
    int numberBatchesCompleted;
    int numberBatchesFailed;
    int numberBatchesInProgress;
    int numberBatchesQueued;
    int numberBatchesTotal;
    int numberRecordsFailed;
    int numberRecordsProcessed;
    int numberRetries;
    const char *v_object;
    const char *operation;
    const char *state;
    const char *systemModstamp;
    int totalProcessingTime;

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

    http = CkHttp_Create();

    // 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 = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"state","Closed");

    CkHttp_SetRequestHeader(http,"Content-Type","application/json");
    CkHttp_SetRequestHeader(http,"X-SFDC-Session","{{_accessToken}}");
    CkHttp_SetRequestHeader(http,"Accept-Encoding","gzip");
    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttp_putAuthToken(http,"<access_token>");
    CkHttp_SetRequestHeader(http,"charset","UTF-8");
    CkHttp_SetRequestHeader(http,"Content-Encoding","gzip");

    resp = CkHttp_PostJson3(http,"https://domain.com/services/async/{{version}}/job/{{_jobId}}","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(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.

    apexProcessingTime = CkJsonObject_IntOf(jResp,"apexProcessingTime");
    apiActiveProcessingTime = CkJsonObject_IntOf(jResp,"apiActiveProcessingTime");
    apiVersion = CkJsonObject_IntOf(jResp,"apiVersion");
    assignmentRuleId = CkJsonObject_stringOf(jResp,"assignmentRuleId");
    concurrencyMode = CkJsonObject_stringOf(jResp,"concurrencyMode");
    contentType = CkJsonObject_stringOf(jResp,"contentType");
    createdById = CkJsonObject_stringOf(jResp,"createdById");
    createdDate = CkJsonObject_stringOf(jResp,"createdDate");
    externalIdFieldName = CkJsonObject_stringOf(jResp,"externalIdFieldName");
    fastPathEnabled = CkJsonObject_BoolOf(jResp,"fastPathEnabled");
    id = CkJsonObject_stringOf(jResp,"id");
    numberBatchesCompleted = CkJsonObject_IntOf(jResp,"numberBatchesCompleted");
    numberBatchesFailed = CkJsonObject_IntOf(jResp,"numberBatchesFailed");
    numberBatchesInProgress = CkJsonObject_IntOf(jResp,"numberBatchesInProgress");
    numberBatchesQueued = CkJsonObject_IntOf(jResp,"numberBatchesQueued");
    numberBatchesTotal = CkJsonObject_IntOf(jResp,"numberBatchesTotal");
    numberRecordsFailed = CkJsonObject_IntOf(jResp,"numberRecordsFailed");
    numberRecordsProcessed = CkJsonObject_IntOf(jResp,"numberRecordsProcessed");
    numberRetries = CkJsonObject_IntOf(jResp,"numberRetries");
    v_object = CkJsonObject_stringOf(jResp,"object");
    operation = CkJsonObject_stringOf(jResp,"operation");
    state = CkJsonObject_stringOf(jResp,"state");
    systemModstamp = CkJsonObject_stringOf(jResp,"systemModstamp");
    totalProcessingTime = CkJsonObject_IntOf(jResp,"totalProcessingTime");


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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