Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *v_Type;
const char *v_Url;
const char *Id;
BOOL IsDeleted;
const char *CreatedDate;
const char *CreatedById;
const char *LastModifiedDate;
const char *LastModifiedById;
const char *SystemModstamp;
const char *SandboxName;
const char *LicenseType;
const char *TemplateId;
int HistoryDays;
BOOL CopyChatter;
BOOL AutoActivate;
const char *ApexClassId;
const char *Description;
const char *SourceId;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
v_Type = CkJsonObject_stringOf(jResp,"attributes.type");
v_Url = CkJsonObject_stringOf(jResp,"attributes.url");
Id = CkJsonObject_stringOf(jResp,"Id");
IsDeleted = CkJsonObject_BoolOf(jResp,"IsDeleted");
CreatedDate = CkJsonObject_stringOf(jResp,"CreatedDate");
CreatedById = CkJsonObject_stringOf(jResp,"CreatedById");
LastModifiedDate = CkJsonObject_stringOf(jResp,"LastModifiedDate");
LastModifiedById = CkJsonObject_stringOf(jResp,"LastModifiedById");
SystemModstamp = CkJsonObject_stringOf(jResp,"SystemModstamp");
SandboxName = CkJsonObject_stringOf(jResp,"SandboxName");
LicenseType = CkJsonObject_stringOf(jResp,"LicenseType");
TemplateId = CkJsonObject_stringOf(jResp,"TemplateId");
HistoryDays = CkJsonObject_IntOf(jResp,"HistoryDays");
CopyChatter = CkJsonObject_BoolOf(jResp,"CopyChatter");
AutoActivate = CkJsonObject_BoolOf(jResp,"AutoActivate");
ApexClassId = CkJsonObject_stringOf(jResp,"ApexClassId");
Description = CkJsonObject_stringOf(jResp,"Description");
SourceId = CkJsonObject_stringOf(jResp,"SourceId");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
