Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME',$sbResponseBody);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->LastHeader . "\n";
print 'Failed.' . "\n";
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
$Activateable = $jResp->BoolOf('objectDescribe.activateable');
$AssociateEntityType = $jResp->stringOf('objectDescribe.associateEntityType');
$AssociateParentEntity = $jResp->stringOf('objectDescribe.associateParentEntity');
$Createable = $jResp->BoolOf('objectDescribe.createable');
$Custom = $jResp->BoolOf('objectDescribe.custom');
$CustomSetting = $jResp->BoolOf('objectDescribe.customSetting');
$DeepCloneable = $jResp->BoolOf('objectDescribe.deepCloneable');
$Deletable = $jResp->BoolOf('objectDescribe.deletable');
$DeprecatedAndHidden = $jResp->BoolOf('objectDescribe.deprecatedAndHidden');
$FeedEnabled = $jResp->BoolOf('objectDescribe.feedEnabled');
$HasSubtypes = $jResp->BoolOf('objectDescribe.hasSubtypes');
$IsInterface = $jResp->BoolOf('objectDescribe.isInterface');
$IsSubtype = $jResp->BoolOf('objectDescribe.isSubtype');
$KeyPrefix = $jResp->stringOf('objectDescribe.keyPrefix');
$Label = $jResp->stringOf('objectDescribe.label');
$LabelPlural = $jResp->stringOf('objectDescribe.labelPlural');
$Layoutable = $jResp->BoolOf('objectDescribe.layoutable');
$Mergeable = $jResp->BoolOf('objectDescribe.mergeable');
$MruEnabled = $jResp->BoolOf('objectDescribe.mruEnabled');
$Name = $jResp->stringOf('objectDescribe.name');
$Queryable = $jResp->BoolOf('objectDescribe.queryable');
$Replicateable = $jResp->BoolOf('objectDescribe.replicateable');
$Retrieveable = $jResp->BoolOf('objectDescribe.retrieveable');
$Searchable = $jResp->BoolOf('objectDescribe.searchable');
$Triggerable = $jResp->BoolOf('objectDescribe.triggerable');
$Undeletable = $jResp->BoolOf('objectDescribe.undeletable');
$Updateable = $jResp->BoolOf('objectDescribe.updateable');
$CompactLayouts = $jResp->stringOf('objectDescribe.urls.compactLayouts');
$RowTemplate = $jResp->stringOf('objectDescribe.urls.rowTemplate');
$Describe = $jResp->stringOf('objectDescribe.urls.describe');
$Layouts = $jResp->stringOf('objectDescribe.urls.layouts');
$Sobject = $jResp->stringOf('objectDescribe.urls.sobject');
$i = 0;
$count_i = $jResp->SizeOfArray('recentItems');
while ($i < $count_i) {
$jResp->I = $i;
$i = $i + 1;
}
?>
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}"
}
]
}
