Chilkat Online Tools

TCL / Salesforce Platform APIs / Get Sandbox Status

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "q" "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpParams $http "GET" "https://domain.com/services/data/v{{version}}/tooling/query/" $queryParams $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "size": 2,
#   "totalSize": 2,
#   "done": true,
#   "queryLocator": null,
#   "entityTypeName": "SandboxProcess",
#   "records": [
#     {
#       "attributes": {
#         "type": "SandboxProcess",
#         "url": "/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2pCWAS"
#       },
#       "SandboxName": "devSandbox",
#       "Status": "Processing",
#       "StartDate": "2023-12-13T12:33:56.000+0000"
#     },
#     {
#       "attributes": {
#         "type": "SandboxProcess",
#         "url": "/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2p7WAC"
#       },
#       "SandboxName": "devSandbox",
#       "Status": "Completed",
#       "StartDate": "2023-12-11T10:44:58.000+0000"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set size [CkJsonObject_IntOf $jResp "size"]
set totalSize [CkJsonObject_IntOf $jResp "totalSize"]
set done [CkJsonObject_BoolOf $jResp "done"]
set queryLocator [CkJsonObject_stringOf $jResp "queryLocator"]
set entityTypeName [CkJsonObject_stringOf $jResp "entityTypeName"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "records"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_Type [CkJsonObject_stringOf $jResp "records[i].attributes.type"]
    set v_Url [CkJsonObject_stringOf $jResp "records[i].attributes.url"]
    set SandboxName [CkJsonObject_stringOf $jResp "records[i].SandboxName"]
    set Status [CkJsonObject_stringOf $jResp "records[i].Status"]
    set StartDate [CkJsonObject_stringOf $jResp "records[i].StartDate"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -G -d "q=SELECT%20SandboxName,%20Status,%20StartDate%20FROM%20SandboxProcess%20WHERE%20SandboxInfoId%3D%27%3CSANDBOX_INFO_ID%3E%27%20ORDER%20BY%20StartDate%20DESC%20LIMIT%20200"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "Get Sandbox Status",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "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 SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200",
          "description": "SOQL Query"
        }
      ]
    },
    "description": "Lists all sandboxes."
  },
  "response": [
    {
      "name": "Get Sandbox Status",
      "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 SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='0GQ4H000000CxSzWAK' ORDER BY StartDate DESC LIMIT 200",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='0GQ4H000000CxSzWAK' ORDER BY StartDate DESC LIMIT 200",
              "description": "SOQL Query"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 13 Dec 2023 12:34:55 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=6/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\": 2,\n    \"totalSize\": 2,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"SandboxProcess\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"SandboxProcess\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2pCWAS\"\n            },\n            \"SandboxName\": \"devSandbox\",\n            \"Status\": \"Processing\",\n            \"StartDate\": \"2023-12-13T12:33:56.000+0000\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"SandboxProcess\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2p7WAC\"\n            },\n            \"SandboxName\": \"devSandbox\",\n            \"Status\": \"Completed\",\n            \"StartDate\": \"2023-12-11T10:44:58.000+0000\"\n        }\n    ]\n}"
    }
  ]
}