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
DECLARE @iTmp0 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
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'spaceKey', '<string>'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @selected nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @selected OUT, 'selected'
DECLARE @Color nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Color OUT, 'global.headings.color'
DECLARE @LinksColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LinksColor OUT, 'global.links.color'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'global.menus.hoverOrFocus.value'
DECLARE @ColorValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ColorValue OUT, 'global.menus.color.value'
DECLARE @BackgroundColorValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @BackgroundColorValue OUT, 'global.header.backgroundColor.value'
DECLARE @ButtonValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ButtonValue OUT, 'global.header.button.value'
DECLARE @PrimaryNavigationValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PrimaryNavigationValue OUT, 'global.header.primaryNavigation.value'
DECLARE @SecondaryNavigationValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SecondaryNavigationValue OUT, 'global.header.secondaryNavigation.value'
DECLARE @SearchValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SearchValue OUT, 'global.header.search.value'
DECLARE @ScreenValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ScreenValue OUT, 'global.content.screen.value'
DECLARE @ContainerValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ContainerValue OUT, 'global.content.container.value'
DECLARE @HeaderValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @HeaderValue OUT, 'global.content.header.value'
DECLARE @BodyValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @BodyValue OUT, 'global.content.body.value'
DECLARE @BordersAndDividersColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @BordersAndDividersColor OUT, 'global.bordersAndDividers.color'
DECLARE @HeadingsColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @HeadingsColor OUT, 'custom.headings.color'
EXEC sp_OAMethod @jResp, 'StringOf', @LinksColor OUT, 'custom.links.color'
DECLARE @HoverOrFocusValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @HoverOrFocusValue OUT, 'custom.menus.hoverOrFocus.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ColorValue OUT, 'custom.menus.color.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BackgroundColorValue OUT, 'custom.header.backgroundColor.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ButtonValue OUT, 'custom.header.button.value'
EXEC sp_OAMethod @jResp, 'StringOf', @PrimaryNavigationValue OUT, 'custom.header.primaryNavigation.value'
EXEC sp_OAMethod @jResp, 'StringOf', @SecondaryNavigationValue OUT, 'custom.header.secondaryNavigation.value'
EXEC sp_OAMethod @jResp, 'StringOf', @SearchValue OUT, 'custom.header.search.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ScreenValue OUT, 'custom.content.screen.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ContainerValue OUT, 'custom.content.container.value'
EXEC sp_OAMethod @jResp, 'StringOf', @HeaderValue OUT, 'custom.content.header.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BodyValue OUT, 'custom.content.body.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BordersAndDividersColor OUT, 'custom.bordersAndDividers.color'
EXEC sp_OAMethod @jResp, 'StringOf', @HeadingsColor OUT, 'theme.headings.color'
EXEC sp_OAMethod @jResp, 'StringOf', @LinksColor OUT, 'theme.links.color'
EXEC sp_OAMethod @jResp, 'StringOf', @HoverOrFocusValue OUT, 'theme.menus.hoverOrFocus.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ColorValue OUT, 'theme.menus.color.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BackgroundColorValue OUT, 'theme.header.backgroundColor.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ButtonValue OUT, 'theme.header.button.value'
EXEC sp_OAMethod @jResp, 'StringOf', @PrimaryNavigationValue OUT, 'theme.header.primaryNavigation.value'
EXEC sp_OAMethod @jResp, 'StringOf', @SecondaryNavigationValue OUT, 'theme.header.secondaryNavigation.value'
EXEC sp_OAMethod @jResp, 'StringOf', @SearchValue OUT, 'theme.header.search.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ScreenValue OUT, 'theme.content.screen.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ContainerValue OUT, 'theme.content.container.value'
EXEC sp_OAMethod @jResp, 'StringOf', @HeaderValue OUT, 'theme.content.header.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BodyValue OUT, 'theme.content.body.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BordersAndDividersColor OUT, 'theme.bordersAndDividers.color'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
