Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Themes

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>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    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}}/theme', @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)

    -- {
    --   "themeItems": [
    --     {
    --       "colors": [
    --         {
    --           "color": "5867E8",
    --           "context": "primary",
    --           "theme": "theme4"
    --         },
    --         {
    --           "color": "236FBD",
    --           "context": "primary",
    --           "theme": "theme3"
    --         }
    --       ],
    --       "icons": [
    --         {
    --           "contentType": "image/png",
    --           "height": 32,
    --           "theme": "theme3",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
    --           "width": 32
    --         },
    --         {
    --           "contentType": "image/png",
    --           "height": 16,
    --           "theme": "theme3",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
    --           "width": 16
    --         },
    --         {
    --           "contentType": "image/svg+xml",
    --           "height": 0,
    --           "theme": "theme4",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg",
    --           "width": 0
    --         },
    --         {
    --           "contentType": "image/png",
    --           "height": 60,
    --           "theme": "theme4",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png",
    --           "width": 60
    --         },
    --         {
    --           "contentType": "image/png",
    --           "height": 120,
    --           "theme": "theme4",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
    --           "width": 120
    --         }
    --       ],
    --       "name": "Account"
    --     },
    --     {
    --       "colors": [
    --         {
    --           "color": "5867E8",
    --           "context": "primary",
    --           "theme": "theme4"
    --         },
    --         {
    --           "color": "5867E8",
    --           "context": "primary",
    --           "theme": "theme3"
    --         }
    --       ],
    --       "icons": [
    --         {
    --           "contentType": "image/png",
    --           "height": 32,
    --           "theme": "theme3",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/account_brand32.png",
    --           "width": 32
    --         },
    --         {
    --           "contentType": "image/png",
    --           "height": 16,
    --           "theme": "theme3",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/account_brand16.png",
    --           "width": 16
    --         },
    --         {
    --           "contentType": "image/svg+xml",
    --           "height": 0,
    --           "theme": "theme4",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_brand.svg",
    --           "width": 0
    --         },
    --         {
    --           "contentType": "image/png",
    --           "height": 60,
    --           "theme": "theme4",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_brand_60.png",
    --           "width": 60
    --         },
    --         {
    --           "contentType": "image/png",
    --           "height": 120,
    --           "theme": "theme4",
    --           "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/brand_120.png",
    --           "width": 120
    --         }
    --       ],
    --       "name": "AccountBrand"
    --     }
    --   ]
    -- }

    -- Sample code for parsing the JSON response...
    -- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    DECLARE @name nvarchar(4000)

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @color nvarchar(4000)

    DECLARE @context nvarchar(4000)

    DECLARE @theme nvarchar(4000)

    DECLARE @contentType nvarchar(4000)

    DECLARE @height int

    DECLARE @url nvarchar(4000)

    DECLARE @width int

    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'themeItems'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'themeItems[i].name'
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'themeItems[i].colors'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            EXEC sp_OAMethod @jResp, 'StringOf', @color OUT, 'themeItems[i].colors[j].color'
            EXEC sp_OAMethod @jResp, 'StringOf', @context OUT, 'themeItems[i].colors[j].context'
            EXEC sp_OAMethod @jResp, 'StringOf', @theme OUT, 'themeItems[i].colors[j].theme'
            SELECT @j = @j + 1
          END
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'themeItems[i].icons'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            EXEC sp_OAMethod @jResp, 'StringOf', @contentType OUT, 'themeItems[i].icons[j].contentType'
            EXEC sp_OAMethod @jResp, 'IntOf', @height OUT, 'themeItems[i].icons[j].height'
            EXEC sp_OAMethod @jResp, 'StringOf', @theme OUT, 'themeItems[i].icons[j].theme'
            EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'themeItems[i].icons[j].url'
            EXEC sp_OAMethod @jResp, 'IntOf', @width OUT, 'themeItems[i].icons[j].width'
            SELECT @j = @j + 1
          END
        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>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/theme

Postman Collection Item JSON

{
  "name": "Themes",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/theme",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "theme"
      ]
    },
    "description": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_themes.htm"
  },
  "response": [
    {
      "name": "Themes",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/theme",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "theme"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 27 Sep 2023 15:30:15 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "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=8/15000"
        },
        {
          "key": "ETag",
          "value": "\"81846348--gzip\""
        },
        {
          "key": "Last-Modified",
          "value": "Tue, 19 Sep 2023 22:01:04 GMT"
        },
        {
          "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    \"themeItems\": [\n        {\n            \"colors\": [\n                {\n                    \"color\": \"5867E8\",\n                    \"context\": \"primary\",\n                    \"theme\": \"theme4\"\n                },\n                {\n                    \"color\": \"236FBD\",\n                    \"context\": \"primary\",\n                    \"theme\": \"theme3\"\n                }\n            ],\n            \"icons\": [\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 32,\n                    \"theme\": \"theme3\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n                    \"width\": 32\n                },\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 16,\n                    \"theme\": \"theme3\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n                    \"width\": 16\n                },\n                {\n                    \"contentType\": \"image/svg+xml\",\n                    \"height\": 0,\n                    \"theme\": \"theme4\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg\",\n                    \"width\": 0\n                },\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 60,\n                    \"theme\": \"theme4\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png\",\n                    \"width\": 60\n                },\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 120,\n                    \"theme\": \"theme4\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n                    \"width\": 120\n                }\n            ],\n            \"name\": \"Account\"\n        },\n        {\n            \"colors\": [\n                {\n                    \"color\": \"5867E8\",\n                    \"context\": \"primary\",\n                    \"theme\": \"theme4\"\n                },\n                {\n                    \"color\": \"5867E8\",\n                    \"context\": \"primary\",\n                    \"theme\": \"theme3\"\n                }\n            ],\n            \"icons\": [\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 32,\n                    \"theme\": \"theme3\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/account_brand32.png\",\n                    \"width\": 32\n                },\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 16,\n                    \"theme\": \"theme3\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/account_brand16.png\",\n                    \"width\": 16\n                },\n                {\n                    \"contentType\": \"image/svg+xml\",\n                    \"height\": 0,\n                    \"theme\": \"theme4\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_brand.svg\",\n                    \"width\": 0\n                },\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 60,\n                    \"theme\": \"theme4\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_brand_60.png\",\n                    \"width\": 60\n                },\n                {\n                    \"contentType\": \"image/png\",\n                    \"height\": 120,\n                    \"theme\": \"theme4\",\n                    \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/brand_120.png\",\n                    \"width\": 120\n                }\n            ],\n            \"name\": \"AccountBrand\"\n        }\n    ]\n}"
    }
  ]
}