Chilkat Online Tools

Perl / Salesforce Platform APIs / Bulk Create Job

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

# The following JSON is sent in the request body.

# {
#   "operation": "insert",
#   "object": "Account",
#   "contentType": "CSV"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("operation","insert");
$json->UpdateString("object","Account");
$json->UpdateString("contentType","CSV");

$http->SetRequestHeader("Accept-Encoding","gzip");
$http->SetRequestHeader("Sforce-Enable-PKChunking","FALSE");
$http->SetRequestHeader("chunkSize","10000");
$http->SetRequestHeader("charset","UTF-8");
$http->SetRequestHeader("X-SFDC-Session","{{_accessToken}}");
$http->SetRequestHeader("Sforce-Disable-Batch-Retry","FALSE");
$http->SetRequestHeader("Sforce-Line-Ending","CRLF");
$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Content-Encoding","gzip");
# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");

# resp is a HttpResponse
$resp = $http->PostJson3("https://domain.com/services/async/{{version}}/job","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

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

# {
#   "apexProcessingTime": 0,
#   "apiActiveProcessingTime": 0,
#   "apiVersion": 58,
#   "assignmentRuleId": null,
#   "concurrencyMode": "Parallel",
#   "contentType": "CSV",
#   "createdById": "005...",
#   "createdDate": "<date_time>",
#   "externalIdFieldName": null,
#   "fastPathEnabled": false,
#   "id": "750...",
#   "numberBatchesCompleted": 0,
#   "numberBatchesFailed": 0,
#   "numberBatchesInProgress": 0,
#   "numberBatchesQueued": 0,
#   "numberBatchesTotal": 0,
#   "numberRecordsFailed": 0,
#   "numberRecordsProcessed": 0,
#   "numberRetries": 0,
#   "object": "<Object>",
#   "operation": "insert",
#   "state": "Open",
#   "systemModstamp": "<date_time>",
#   "totalProcessingTime": 0
# }

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

$apexProcessingTime = $jResp->IntOf("apexProcessingTime");
$apiActiveProcessingTime = $jResp->IntOf("apiActiveProcessingTime");
$apiVersion = $jResp->IntOf("apiVersion");
$assignmentRuleId = $jResp->stringOf("assignmentRuleId");
$concurrencyMode = $jResp->stringOf("concurrencyMode");
$contentType = $jResp->stringOf("contentType");
$createdById = $jResp->stringOf("createdById");
$createdDate = $jResp->stringOf("createdDate");
$externalIdFieldName = $jResp->stringOf("externalIdFieldName");
$fastPathEnabled = $jResp->BoolOf("fastPathEnabled");
$id = $jResp->stringOf("id");
$numberBatchesCompleted = $jResp->IntOf("numberBatchesCompleted");
$numberBatchesFailed = $jResp->IntOf("numberBatchesFailed");
$numberBatchesInProgress = $jResp->IntOf("numberBatchesInProgress");
$numberBatchesQueued = $jResp->IntOf("numberBatchesQueued");
$numberBatchesTotal = $jResp->IntOf("numberBatchesTotal");
$numberRecordsFailed = $jResp->IntOf("numberRecordsFailed");
$numberRecordsProcessed = $jResp->IntOf("numberRecordsProcessed");
$numberRetries = $jResp->IntOf("numberRetries");
$v_object = $jResp->stringOf("object");
$operation = $jResp->stringOf("operation");
$state = $jResp->stringOf("state");
$systemModstamp = $jResp->stringOf("systemModstamp");
$totalProcessingTime = $jResp->IntOf("totalProcessingTime");

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-SFDC-Session: {{_accessToken}}"
	-H "Content-Type: application/json"
	-H "charset: UTF-8"
	-H "Sforce-Disable-Batch-Retry: FALSE"
	-H "Sforce-Line-Ending: CRLF"
	-H "Sforce-Enable-PKChunking: FALSE"
	-H "chunkSize: 10000"
	-H "Accept-Encoding: gzip"
	-H "Content-Encoding: gzip"
	-d '{
    "operation": "insert",
    "object": "Account",
    "contentType": "CSV"
}'
https://domain.com/services/async/{{version}}/job

