Chilkat Online Tools

TCL / Atlassian Confluence Cloud / Get themes

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateInt $queryParams "start" 0
CkJsonObject_UpdateInt $queryParams "limit" 100

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://your-domain.atlassian.net/wiki/rest/api/settings/theme" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set start [CkJsonObject_IntOf $jResp "start"]
set limit [CkJsonObject_IntOf $jResp "limit"]
set size [CkJsonObject_IntOf $jResp "size"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Value [CkJsonObject_stringOf $jResp "results[i].themeKey.value"]
    set nameValue [CkJsonObject_stringOf $jResp "results[i].name.value"]
    set descriptionValue [CkJsonObject_stringOf $jResp "results[i].description.value"]
    set iconValue [CkJsonObject_stringOf $jResp "results[i].icon.value"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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