Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'q', 'SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/services/data/v{{version}}/tooling/query/', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @v_Type nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @IsDeleted int
DECLARE @DeveloperName nvarchar(4000)
DECLARE @Language nvarchar(4000)
DECLARE @MasterLabel nvarchar(4000)
DECLARE @NamespacePrefix nvarchar(4000)
DECLARE @CreatedDate nvarchar(4000)
DECLARE @CreatedById nvarchar(4000)
DECLARE @LastModifiedDate nvarchar(4000)
DECLARE @LastModifiedById nvarchar(4000)
DECLARE @SystemModstamp nvarchar(4000)
DECLARE @Endpoint nvarchar(4000)
DECLARE @PrincipalType nvarchar(4000)
DECLARE @JwtIssuer nvarchar(4000)
DECLARE @JwtFormulaSubject nvarchar(4000)
DECLARE @JwtTextSubject nvarchar(4000)
DECLARE @JwtValidityPeriodSeconds nvarchar(4000)
DECLARE @JwtAudience nvarchar(4000)
DECLARE @AuthTokenEndpointUrl nvarchar(4000)
DECLARE @size int
EXEC sp_OAMethod @jResp, 'IntOf', @size OUT, 'size'
DECLARE @totalSize int
EXEC sp_OAMethod @jResp, 'IntOf', @totalSize OUT, 'totalSize'
DECLARE @done int
EXEC sp_OAMethod @jResp, 'BoolOf', @done OUT, 'done'
DECLARE @queryLocator nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @queryLocator OUT, 'queryLocator'
DECLARE @entityTypeName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @entityTypeName OUT, 'entityTypeName'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'records'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'records[i].attributes.type'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'records[i].attributes.url'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'records[i].Id'
EXEC sp_OAMethod @jResp, 'BoolOf', @IsDeleted OUT, 'records[i].IsDeleted'
EXEC sp_OAMethod @jResp, 'StringOf', @DeveloperName OUT, 'records[i].DeveloperName'
EXEC sp_OAMethod @jResp, 'StringOf', @Language OUT, 'records[i].Language'
EXEC sp_OAMethod @jResp, 'StringOf', @MasterLabel OUT, 'records[i].MasterLabel'
EXEC sp_OAMethod @jResp, 'StringOf', @NamespacePrefix OUT, 'records[i].NamespacePrefix'
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedDate OUT, 'records[i].CreatedDate'
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedById OUT, 'records[i].CreatedById'
EXEC sp_OAMethod @jResp, 'StringOf', @LastModifiedDate OUT, 'records[i].LastModifiedDate'
EXEC sp_OAMethod @jResp, 'StringOf', @LastModifiedById OUT, 'records[i].LastModifiedById'
EXEC sp_OAMethod @jResp, 'StringOf', @SystemModstamp OUT, 'records[i].SystemModstamp'
EXEC sp_OAMethod @jResp, 'StringOf', @Endpoint OUT, 'records[i].Endpoint'
EXEC sp_OAMethod @jResp, 'StringOf', @PrincipalType OUT, 'records[i].PrincipalType'
EXEC sp_OAMethod @jResp, 'StringOf', @JwtIssuer OUT, 'records[i].JwtIssuer'
EXEC sp_OAMethod @jResp, 'StringOf', @JwtFormulaSubject OUT, 'records[i].JwtFormulaSubject'
EXEC sp_OAMethod @jResp, 'StringOf', @JwtTextSubject OUT, 'records[i].JwtTextSubject'
EXEC sp_OAMethod @jResp, 'StringOf', @JwtValidityPeriodSeconds OUT, 'records[i].JwtValidityPeriodSeconds'
EXEC sp_OAMethod @jResp, 'StringOf', @JwtAudience OUT, 'records[i].JwtAudience'
EXEC sp_OAMethod @jResp, 'StringOf', @AuthTokenEndpointUrl OUT, 'records[i].AuthTokenEndpointUrl'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
