Chilkat Online Tools

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

Dim http As New ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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

Dim v_Type As String
v_Type = jResp.StringOf("attributes.type")
Dim v_Url As String
v_Url = jResp.StringOf("attributes.url")
Dim Id As String
Id = jResp.StringOf("Id")
Dim IsDeleted As Long
IsDeleted = jResp.BoolOf("IsDeleted")
Dim CreatedDate As String
CreatedDate = jResp.StringOf("CreatedDate")
Dim CreatedById As String
CreatedById = jResp.StringOf("CreatedById")
Dim LastModifiedDate As String
LastModifiedDate = jResp.StringOf("LastModifiedDate")
Dim LastModifiedById As String
LastModifiedById = jResp.StringOf("LastModifiedById")
Dim SystemModstamp As String
SystemModstamp = jResp.StringOf("SystemModstamp")
Dim SandboxName As String
SandboxName = jResp.StringOf("SandboxName")
Dim LicenseType As String
LicenseType = jResp.StringOf("LicenseType")
Dim TemplateId As String
TemplateId = jResp.StringOf("TemplateId")
Dim HistoryDays As Long
HistoryDays = jResp.IntOf("HistoryDays")
Dim CopyChatter As Long
CopyChatter = jResp.BoolOf("CopyChatter")
Dim AutoActivate As Long
AutoActivate = jResp.BoolOf("AutoActivate")
Dim ApexClassId As String
ApexClassId = jResp.StringOf("ApexClassId")
Dim Description As String
Description = jResp.StringOf("Description")
Dim SourceId As String
SourceId = jResp.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}"
    }
  ]
}