Chilkat Online Tools

phpExt / Salesforce Platform APIs / Bulk Create Batch

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$bdRequestBody = new CkBinData();
$success = $bdRequestBody->LoadFile('file');
if ($success != true) {
    print 'Failed to load file' . "\n";
    exit;
}

$http->SetRequestHeader('X-SFDC-Session','{{_accessToken}}');
$http->SetRequestHeader('Accept-Encoding','gzip');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('charset','UTF-8');
$http->SetRequestHeader('Content-Encoding','gzip');

// resp is a CkHttpResponse
$resp = $http->PBinaryBd('POST','https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch',$bdRequestBody,'zip/csv',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

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

$xmlResponse = new CkXml();
$xmlResponse->LoadSb($sbResponseBody,true);
print $xmlResponse->getXml() . "\n";

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

// <?xml version="1.0" encoding="UTF-8"?>
// <batchInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">
//     <id>751...</id>
//     <jobId>750...</jobId>
//     <state>Queued</state>
//     <createdDate>datetime</createdDate>
//     <systemModstamp>datetime</systemModstamp>
//     <numberRecordsProcessed>0</numberRecordsProcessed>
//     <numberRecordsFailed>0</numberRecordsFailed>
//     <totalProcessingTime>0</totalProcessingTime>
//     <apiActiveProcessingTime>0</apiActiveProcessingTime>
//     <apexProcessingTime>0</apexProcessingTime>
// </batchInfo>

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

$batchInfo_xmlns = $xmlResponse->getAttrValue('xmlns');
$id = $xmlResponse->getChildContent('id');
$jobId = $xmlResponse->getChildContent('jobId');
$state = $xmlResponse->getChildContent('state');
$createdDate = $xmlResponse->getChildContent('createdDate');
$systemModstamp = $xmlResponse->getChildContent('systemModstamp');
$numberRecordsProcessed = $xmlResponse->GetChildIntValue('numberRecordsProcessed');
$numberRecordsFailed = $xmlResponse->GetChildIntValue('numberRecordsFailed');
$totalProcessingTime = $xmlResponse->GetChildIntValue('totalProcessingTime');
$apiActiveProcessingTime = $xmlResponse->GetChildIntValue('apiActiveProcessingTime');
$apexProcessingTime = $xmlResponse->GetChildIntValue('apexProcessingTime');

?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-SFDC-Session: {{_accessToken}}"
	-H "Content-Type: text/csv"
	-H "Content-Type: zip/csv"
	-H "charset: UTF-8"
	-H "Accept-Encoding: gzip"
	-H "Content-Encoding: gzip"
	--data-binary '@file'
https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch

Postman Collection Item JSON

{
  "name": "Bulk Create Batch",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "",
          "var xmlTree = xml2Json(pm.response.text());",
          "console.log(xmlTree);",
          "context.set(\"_batchId\", xmlTree['batchInfo']['id']);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-SFDC-Session",
        "value": "{{_accessToken}}"
      },
      {
        "key": "Content-Type",
        "value": "text/csv"
      },
      {
        "key": "Content-Type",
        "value": "zip/csv",
        "disabled": true
      },
      {
        "key": "charset",
        "value": "UTF-8"
      },
      {
        "key": "Accept-Encoding",
        "value": "gzip",
        "disabled": true
      },
      {
        "key": "Content-Encoding",
        "value": "gzip",
        "disabled": true
      }
    ],
    "body": {
      "mode": "file",
      "file": {
        "src": ""
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}/batch",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "async",
        "{{version}}",
        "job",
        "{{_jobId}}",
        "batch"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Bulk Create Batch",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "X-SFDC-Session",
            "value": "{{_accessToken}}"
          },
          {
            "key": "Content-Type",
            "value": "text/csv"
          },
          {
            "key": "Content-Type",
            "value": "zip/csv",
            "disabled": true
          },
          {
            "key": "charset",
            "value": "UTF-8"
          },
          {
            "key": "Accept-Encoding",
            "value": "gzip",
            "disabled": true
          },
          {
            "key": "Content-Encoding",
            "value": "gzip",
            "disabled": true
          }
        ],
        "body": {
          "mode": "file",
          "file": {
            "src": "/Users/username/Downloads/account.csv"
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}/batch",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "async",
            "{{version}}",
            "job",
            "{{_jobId}}",
            "batch"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "xml",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 16:16:10 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/batch/7512o00001DSJWnAAP"
        },
        {
          "key": "Content-Type",
          "value": "application/xml"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfo\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <id>751...</id>\n    <jobId>750...</jobId>\n    <state>Queued</state>\n    <createdDate>datetime</createdDate>\n    <systemModstamp>datetime</systemModstamp>\n    <numberRecordsProcessed>0</numberRecordsProcessed>\n    <numberRecordsFailed>0</numberRecordsFailed>\n    <totalProcessingTime>0</totalProcessingTime>\n    <apiActiveProcessingTime>0</apiActiveProcessingTime>\n    <apexProcessingTime>0</apexProcessingTime>\n</batchInfo>"
    }
  ]
}