Chilkat Online Tools

delphiDll / Salesforce Platform APIs / Get Tooling Metadata SObject

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Activateable: Boolean;
AssociateEntityType: PWideChar;
AssociateParentEntity: PWideChar;
Createable: Boolean;
Custom: Boolean;
CustomSetting: Boolean;
DeepCloneable: Boolean;
Deletable: Boolean;
DeprecatedAndHidden: Boolean;
FeedEnabled: Boolean;
HasSubtypes: Boolean;
IsInterface: Boolean;
IsSubtype: Boolean;
KeyPrefix: PWideChar;
Label: PWideChar;
LabelPlural: PWideChar;
Layoutable: Boolean;
Mergeable: Boolean;
MruEnabled: Boolean;
Name: PWideChar;
Queryable: Boolean;
Replicateable: Boolean;
Retrieveable: Boolean;
Searchable: Boolean;
Triggerable: Boolean;
Undeletable: Boolean;
Updateable: Boolean;
CompactLayouts: PWideChar;
RowTemplate: PWideChar;
Describe: PWideChar;
Layouts: PWideChar;
Sobject: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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 := CkJsonObject_BoolOf(jResp,'objectDescribe.activateable');
AssociateEntityType := CkJsonObject__stringOf(jResp,'objectDescribe.associateEntityType');
AssociateParentEntity := CkJsonObject__stringOf(jResp,'objectDescribe.associateParentEntity');
Createable := CkJsonObject_BoolOf(jResp,'objectDescribe.createable');
Custom := CkJsonObject_BoolOf(jResp,'objectDescribe.custom');
CustomSetting := CkJsonObject_BoolOf(jResp,'objectDescribe.customSetting');
DeepCloneable := CkJsonObject_BoolOf(jResp,'objectDescribe.deepCloneable');
Deletable := CkJsonObject_BoolOf(jResp,'objectDescribe.deletable');
DeprecatedAndHidden := CkJsonObject_BoolOf(jResp,'objectDescribe.deprecatedAndHidden');
FeedEnabled := CkJsonObject_BoolOf(jResp,'objectDescribe.feedEnabled');
HasSubtypes := CkJsonObject_BoolOf(jResp,'objectDescribe.hasSubtypes');
IsInterface := CkJsonObject_BoolOf(jResp,'objectDescribe.isInterface');
IsSubtype := CkJsonObject_BoolOf(jResp,'objectDescribe.isSubtype');
KeyPrefix := CkJsonObject__stringOf(jResp,'objectDescribe.keyPrefix');
Label := CkJsonObject__stringOf(jResp,'objectDescribe.label');
LabelPlural := CkJsonObject__stringOf(jResp,'objectDescribe.labelPlural');
Layoutable := CkJsonObject_BoolOf(jResp,'objectDescribe.layoutable');
Mergeable := CkJsonObject_BoolOf(jResp,'objectDescribe.mergeable');
MruEnabled := CkJsonObject_BoolOf(jResp,'objectDescribe.mruEnabled');
Name := CkJsonObject__stringOf(jResp,'objectDescribe.name');
Queryable := CkJsonObject_BoolOf(jResp,'objectDescribe.queryable');
Replicateable := CkJsonObject_BoolOf(jResp,'objectDescribe.replicateable');
Retrieveable := CkJsonObject_BoolOf(jResp,'objectDescribe.retrieveable');
Searchable := CkJsonObject_BoolOf(jResp,'objectDescribe.searchable');
Triggerable := CkJsonObject_BoolOf(jResp,'objectDescribe.triggerable');
Undeletable := CkJsonObject_BoolOf(jResp,'objectDescribe.undeletable');
Updateable := CkJsonObject_BoolOf(jResp,'objectDescribe.updateable');
CompactLayouts := CkJsonObject__stringOf(jResp,'objectDescribe.urls.compactLayouts');
RowTemplate := CkJsonObject__stringOf(jResp,'objectDescribe.urls.rowTemplate');
Describe := CkJsonObject__stringOf(jResp,'objectDescribe.urls.describe');
Layouts := CkJsonObject__stringOf(jResp,'objectDescribe.urls.layouts');
Sobject := CkJsonObject__stringOf(jResp,'objectDescribe.urls.sobject');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'recentItems');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
    }
  ]
}