Chilkat Online Tools

VB.NET / Atlassian Confluence Cloud / Update 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

' 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>"
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("headings.color","<string>")
json.UpdateString("links.color","<string>")
json.UpdateString("menus.hoverOrFocus.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("menus.color.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("header.backgroundColor.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("header.button.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("header.primaryNavigation.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("header.secondaryNavigation.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("header.search.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("content.screen.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("content.container.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("content.header.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("content.body.value","<Error: Too many levels of nesting to fake this schema>")
json.UpdateString("bordersAndDividers.color","<string>")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom?spaceKey=<string>","application/json",json)
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


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": ""
    }
  ]
}