Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_Type: WideString;
v_Url: WideString;
SandboxName: WideString;
Status: WideString;
StartDate: WideString;
size: Integer;
totalSize: Integer;
done: Integer;
queryLocator: WideString;
entityTypeName: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('q','SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId=''<SANDBOX_INFO_ID>'' ORDER BY StartDate DESC LIMIT 200');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Content-Type','application/json');
resp := http.QuickRequestParams('GET','https://domain.com/services/data/v{{version}}/tooling/query/',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "size": 2,
// "totalSize": 2,
// "done": true,
// "queryLocator": null,
// "entityTypeName": "SandboxProcess",
// "records": [
// {
// "attributes": {
// "type": "SandboxProcess",
// "url": "/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2pCWAS"
// },
// "SandboxName": "devSandbox",
// "Status": "Processing",
// "StartDate": "2023-12-13T12:33:56.000+0000"
// },
// {
// "attributes": {
// "type": "SandboxProcess",
// "url": "/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2p7WAC"
// },
// "SandboxName": "devSandbox",
// "Status": "Completed",
// "StartDate": "2023-12-11T10:44:58.000+0000"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
size := jResp.IntOf('size');
totalSize := jResp.IntOf('totalSize');
done := jResp.BoolOf('done');
queryLocator := jResp.StringOf('queryLocator');
entityTypeName := jResp.StringOf('entityTypeName');
i := 0;
count_i := jResp.SizeOfArray('records');
while i < count_i do
begin
jResp.I := i;
v_Type := jResp.StringOf('records[i].attributes.type');
v_Url := jResp.StringOf('records[i].attributes.url');
SandboxName := jResp.StringOf('records[i].SandboxName');
Status := jResp.StringOf('records[i].Status');
StartDate := jResp.StringOf('records[i].StartDate');
i := i + 1;
end;
Curl Command
curl -G -d "q=SELECT%20SandboxName,%20Status,%20StartDate%20FROM%20SandboxProcess%20WHERE%20SandboxInfoId%3D%27%3CSANDBOX_INFO_ID%3E%27%20ORDER%20BY%20StartDate%20DESC%20LIMIT%20200"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "Get Sandbox Status",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='<SANDBOX_INFO_ID>' ORDER BY StartDate DESC LIMIT 200",
"description": "SOQL Query"
}
]
},
"description": "Lists all sandboxes."
},
"response": [
{
"name": "Get Sandbox Status",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='0GQ4H000000CxSzWAK' ORDER BY StartDate DESC LIMIT 200",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT SandboxName, Status, StartDate FROM SandboxProcess WHERE SandboxInfoId='0GQ4H000000CxSzWAK' ORDER BY StartDate DESC LIMIT 200",
"description": "SOQL Query"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 13 Dec 2023 12:34:55 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=6/15000"
},
{
"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 \"size\": 2,\n \"totalSize\": 2,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"SandboxProcess\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"SandboxProcess\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2pCWAS\"\n },\n \"SandboxName\": \"devSandbox\",\n \"Status\": \"Processing\",\n \"StartDate\": \"2023-12-13T12:33:56.000+0000\"\n },\n {\n \"attributes\": {\n \"type\": \"SandboxProcess\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxProcess/0GR4H000000D2p7WAC\"\n },\n \"SandboxName\": \"devSandbox\",\n \"Status\": \"Completed\",\n \"StartDate\": \"2023-12-11T10:44:58.000+0000\"\n }\n ]\n}"
}
]
}
