Chilkat Online Tools

Powershell / Salesforce Platform APIs / Get Active Theme

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/themes/active",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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}"
    }
  ]
}