Chilkat Online Tools

VB.NET / Atlassian Confluence Cloud / Get look and feel settings

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("spaceKey","<string>")

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


Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel",queryParams)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "selected": "global",
'   "global": {
'     "headings": {
'       "color": "veniam in ex velit"
'     },
'     "links": {
'       "color": "fugiat irure dolor nulla"
'     },
'     "menus": {
'       "hoverOrFocus": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "color": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "header": {
'       "backgroundColor": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "button": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "primaryNavigation": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "secondaryNavigation": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "search": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "content": {
'       "screen": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "container": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "header": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "body": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "bordersAndDividers": {
'       "color": "in"
'     }
'   },
'   "custom": {
'     "headings": {
'       "color": "elit aliquip nulla aliqua"
'     },
'     "links": {
'       "color": "aliquip consequat ut occaecat"
'     },
'     "menus": {
'       "hoverOrFocus": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "color": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "header": {
'       "backgroundColor": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "button": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "primaryNavigation": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "secondaryNavigation": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "search": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "content": {
'       "screen": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "container": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "header": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "body": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "bordersAndDividers": {
'       "color": "ut ut"
'     }
'   },
'   "theme": {
'     "headings": {
'       "color": "l"
'     },
'     "links": {
'       "color": "qui do laborum ut"
'     },
'     "menus": {
'       "hoverOrFocus": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "color": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "header": {
'       "backgroundColor": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "button": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "primaryNavigation": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "secondaryNavigation": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "search": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "content": {
'       "screen": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "container": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "header": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       },
'       "body": {
'         "value": "<Error: Too many levels of nesting to fake this schema>"
'       }
'     },
'     "bordersAndDividers": {
'       "color": "quis dolore"
'     }
'   }
' }

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




Dim selected As String = jResp.StringOf("selected")
Dim Color As String = jResp.StringOf("global.headings.color")
Dim LinksColor As String = jResp.StringOf("global.links.color")
Dim Value As String = jResp.StringOf("global.menus.hoverOrFocus.value")
Dim ColorValue As String = jResp.StringOf("global.menus.color.value")
Dim BackgroundColorValue As String = jResp.StringOf("global.header.backgroundColor.value")
Dim ButtonValue As String = jResp.StringOf("global.header.button.value")
Dim PrimaryNavigationValue As String = jResp.StringOf("global.header.primaryNavigation.value")
Dim SecondaryNavigationValue As String = jResp.StringOf("global.header.secondaryNavigation.value")
Dim SearchValue As String = jResp.StringOf("global.header.search.value")
Dim ScreenValue As String = jResp.StringOf("global.content.screen.value")
Dim ContainerValue As String = jResp.StringOf("global.content.container.value")
Dim HeaderValue As String = jResp.StringOf("global.content.header.value")
Dim BodyValue As String = jResp.StringOf("global.content.body.value")
Dim BordersAndDividersColor As String = jResp.StringOf("global.bordersAndDividers.color")
Dim HeadingsColor As String = jResp.StringOf("custom.headings.color")
LinksColor = jResp.StringOf("custom.links.color")
Dim HoverOrFocusValue As String = jResp.StringOf("custom.menus.hoverOrFocus.value")
ColorValue = jResp.StringOf("custom.menus.color.value")
BackgroundColorValue = jResp.StringOf("custom.header.backgroundColor.value")
ButtonValue = jResp.StringOf("custom.header.button.value")
PrimaryNavigationValue = jResp.StringOf("custom.header.primaryNavigation.value")
SecondaryNavigationValue = jResp.StringOf("custom.header.secondaryNavigation.value")
SearchValue = jResp.StringOf("custom.header.search.value")
ScreenValue = jResp.StringOf("custom.content.screen.value")
ContainerValue = jResp.StringOf("custom.content.container.value")
HeaderValue = jResp.StringOf("custom.content.header.value")
BodyValue = jResp.StringOf("custom.content.body.value")
BordersAndDividersColor = jResp.StringOf("custom.bordersAndDividers.color")
HeadingsColor = jResp.StringOf("theme.headings.color")
LinksColor = jResp.StringOf("theme.links.color")
HoverOrFocusValue = jResp.StringOf("theme.menus.hoverOrFocus.value")
ColorValue = jResp.StringOf("theme.menus.color.value")
BackgroundColorValue = jResp.StringOf("theme.header.backgroundColor.value")
ButtonValue = jResp.StringOf("theme.header.button.value")
PrimaryNavigationValue = jResp.StringOf("theme.header.primaryNavigation.value")
SecondaryNavigationValue = jResp.StringOf("theme.header.secondaryNavigation.value")
SearchValue = jResp.StringOf("theme.header.search.value")
ScreenValue = jResp.StringOf("theme.content.screen.value")
ContainerValue = jResp.StringOf("theme.content.container.value")
HeaderValue = jResp.StringOf("theme.content.header.value")
BodyValue = jResp.StringOf("theme.content.body.value")
BordersAndDividersColor = jResp.StringOf("theme.bordersAndDividers.color")

