Chilkat Online Tools

TCL / Salesforce Platform APIs / Resources by Version

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

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

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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