Chilkat Online Tools

lianja / 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.

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("q","SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loQueryParams
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lnSize = loJResp.IntOf("size")
lnTotalSize = loJResp.IntOf("totalSize")
llDone = loJResp.BoolOf("done")
lcQueryLocator = loJResp.StringOf("queryLocator")
lcEntityTypeName = loJResp.StringOf("entityTypeName")
i = 0
lnCount_i = loJResp.SizeOfArray("records")
do while i < lnCount_i
    loJResp.I = i
    lcV_Type = loJResp.StringOf("records[i].attributes.type")
    lcV_Url = loJResp.StringOf("records[i].attributes.url")
    lcId = loJResp.StringOf("records[i].Id")
    lcSandboxName = loJResp.StringOf("records[i].SandboxName")
    lcLicenseType = loJResp.StringOf("records[i].LicenseType")
    llAutoActivate = loJResp.BoolOf("records[i].AutoActivate")
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJResp

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