Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_Type
string ls_V_Url
string ls_Id
integer li_IsDeleted
string ls_CreatedDate
string ls_CreatedById
string ls_LastModifiedDate
string ls_LastModifiedById
string ls_SystemModstamp
string ls_SandboxName
string ls_LicenseType
string ls_TemplateId
integer li_HistoryDays
integer li_CopyChatter
integer li_AutoActivate
string ls_ApexClassId
string ls_Description
string ls_SourceId
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// 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
ls_V_Type = loo_JResp.StringOf("attributes.type")
ls_V_Url = loo_JResp.StringOf("attributes.url")
ls_Id = loo_JResp.StringOf("Id")
li_IsDeleted = loo_JResp.BoolOf("IsDeleted")
ls_CreatedDate = loo_JResp.StringOf("CreatedDate")
ls_CreatedById = loo_JResp.StringOf("CreatedById")
ls_LastModifiedDate = loo_JResp.StringOf("LastModifiedDate")
ls_LastModifiedById = loo_JResp.StringOf("LastModifiedById")
ls_SystemModstamp = loo_JResp.StringOf("SystemModstamp")
ls_SandboxName = loo_JResp.StringOf("SandboxName")
ls_LicenseType = loo_JResp.StringOf("LicenseType")
ls_TemplateId = loo_JResp.StringOf("TemplateId")
li_HistoryDays = loo_JResp.IntOf("HistoryDays")
li_CopyChatter = loo_JResp.BoolOf("CopyChatter")
li_AutoActivate = loo_JResp.BoolOf("AutoActivate")
ls_ApexClassId = loo_JResp.StringOf("ApexClassId")
ls_Description = loo_JResp.StringOf("Description")
ls_SourceId = loo_JResp.StringOf("SourceId")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
