Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-SFDC-Session', '{{_accessToken}}'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept-Encoding', 'gzip'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Encoding', 'gzip'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/async/{{version}}/job/{{_jobId}}/batch', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @xmlResponse int
-- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Xml', @xmlResponse OUT
EXEC sp_OAMethod @xmlResponse, 'LoadSb', @success OUT, @sbResponseBody, 1
EXEC sp_OAMethod @xmlResponse, 'GetXml', @sTmp0 OUT
PRINT @sTmp0
-- 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
DECLARE @batchInfoList_xmlns nvarchar(4000)
EXEC sp_OAMethod @xmlResponse, 'GetAttrValue', @batchInfoList_xmlns OUT, 'xmlns'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @xmlResponse, 'GetChildContent', @id OUT, 'batchInfo|id'
DECLARE @jobId nvarchar(4000)
EXEC sp_OAMethod @xmlResponse, 'GetChildContent', @jobId OUT, 'batchInfo|jobId'
DECLARE @state nvarchar(4000)
EXEC sp_OAMethod @xmlResponse, 'GetChildContent', @state OUT, 'batchInfo|state'
DECLARE @createdDate nvarchar(4000)
EXEC sp_OAMethod @xmlResponse, 'GetChildContent', @createdDate OUT, 'batchInfo|createdDate'
DECLARE @systemModstamp nvarchar(4000)
EXEC sp_OAMethod @xmlResponse, 'GetChildContent', @systemModstamp OUT, 'batchInfo|systemModstamp'
DECLARE @numberRecordsProcessed int
EXEC sp_OAMethod @xmlResponse, 'GetChildIntValue', @numberRecordsProcessed OUT, 'batchInfo|numberRecordsProcessed'
DECLARE @numberRecordsFailed int
EXEC sp_OAMethod @xmlResponse, 'GetChildIntValue', @numberRecordsFailed OUT, 'batchInfo|numberRecordsFailed'
DECLARE @totalProcessingTime int
EXEC sp_OAMethod @xmlResponse, 'GetChildIntValue', @totalProcessingTime OUT, 'batchInfo|totalProcessingTime'
DECLARE @apiActiveProcessingTime int
EXEC sp_OAMethod @xmlResponse, 'GetChildIntValue', @apiActiveProcessingTime OUT, 'batchInfo|apiActiveProcessingTime'
DECLARE @apexProcessingTime int
EXEC sp_OAMethod @xmlResponse, 'GetChildIntValue', @apexProcessingTime OUT, 'batchInfo|apexProcessingTime'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @xmlResponse
END
GO
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>"
}
]
}
