Chilkat Online Tools

Perl / Atlassian Confluence Cloud / Get themes

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateInt("start",0);
$queryParams->UpdateInt("limit",100);

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

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/settings/theme",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "results": [
#     {
#       "themeKey": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       },
#       "name": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       },
#       "description": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       },
#       "icon": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       }
#     },
#     {
#       "themeKey": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       },
#       "name": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       },
#       "description": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       },
#       "icon": {
#         "value": "<Error: Too many levels of nesting to fake this schema>"
#       }
#     }
#   ],
#   "start": -38154645,
#   "limit": 39974479,
#   "size": 80861730,
#   "_links": {}
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$start = $jResp->IntOf("start");
$limit = $jResp->IntOf("limit");
$size = $jResp->IntOf("size");
$i = 0;
$count_i = $jResp->SizeOfArray("results");
while ($i < $count_i) {
    $jResp->put_I($i);
    $Value = $jResp->stringOf("results[i].themeKey.value");
    $nameValue = $jResp->stringOf("results[i].name.value");
    $descriptionValue = $jResp->stringOf("results[i].description.value");
    $iconValue = $jResp->stringOf("results[i].icon.value");
    $i = $i + 1;
}

Curl Command

curl -G -d "start=0"
	-d "limit=100"
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/settings/theme

Postman Collection Item JSON

{
  "name": "Get themes",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/settings/theme?start=0&limit=100",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "settings",
        "theme"
      ],
      "query": [
        {
          "key": "start",
          "value": "0",
          "description": "The starting index of the returned themes."
        },
        {
          "key": "limit",
          "value": "100",
          "description": "The maximum number of themes to return per page.\nNote, this may be restricted by fixed system limits."
        }
      ]
    },
    "description": "Returns all themes, not including the default theme.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None"
  },
  "response": [
    {
      "name": "Returned if the requested themes 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/theme?start=0&limit=100",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "settings",
            "theme"
          ],
          "query": [
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "100"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"results\": [\n  {\n   \"themeKey\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"name\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"description\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"icon\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  },\n  {\n   \"themeKey\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"name\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"description\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   },\n   \"icon\": {\n    \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n   }\n  }\n ],\n \"start\": -38154645,\n \"limit\": 39974479,\n \"size\": 80861730,\n \"_links\": {}\n}"
    }
  ]
}