Chilkat Online Tools

Node.js / Salesforce Platform APIs / List Sandboxes

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("q","SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>";
    http.SetRequestHeader("Content-Type","application/json");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "size": 1,
    //   "totalSize": 1,
    //   "done": true,
    //   "queryLocator": null,
    //   "entityTypeName": "SandboxInfo",
    //   "records": [
    //     {
    //       "attributes": {
    //         "type": "SandboxInfo",
    //         "url": "/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK"
    //       },
    //       "Id": "0GQ4H000000CxSzWAK",
    //       "SandboxName": "devSandbox",
    //       "LicenseType": "DEVELOPER",
    //       "AutoActivate": false
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var v_Type;
    var v_Url;
    var Id;
    var SandboxName;
    var LicenseType;
    var AutoActivate;

    var size = jResp.IntOf("size");
    var totalSize = jResp.IntOf("totalSize");
    var done = jResp.BoolOf("done");
    var queryLocator = jResp.StringOf("queryLocator");
    var entityTypeName = jResp.StringOf("entityTypeName");
    var i = 0;
    var count_i = jResp.SizeOfArray("records");
    while (i < count_i) {
        jResp.I = i;
        v_Type = jResp.StringOf("records[i].attributes.type");
        v_Url = jResp.StringOf("records[i].attributes.url");
        Id = jResp.StringOf("records[i].Id");
        SandboxName = jResp.StringOf("records[i].SandboxName");
        LicenseType = jResp.StringOf("records[i].LicenseType");
        AutoActivate = jResp.BoolOf("records[i].AutoActivate");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -G -d "q=SELECT%20Id,%20SandboxName,%20LicenseType,%20AutoActivate%20FROM%20SandboxInfo"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "List Sandboxes",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
          "description": "SOQL Query"
        }
      ]
    },
    "description": "Lists all sandboxes."
  },
  "response": [
    {
      "name": "List Sandboxes",
      "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 Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT Id, SandboxName, LicenseType, AutoActivate FROM SandboxInfo",
              "description": "SOQL Query"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 11 Dec 2023 10:45:22 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=312/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\": 1,\n    \"totalSize\": 1,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"SandboxInfo\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"SandboxInfo\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK\"\n            },\n            \"Id\": \"0GQ4H000000CxSzWAK\",\n            \"SandboxName\": \"devSandbox\",\n            \"LicenseType\": \"DEVELOPER\",\n            \"AutoActivate\": false\n        }\n    ]\n}"
    }
  ]
}