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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
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/data/v{{version}}/jobs/ingest/{{_jobId}}', @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 @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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "id": "750...",
-- "operation": "insert",
-- "object": "Asset",
-- "createdById": "005...",
-- "createdDate": "<datetime>",
-- "systemModstamp": "<datetime>",
-- "state": "JobComplete",
-- "concurrencyMode": "Parallel",
-- "contentType": "CSV",
-- "apiVersion": 58,
-- "jobType": "V2Ingest",
-- "lineEnding": "LF",
-- "columnDelimiter": "COMMA",
-- "numberRecordsProcessed": 1,
-- "numberRecordsFailed": 1,
-- "retries": 0,
-- "totalProcessingTime": 100,
-- "apiActiveProcessingTime": 43,
-- "apexProcessingTime": 0
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @operation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @operation OUT, 'operation'
DECLARE @v_object nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_object OUT, 'object'
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 @systemModstamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @systemModstamp OUT, 'systemModstamp'
DECLARE @state nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @state OUT, 'state'
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 @apiVersion int
EXEC sp_OAMethod @jResp, 'IntOf', @apiVersion OUT, 'apiVersion'
DECLARE @jobType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @jobType OUT, 'jobType'
DECLARE @lineEnding nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lineEnding OUT, 'lineEnding'
DECLARE @columnDelimiter nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @columnDelimiter OUT, 'columnDelimiter'
DECLARE @numberRecordsProcessed int
EXEC sp_OAMethod @jResp, 'IntOf', @numberRecordsProcessed OUT, 'numberRecordsProcessed'
DECLARE @numberRecordsFailed int
EXEC sp_OAMethod @jResp, 'IntOf', @numberRecordsFailed OUT, 'numberRecordsFailed'
DECLARE @retries int
EXEC sp_OAMethod @jResp, 'IntOf', @retries OUT, 'retries'
DECLARE @totalProcessingTime int
EXEC sp_OAMethod @jResp, 'IntOf', @totalProcessingTime OUT, 'totalProcessingTime'
DECLARE @apiActiveProcessingTime int
EXEC sp_OAMethod @jResp, 'IntOf', @apiActiveProcessingTime OUT, 'apiActiveProcessingTime'
DECLARE @apexProcessingTime int
EXEC sp_OAMethod @jResp, 'IntOf', @apexProcessingTime OUT, 'apexProcessingTime'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/jobs/ingest/{{_jobId}}
Postman Collection Item JSON
{
"name": "Get Job Info",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest/{{_jobId}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"jobs",
"ingest",
"{{_jobId}}"
]
}
},
"response": [
{
"name": "Successful Get Job Info",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/jobs/ingest/{{_jobId}}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"jobs",
"ingest",
"{{_jobId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:03:34 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": "Sforce-Limit-Info",
"value": "api-usage=8/15000"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"id\": \"750...\",\n \"operation\": \"insert\",\n \"object\": \"Asset\",\n \"createdById\": \"005...\",\n \"createdDate\": \"<datetime>\",\n \"systemModstamp\": \"<datetime>\",\n \"state\": \"JobComplete\",\n \"concurrencyMode\": \"Parallel\",\n \"contentType\": \"CSV\",\n \"apiVersion\": 58,\n \"jobType\": \"V2Ingest\",\n \"lineEnding\": \"LF\",\n \"columnDelimiter\": \"COMMA\",\n \"numberRecordsProcessed\": 1,\n \"numberRecordsFailed\": 1,\n \"retries\": 0,\n \"totalProcessingTime\": 100,\n \"apiActiveProcessingTime\": 43,\n \"apexProcessingTime\": 0\n}"
}
]
}
