Chilkat Online Tools

Swift / Salesforce Platform APIs / Bulk Close Job

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    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")

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/services/async/{{version}}/job/{{_jobId}}", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var apexProcessingTime: Int = jResp.IntOf("apexProcessingTime").intValue
    var apiActiveProcessingTime: Int = jResp.IntOf("apiActiveProcessingTime").intValue
    var apiVersion: Int = jResp.IntOf("apiVersion").intValue
    var assignmentRuleId: String? = jResp.StringOf("assignmentRuleId")
    var concurrencyMode: String? = jResp.StringOf("concurrencyMode")
    var contentType: String? = jResp.StringOf("contentType")
    var createdById: String? = jResp.StringOf("createdById")
    var createdDate: String? = jResp.StringOf("createdDate")
    var externalIdFieldName: String? = jResp.StringOf("externalIdFieldName")
    var fastPathEnabled: Bool = jResp.BoolOf("fastPathEnabled")
    var id: String? = jResp.StringOf("id")
    var numberBatchesCompleted: Int = jResp.IntOf("numberBatchesCompleted").intValue
    var numberBatchesFailed: Int = jResp.IntOf("numberBatchesFailed").intValue
    var numberBatchesInProgress: Int = jResp.IntOf("numberBatchesInProgress").intValue
    var numberBatchesQueued: Int = jResp.IntOf("numberBatchesQueued").intValue
    var numberBatchesTotal: Int = jResp.IntOf("numberBatchesTotal").intValue
    var numberRecordsFailed: Int = jResp.IntOf("numberRecordsFailed").intValue
    var numberRecordsProcessed: Int = jResp.IntOf("numberRecordsProcessed").intValue
    var numberRetries: Int = jResp.IntOf("numberRetries").intValue
    var v_object: String? = jResp.StringOf("object")
    var operation: String? = jResp.StringOf("operation")
    var state: String? = jResp.StringOf("state")
    var systemModstamp: String? = jResp.StringOf("systemModstamp")
    var totalProcessingTime: Int = 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}"
    }
  ]
}