Chilkat Online Tools

PowerBuilder / Salesforce Platform APIs / Bulk Retrieve Batch Result Data

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("X-SFDC-Session","{{_accessToken}}")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Accept-Encoding","gzip")
loo_Http.SetRequestHeader("Content-Encoding","gzip")

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch/{{_batchId}}/result/:batchResultId",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

Write-Debug "Response status code = " + string(loo_Http.LastStatus)
Write-Debug loo_SbResponseBody.GetAsString()


destroy loo_Http
destroy loo_SbResponseBody

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/{{_batchId}}/result/:batchResultId

Postman Collection Item JSON

{
  "name": "Bulk Retrieve Batch Result Data",
  "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/{{_batchId}}/result/:batchResultId",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "async",
        "{{version}}",
        "job",
        "{{_jobId}}",
        "batch",
        "{{_batchId}}",
        "result",
        ":batchResultId"
      ],
      "variable": [
        {
          "key": "batchResultId",
          "value": null
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful Bulk Retrieve Batch Result Data",
      "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/{{_batchId}}/result/:batchResultId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "async",
            "{{version}}",
            "job",
            "{{_jobId}}",
            "batch",
            "{{_batchId}}",
            "result",
            ":batchResultId"
          ],
          "variable": [
            {
              "key": "batchResultId",
              "value": "7522o00000PATNY"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "plain",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 16:36:36 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": "text/csv; charset=UTF-8"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "\"Id\",\"Name\"\n\"001...\",\"GenePoint\"\n\"001...\",\"United Oil & Gas, UK\"\n\"001...\",\"United Oil & Gas, Singapore\"\n\"001...\",\"Edge Communications\"\n\"001...\",\"Burlington Textiles Corp of America\"\n\"001...\",\"Pyramid Construction Inc.\"\n\"001...\",\"Dickenson plc\"\n\"001...\",\"Grand Hotels & Resorts Ltd\"\n\"001...\",\"Express Logistics and Transport\"\n\"001...\",\"University of Arizona\"\n\"001...\",\"United Oil & Gas Corp.\"\n\"001...\",\"sForce\"\n\"001...\",\"Exemple de comptes pour les autorisations\"\n\"001...\",\"Tom Jones\"\n"
    }
  ]
}