Curl Command

curl -G -d "spaceKey=%3Cstring%3E"
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel

Postman Collection Item JSON

{
  "name": "Get look and feel settings",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/settings/lookandfeel?spaceKey=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "settings",
        "lookandfeel"
      ],
      "query": [
        {
          "key": "spaceKey",
          "value": "<string>",
          "description": "The key of the space for which the look and feel settings will be\nreturned. If this is not set, only the global look and feel settings\nare returned."
        }
      ]
    },
    "description": "Returns the look and feel settings for the site or a single space. This\nincludes attributes such as the color scheme, padding, and border radius.\n\nThe look and feel settings for a space can be inherited from the global\nlook and feel settings or provided by a theme.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nNone"
  },
  "response": [
    {
      "name": "Returned if the requested look and feel settings are returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/settings/lookandfeel?spaceKey=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "settings",
            "lookandfeel"
          ],
          "query": [
            {
              "key": "spaceKey",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"selected\": \"global\",\n \"global\": {\n  \"headings\": {\n   \"color\": \"veniam in ex velit\"\n  },\n  \"links\": {\n   \"color\": \"fugiat irure dolor nulla\"\n  },\n  \"menus\": {\n   \"hoverOrFocus\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"color\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"header\": {\n   \"backgroundColor\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"button\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"primaryNavigation\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"secondaryNavigation\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"search\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"content\": {\n   \"screen\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"container\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"header\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"body\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"bordersAndDividers\": {\n   \"color\": \"in\"\n  }\n },\n \"custom\": {\n  \"headings\": {\n   \"color\": \"elit aliquip nulla aliqua\"\n  },\n  \"links\": {\n   \"color\": \"aliquip consequat ut occaecat\"\n  },\n  \"menus\": {\n   \"hoverOrFocus\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"color\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"header\": {\n   \"backgroundColor\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"button\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"primaryNavigation\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"secondaryNavigation\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"search\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"content\": {\n   \"screen\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"container\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"header\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"body\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"bordersAndDividers\": {\n   \"color\": \"ut ut\"\n  }\n },\n \"theme\": {\n  \"headings\": {\n   \"color\": \"l\"\n  },\n  \"links\": {\n   \"color\": \"qui do laborum ut\"\n  },\n  \"menus\": {\n   \"hoverOrFocus\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"color\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"header\": {\n   \"backgroundColor\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"button\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"primaryNavigation\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"secondaryNavigation\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"search\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"content\": {\n   \"screen\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"container\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"header\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"body\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  \"bordersAndDividers\": {\n   \"color\": \"quis dolore\"\n  }\n }\n}"
    },
    {
      "name": "Returned if `spaceKey` is invalid.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/settings/lookandfeel?spaceKey=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "settings",
            "lookandfeel"
          ],
          "query": [
            {
              "key": "spaceKey",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if there is no space with the given `spaceKey`.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/settings/lookandfeel?spaceKey=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "settings",
            "lookandfeel"
          ],
          "query": [
            {
              "key": "spaceKey",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}