Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"q","SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/services/data/v{{version}}/tooling/query/",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "size": 1,
; "totalSize": 1,
; "done": true,
; "queryLocator": null,
; "entityTypeName": "NamedCredential",
; "records": [
; {
; "attributes": {
; "type": "NamedCredential",
; "url": "/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO"
; },
; "Id": "0XA4H000000TNRhWAO",
; "IsDeleted": false,
; "DeveloperName": "Slack_Webhook_for_integration_Channel",
; "Language": "en_US",
; "MasterLabel": "Slack Webhook for #integration Channel",
; "NamespacePrefix": null,
; "CreatedDate": "2020-11-06T14:04:44.000+0000",
; "CreatedById": "00558000000yFyDAAU",
; "LastModifiedDate": "2020-11-06T14:04:44.000+0000",
; "LastModifiedById": "00558000000yFyDAAU",
; "SystemModstamp": "2020-11-06T14:04:44.000+0000",
; "Endpoint": "https://hooks.slack.com/services/SECRET",
; "PrincipalType": "Anonymous",
; "JwtIssuer": null,
; "JwtFormulaSubject": null,
; "JwtTextSubject": null,
; "JwtValidityPeriodSeconds": null,
; "JwtAudience": null,
; "AuthTokenEndpointUrl": null
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Type.s
v_Url.s
Id.s
IsDeleted.i
DeveloperName.s
Language.s
MasterLabel.s
NamespacePrefix.s
CreatedDate.s
CreatedById.s
LastModifiedDate.s
LastModifiedById.s
SystemModstamp.s
Endpoint.s
PrincipalType.s
JwtIssuer.s
JwtFormulaSubject.s
JwtTextSubject.s
JwtValidityPeriodSeconds.s
JwtAudience.s
AuthTokenEndpointUrl.s
size.i = CkJsonObject::ckIntOf(jResp,"size")
totalSize.i = CkJsonObject::ckIntOf(jResp,"totalSize")
done.i = CkJsonObject::ckBoolOf(jResp,"done")
queryLocator.s = CkJsonObject::ckStringOf(jResp,"queryLocator")
entityTypeName.s = CkJsonObject::ckStringOf(jResp,"entityTypeName")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"records")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_Type = CkJsonObject::ckStringOf(jResp,"records[i].attributes.type")
v_Url = CkJsonObject::ckStringOf(jResp,"records[i].attributes.url")
Id = CkJsonObject::ckStringOf(jResp,"records[i].Id")
IsDeleted = CkJsonObject::ckBoolOf(jResp,"records[i].IsDeleted")
DeveloperName = CkJsonObject::ckStringOf(jResp,"records[i].DeveloperName")
Language = CkJsonObject::ckStringOf(jResp,"records[i].Language")
MasterLabel = CkJsonObject::ckStringOf(jResp,"records[i].MasterLabel")
NamespacePrefix = CkJsonObject::ckStringOf(jResp,"records[i].NamespacePrefix")
CreatedDate = CkJsonObject::ckStringOf(jResp,"records[i].CreatedDate")
CreatedById = CkJsonObject::ckStringOf(jResp,"records[i].CreatedById")
LastModifiedDate = CkJsonObject::ckStringOf(jResp,"records[i].LastModifiedDate")
LastModifiedById = CkJsonObject::ckStringOf(jResp,"records[i].LastModifiedById")
SystemModstamp = CkJsonObject::ckStringOf(jResp,"records[i].SystemModstamp")
Endpoint = CkJsonObject::ckStringOf(jResp,"records[i].Endpoint")
PrincipalType = CkJsonObject::ckStringOf(jResp,"records[i].PrincipalType")
JwtIssuer = CkJsonObject::ckStringOf(jResp,"records[i].JwtIssuer")
JwtFormulaSubject = CkJsonObject::ckStringOf(jResp,"records[i].JwtFormulaSubject")
JwtTextSubject = CkJsonObject::ckStringOf(jResp,"records[i].JwtTextSubject")
JwtValidityPeriodSeconds = CkJsonObject::ckStringOf(jResp,"records[i].JwtValidityPeriodSeconds")
JwtAudience = CkJsonObject::ckStringOf(jResp,"records[i].JwtAudience")
AuthTokenEndpointUrl = CkJsonObject::ckStringOf(jResp,"records[i].AuthTokenEndpointUrl")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "q=SELECT%20FIELDS%28ALL%29%20FROM%20NamedCredential%20LIMIT%20200"
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "List named credentials",
"protocolProfileBehavior": {
"strictSSL": false,
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
}
]
}
},
"response": [
{
"name": "List named credentials",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 03 Jul 2023 13:09:27 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=5/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\": 1,\n \"totalSize\": 1,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"NamedCredential\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"NamedCredential\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO\"\n },\n \"Id\": \"0XA4H000000TNRhWAO\",\n \"IsDeleted\": false,\n \"DeveloperName\": \"Slack_Webhook_for_integration_Channel\",\n \"Language\": \"en_US\",\n \"MasterLabel\": \"Slack Webhook for #integration Channel\",\n \"NamespacePrefix\": null,\n \"CreatedDate\": \"2020-11-06T14:04:44.000+0000\",\n \"CreatedById\": \"00558000000yFyDAAU\",\n \"LastModifiedDate\": \"2020-11-06T14:04:44.000+0000\",\n \"LastModifiedById\": \"00558000000yFyDAAU\",\n \"SystemModstamp\": \"2020-11-06T14:04:44.000+0000\",\n \"Endpoint\": \"https://hooks.slack.com/services/SECRET\",\n \"PrincipalType\": \"Anonymous\",\n \"JwtIssuer\": null,\n \"JwtFormulaSubject\": null,\n \"JwtTextSubject\": null,\n \"JwtValidityPeriodSeconds\": null,\n \"JwtAudience\": null,\n \"AuthTokenEndpointUrl\": null\n }\n ]\n}"
}
]
}
