Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Get Sandbox

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcV_Url
LOCAL lcId
LOCAL lnIsDeleted
LOCAL lcCreatedDate
LOCAL lcCreatedById
LOCAL lcLastModifiedDate
LOCAL lcLastModifiedById
LOCAL lcSystemModstamp
LOCAL lcSandboxName
LOCAL lcLicenseType
LOCAL lcTemplateId
LOCAL lnHistoryDays
LOCAL lnCopyChatter
LOCAL lnAutoActivate
LOCAL lcApexClassId
LOCAL lcDescription
LOCAL lcSourceId

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

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

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
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

lcV_Type = loJResp.StringOf("attributes.type")
lcV_Url = loJResp.StringOf("attributes.url")
lcId = loJResp.StringOf("Id")
lnIsDeleted = loJResp.BoolOf("IsDeleted")
lcCreatedDate = loJResp.StringOf("CreatedDate")
lcCreatedById = loJResp.StringOf("CreatedById")
lcLastModifiedDate = loJResp.StringOf("LastModifiedDate")
lcLastModifiedById = loJResp.StringOf("LastModifiedById")
lcSystemModstamp = loJResp.StringOf("SystemModstamp")
lcSandboxName = loJResp.StringOf("SandboxName")
lcLicenseType = loJResp.StringOf("LicenseType")
lcTemplateId = loJResp.StringOf("TemplateId")
lnHistoryDays = loJResp.IntOf("HistoryDays")
lnCopyChatter = loJResp.BoolOf("CopyChatter")
lnAutoActivate = loJResp.BoolOf("AutoActivate")
lcApexClassId = loJResp.StringOf("ApexClassId")
lcDescription = loJResp.StringOf("Description")
lcSourceId = loJResp.StringOf("SourceId")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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