Chilkat Online Tools

Node.js / Salesforce Platform APIs / Resources by Version

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;

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

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

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

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

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

    // {
    //   "tooling": "/services/data/v58.0/tooling",
    //   "metadata": "/services/data/v58.0/metadata",
    //   "eclair": "/services/data/v58.0/eclair",
    //   "folders": "/services/data/v58.0/folders",
    //   "prechatForms": "/services/data/v58.0/prechatForms",
    //   "contact-tracing": "/services/data/v58.0/contact-tracing",
    //   "jsonxform": "/services/data/v58.0/jsonxform",
    //   "chatter": "/services/data/v58.0/chatter",
    //   "payments": "/services/data/v58.0/payments",
    //   "tabs": "/services/data/v58.0/tabs",
    //   "appMenu": "/services/data/v58.0/appMenu",
    //   "quickActions": "/services/data/v58.0/quickActions",
    //   "queryAll": "/services/data/v58.0/queryAll",
    //   "commerce": "/services/data/v58.0/commerce",
    //   "wave": "/services/data/v58.0/wave",
    //   "iot": "/services/data/v58.0/iot",
    //   "analytics": "/services/data/v58.0/analytics",
    //   "search": "/services/data/v58.0/search",
    //   "smartdatadiscovery": "/services/data/v58.0/smartdatadiscovery",
    //   "identity": "https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO",
    //   "composite": "/services/data/v58.0/composite",
    //   "parameterizedSearch": "/services/data/v58.0/parameterizedSearch",
    //   "fingerprint": "/services/data/v58.0/fingerprint",
    //   "theme": "/services/data/v58.0/theme",
    //   "nouns": "/services/data/v58.0/nouns",
    //   "domino": "/services/data/v58.0/domino",
    //   "event": "/services/data/v58.0/event",
    //   "serviceTemplates": "/services/data/v58.0/serviceTemplates",
    //   "recent": "/services/data/v58.0/recent",
    //   "connect": "/services/data/v58.0/connect",
    //   "licensing": "/services/data/v58.0/licensing",
    //   "limits": "/services/data/v58.0/limits",
    //   "process": "/services/data/v58.0/process",
    //   "dedupe": "/services/data/v58.0/dedupe",
    //   "async-queries": "/services/data/v58.0/async-queries",
    //   "query": "/services/data/v58.0/query",
    //   "jobs": "/services/data/v58.0/jobs",
    //   "match": "/services/data/v58.0/match",
    //   "localizedvalue": "/services/data/v58.0/localizedvalue",
    //   "mobile": "/services/data/v58.0/mobile",
    //   "emailConnect": "/services/data/v58.0/emailConnect",
    //   "consent": "/services/data/v58.0/consent",
    //   "tokenizer": "/services/data/v58.0/tokenizer",
    //   "compactLayouts": "/services/data/v58.0/compactLayouts",
    //   "knowledgeManagement": "/services/data/v58.0/knowledgeManagement",
    //   "sobjects": "/services/data/v58.0/sobjects",
    //   "actions": "/services/data/v58.0/actions",
    //   "support": "/services/data/v58.0/support"
    // }

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

    var tooling = jResp.StringOf("tooling");
    var metadata = jResp.StringOf("metadata");
    var eclair = jResp.StringOf("eclair");
    var folders = jResp.StringOf("folders");
    var prechatForms = jResp.StringOf("prechatForms");
    var contact_tracing = jResp.StringOf("contact-tracing");
    var jsonxform = jResp.StringOf("jsonxform");
    var chatter = jResp.StringOf("chatter");
    var payments = jResp.StringOf("payments");
    var tabs = jResp.StringOf("tabs");
    var appMenu = jResp.StringOf("appMenu");
    var quickActions = jResp.StringOf("quickActions");
    var queryAll = jResp.StringOf("queryAll");
    var commerce = jResp.StringOf("commerce");
    var wave = jResp.StringOf("wave");
    var iot = jResp.StringOf("iot");
    var analytics = jResp.StringOf("analytics");
    var search = jResp.StringOf("search");
    var smartdatadiscovery = jResp.StringOf("smartdatadiscovery");
    var identity = jResp.StringOf("identity");
    var composite = jResp.StringOf("composite");
    var parameterizedSearch = jResp.StringOf("parameterizedSearch");
    var fingerprint = jResp.StringOf("fingerprint");
    var theme = jResp.StringOf("theme");
    var nouns = jResp.StringOf("nouns");
    var domino = jResp.StringOf("domino");
    var v_event = jResp.StringOf("event");
    var serviceTemplates = jResp.StringOf("serviceTemplates");
    var recent = jResp.StringOf("recent");
    var connect = jResp.StringOf("connect");
    var licensing = jResp.StringOf("licensing");
    var limits = jResp.StringOf("limits");
    var process = jResp.StringOf("process");
    var dedupe = jResp.StringOf("dedupe");
    var async_queries = jResp.StringOf("async-queries");
    var query = jResp.StringOf("query");
    var jobs = jResp.StringOf("jobs");
    var match = jResp.StringOf("match");
    var localizedvalue = jResp.StringOf("localizedvalue");
    var mobile = jResp.StringOf("mobile");
    var emailConnect = jResp.StringOf("emailConnect");
    var consent = jResp.StringOf("consent");
    var tokenizer = jResp.StringOf("tokenizer");
    var compactLayouts = jResp.StringOf("compactLayouts");
    var knowledgeManagement = jResp.StringOf("knowledgeManagement");
    var sobjects = jResp.StringOf("sobjects");
    var actions = jResp.StringOf("actions");
    var support = jResp.StringOf("support");

}

