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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID', @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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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)
-- {
-- "attributes": {
-- "type": "SandboxInfo",
-- "url": "/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK"
-- },
-- "Id": "0GQ4H000000CxSzWAK",
-- "IsDeleted": false,
-- "CreatedDate": "2023-12-11T10:44:58.000+0000",
-- "CreatedById": "00558000000yFyDAAU",
-- "LastModifiedDate": "2023-12-11T10:44:58.000+0000",
-- "LastModifiedById": "00558000000yFyDAAU",
-- "SystemModstamp": "2023-12-11T10:44:58.000+0000",
-- "SandboxName": "devSandbox",
-- "LicenseType": "DEVELOPER",
-- "TemplateId": null,
-- "HistoryDays": 0,
-- "CopyChatter": false,
-- "AutoActivate": false,
-- "ApexClassId": null,
-- "Description": "My new fresh sandbox",
-- "SourceId": null
-- }
-- 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)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'attributes.type'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'attributes.url'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'Id'
DECLARE @IsDeleted int
EXEC sp_OAMethod @jResp, 'BoolOf', @IsDeleted OUT, 'IsDeleted'
DECLARE @CreatedDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedDate OUT, 'CreatedDate'
DECLARE @CreatedById nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedById OUT, 'CreatedById'
DECLARE @LastModifiedDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastModifiedDate OUT, 'LastModifiedDate'
DECLARE @LastModifiedById nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastModifiedById OUT, 'LastModifiedById'
DECLARE @SystemModstamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SystemModstamp OUT, 'SystemModstamp'
DECLARE @SandboxName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SandboxName OUT, 'SandboxName'
DECLARE @LicenseType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LicenseType OUT, 'LicenseType'
DECLARE @TemplateId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TemplateId OUT, 'TemplateId'
DECLARE @HistoryDays int
EXEC sp_OAMethod @jResp, 'IntOf', @HistoryDays OUT, 'HistoryDays'
DECLARE @CopyChatter int
EXEC sp_OAMethod @jResp, 'BoolOf', @CopyChatter OUT, 'CopyChatter'
DECLARE @AutoActivate int
EXEC sp_OAMethod @jResp, 'BoolOf', @AutoActivate OUT, 'AutoActivate'
DECLARE @ApexClassId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ApexClassId OUT, 'ApexClassId'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'Description'
DECLARE @SourceId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SourceId OUT, 'SourceId'
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>"
https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID
Postman Collection Item JSON
{
"name": "Get Sandbox",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"SandboxInfo",
":SANDBOX_INFO_ID"
],
"variable": [
{
"key": "SANDBOX_INFO_ID",
"value": ""
}
]
},
"description": "Retrieves a sandbox record."
},
"response": [
{
"name": "Get Sandbox",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"SandboxInfo",
":SANDBOX_INFO_ID"
],
"variable": [
{
"key": "SANDBOX_INFO_ID",
"value": "0GQ4H000000CxSzWAK"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 11 Dec 2023 10:45:48 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=316/15000"
},
{
"key": "Last-Modified",
"value": "Mon, 11 Dec 2023 10:44:58 GMT"
},
{
"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 \"attributes\": {\n \"type\": \"SandboxInfo\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK\"\n },\n \"Id\": \"0GQ4H000000CxSzWAK\",\n \"IsDeleted\": false,\n \"CreatedDate\": \"2023-12-11T10:44:58.000+0000\",\n \"CreatedById\": \"00558000000yFyDAAU\",\n \"LastModifiedDate\": \"2023-12-11T10:44:58.000+0000\",\n \"LastModifiedById\": \"00558000000yFyDAAU\",\n \"SystemModstamp\": \"2023-12-11T10:44:58.000+0000\",\n \"SandboxName\": \"devSandbox\",\n \"LicenseType\": \"DEVELOPER\",\n \"TemplateId\": null,\n \"HistoryDays\": 0,\n \"CopyChatter\": false,\n \"AutoActivate\": false,\n \"ApexClassId\": null,\n \"Description\": \"My new fresh sandbox\",\n \"SourceId\": null\n}"
}
]
}
