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
-- 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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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 @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/ui-api/themes/active', @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
-- 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 @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)
-- {
-- "brandColor": "#0176D3",
-- "brandImage": {
-- "largeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png",
-- "mediumUrl": "/_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png",
-- "smallUrl": "/_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png"
-- },
-- "defaultGroupBanner": {
-- "fullSizeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group.png"
-- },
-- "defaultGroupImage": {
-- "largeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png",
-- "mediumUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png",
-- "smallUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png"
-- },
-- "defaultPageBanner": {
-- "fullSizeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_background.png"
-- },
-- "defaultUserBanner": {
-- "fullSizeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile.png"
-- },
-- "defaultUserImage": {
-- "largeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png",
-- "mediumUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png",
-- "smallUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png"
-- },
-- "density": "ViewOne",
-- "headerColor": "#FFFFFF",
-- "linkColor": "#0176D3",
-- "pageColor": "#B0C4DF"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @brandColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @brandColor OUT, 'brandColor'
DECLARE @LargeUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LargeUrl OUT, 'brandImage.largeUrl'
DECLARE @MediumUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MediumUrl OUT, 'brandImage.mediumUrl'
DECLARE @SmallUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SmallUrl OUT, 'brandImage.smallUrl'
DECLARE @FullSizeUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FullSizeUrl OUT, 'defaultGroupBanner.fullSizeUrl'
DECLARE @defaultGroupImageLargeUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultGroupImageLargeUrl OUT, 'defaultGroupImage.largeUrl'
DECLARE @defaultGroupImageMediumUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultGroupImageMediumUrl OUT, 'defaultGroupImage.mediumUrl'
DECLARE @defaultGroupImageSmallUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultGroupImageSmallUrl OUT, 'defaultGroupImage.smallUrl'
DECLARE @defaultPageBannerFullSizeUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultPageBannerFullSizeUrl OUT, 'defaultPageBanner.fullSizeUrl'
DECLARE @defaultUserBannerFullSizeUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultUserBannerFullSizeUrl OUT, 'defaultUserBanner.fullSizeUrl'
DECLARE @defaultUserImageLargeUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultUserImageLargeUrl OUT, 'defaultUserImage.largeUrl'
DECLARE @defaultUserImageMediumUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultUserImageMediumUrl OUT, 'defaultUserImage.mediumUrl'
DECLARE @defaultUserImageSmallUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @defaultUserImageSmallUrl OUT, 'defaultUserImage.smallUrl'
DECLARE @density nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @density OUT, 'density'
DECLARE @headerColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @headerColor OUT, 'headerColor'
DECLARE @linkColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @linkColor OUT, 'linkColor'
DECLARE @pageColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pageColor OUT, 'pageColor'
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/themes/active
Postman Collection Item JSON
{
"name": "Get Active Theme",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/themes/active",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"themes",
"active"
]
},
"description": "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection."
},
"response": [
{
"name": "Get Active Theme",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/themes/active",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"themes",
"active"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 09:24:07 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": "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 \"brandColor\": \"#0176D3\",\n \"brandImage\": {\n \"largeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png\",\n \"mediumUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png\",\n \"smallUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png\"\n },\n \"defaultGroupBanner\": {\n \"fullSizeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group.png\"\n },\n \"defaultGroupImage\": {\n \"largeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png\",\n \"mediumUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png\",\n \"smallUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png\"\n },\n \"defaultPageBanner\": {\n \"fullSizeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_background.png\"\n },\n \"defaultUserBanner\": {\n \"fullSizeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile.png\"\n },\n \"defaultUserImage\": {\n \"largeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png\",\n \"mediumUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png\",\n \"smallUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png\"\n },\n \"density\": \"ViewOne\",\n \"headerColor\": \"#FFFFFF\",\n \"linkColor\": \"#0176D3\",\n \"pageColor\": \"#B0C4DF\"\n}"
}
]
}
