Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Get Job Info

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcOperation
LOCAL lcV_object
LOCAL lcCreatedById
LOCAL lcCreatedDate
LOCAL lcSystemModstamp
LOCAL lcState
LOCAL lcConcurrencyMode
LOCAL lcContentType
LOCAL lnApiVersion
LOCAL lcJobType
LOCAL lcLineEnding
LOCAL lcColumnDelimiter
LOCAL lnNumberRecordsProcessed
LOCAL lnNumberRecordsFailed
LOCAL lnRetries
LOCAL lnTotalProcessingTime
LOCAL lnApiActiveProcessingTime
LOCAL lnApexProcessingTime

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

lcId = loJResp.StringOf("id")
lcOperation = loJResp.StringOf("operation")
lcV_object = loJResp.StringOf("object")
lcCreatedById = loJResp.StringOf("createdById")
lcCreatedDate = loJResp.StringOf("createdDate")
lcSystemModstamp = loJResp.StringOf("systemModstamp")
lcState = loJResp.StringOf("state")
lcConcurrencyMode = loJResp.StringOf("concurrencyMode")
lcContentType = loJResp.StringOf("contentType")
lnApiVersion = loJResp.IntOf("apiVersion")
lcJobType = loJResp.StringOf("jobType")
lcLineEnding = loJResp.StringOf("lineEnding")
lcColumnDelimiter = loJResp.StringOf("columnDelimiter")
lnNumberRecordsProcessed = loJResp.IntOf("numberRecordsProcessed")
lnNumberRecordsFailed = loJResp.IntOf("numberRecordsFailed")
lnRetries = loJResp.IntOf("retries")
lnTotalProcessingTime = loJResp.IntOf("totalProcessingTime")
lnApiActiveProcessingTime = loJResp.IntOf("apiActiveProcessingTime")
lnApexProcessingTime = loJResp.IntOf("apexProcessingTime")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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