Chilkat Online Tools

C++ / Atlassian Confluence Cloud / Get look and feel settings

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("spaceKey","<string>");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *selected = jResp.stringOf("selected");
    const char *Color = jResp.stringOf("global.headings.color");
    const char *LinksColor = jResp.stringOf("global.links.color");
    const char *Value = jResp.stringOf("global.menus.hoverOrFocus.value");
    const char *ColorValue = jResp.stringOf("global.menus.color.value");
    const char *BackgroundColorValue = jResp.stringOf("global.header.backgroundColor.value");
    const char *ButtonValue = jResp.stringOf("global.header.button.value");
    const char *PrimaryNavigationValue = jResp.stringOf("global.header.primaryNavigation.value");
    const char *SecondaryNavigationValue = jResp.stringOf("global.header.secondaryNavigation.value");
    const char *SearchValue = jResp.stringOf("global.header.search.value");
    const char *ScreenValue = jResp.stringOf("global.content.screen.value");
    const char *ContainerValue = jResp.stringOf("global.content.container.value");
    const char *HeaderValue = jResp.stringOf("global.content.header.value");
    const char *BodyValue = jResp.stringOf("global.content.body.value");
    const char *BordersAndDividersColor = jResp.stringOf("global.bordersAndDividers.color");
    const char *HeadingsColor = jResp.stringOf("custom.headings.color");
    LinksColor = jResp.stringOf("custom.links.color");
    const char *HoverOrFocusValue = jResp.stringOf("custom.menus.hoverOrFocus.value");
    ColorValue = jResp.stringOf("custom.menus.color.value");
    BackgroundColorValue = jResp.stringOf("custom.header.backgroundColor.value");
    ButtonValue = jResp.stringOf("custom.header.button.value");
    PrimaryNavigationValue = jResp.stringOf("custom.header.primaryNavigation.value");
    SecondaryNavigationValue = jResp.stringOf("custom.header.secondaryNavigation.value");
    SearchValue = jResp.stringOf("custom.header.search.value");
    ScreenValue = jResp.stringOf("custom.content.screen.value");
    ContainerValue = jResp.stringOf("custom.content.container.value");
    HeaderValue = jResp.stringOf("custom.content.header.value");
    BodyValue = jResp.stringOf("custom.content.body.value");
    BordersAndDividersColor = jResp.stringOf("custom.bordersAndDividers.color");
    HeadingsColor = jResp.stringOf("theme.headings.color");
    LinksColor = jResp.stringOf("theme.links.color");
    HoverOrFocusValue = jResp.stringOf("theme.menus.hoverOrFocus.value");
    ColorValue = jResp.stringOf("theme.menus.color.value");
    BackgroundColorValue = jResp.stringOf("theme.header.backgroundColor.value");
    ButtonValue = jResp.stringOf("theme.header.button.value");
    PrimaryNavigationValue = jResp.stringOf("theme.header.primaryNavigation.value");
    SecondaryNavigationValue = jResp.stringOf("theme.header.secondaryNavigation.value");
    SearchValue = jResp.stringOf("theme.header.search.value");
    ScreenValue = jResp.stringOf("theme.content.screen.value");
    ContainerValue = jResp.stringOf("theme.content.container.value");
    HeaderValue = jResp.stringOf("theme.content.header.value");
    BodyValue = jResp.stringOf("theme.content.body.value");
    BordersAndDividersColor = jResp.stringOf("theme.bordersAndDividers.color");
    }

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