Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"spaceKey","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
selected.s = CkJsonObject::ckStringOf(jResp,"selected")
Color.s = CkJsonObject::ckStringOf(jResp,"global.headings.color")
LinksColor.s = CkJsonObject::ckStringOf(jResp,"global.links.color")
Value.s = CkJsonObject::ckStringOf(jResp,"global.menus.hoverOrFocus.value")
ColorValue.s = CkJsonObject::ckStringOf(jResp,"global.menus.color.value")
BackgroundColorValue.s = CkJsonObject::ckStringOf(jResp,"global.header.backgroundColor.value")
ButtonValue.s = CkJsonObject::ckStringOf(jResp,"global.header.button.value")
PrimaryNavigationValue.s = CkJsonObject::ckStringOf(jResp,"global.header.primaryNavigation.value")
SecondaryNavigationValue.s = CkJsonObject::ckStringOf(jResp,"global.header.secondaryNavigation.value")
SearchValue.s = CkJsonObject::ckStringOf(jResp,"global.header.search.value")
ScreenValue.s = CkJsonObject::ckStringOf(jResp,"global.content.screen.value")
ContainerValue.s = CkJsonObject::ckStringOf(jResp,"global.content.container.value")
HeaderValue.s = CkJsonObject::ckStringOf(jResp,"global.content.header.value")
BodyValue.s = CkJsonObject::ckStringOf(jResp,"global.content.body.value")
BordersAndDividersColor.s = CkJsonObject::ckStringOf(jResp,"global.bordersAndDividers.color")
HeadingsColor.s = CkJsonObject::ckStringOf(jResp,"custom.headings.color")
LinksColor = CkJsonObject::ckStringOf(jResp,"custom.links.color")
HoverOrFocusValue.s = CkJsonObject::ckStringOf(jResp,"custom.menus.hoverOrFocus.value")
ColorValue = CkJsonObject::ckStringOf(jResp,"custom.menus.color.value")
BackgroundColorValue = CkJsonObject::ckStringOf(jResp,"custom.header.backgroundColor.value")
ButtonValue = CkJsonObject::ckStringOf(jResp,"custom.header.button.value")
PrimaryNavigationValue = CkJsonObject::ckStringOf(jResp,"custom.header.primaryNavigation.value")
SecondaryNavigationValue = CkJsonObject::ckStringOf(jResp,"custom.header.secondaryNavigation.value")
SearchValue = CkJsonObject::ckStringOf(jResp,"custom.header.search.value")
ScreenValue = CkJsonObject::ckStringOf(jResp,"custom.content.screen.value")
ContainerValue = CkJsonObject::ckStringOf(jResp,"custom.content.container.value")
HeaderValue = CkJsonObject::ckStringOf(jResp,"custom.content.header.value")
BodyValue = CkJsonObject::ckStringOf(jResp,"custom.content.body.value")
BordersAndDividersColor = CkJsonObject::ckStringOf(jResp,"custom.bordersAndDividers.color")
HeadingsColor = CkJsonObject::ckStringOf(jResp,"theme.headings.color")
LinksColor = CkJsonObject::ckStringOf(jResp,"theme.links.color")
HoverOrFocusValue = CkJsonObject::ckStringOf(jResp,"theme.menus.hoverOrFocus.value")
ColorValue = CkJsonObject::ckStringOf(jResp,"theme.menus.color.value")
BackgroundColorValue = CkJsonObject::ckStringOf(jResp,"theme.header.backgroundColor.value")
ButtonValue = CkJsonObject::ckStringOf(jResp,"theme.header.button.value")
PrimaryNavigationValue = CkJsonObject::ckStringOf(jResp,"theme.header.primaryNavigation.value")
SecondaryNavigationValue = CkJsonObject::ckStringOf(jResp,"theme.header.secondaryNavigation.value")
SearchValue = CkJsonObject::ckStringOf(jResp,"theme.header.search.value")
ScreenValue = CkJsonObject::ckStringOf(jResp,"theme.content.screen.value")
ContainerValue = CkJsonObject::ckStringOf(jResp,"theme.content.container.value")
HeaderValue = CkJsonObject::ckStringOf(jResp,"theme.content.header.value")
BodyValue = CkJsonObject::ckStringOf(jResp,"theme.content.body.value")
BordersAndDividersColor = CkJsonObject::ckStringOf(jResp,"theme.bordersAndDividers.color")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
