Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("q","SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "size": 1,
' "totalSize": 1,
' "done": true,
' "queryLocator": null,
' "entityTypeName": "SandboxInfo",
' "records": [
' {
' "attributes": {
' "type": "SandboxInfo",
' "url": "/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK"
' },
' "Id": "0GQ4H000000CxSzWAK",
' "SandboxName": "devSandbox",
' "LicenseType": "DEVELOPER",
' "AutoActivate": false
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim v_Type As String
Dim v_Url As String
Dim Id As String
Dim SandboxName As String
Dim LicenseType As String
Dim AutoActivate As Long
Dim size As Long
size = jResp.IntOf("size")
Dim totalSize As Long
totalSize = jResp.IntOf("totalSize")
Dim done As Long
done = jResp.BoolOf("done")
Dim queryLocator As String
queryLocator = jResp.StringOf("queryLocator")
Dim entityTypeName As String
entityTypeName = jResp.StringOf("entityTypeName")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("records")
Do While i < count_i
jResp.I = i
v_Type = jResp.StringOf("records[i].attributes.type")
v_Url = jResp.StringOf("records[i].attributes.url")
Id = jResp.StringOf("records[i].Id")
SandboxName = jResp.StringOf("records[i].SandboxName")
LicenseType = jResp.StringOf("records[i].LicenseType")
AutoActivate = jResp.BoolOf("records[i].AutoActivate")
i = i + 1
Loop
Curl Command
curl -G -d "q=SELECT%20Id,%20SandboxName,%20LicenseType,%20AutoActivate%20FROM%20SandboxInfo"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "List Sandboxes",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
"description": "SOQL Query"
}
]
},
"description": "Lists all sandboxes."
},
"response": [
{
"name": "List Sandboxes",
"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 Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
"description": "SOQL Query"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 11 Dec 2023 10:45:22 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=312/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\": 1,\n \"totalSize\": 1,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"SandboxInfo\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"SandboxInfo\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK\"\n },\n \"Id\": \"0GQ4H000000CxSzWAK\",\n \"SandboxName\": \"devSandbox\",\n \"LicenseType\": \"DEVELOPER\",\n \"AutoActivate\": false\n }\n ]\n}"
}
]
}
