Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.activateable")
AssociateEntityType.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.associateEntityType")
AssociateParentEntity.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.associateParentEntity")
Createable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.createable")
Custom.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.custom")
CustomSetting.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.customSetting")
DeepCloneable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.deepCloneable")
Deletable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.deletable")
DeprecatedAndHidden.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.deprecatedAndHidden")
FeedEnabled.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.feedEnabled")
HasSubtypes.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.hasSubtypes")
IsInterface.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.isInterface")
IsSubtype.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.isSubtype")
KeyPrefix.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.keyPrefix")
Label.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.label")
LabelPlural.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.labelPlural")
Layoutable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.layoutable")
Mergeable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.mergeable")
MruEnabled.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.mruEnabled")
Name.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.name")
Queryable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.queryable")
Replicateable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.replicateable")
Retrieveable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.retrieveable")
Searchable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.searchable")
Triggerable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.triggerable")
Undeletable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.undeletable")
Updateable.i = CkJsonObject::ckBoolOf(jResp,"objectDescribe.updateable")
CompactLayouts.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.urls.compactLayouts")
RowTemplate.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.urls.rowTemplate")
Describe.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.urls.describe")
Layouts.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.urls.layouts")
Sobject.s = CkJsonObject::ckStringOf(jResp,"objectDescribe.urls.sobject")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"recentItems")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
