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
-- 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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/ui-api/list-ui/:SOBJECT_API_NAME', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "count": 6,
-- "currentPageToken": "0",
-- "currentPageUrl": "/services/data/v58.0/ui-api/list-ui/Account?pageSize=20&pageToken=0",
-- "eTag": "7a9cf6dc597cbc985bab8a26df2f1752",
-- "lists": [
-- {
-- "apiName": "AllAccounts",
-- "id": "00B58000002ssinEAA",
-- "label": "All Accounts",
-- "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/AllAccounts"
-- },
-- {
-- "apiName": "MyAccounts",
-- "id": "00B58000002ssivEAA",
-- "label": "My Accounts",
-- "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/MyAccounts"
-- },
-- {
-- "apiName": "NewLastWeek",
-- "id": "00B58000002ssiHEAQ",
-- "label": "New Last Week",
-- "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/NewLastWeek"
-- },
-- {
-- "apiName": "NewThisWeek",
-- "id": "00B58000002ssi6EAA",
-- "label": "New This Week",
-- "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/NewThisWeek"
-- },
-- {
-- "apiName": "PlatinumandGoldSLACustomers",
-- "id": "00B58000002ssiXEAQ",
-- "label": "Platinum and Gold SLA Customers",
-- "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/PlatinumandGoldSLACustomers"
-- },
-- {
-- "apiName": "RecentlyViewedAccounts",
-- "id": "00B58000002ssimEAA",
-- "label": "Recently Viewed Accounts",
-- "listUiUrl": "/services/data/v58.0/ui-api/list-ui/Account/RecentlyViewedAccounts"
-- }
-- ],
-- "nextPageToken": null,
-- "nextPageUrl": null,
-- "objectApiName": "Account",
-- "pageSize": 20,
-- "previousPageToken": null,
-- "previousPageUrl": null,
-- "queryString": null,
-- "recentListsOnly": false
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @apiName nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @label nvarchar(4000)
DECLARE @listUiUrl nvarchar(4000)
DECLARE @count int
EXEC sp_OAMethod @jResp, 'IntOf', @count OUT, 'count'
DECLARE @currentPageToken nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @currentPageToken OUT, 'currentPageToken'
DECLARE @currentPageUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @currentPageUrl OUT, 'currentPageUrl'
DECLARE @eTag nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @eTag OUT, 'eTag'
DECLARE @nextPageToken nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @nextPageToken OUT, 'nextPageToken'
DECLARE @nextPageUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @nextPageUrl OUT, 'nextPageUrl'
DECLARE @objectApiName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @objectApiName OUT, 'objectApiName'
DECLARE @pageSize int
EXEC sp_OAMethod @jResp, 'IntOf', @pageSize OUT, 'pageSize'
DECLARE @previousPageToken nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previousPageToken OUT, 'previousPageToken'
DECLARE @previousPageUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previousPageUrl OUT, 'previousPageUrl'
DECLARE @queryString nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @queryString OUT, 'queryString'
DECLARE @recentListsOnly int
EXEC sp_OAMethod @jResp, 'BoolOf', @recentListsOnly OUT, 'recentListsOnly'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'lists'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @apiName OUT, 'lists[i].apiName'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'lists[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @label OUT, 'lists[i].label'
EXEC sp_OAMethod @jResp, 'StringOf', @listUiUrl OUT, 'lists[i].listUiUrl'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/list-ui/:SOBJECT_API_NAME
Postman Collection Item JSON
{
"name": "Get List View for an Object",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/list-ui/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-ui",
":SOBJECT_API_NAME"
],
"query": [
{
"key": "pageSize",
"value": "",
"description": "The number of list records viewed at one time. The default value is 20. Value can be 1–2000.",
"disabled": true
},
{
"key": "pageToken",
"value": "",
"description": "A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0.",
"disabled": true
},
{
"key": "q",
"value": "",
"description": "Query list views that contain certain key words.",
"disabled": true
},
{
"key": "recentListsOnly",
"value": "true",
"description": "Show only recently viewed lists.",
"disabled": true
}
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account",
"description": "Object API name"
}
]
},
"description": "Returns a collection of list views associated with an object."
},
"response": [
{
"name": "Get List View for an Object",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/list-ui/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"list-ui",
":SOBJECT_API_NAME"
],
"query": [
{
"key": "pageSize",
"value": null,
"description": "The number of list records viewed at one time. The default value is 20. Value can be 1–2000.",
"disabled": true
},
{
"key": "pageToken",
"value": null,
"description": "A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0.",
"disabled": true
},
{
"key": "q",
"value": null,
"description": "Query list views that contain certain key words.",
"disabled": true
},
{
"key": "recentListsOnly",
"value": "true",
"description": "Show only recently viewed lists.",
"disabled": true
}
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account",
"description": "Object API name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 09:49:33 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": "ETag",
"value": "\"7a9cf6dc597cbc985bab8a26df2f1752--gzip\""
},
{
"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 \"count\": 6,\n \"currentPageToken\": \"0\",\n \"currentPageUrl\": \"/services/data/v58.0/ui-api/list-ui/Account?pageSize=20&pageToken=0\",\n \"eTag\": \"7a9cf6dc597cbc985bab8a26df2f1752\",\n \"lists\": [\n {\n \"apiName\": \"AllAccounts\",\n \"id\": \"00B58000002ssinEAA\",\n \"label\": \"All Accounts\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/AllAccounts\"\n },\n {\n \"apiName\": \"MyAccounts\",\n \"id\": \"00B58000002ssivEAA\",\n \"label\": \"My Accounts\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/MyAccounts\"\n },\n {\n \"apiName\": \"NewLastWeek\",\n \"id\": \"00B58000002ssiHEAQ\",\n \"label\": \"New Last Week\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/NewLastWeek\"\n },\n {\n \"apiName\": \"NewThisWeek\",\n \"id\": \"00B58000002ssi6EAA\",\n \"label\": \"New This Week\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/NewThisWeek\"\n },\n {\n \"apiName\": \"PlatinumandGoldSLACustomers\",\n \"id\": \"00B58000002ssiXEAQ\",\n \"label\": \"Platinum and Gold SLA Customers\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/PlatinumandGoldSLACustomers\"\n },\n {\n \"apiName\": \"RecentlyViewedAccounts\",\n \"id\": \"00B58000002ssimEAA\",\n \"label\": \"Recently Viewed Accounts\",\n \"listUiUrl\": \"/services/data/v58.0/ui-api/list-ui/Account/RecentlyViewedAccounts\"\n }\n ],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"objectApiName\": \"Account\",\n \"pageSize\": 20,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"queryString\": null,\n \"recentListsOnly\": false\n}"
}
]
}
