Chilkat Online Tools

Xojo / Salesforce Platform APIs / Resources by Version

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// 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

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

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}"
    }
  ]
}