Chilkat Online Tools

Swift / Salesforce Platform APIs / Get Job Info

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

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "application/json")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

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

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "id": "750...",
    //   "operation": "insert",
    //   "object": "Asset",
    //   "createdById": "005...",
    //   "createdDate": "<datetime>",
    //   "systemModstamp": "<datetime>",
    //   "state": "JobComplete",
    //   "concurrencyMode": "Parallel",
    //   "contentType": "CSV",
    //   "apiVersion": 58,
    //   "jobType": "V2Ingest",
    //   "lineEnding": "LF",
    //   "columnDelimiter": "COMMA",
    //   "numberRecordsProcessed": 1,
    //   "numberRecordsFailed": 1,
    //   "retries": 0,
    //   "totalProcessingTime": 100,
    //   "apiActiveProcessingTime": 43,
    //   "apexProcessingTime": 0
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var id: String? = jResp.string(of: "id")
    var operation: String? = jResp.string(of: "operation")
    var v_object: String? = jResp.string(of: "object")
    var createdById: String? = jResp.string(of: "createdById")
    var createdDate: String? = jResp.string(of: "createdDate")
    var systemModstamp: String? = jResp.string(of: "systemModstamp")
    var state: String? = jResp.string(of: "state")
    var concurrencyMode: String? = jResp.string(of: "concurrencyMode")
    var contentType: String? = jResp.string(of: "contentType")
    var apiVersion: Int = jResp.int(of: "apiVersion").intValue
    var jobType: String? = jResp.string(of: "jobType")
    var lineEnding: String? = jResp.string(of: "lineEnding")
    var columnDelimiter: String? = jResp.string(of: "columnDelimiter")
    var numberRecordsProcessed: Int = jResp.int(of: "numberRecordsProcessed").intValue
    var numberRecordsFailed: Int = jResp.int(of: "numberRecordsFailed").intValue
    var retries: Int = jResp.int(of: "retries").intValue
    var totalProcessingTime: Int = jResp.int(of: "totalProcessingTime").intValue
    var apiActiveProcessingTime: Int = jResp.int(of: "apiActiveProcessingTime").intValue
    var apexProcessingTime: Int = jResp.int(of: "apexProcessingTime").intValue

}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}

Postman Collection Item JSON

{
  "name": "Get Job Info",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "disabled": true
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest/{{_jobId}}",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "jobs",
        "ingest",
        "{{_jobId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Get Job Info",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "disabled": true
          }
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest/{{_jobId}}",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "jobs",
            "ingest",
            "{{_jobId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:03:34 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": "Sforce-Limit-Info",
          "value": "api-usage=8/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"id\": \"750...\",\n    \"operation\": \"insert\",\n    \"object\": \"Asset\",\n    \"createdById\": \"005...\",\n    \"createdDate\": \"<datetime>\",\n    \"systemModstamp\": \"<datetime>\",\n    \"state\": \"JobComplete\",\n    \"concurrencyMode\": \"Parallel\",\n    \"contentType\": \"CSV\",\n    \"apiVersion\": 58,\n    \"jobType\": \"V2Ingest\",\n    \"lineEnding\": \"LF\",\n    \"columnDelimiter\": \"COMMA\",\n    \"numberRecordsProcessed\": 1,\n    \"numberRecordsFailed\": 1,\n    \"retries\": 0,\n    \"totalProcessingTime\": 100,\n    \"apiActiveProcessingTime\": 43,\n    \"apexProcessingTime\": 0\n}"
    }
  ]
}