chilkatExample();

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/

Postman Collection Item JSON

{
  "name": "Resources by Version",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        ""
      ]
    },
    "description": "Lists available resources for the specified API version, including resource name and URI."
  },
  "response": [
    {
      "name": "Resources by Version",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            ""
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 26 Sep 2023 13:29:43 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "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=3/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    \"tooling\": \"/services/data/v58.0/tooling\",\n    \"metadata\": \"/services/data/v58.0/metadata\",\n    \"eclair\": \"/services/data/v58.0/eclair\",\n    \"folders\": \"/services/data/v58.0/folders\",\n    \"prechatForms\": \"/services/data/v58.0/prechatForms\",\n    \"contact-tracing\": \"/services/data/v58.0/contact-tracing\",\n    \"jsonxform\": \"/services/data/v58.0/jsonxform\",\n    \"chatter\": \"/services/data/v58.0/chatter\",\n    \"payments\": \"/services/data/v58.0/payments\",\n    \"tabs\": \"/services/data/v58.0/tabs\",\n    \"appMenu\": \"/services/data/v58.0/appMenu\",\n    \"quickActions\": \"/services/data/v58.0/quickActions\",\n    \"queryAll\": \"/services/data/v58.0/queryAll\",\n    \"commerce\": \"/services/data/v58.0/commerce\",\n    \"wave\": \"/services/data/v58.0/wave\",\n    \"iot\": \"/services/data/v58.0/iot\",\n    \"analytics\": \"/services/data/v58.0/analytics\",\n    \"search\": \"/services/data/v58.0/search\",\n    \"smartdatadiscovery\": \"/services/data/v58.0/smartdatadiscovery\",\n    \"identity\": \"https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO\",\n    \"composite\": \"/services/data/v58.0/composite\",\n    \"parameterizedSearch\": \"/services/data/v58.0/parameterizedSearch\",\n    \"fingerprint\": \"/services/data/v58.0/fingerprint\",\n    \"theme\": \"/services/data/v58.0/theme\",\n    \"nouns\": \"/services/data/v58.0/nouns\",\n    \"domino\": \"/services/data/v58.0/domino\",\n    \"event\": \"/services/data/v58.0/event\",\n    \"serviceTemplates\": \"/services/data/v58.0/serviceTemplates\",\n    \"recent\": \"/services/data/v58.0/recent\",\n    \"connect\": \"/services/data/v58.0/connect\",\n    \"licensing\": \"/services/data/v58.0/licensing\",\n    \"limits\": \"/services/data/v58.0/limits\",\n    \"process\": \"/services/data/v58.0/process\",\n    \"dedupe\": \"/services/data/v58.0/dedupe\",\n    \"async-queries\": \"/services/data/v58.0/async-queries\",\n    \"query\": \"/services/data/v58.0/query\",\n    \"jobs\": \"/services/data/v58.0/jobs\",\n    \"match\": \"/services/data/v58.0/match\",\n    \"localizedvalue\": \"/services/data/v58.0/localizedvalue\",\n    \"mobile\": \"/services/data/v58.0/mobile\",\n    \"emailConnect\": \"/services/data/v58.0/emailConnect\",\n    \"consent\": \"/services/data/v58.0/consent\",\n    \"tokenizer\": \"/services/data/v58.0/tokenizer\",\n    \"compactLayouts\": \"/services/data/v58.0/compactLayouts\",\n    \"knowledgeManagement\": \"/services/data/v58.0/knowledgeManagement\",\n    \"sobjects\": \"/services/data/v58.0/sobjects\",\n    \"actions\": \"/services/data/v58.0/actions\",\n    \"support\": \"/services/data/v58.0/support\"\n}"
    }
  ]
}