Chilkat Online Tools

TCL / Salesforce Platform APIs / Get Sandbox

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]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

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

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

# 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

set v_Type [CkJsonObject_stringOf $jResp "attributes.type"]
set v_Url [CkJsonObject_stringOf $jResp "attributes.url"]
set Id [CkJsonObject_stringOf $jResp "Id"]
set IsDeleted [CkJsonObject_BoolOf $jResp "IsDeleted"]
set CreatedDate [CkJsonObject_stringOf $jResp "CreatedDate"]
set CreatedById [CkJsonObject_stringOf $jResp "CreatedById"]
set LastModifiedDate [CkJsonObject_stringOf $jResp "LastModifiedDate"]
set LastModifiedById [CkJsonObject_stringOf $jResp "LastModifiedById"]
set SystemModstamp [CkJsonObject_stringOf $jResp "SystemModstamp"]
set SandboxName [CkJsonObject_stringOf $jResp "SandboxName"]
set LicenseType [CkJsonObject_stringOf $jResp "LicenseType"]
set TemplateId [CkJsonObject_stringOf $jResp "TemplateId"]
set HistoryDays [CkJsonObject_IntOf $jResp "HistoryDays"]
set CopyChatter [CkJsonObject_BoolOf $jResp "CopyChatter"]
set AutoActivate [CkJsonObject_BoolOf $jResp "AutoActivate"]
set ApexClassId [CkJsonObject_stringOf $jResp "ApexClassId"]
set Description [CkJsonObject_stringOf $jResp "Description"]
set SourceId [CkJsonObject_stringOf $jResp "SourceId"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
    }
  ]
}