Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
BOOL Activateable;
const wchar_t *AssociateEntityType;
const wchar_t *AssociateParentEntity;
BOOL Createable;
BOOL Custom;
BOOL CustomSetting;
BOOL DeepCloneable;
BOOL Deletable;
BOOL DeprecatedAndHidden;
BOOL FeedEnabled;
BOOL HasSubtypes;
BOOL IsInterface;
BOOL IsSubtype;
const wchar_t *KeyPrefix;
const wchar_t *Label;
const wchar_t *LabelPlural;
BOOL Layoutable;
BOOL Mergeable;
BOOL MruEnabled;
const wchar_t *Name;
BOOL Queryable;
BOOL Replicateable;
BOOL Retrieveable;
BOOL Searchable;
BOOL Triggerable;
BOOL Undeletable;
BOOL Updateable;
const wchar_t *CompactLayouts;
const wchar_t *RowTemplate;
const wchar_t *Describe;
const wchar_t *Layouts;
const wchar_t *Sobject;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Activateable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.activateable");
AssociateEntityType = CkJsonObjectW_stringOf(jResp,L"objectDescribe.associateEntityType");
AssociateParentEntity = CkJsonObjectW_stringOf(jResp,L"objectDescribe.associateParentEntity");
Createable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.createable");
Custom = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.custom");
CustomSetting = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.customSetting");
DeepCloneable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.deepCloneable");
Deletable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.deletable");
DeprecatedAndHidden = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.deprecatedAndHidden");
FeedEnabled = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.feedEnabled");
HasSubtypes = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.hasSubtypes");
IsInterface = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.isInterface");
IsSubtype = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.isSubtype");
KeyPrefix = CkJsonObjectW_stringOf(jResp,L"objectDescribe.keyPrefix");
Label = CkJsonObjectW_stringOf(jResp,L"objectDescribe.label");
LabelPlural = CkJsonObjectW_stringOf(jResp,L"objectDescribe.labelPlural");
Layoutable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.layoutable");
Mergeable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.mergeable");
MruEnabled = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.mruEnabled");
Name = CkJsonObjectW_stringOf(jResp,L"objectDescribe.name");
Queryable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.queryable");
Replicateable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.replicateable");
Retrieveable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.retrieveable");
Searchable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.searchable");
Triggerable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.triggerable");
Undeletable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.undeletable");
Updateable = CkJsonObjectW_BoolOf(jResp,L"objectDescribe.updateable");
CompactLayouts = CkJsonObjectW_stringOf(jResp,L"objectDescribe.urls.compactLayouts");
RowTemplate = CkJsonObjectW_stringOf(jResp,L"objectDescribe.urls.rowTemplate");
Describe = CkJsonObjectW_stringOf(jResp,L"objectDescribe.urls.describe");
Layouts = CkJsonObjectW_stringOf(jResp,L"objectDescribe.urls.layouts");
Sobject = CkJsonObjectW_stringOf(jResp,L"objectDescribe.urls.sobject");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"recentItems");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_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}"
}
]
}
