Chilkat Online Tools

phpAx / Salesforce Platform APIs / Get Job Info Query

Back to Collection Items

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Content-Type','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/services/data/v{{version}}/jobs/query/{{_jobId}}',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

// {
//   "id": "750...",
//   "operation": "insert",
//   "object": "Account",
//   "createdById": "005...",
//   "createdDate": "<datetime>",
//   "systemModstamp": "<datetime>",
//   "state": "Open",
//   "concurrencyMode": "Parallel",
//   "contentType": "CSV",
//   "apiVersion": 58,
//   "jobType": "Classic",
//   "retries": 0,
//   "totalProcessingTime": 0,
//   "apiActiveProcessingTime": 0,
//   "apexProcessingTime": 0
// }

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

$id = $jResp->stringOf('id');
$operation = $jResp->stringOf('operation');
$v_object = $jResp->stringOf('object');
$createdById = $jResp->stringOf('createdById');
$createdDate = $jResp->stringOf('createdDate');
$systemModstamp = $jResp->stringOf('systemModstamp');
$state = $jResp->stringOf('state');
$concurrencyMode = $jResp->stringOf('concurrencyMode');
$contentType = $jResp->stringOf('contentType');
$apiVersion = $jResp->IntOf('apiVersion');
$jobType = $jResp->stringOf('jobType');
$retries = $jResp->IntOf('retries');
$totalProcessingTime = $jResp->IntOf('totalProcessingTime');
$apiActiveProcessingTime = $jResp->IntOf('apiActiveProcessingTime');
$apexProcessingTime = $jResp->IntOf('apexProcessingTime');

?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get Job Info Query",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "disabled": true
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query/{{_jobId}}",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "jobs",
        "query",
        "{{_jobId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Get Job Info Query",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "disabled": true
          }
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/query/{{_jobId}}",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "jobs",
            "query",
            "{{_jobId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 17 Nov 2023 16:13:43 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=2/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\": \"Account\",\n    \"createdById\": \"005...\",\n    \"createdDate\": \"<datetime>\",\n    \"systemModstamp\": \"<datetime>\",\n    \"state\": \"Open\",\n    \"concurrencyMode\": \"Parallel\",\n    \"contentType\": \"CSV\",\n    \"apiVersion\": 58,\n    \"jobType\": \"Classic\",\n    \"retries\": 0,\n    \"totalProcessingTime\": 0,\n    \"apiActiveProcessingTime\": 0,\n    \"apexProcessingTime\": 0\n}"
    }
  ]
}