Postman Collection Item JSON

{
  "name": "Bulk Create Job",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "",
          "const contentType = pm.response.headers.get(\"Content-Type\");",
          "if (contentType.indexOf(\"xml\") !== -1) {",
          "    const jsonData = xml2Json(pm.response.text());",
          "    context.set(\"_jobId\", jsonData['jobInfo']['id']);    ",
          "}",
          "else if (contentType.indexOf(\"json\") !== -1) {",
          "    const jsonData = pm.response.json();",
          "    context.set(\"_jobId\", jsonData.id);",
          "}",
          "",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-SFDC-Session",
        "value": "{{_accessToken}}"
      },
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "charset",
        "value": "UTF-8"
      },
      {
        "key": "Sforce-Disable-Batch-Retry",
        "value": "FALSE",
        "disabled": true
      },
      {
        "key": "Sforce-Line-Ending",
        "value": "CRLF",
        "disabled": true
      },
      {
        "key": "Sforce-Enable-PKChunking",
        "value": "FALSE",
        "disabled": true
      },
      {
        "key": "chunkSize",
        "value": "10000",
        "type": "text",
        "disabled": true
      },
      {
        "key": "Accept-Encoding",
        "value": "gzip",
        "disabled": true
      },
      {
        "key": "Content-Encoding",
        "value": "gzip",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"operation\": \"insert\",\n    \"object\": \"Account\",\n    \"contentType\": \"CSV\"\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/async/{{version}}/job",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "async",
        "{{version}}",
        "job"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Bulk Create Job",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "X-SFDC-Session",
            "value": "{{_accessToken}}"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "charset",
            "value": "UTF-8"
          },
          {
            "key": "Sforce-Disable-Batch-Retry",
            "value": "FALSE",
            "disabled": true
          },
          {
            "key": "Sforce-Line-Ending",
            "value": "CRLF",
            "disabled": true
          },
          {
            "key": "Sforce-Enable-PKChunking",
            "value": "FALSE",
            "disabled": true
          },
          {
            "key": "chunkSize",
            "value": "10000",
            "disabled": true
          },
          {
            "key": "Accept-Encoding",
            "value": "gzip",
            "disabled": true
          },
          {
            "key": "Content-Encoding",
            "value": "gzip",
            "disabled": true
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"operation\" : \"insert\",\n  \"object\" : \"Account\",\n  \"contentType\" : \"CSV\"\n}"
        },
        "url": {
          "raw": "{{_endpoint}}/services/async/{{version}}/job",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "async",
            "{{version}}",
            "job"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 16:07:11 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": "Location",
          "value": "/services/async/58.0/job/7502o00000kjNCsAAM"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"apexProcessingTime\": 0,\n    \"apiActiveProcessingTime\": 0,\n    \"apiVersion\": 58,\n    \"assignmentRuleId\": null,\n    \"concurrencyMode\": \"Parallel\",\n    \"contentType\": \"CSV\",\n    \"createdById\": \"005...\",\n    \"createdDate\": \"<date_time>\",\n    \"externalIdFieldName\": null,\n    \"fastPathEnabled\": false,\n    \"id\": \"750...\",\n    \"numberBatchesCompleted\": 0,\n    \"numberBatchesFailed\": 0,\n    \"numberBatchesInProgress\": 0,\n    \"numberBatchesQueued\": 0,\n    \"numberBatchesTotal\": 0,\n    \"numberRecordsFailed\": 0,\n    \"numberRecordsProcessed\": 0,\n    \"numberRetries\": 0,\n    \"object\": \"<Object>\",\n    \"operation\": \"insert\",\n    \"state\": \"Open\",\n    \"systemModstamp\": \"<date_time>\",\n    \"totalProcessingTime\": 0\n}"
    }
  ]
}