Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcSelected
LOCAL lcColor
LOCAL lcLinksColor
LOCAL lcValue
LOCAL lcColorValue
LOCAL lcBackgroundColorValue
LOCAL lcButtonValue
LOCAL lcPrimaryNavigationValue
LOCAL lcSecondaryNavigationValue
LOCAL lcSearchValue
LOCAL lcScreenValue
LOCAL lcContainerValue
LOCAL lcHeaderValue
LOCAL lcBodyValue
LOCAL lcBordersAndDividersColor
LOCAL lcHeadingsColor
LOCAL lcHoverOrFocusValue
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("spaceKey","<string>")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcSelected = loJResp.StringOf("selected")
lcColor = loJResp.StringOf("global.headings.color")
lcLinksColor = loJResp.StringOf("global.links.color")
lcValue = loJResp.StringOf("global.menus.hoverOrFocus.value")
lcColorValue = loJResp.StringOf("global.menus.color.value")
lcBackgroundColorValue = loJResp.StringOf("global.header.backgroundColor.value")
lcButtonValue = loJResp.StringOf("global.header.button.value")
lcPrimaryNavigationValue = loJResp.StringOf("global.header.primaryNavigation.value")
lcSecondaryNavigationValue = loJResp.StringOf("global.header.secondaryNavigation.value")
lcSearchValue = loJResp.StringOf("global.header.search.value")
lcScreenValue = loJResp.StringOf("global.content.screen.value")
lcContainerValue = loJResp.StringOf("global.content.container.value")
lcHeaderValue = loJResp.StringOf("global.content.header.value")
lcBodyValue = loJResp.StringOf("global.content.body.value")
lcBordersAndDividersColor = loJResp.StringOf("global.bordersAndDividers.color")
lcHeadingsColor = loJResp.StringOf("custom.headings.color")
lcLinksColor = loJResp.StringOf("custom.links.color")
lcHoverOrFocusValue = loJResp.StringOf("custom.menus.hoverOrFocus.value")
lcColorValue = loJResp.StringOf("custom.menus.color.value")
lcBackgroundColorValue = loJResp.StringOf("custom.header.backgroundColor.value")
lcButtonValue = loJResp.StringOf("custom.header.button.value")
lcPrimaryNavigationValue = loJResp.StringOf("custom.header.primaryNavigation.value")
lcSecondaryNavigationValue = loJResp.StringOf("custom.header.secondaryNavigation.value")
lcSearchValue = loJResp.StringOf("custom.header.search.value")
lcScreenValue = loJResp.StringOf("custom.content.screen.value")
lcContainerValue = loJResp.StringOf("custom.content.container.value")
lcHeaderValue = loJResp.StringOf("custom.content.header.value")
lcBodyValue = loJResp.StringOf("custom.content.body.value")
lcBordersAndDividersColor = loJResp.StringOf("custom.bordersAndDividers.color")
lcHeadingsColor = loJResp.StringOf("theme.headings.color")
lcLinksColor = loJResp.StringOf("theme.links.color")
lcHoverOrFocusValue = loJResp.StringOf("theme.menus.hoverOrFocus.value")
lcColorValue = loJResp.StringOf("theme.menus.color.value")
lcBackgroundColorValue = loJResp.StringOf("theme.header.backgroundColor.value")
lcButtonValue = loJResp.StringOf("theme.header.button.value")
lcPrimaryNavigationValue = loJResp.StringOf("theme.header.primaryNavigation.value")
lcSecondaryNavigationValue = loJResp.StringOf("theme.header.secondaryNavigation.value")
lcSearchValue = loJResp.StringOf("theme.header.search.value")
lcScreenValue = loJResp.StringOf("theme.content.screen.value")
lcContainerValue = loJResp.StringOf("theme.content.container.value")
lcHeaderValue = loJResp.StringOf("theme.content.header.value")
lcBodyValue = loJResp.StringOf("theme.content.body.value")
lcBordersAndDividersColor = loJResp.StringOf("theme.bordersAndDividers.color")
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
