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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "headings": {
-- "color": "<string>"
-- },
-- "links": {
-- "color": "<string>"
-- },
-- "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": "<string>"
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'headings.color', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'links.color', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'menus.hoverOrFocus.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'menus.color.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'header.backgroundColor.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'header.button.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'header.primaryNavigation.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'header.secondaryNavigation.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'header.search.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.screen.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.container.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.header.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.body.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bordersAndDividers.color', '<string>'
-- 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 @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom?spaceKey=<string>', 'application/json', @json
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 @json
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 @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"headings": {
"color": "<string>"
},
"links": {
"color": "<string>"
},
"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": "<string>"
}
}'
https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom?spaceKey=<string>
Postman Collection Item JSON
{
"name": "Update look and feel settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\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\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/settings/lookandfeel/custom?spaceKey=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"settings",
"lookandfeel",
"custom"
],
"query": [
{
"key": "spaceKey",
"value": "<string>",
"description": "The key of the space for which the look and feel settings will be\nupdated. If this is not set, the global look and feel settings will\nbe updated."
}
]
},
"description": "Updates the look and feel settings for the site or for a single space.\nIf custom settings exist, they are updated. If no custom settings exist,\nthen a set of custom settings is created.\n\nNote, if a theme is selected for a space, the space look and feel settings\nare provided by the theme and cannot be overridden.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space."
},
"response": [
{
"name": "Returned if the look and feel settings are updated.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\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\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/settings/lookandfeel/custom?spaceKey=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"settings",
"lookandfeel",
"custom"
],
"query": [
{
"key": "spaceKey",
"value": "<string>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "Returned if;\n\n- The `spaceKey` is invalid\n- The request body contains invalid data.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\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\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/settings/lookandfeel/custom?spaceKey=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"settings",
"lookandfeel",
"custom"
],
"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 the calling user doesn't have permission to edit the\nlook and feel settings.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\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\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/settings/lookandfeel/custom?spaceKey=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"settings",
"lookandfeel",
"custom"
],
"query": [
{
"key": "spaceKey",
"value": "<string>"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_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": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\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\": \"<string>\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/api/settings/lookandfeel/custom?spaceKey=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"settings",
"lookandfeel",
"custom"
],
"query": [
{
"key": "spaceKey",
"value": "<string>"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
