Chilkat Online Tools

C# / Salesforce Platform APIs / Get Tooling Metadata SObject

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

bool Activateable = jResp.BoolOf("objectDescribe.activateable");
string AssociateEntityType = jResp.StringOf("objectDescribe.associateEntityType");
string AssociateParentEntity = jResp.StringOf("objectDescribe.associateParentEntity");
bool Createable = jResp.BoolOf("objectDescribe.createable");
bool Custom = jResp.BoolOf("objectDescribe.custom");
bool CustomSetting = jResp.BoolOf("objectDescribe.customSetting");
bool DeepCloneable = jResp.BoolOf("objectDescribe.deepCloneable");
bool Deletable = jResp.BoolOf("objectDescribe.deletable");
bool DeprecatedAndHidden = jResp.BoolOf("objectDescribe.deprecatedAndHidden");
bool FeedEnabled = jResp.BoolOf("objectDescribe.feedEnabled");
bool HasSubtypes = jResp.BoolOf("objectDescribe.hasSubtypes");
bool IsInterface = jResp.BoolOf("objectDescribe.isInterface");
bool IsSubtype = jResp.BoolOf("objectDescribe.isSubtype");
string KeyPrefix = jResp.StringOf("objectDescribe.keyPrefix");
string Label = jResp.StringOf("objectDescribe.label");
string LabelPlural = jResp.StringOf("objectDescribe.labelPlural");
bool Layoutable = jResp.BoolOf("objectDescribe.layoutable");
bool Mergeable = jResp.BoolOf("objectDescribe.mergeable");
bool MruEnabled = jResp.BoolOf("objectDescribe.mruEnabled");
string Name = jResp.StringOf("objectDescribe.name");
bool Queryable = jResp.BoolOf("objectDescribe.queryable");
bool Replicateable = jResp.BoolOf("objectDescribe.replicateable");
bool Retrieveable = jResp.BoolOf("objectDescribe.retrieveable");
bool Searchable = jResp.BoolOf("objectDescribe.searchable");
bool Triggerable = jResp.BoolOf("objectDescribe.triggerable");
bool Undeletable = jResp.BoolOf("objectDescribe.undeletable");
bool Updateable = jResp.BoolOf("objectDescribe.updateable");
string CompactLayouts = jResp.StringOf("objectDescribe.urls.compactLayouts");
string RowTemplate = jResp.StringOf("objectDescribe.urls.rowTemplate");
string Describe = jResp.StringOf("objectDescribe.urls.describe");
string Layouts = jResp.StringOf("objectDescribe.urls.layouts");
string Sobject = jResp.StringOf("objectDescribe.urls.sobject");
int i = 0;
int 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}"
    }
  ]
}