Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/themes/active",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
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
brandColor = jResp.stringOf("brandColor")
LargeUrl = jResp.stringOf("brandImage.largeUrl")
MediumUrl = jResp.stringOf("brandImage.mediumUrl")
SmallUrl = jResp.stringOf("brandImage.smallUrl")
FullSizeUrl = jResp.stringOf("defaultGroupBanner.fullSizeUrl")
defaultGroupImageLargeUrl = jResp.stringOf("defaultGroupImage.largeUrl")
defaultGroupImageMediumUrl = jResp.stringOf("defaultGroupImage.mediumUrl")
defaultGroupImageSmallUrl = jResp.stringOf("defaultGroupImage.smallUrl")
defaultPageBannerFullSizeUrl = jResp.stringOf("defaultPageBanner.fullSizeUrl")
defaultUserBannerFullSizeUrl = jResp.stringOf("defaultUserBanner.fullSizeUrl")
defaultUserImageLargeUrl = jResp.stringOf("defaultUserImage.largeUrl")
defaultUserImageMediumUrl = jResp.stringOf("defaultUserImage.mediumUrl")
defaultUserImageSmallUrl = jResp.stringOf("defaultUserImage.smallUrl")
density = jResp.stringOf("density")
headerColor = jResp.stringOf("headerColor")
linkColor = jResp.stringOf("linkColor")
pageColor = jResp.stringOf("pageColor")
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}"
}
]
}
