Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
v_Type.s = CkJsonObject::ckStringOf(jResp,"attributes.type")
v_Url.s = CkJsonObject::ckStringOf(jResp,"attributes.url")
Id.s = CkJsonObject::ckStringOf(jResp,"Id")
IsDeleted.i = CkJsonObject::ckBoolOf(jResp,"IsDeleted")
CreatedDate.s = CkJsonObject::ckStringOf(jResp,"CreatedDate")
CreatedById.s = CkJsonObject::ckStringOf(jResp,"CreatedById")
LastModifiedDate.s = CkJsonObject::ckStringOf(jResp,"LastModifiedDate")
LastModifiedById.s = CkJsonObject::ckStringOf(jResp,"LastModifiedById")
SystemModstamp.s = CkJsonObject::ckStringOf(jResp,"SystemModstamp")
SandboxName.s = CkJsonObject::ckStringOf(jResp,"SandboxName")
LicenseType.s = CkJsonObject::ckStringOf(jResp,"LicenseType")
TemplateId.s = CkJsonObject::ckStringOf(jResp,"TemplateId")
HistoryDays.i = CkJsonObject::ckIntOf(jResp,"HistoryDays")
CopyChatter.i = CkJsonObject::ckBoolOf(jResp,"CopyChatter")
AutoActivate.i = CkJsonObject::ckBoolOf(jResp,"AutoActivate")
ApexClassId.s = CkJsonObject::ckStringOf(jResp,"ApexClassId")
Description.s = CkJsonObject::ckStringOf(jResp,"Description")
SourceId.s = CkJsonObject::ckStringOf(jResp,"SourceId")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
