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
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'q', 'SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId=''<SANDBOX_INFO_ID>'' ORDER BY StartDate DESC LIMIT 200'
-- 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 @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/services/data/v{{version}}/tooling/query/', @queryParams
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 @queryParams
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 @queryParams
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)
-- {
-- "size": 2,
-- "totalSize": 2,
-- "done": true,
-- "queryLocator": null,
-- "entityTypeName": "SandboxProcess",
-- "records": [
-- {
-- "attributes": {
-- "type": "SandboxProcess",
-- "url": "/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2pCWAS"
-- },
-- "SandboxName": "devSandbox",
-- "Status": "Processing",
-- "StartDate": "2023-12-13T12:33:56.000+0000"
-- },
-- {
-- "attributes": {
-- "type": "SandboxProcess",
-- "url": "/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2p7WAC"
-- },
-- "SandboxName": "devSandbox",
-- "Status": "Completed",
-- "StartDate": "2023-12-11T10:44:58.000+0000"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @v_Type nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
DECLARE @SandboxName nvarchar(4000)
DECLARE @Status nvarchar(4000)
DECLARE @StartDate nvarchar(4000)
DECLARE @size int
EXEC sp_OAMethod @jResp, 'IntOf', @size OUT, 'size'
DECLARE @totalSize int
EXEC sp_OAMethod @jResp, 'IntOf', @totalSize OUT, 'totalSize'
DECLARE @done int
EXEC sp_OAMethod @jResp, 'BoolOf', @done OUT, 'done'
DECLARE @queryLocator nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @queryLocator OUT, 'queryLocator'
DECLARE @entityTypeName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @entityTypeName OUT, 'entityTypeName'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'records'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'records[i].attributes.type'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'records[i].attributes.url'
EXEC sp_OAMethod @jResp, 'StringOf', @SandboxName OUT, 'records[i].SandboxName'
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'records[i].Status'
EXEC sp_OAMethod @jResp, 'StringOf', @StartDate OUT, 'records[i].StartDate'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "q=SELECT%20SandboxName,%20Status,%20StartDate%20FROM%20SandboxProcess%20WHERE%20SandboxInfoId%3D%27%3CSANDBOX_INFO_ID%3E%27%20ORDER%20BY%20StartDate%20DESC%20LIMIT%20200"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "Get Sandbox Status",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200",
"description": "SOQL Query"
}
]
},
"description": "Lists all sandboxes."
},
"response": [
{
"name": "Get Sandbox Status",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='0GQ4H000000CxSzWAK' ORDER BY StartDate DESC LIMIT 200",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='0GQ4H000000CxSzWAK' ORDER BY StartDate DESC LIMIT 200",
"description": "SOQL Query"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 13 Dec 2023 12:34:55 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"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=6/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 \"size\": 2,\n \"totalSize\": 2,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"SandboxProcess\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"SandboxProcess\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2pCWAS\"\n },\n \"SandboxName\": \"devSandbox\",\n \"Status\": \"Processing\",\n \"StartDate\": \"2023-12-13T12:33:56.000+0000\"\n },\n {\n \"attributes\": {\n \"type\": \"SandboxProcess\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2p7WAC\"\n },\n \"SandboxName\": \"devSandbox\",\n \"Status\": \"Completed\",\n \"StartDate\": \"2023-12-11T10:44:58.000+0000\"\n }\n ]\n}"
}
]
}
