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>"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME",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)
// {
// "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
Dim Activateable As Boolean
Activateable = jResp.BoolOf("objectDescribe.activateable")
Dim AssociateEntityType As String
AssociateEntityType = jResp.StringOf("objectDescribe.associateEntityType")
Dim AssociateParentEntity As String
AssociateParentEntity = jResp.StringOf("objectDescribe.associateParentEntity")
Dim Createable As Boolean
Createable = jResp.BoolOf("objectDescribe.createable")
Dim Custom As Boolean
Custom = jResp.BoolOf("objectDescribe.custom")
Dim CustomSetting As Boolean
CustomSetting = jResp.BoolOf("objectDescribe.customSetting")
Dim DeepCloneable As Boolean
DeepCloneable = jResp.BoolOf("objectDescribe.deepCloneable")
Dim Deletable As Boolean
Deletable = jResp.BoolOf("objectDescribe.deletable")
Dim DeprecatedAndHidden As Boolean
DeprecatedAndHidden = jResp.BoolOf("objectDescribe.deprecatedAndHidden")
Dim FeedEnabled As Boolean
FeedEnabled = jResp.BoolOf("objectDescribe.feedEnabled")
Dim HasSubtypes As Boolean
HasSubtypes = jResp.BoolOf("objectDescribe.hasSubtypes")
Dim IsInterface As Boolean
IsInterface = jResp.BoolOf("objectDescribe.isInterface")
Dim IsSubtype As Boolean
IsSubtype = jResp.BoolOf("objectDescribe.isSubtype")
Dim KeyPrefix As String
KeyPrefix = jResp.StringOf("objectDescribe.keyPrefix")
Dim Label As String
Label = jResp.StringOf("objectDescribe.label")
Dim LabelPlural As String
LabelPlural = jResp.StringOf("objectDescribe.labelPlural")
Dim Layoutable As Boolean
Layoutable = jResp.BoolOf("objectDescribe.layoutable")
Dim Mergeable As Boolean
Mergeable = jResp.BoolOf("objectDescribe.mergeable")
Dim MruEnabled As Boolean
MruEnabled = jResp.BoolOf("objectDescribe.mruEnabled")
Dim Name As String
Name = jResp.StringOf("objectDescribe.name")
Dim Queryable As Boolean
Queryable = jResp.BoolOf("objectDescribe.queryable")
Dim Replicateable As Boolean
Replicateable = jResp.BoolOf("objectDescribe.replicateable")
Dim Retrieveable As Boolean
Retrieveable = jResp.BoolOf("objectDescribe.retrieveable")
Dim Searchable As Boolean
Searchable = jResp.BoolOf("objectDescribe.searchable")
Dim Triggerable As Boolean
Triggerable = jResp.BoolOf("objectDescribe.triggerable")
Dim Undeletable As Boolean
Undeletable = jResp.BoolOf("objectDescribe.undeletable")
Dim Updateable As Boolean
Updateable = jResp.BoolOf("objectDescribe.updateable")
Dim CompactLayouts As String
CompactLayouts = jResp.StringOf("objectDescribe.urls.compactLayouts")
Dim RowTemplate As String
RowTemplate = jResp.StringOf("objectDescribe.urls.rowTemplate")
Dim Describe As String
Describe = jResp.StringOf("objectDescribe.urls.describe")
Dim Layouts As String
Layouts = jResp.StringOf("objectDescribe.urls.layouts")
Dim Sobject As String
Sobject = jResp.StringOf("objectDescribe.urls.sobject")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("recentItems")
While i < count_i
jResp.I = i
i = i + 1
Wend
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}"
}
]
}
