Chilkat Online Tools

phpAx / Salesforce Platform APIs / Create job

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");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "object": "Asset",
//   "operation": "update"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('object','Asset');
$json->UpdateString('operation','update');

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/services/data/v{{version}}/jobs/ingest','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// 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 = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\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,
//   "contentUrl": "services/data/v58.0/jobs/ingest/750.../batches",
//   "lineEnding": "LF",
//   "columnDelimiter": "COMMA"
// }

// 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');
$contentUrl = $jResp->stringOf('contentUrl');
$lineEnding = $jResp->stringOf('lineEnding');
$columnDelimiter = $jResp->stringOf('columnDelimiter');

?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "object": "Asset",
    "operation": "update"
}'
https://domain.com/services/data/v{{version}}/jobs/ingest

Postman Collection Item JSON

{
  "name": "Create job",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "",
          "const response = JSON.parse(pm.response.text())",
          "context.set(\"_jobId\", response.id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"object\": \"Asset\",\n    \"operation\": \"update\"\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "jobs",
        "ingest"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Create job",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"object\": \"Account\",\n    \"operation\": \"insert\"\n}"
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "jobs",
            "ingest"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 14:58:56 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=1/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    \"contentUrl\": \"services/data/v58.0/jobs/ingest/750.../batches\",\n    \"lineEnding\": \"LF\",\n    \"columnDelimiter\": \"COMMA\"\n}"
    }
  ]
}