Chilkat Online Tools

autoit / Salesforce Platform APIs / Get Sandbox

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

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

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

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

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sV_Type = $oJResp.StringOf("attributes.type")
Local $sV_Url = $oJResp.StringOf("attributes.url")
Local $sId = $oJResp.StringOf("Id")
Local $bIsDeleted = $oJResp.BoolOf("IsDeleted")
Local $sCreatedDate = $oJResp.StringOf("CreatedDate")
Local $sCreatedById = $oJResp.StringOf("CreatedById")
Local $sLastModifiedDate = $oJResp.StringOf("LastModifiedDate")
Local $sLastModifiedById = $oJResp.StringOf("LastModifiedById")
Local $sSystemModstamp = $oJResp.StringOf("SystemModstamp")
Local $sSandboxName = $oJResp.StringOf("SandboxName")
Local $sLicenseType = $oJResp.StringOf("LicenseType")
Local $sTemplateId = $oJResp.StringOf("TemplateId")
Local $iHistoryDays = $oJResp.IntOf("HistoryDays")
Local $bCopyChatter = $oJResp.BoolOf("CopyChatter")
Local $bAutoActivate = $oJResp.BoolOf("AutoActivate")
Local $sApexClassId = $oJResp.StringOf("ApexClassId")
Local $sDescription = $oJResp.StringOf("Description")
Local $sSourceId = $oJResp.StringOf("SourceId")

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