Chilkat Online Tools

TCL / Salesforce Platform APIs / Bulk Check Batch Status

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "X-SFDC-Session" "{{_accessToken}}"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Accept-Encoding" "gzip"
CkHttp_SetRequestHeader $http "Content-Encoding" "gzip"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set xmlResponse [new_CkXml]

CkXml_LoadSb $xmlResponse $sbResponseBody 1
puts [CkXml_getXml $xmlResponse]

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

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

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

set batchInfoList_xmlns [CkXml_getAttrValue $xmlResponse "xmlns"]
set id [CkXml_getChildContent $xmlResponse "batchInfo|id"]
set jobId [CkXml_getChildContent $xmlResponse "batchInfo|jobId"]
set state [CkXml_getChildContent $xmlResponse "batchInfo|state"]
set createdDate [CkXml_getChildContent $xmlResponse "batchInfo|createdDate"]
set systemModstamp [CkXml_getChildContent $xmlResponse "batchInfo|systemModstamp"]
set numberRecordsProcessed [CkXml_GetChildIntValue $xmlResponse "batchInfo|numberRecordsProcessed"]
set numberRecordsFailed [CkXml_GetChildIntValue $xmlResponse "batchInfo|numberRecordsFailed"]
set totalProcessingTime [CkXml_GetChildIntValue $xmlResponse "batchInfo|totalProcessingTime"]
set apiActiveProcessingTime [CkXml_GetChildIntValue $xmlResponse "batchInfo|apiActiveProcessingTime"]
set apexProcessingTime [CkXml_GetChildIntValue $xmlResponse "batchInfo|apexProcessingTime"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkXml $xmlResponse

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "X-SFDC-Session: {{_accessToken}}"
	-H "Accept-Encoding: gzip"
	-H "Content-Encoding: gzip"
https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch

Postman Collection Item JSON

{
  "name": "Bulk Check Batch Status",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "X-SFDC-Session",
        "value": "{{_accessToken}}"
      },
      {
        "key": "Accept-Encoding",
        "value": "gzip"
      },
      {
        "key": "Content-Encoding",
        "value": "gzip"
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}/batch",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "async",
        "{{version}}",
        "job",
        "{{_jobId}}",
        "batch"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Bulk Check Batch Status",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "X-SFDC-Session",
            "value": "{{_accessToken}}"
          },
          {
            "key": "Accept-Encoding",
            "value": "gzip"
          },
          {
            "key": "Content-Encoding",
            "value": "gzip"
          }
        ],
        "url": {
          "raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}/batch",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "async",
            "{{version}}",
            "job",
            "{{_jobId}}",
            "batch"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "xml",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 16:19:29 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": "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<batchInfoList\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <batchInfo>\n        <id>751...</id>\n        <jobId>750...</jobId>\n        <state>Completed</state>\n        <createdDate>datetime</createdDate>\n        <systemModstamp>datetime</systemModstamp>\n        <numberRecordsProcessed>1</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>403</totalProcessingTime>\n        <apiActiveProcessingTime>225</apiActiveProcessingTime>\n        <apexProcessingTime>64</apexProcessingTime>\n    </batchInfo>\n</batchInfoList>"
    }
  ]
}