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
DECLARE @iTmp0 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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "state": "Closed"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'state', 'Closed'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-SFDC-Session', '{{_accessToken}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept-Encoding', 'gzip'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'charset', 'UTF-8'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Encoding', 'gzip'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/async/{{version}}/job/{{_jobId}}', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
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 @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "apexProcessingTime": 64,
-- "apiActiveProcessingTime": 225,
-- "apiVersion": 58,
-- "assignmentRuleId": null,
-- "concurrencyMode": "Parallel",
-- "contentType": "CSV",
-- "createdById": "005...",
-- "createdDate": "<date_time>",
-- "externalIdFieldName": null,
-- "fastPathEnabled": false,
-- "id": "750...",
-- "numberBatchesCompleted": 1,
-- "numberBatchesFailed": 0,
-- "numberBatchesInProgress": 0,
-- "numberBatchesQueued": 0,
-- "numberBatchesTotal": 1,
-- "numberRecordsFailed": 0,
-- "numberRecordsProcessed": 1,
-- "numberRetries": 0,
-- "object": "<Object>",
-- "operation": "insert",
-- "state": "Closed",
-- "systemModstamp": "<date_time>",
-- "totalProcessingTime": 403
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @apexProcessingTime int
EXEC sp_OAMethod @jResp, 'IntOf', @apexProcessingTime OUT, 'apexProcessingTime'
DECLARE @apiActiveProcessingTime int
EXEC sp_OAMethod @jResp, 'IntOf', @apiActiveProcessingTime OUT, 'apiActiveProcessingTime'
DECLARE @apiVersion int
EXEC sp_OAMethod @jResp, 'IntOf', @apiVersion OUT, 'apiVersion'
DECLARE @assignmentRuleId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @assignmentRuleId OUT, 'assignmentRuleId'
DECLARE @concurrencyMode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @concurrencyMode OUT, 'concurrencyMode'
DECLARE @contentType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @contentType OUT, 'contentType'
DECLARE @createdById nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @createdById OUT, 'createdById'
DECLARE @createdDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @createdDate OUT, 'createdDate'
DECLARE @externalIdFieldName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @externalIdFieldName OUT, 'externalIdFieldName'
DECLARE @fastPathEnabled int
EXEC sp_OAMethod @jResp, 'BoolOf', @fastPathEnabled OUT, 'fastPathEnabled'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @numberBatchesCompleted int
EXEC sp_OAMethod @jResp, 'IntOf', @numberBatchesCompleted OUT, 'numberBatchesCompleted'
DECLARE @numberBatchesFailed int
EXEC sp_OAMethod @jResp, 'IntOf', @numberBatchesFailed OUT, 'numberBatchesFailed'
DECLARE @numberBatchesInProgress int
EXEC sp_OAMethod @jResp, 'IntOf', @numberBatchesInProgress OUT, 'numberBatchesInProgress'
DECLARE @numberBatchesQueued int
EXEC sp_OAMethod @jResp, 'IntOf', @numberBatchesQueued OUT, 'numberBatchesQueued'
DECLARE @numberBatchesTotal int
EXEC sp_OAMethod @jResp, 'IntOf', @numberBatchesTotal OUT, 'numberBatchesTotal'
DECLARE @numberRecordsFailed int
EXEC sp_OAMethod @jResp, 'IntOf', @numberRecordsFailed OUT, 'numberRecordsFailed'
DECLARE @numberRecordsProcessed int
EXEC sp_OAMethod @jResp, 'IntOf', @numberRecordsProcessed OUT, 'numberRecordsProcessed'
DECLARE @numberRetries int
EXEC sp_OAMethod @jResp, 'IntOf', @numberRetries OUT, 'numberRetries'
DECLARE @v_object nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_object OUT, 'object'
DECLARE @operation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @operation OUT, 'operation'
DECLARE @state nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @state OUT, 'state'
DECLARE @systemModstamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @systemModstamp OUT, 'systemModstamp'
DECLARE @totalProcessingTime int
EXEC sp_OAMethod @jResp, 'IntOf', @totalProcessingTime OUT, 'totalProcessingTime'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-SFDC-Session: {{_accessToken}}"
-H "Content-Type: application/json"
-H "charset: UTF-8"
-H "Accept-Encoding: gzip"
-H "Content-Encoding: gzip"
-d '{
"state" : "Closed"
}'
https://domain.com/services/async/{{version}}/job/{{_jobId}}
Postman Collection Item JSON
{
"name": "Bulk Close Job",
"request": {
"method": "POST",
"header": [
{
"key": "X-SFDC-Session",
"value": "{{_accessToken}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "Accept-Encoding",
"value": "gzip",
"disabled": true
},
{
"key": "Content-Encoding",
"value": "gzip",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"state\" : \"Closed\"\n}"
},
"url": {
"raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"async",
"{{version}}",
"job",
"{{_jobId}}"
]
}
},
"response": [
{
"name": "Successful Bulk Close Job",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-SFDC-Session",
"value": "{{_accessToken}}"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "charset",
"value": "UTF-8"
},
{
"key": "Accept-Encoding",
"value": "gzip",
"disabled": true
},
{
"key": "Content-Encoding",
"value": "gzip",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"state\" : \"Closed\"\n}"
},
"url": {
"raw": "{{_endpoint}}/services/async/{{version}}/job/{{_jobId}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"async",
"{{version}}",
"job",
"{{_jobId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 16:23:52 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/json"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"apexProcessingTime\": 64,\n \"apiActiveProcessingTime\": 225,\n \"apiVersion\": 58,\n \"assignmentRuleId\": null,\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"createdById\": \"005...\",\n \"createdDate\": \"<date_time>\",\n \"externalIdFieldName\": null,\n \"fastPathEnabled\": false,\n \"id\": \"750...\",\n \"numberBatchesCompleted\": 1,\n \"numberBatchesFailed\": 0,\n \"numberBatchesInProgress\": 0,\n \"numberBatchesQueued\": 0,\n \"numberBatchesTotal\": 1,\n \"numberRecordsFailed\": 0,\n \"numberRecordsProcessed\": 1,\n \"numberRetries\": 0,\n \"object\": \"<Object>\",\n \"operation\": \"insert\",\n \"state\": \"Closed\",\n \"systemModstamp\": \"<date_time>\",\n \"totalProcessingTime\": 403\n}"
}
]
}
