Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Bulk Check Batch Status

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"X-SFDC-Session","{{_accessToken}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Accept-Encoding","gzip")
    CkHttp::ckSetRequestHeader(http,"Content-Encoding","gzip")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    xmlResponse.i = CkXml::ckCreate()
    If xmlResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadSb(xmlResponse,sbResponseBody,1)
    Debug CkXml::ckGetXml(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

    batchInfoList_xmlns.s = CkXml::ckGetAttrValue(xmlResponse,"xmlns")
    id.s = CkXml::ckGetChildContent(xmlResponse,"batchInfo|id")
    jobId.s = CkXml::ckGetChildContent(xmlResponse,"batchInfo|jobId")
    state.s = CkXml::ckGetChildContent(xmlResponse,"batchInfo|state")
    createdDate.s = CkXml::ckGetChildContent(xmlResponse,"batchInfo|createdDate")
    systemModstamp.s = CkXml::ckGetChildContent(xmlResponse,"batchInfo|systemModstamp")
    numberRecordsProcessed.i = CkXml::ckGetChildIntValue(xmlResponse,"batchInfo|numberRecordsProcessed")
    numberRecordsFailed.i = CkXml::ckGetChildIntValue(xmlResponse,"batchInfo|numberRecordsFailed")
    totalProcessingTime.i = CkXml::ckGetChildIntValue(xmlResponse,"batchInfo|totalProcessingTime")
    apiActiveProcessingTime.i = CkXml::ckGetChildIntValue(xmlResponse,"batchInfo|apiActiveProcessingTime")
    apexProcessingTime.i = CkXml::ckGetChildIntValue(xmlResponse,"batchInfo|apexProcessingTime")


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkXml::ckDispose(xmlResponse)


    ProcedureReturn
EndProcedure

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>"
    }
  ]
}