Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("q","")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "size": 38,
// "totalSize": 38,
// "done": true,
// "queryLocator": null,
// "entityTypeName": "ApexClass",
// "records": [
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfqQAB"
// },
// "Name": "GenericEventPostMock"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfrQAB"
// },
// "Name": "StreamingMonitorController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfsQAB"
// },
// "Name": "StreamingMonitorControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p58000009UEeJAAW"
// },
// "Name": "MyController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p58000009UDoMAAW"
// },
// "Name": "ProcessingController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4"
// },
// "Name": "PrepareSandbox"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ"
// },
// "Name": "PrepareSandboxTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqEAAQ"
// },
// "Name": "MyProfilePageController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090uh7AAA"
// },
// "Name": "InTheArea"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq6AAA"
// },
// "Name": "SiteLoginController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA"
// },
// "Name": "SiteLoginControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq8AAA"
// },
// "Name": "SiteRegisterController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA"
// },
// "Name": "SiteRegisterControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqAAAQ"
// },
// "Name": "ChangePasswordController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ"
// },
// "Name": "ChangePasswordControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqCAAQ"
// },
// "Name": "ForgotPasswordController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ"
// },
// "Name": "ForgotPasswordControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ"
// },
// "Name": "MyProfilePageControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqOAAQ"
// },
// "Name": "CommunitiesLoginController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ"
// },
// "Name": "CommunitiesLoginControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqQAAQ"
// },
// "Name": "CommunitiesLandingController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ"
// },
// "Name": "CommunitiesLandingControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqSAAQ"
// },
// "Name": "CommunitiesSelfRegController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ"
// },
// "Name": "CommunitiesSelfRegControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqUAAQ"
// },
// "Name": "CommunitiesSelfRegConfirmController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ"
// },
// "Name": "CommunitiesSelfRegConfirmControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA"
// },
// "Name": "LightningSelfRegisterController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqdAAA"
// },
// "Name": "LightningForgotPasswordController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA"
// },
// "Name": "LightningLoginFormController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA"
// },
// "Name": "LightningLoginFormControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA"
// },
// "Name": "LightningForgotPasswordControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA"
// },
// "Name": "LightningSelfRegisterControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wrUAAQ"
// },
// "Name": "SigninController"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090sf4AAA"
// },
// "Name": "trailheadAPIChallenge"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD"
// },
// "Name": "AccountTriggerHelperTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnpQAD"
// },
// "Name": "AccountTriggerHelper"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE"
// },
// "Name": "MicrobatchSelfRegControllerTest"
// },
// {
// "attributes": {
// "type": "ApexClass",
// "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwuQAE"
// },
// "Name": "MicrobatchSelfRegController"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnSize = loJResp.IntOf("size")
lnTotalSize = loJResp.IntOf("totalSize")
llDone = loJResp.BoolOf("done")
lcQueryLocator = loJResp.StringOf("queryLocator")
lcEntityTypeName = loJResp.StringOf("entityTypeName")
i = 0
lnCount_i = loJResp.SizeOfArray("records")
do while i < lnCount_i
loJResp.I = i
lcV_Type = loJResp.StringOf("records[i].attributes.type")
lcV_Url = loJResp.StringOf("records[i].attributes.url")
lcName = loJResp.StringOf("records[i].Name")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "q="
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "Tooling Query",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": null,
"description": "SOQL Query"
}
]
},
"description": "Executes a query against an object and returns data that matches the specified criteria. Tooling API exposes objects like EntityDefinition and FieldDefinition that use the external object framework. That is, they don’t exist in the database but are constructed dynamically. Special query rules apply to virtual entities.\nIf the query result is too large, it’s broken up into batches. The response contains the first batch of results and a query identifier. The identifier can be used in a request to retrieve the next batch."
},
"response": [
{
"name": "Tooling Query",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Name FROM ApexClass",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Name FROM ApexClass",
"description": "SOQL Query"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 11 Dec 2023 09:36:10 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=93/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 \"size\": 38,\n \"totalSize\": 38,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"ApexClass\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfqQAB\"\n },\n \"Name\": \"GenericEventPostMock\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfrQAB\"\n },\n \"Name\": \"StreamingMonitorController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfsQAB\"\n },\n \"Name\": \"StreamingMonitorControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p58000009UEeJAAW\"\n },\n \"Name\": \"MyController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p58000009UDoMAAW\"\n },\n \"Name\": \"ProcessingController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4\"\n },\n \"Name\": \"PrepareSandbox\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ\"\n },\n \"Name\": \"PrepareSandboxTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqEAAQ\"\n },\n \"Name\": \"MyProfilePageController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090uh7AAA\"\n },\n \"Name\": \"InTheArea\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq6AAA\"\n },\n \"Name\": \"SiteLoginController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA\"\n },\n \"Name\": \"SiteLoginControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq8AAA\"\n },\n \"Name\": \"SiteRegisterController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA\"\n },\n \"Name\": \"SiteRegisterControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqAAAQ\"\n },\n \"Name\": \"ChangePasswordController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ\"\n },\n \"Name\": \"ChangePasswordControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqCAAQ\"\n },\n \"Name\": \"ForgotPasswordController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ\"\n },\n \"Name\": \"ForgotPasswordControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ\"\n },\n \"Name\": \"MyProfilePageControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqOAAQ\"\n },\n \"Name\": \"CommunitiesLoginController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ\"\n },\n \"Name\": \"CommunitiesLoginControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqQAAQ\"\n },\n \"Name\": \"CommunitiesLandingController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ\"\n },\n \"Name\": \"CommunitiesLandingControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqSAAQ\"\n },\n \"Name\": \"CommunitiesSelfRegController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ\"\n },\n \"Name\": \"CommunitiesSelfRegControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqUAAQ\"\n },\n \"Name\": \"CommunitiesSelfRegConfirmController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ\"\n },\n \"Name\": \"CommunitiesSelfRegConfirmControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA\"\n },\n \"Name\": \"LightningSelfRegisterController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqdAAA\"\n },\n \"Name\": \"LightningForgotPasswordController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA\"\n },\n \"Name\": \"LightningLoginFormController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA\"\n },\n \"Name\": \"LightningLoginFormControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA\"\n },\n \"Name\": \"LightningForgotPasswordControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA\"\n },\n \"Name\": \"LightningSelfRegisterControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wrUAAQ\"\n },\n \"Name\": \"SigninController\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090sf4AAA\"\n },\n \"Name\": \"trailheadAPIChallenge\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD\"\n },\n \"Name\": \"AccountTriggerHelperTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnpQAD\"\n },\n \"Name\": \"AccountTriggerHelper\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE\"\n },\n \"Name\": \"MicrobatchSelfRegControllerTest\"\n },\n {\n \"attributes\": {\n \"type\": \"ApexClass\",\n \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwuQAE\"\n },\n \"Name\": \"MicrobatchSelfRegController\"\n }\n ]\n}"
}
]
}
