Chilkat Online Tools

TCL / Salesforce Platform APIs / Bulk Close Job

Back to Collection Items

load ./chilkat.dll

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

set 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"
# }

set json [new_CkJsonObject]

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_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "charset" "UTF-8"
CkHttp_SetRequestHeader $http "Content-Encoding" "gzip"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/services/async/{{version}}/job/{{_jobId}}" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $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

set apexProcessingTime [CkJsonObject_IntOf $jResp "apexProcessingTime"]
set apiActiveProcessingTime [CkJsonObject_IntOf $jResp "apiActiveProcessingTime"]
set apiVersion [CkJsonObject_IntOf $jResp "apiVersion"]
set assignmentRuleId [CkJsonObject_stringOf $jResp "assignmentRuleId"]
set concurrencyMode [CkJsonObject_stringOf $jResp "concurrencyMode"]
set contentType [CkJsonObject_stringOf $jResp "contentType"]
set createdById [CkJsonObject_stringOf $jResp "createdById"]
set createdDate [CkJsonObject_stringOf $jResp "createdDate"]
set externalIdFieldName [CkJsonObject_stringOf $jResp "externalIdFieldName"]
set fastPathEnabled [CkJsonObject_BoolOf $jResp "fastPathEnabled"]
set id [CkJsonObject_stringOf $jResp "id"]
set numberBatchesCompleted [CkJsonObject_IntOf $jResp "numberBatchesCompleted"]
set numberBatchesFailed [CkJsonObject_IntOf $jResp "numberBatchesFailed"]
set numberBatchesInProgress [CkJsonObject_IntOf $jResp "numberBatchesInProgress"]
set numberBatchesQueued [CkJsonObject_IntOf $jResp "numberBatchesQueued"]
set numberBatchesTotal [CkJsonObject_IntOf $jResp "numberBatchesTotal"]
set numberRecordsFailed [CkJsonObject_IntOf $jResp "numberRecordsFailed"]
set numberRecordsProcessed [CkJsonObject_IntOf $jResp "numberRecordsProcessed"]
set numberRetries [CkJsonObject_IntOf $jResp "numberRetries"]
set v_object [CkJsonObject_stringOf $jResp "object"]
set operation [CkJsonObject_stringOf $jResp "operation"]
set state [CkJsonObject_stringOf $jResp "state"]
set systemModstamp [CkJsonObject_stringOf $jResp "systemModstamp"]
set totalProcessingTime [CkJsonObject_IntOf $jResp "totalProcessingTime"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
    }
  ]
}