Chilkat Online Tools

autoit / Salesforce Platform APIs / List Sandboxes

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("q","SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sV_Type
Local $sV_Url
Local $sId
Local $sSandboxName
Local $sLicenseType
Local $bAutoActivate

Local $iSize = $oJResp.IntOf("size")
Local $iTotalSize = $oJResp.IntOf("totalSize")
Local $bDone = $oJResp.BoolOf("done")
Local $sQueryLocator = $oJResp.StringOf("queryLocator")
Local $sEntityTypeName = $oJResp.StringOf("entityTypeName")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("records")
While $i < $iCount_i
    $oJResp.I = $i
    $sV_Type = $oJResp.StringOf("records[i].attributes.type")
    $sV_Url = $oJResp.StringOf("records[i].attributes.url")
    $sId = $oJResp.StringOf("records[i].Id")
    $sSandboxName = $oJResp.StringOf("records[i].SandboxName")
    $sLicenseType = $oJResp.StringOf("records[i].LicenseType")
    $bAutoActivate = $oJResp.BoolOf("records[i].AutoActivate")
    $i = $i + 1
Wend

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}"
    }
  ]
}