Chilkat Online Tools

TCL / Salesforce Platform APIs / Get Job Info

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]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

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

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set id [CkJsonObject_stringOf $jResp "id"]
set operation [CkJsonObject_stringOf $jResp "operation"]
set v_object [CkJsonObject_stringOf $jResp "object"]
set createdById [CkJsonObject_stringOf $jResp "createdById"]
set createdDate [CkJsonObject_stringOf $jResp "createdDate"]
set systemModstamp [CkJsonObject_stringOf $jResp "systemModstamp"]
set state [CkJsonObject_stringOf $jResp "state"]
set concurrencyMode [CkJsonObject_stringOf $jResp "concurrencyMode"]
set contentType [CkJsonObject_stringOf $jResp "contentType"]
set apiVersion [CkJsonObject_IntOf $jResp "apiVersion"]
set jobType [CkJsonObject_stringOf $jResp "jobType"]
set lineEnding [CkJsonObject_stringOf $jResp "lineEnding"]
set columnDelimiter [CkJsonObject_stringOf $jResp "columnDelimiter"]
set numberRecordsProcessed [CkJsonObject_IntOf $jResp "numberRecordsProcessed"]
set numberRecordsFailed [CkJsonObject_IntOf $jResp "numberRecordsFailed"]
set retries [CkJsonObject_IntOf $jResp "retries"]
set totalProcessingTime [CkJsonObject_IntOf $jResp "totalProcessingTime"]
set apiActiveProcessingTime [CkJsonObject_IntOf $jResp "apiActiveProcessingTime"]
set apexProcessingTime [CkJsonObject_IntOf $jResp "apexProcessingTime"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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