Chilkat Online Tools

TCL / Salesforce Platform APIs / Get Tooling Metadata SObject

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

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME" $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)

# {
#   "objectDescribe": {
#     "activateable": false,
#     "associateEntityType": null,
#     "associateParentEntity": null,
#     "createable": true,
#     "custom": false,
#     "customSetting": false,
#     "deepCloneable": false,
#     "deletable": true,
#     "deprecatedAndHidden": false,
#     "feedEnabled": false,
#     "hasSubtypes": false,
#     "isInterface": false,
#     "isSubtype": false,
#     "keyPrefix": "01p",
#     "label": "Apex Class",
#     "labelPlural": "Apex Classes",
#     "layoutable": true,
#     "mergeable": false,
#     "mruEnabled": true,
#     "name": "ApexClass",
#     "queryable": true,
#     "replicateable": true,
#     "retrieveable": true,
#     "searchable": true,
#     "triggerable": false,
#     "undeletable": false,
#     "updateable": true,
#     "urls": {
#       "compactLayouts": "/services/data/v59.0/tooling/sobjects/ApexClass/describe/compactLayouts",
#       "rowTemplate": "/services/data/v59.0/tooling/sobjects/ApexClass/{ID}",
#       "describe": "/services/data/v59.0/tooling/sobjects/ApexClass/describe",
#       "layouts": "/services/data/v59.0/tooling/sobjects/ApexClass/describe/layouts",
#       "sobject": "/services/data/v59.0/tooling/sobjects/ApexClass"
#     }
#   },
#   "recentItems": [
#   ]
# }

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

set Activateable [CkJsonObject_BoolOf $jResp "objectDescribe.activateable"]
set AssociateEntityType [CkJsonObject_stringOf $jResp "objectDescribe.associateEntityType"]
set AssociateParentEntity [CkJsonObject_stringOf $jResp "objectDescribe.associateParentEntity"]
set Createable [CkJsonObject_BoolOf $jResp "objectDescribe.createable"]
set Custom [CkJsonObject_BoolOf $jResp "objectDescribe.custom"]
set CustomSetting [CkJsonObject_BoolOf $jResp "objectDescribe.customSetting"]
set DeepCloneable [CkJsonObject_BoolOf $jResp "objectDescribe.deepCloneable"]
set Deletable [CkJsonObject_BoolOf $jResp "objectDescribe.deletable"]
set DeprecatedAndHidden [CkJsonObject_BoolOf $jResp "objectDescribe.deprecatedAndHidden"]
set FeedEnabled [CkJsonObject_BoolOf $jResp "objectDescribe.feedEnabled"]
set HasSubtypes [CkJsonObject_BoolOf $jResp "objectDescribe.hasSubtypes"]
set IsInterface [CkJsonObject_BoolOf $jResp "objectDescribe.isInterface"]
set IsSubtype [CkJsonObject_BoolOf $jResp "objectDescribe.isSubtype"]
set KeyPrefix [CkJsonObject_stringOf $jResp "objectDescribe.keyPrefix"]
set Label [CkJsonObject_stringOf $jResp "objectDescribe.label"]
set LabelPlural [CkJsonObject_stringOf $jResp "objectDescribe.labelPlural"]
set Layoutable [CkJsonObject_BoolOf $jResp "objectDescribe.layoutable"]
set Mergeable [CkJsonObject_BoolOf $jResp "objectDescribe.mergeable"]
set MruEnabled [CkJsonObject_BoolOf $jResp "objectDescribe.mruEnabled"]
set Name [CkJsonObject_stringOf $jResp "objectDescribe.name"]
set Queryable [CkJsonObject_BoolOf $jResp "objectDescribe.queryable"]
set Replicateable [CkJsonObject_BoolOf $jResp "objectDescribe.replicateable"]
set Retrieveable [CkJsonObject_BoolOf $jResp "objectDescribe.retrieveable"]
set Searchable [CkJsonObject_BoolOf $jResp "objectDescribe.searchable"]
set Triggerable [CkJsonObject_BoolOf $jResp "objectDescribe.triggerable"]
set Undeletable [CkJsonObject_BoolOf $jResp "objectDescribe.undeletable"]
set Updateable [CkJsonObject_BoolOf $jResp "objectDescribe.updateable"]
set CompactLayouts [CkJsonObject_stringOf $jResp "objectDescribe.urls.compactLayouts"]
set RowTemplate [CkJsonObject_stringOf $jResp "objectDescribe.urls.rowTemplate"]
set Describe [CkJsonObject_stringOf $jResp "objectDescribe.urls.describe"]
set Layouts [CkJsonObject_stringOf $jResp "objectDescribe.urls.layouts"]
set Sobject [CkJsonObject_stringOf $jResp "objectDescribe.urls.sobject"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "recentItems"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME

Postman Collection Item JSON

{
  "name": "Get Tooling Metadata SObject",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "sobjects",
        ":SOBJECT_API_NAME"
      ],
      "variable": [
        {
          "key": "SOBJECT_API_NAME",
          "value": ""
        }
      ]
    }
  },
  "response": [
    {
      "name": "Get Tooling Metadata SObject",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "sobjects",
            ":SOBJECT_API_NAME"
          ],
          "variable": [
            {
              "key": "SOBJECT_API_NAME",
              "value": "ApexClass"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 11 Dec 2023 10:36:20 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=298/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    \"objectDescribe\": {\n        \"activateable\": false,\n        \"associateEntityType\": null,\n        \"associateParentEntity\": null,\n        \"createable\": true,\n        \"custom\": false,\n        \"customSetting\": false,\n        \"deepCloneable\": false,\n        \"deletable\": true,\n        \"deprecatedAndHidden\": false,\n        \"feedEnabled\": false,\n        \"hasSubtypes\": false,\n        \"isInterface\": false,\n        \"isSubtype\": false,\n        \"keyPrefix\": \"01p\",\n        \"label\": \"Apex Class\",\n        \"labelPlural\": \"Apex Classes\",\n        \"layoutable\": true,\n        \"mergeable\": false,\n        \"mruEnabled\": true,\n        \"name\": \"ApexClass\",\n        \"queryable\": true,\n        \"replicateable\": true,\n        \"retrieveable\": true,\n        \"searchable\": true,\n        \"triggerable\": false,\n        \"undeletable\": false,\n        \"updateable\": true,\n        \"urls\": {\n            \"compactLayouts\": \"/services/data/v59.0/tooling/sobjects/ApexClass/describe/compactLayouts\",\n            \"rowTemplate\": \"/services/data/v59.0/tooling/sobjects/ApexClass/{ID}\",\n            \"describe\": \"/services/data/v59.0/tooling/sobjects/ApexClass/describe\",\n            \"layouts\": \"/services/data/v59.0/tooling/sobjects/ApexClass/describe/layouts\",\n            \"sobject\": \"/services/data/v59.0/tooling/sobjects/ApexClass\"\n        }\n    },\n    \"recentItems\": []\n}"
    }
  ]
}