Chilkat Online Tools

Xojo / Atlassian Confluence Cloud / Get themes

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

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateInt("start",0)
success = queryParams.UpdateInt("limit",100)

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/settings/theme",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim Value As String
Dim nameValue As String
Dim descriptionValue As String
Dim iconValue As String

Dim start As Int32
start = jResp.IntOf("start")
Dim limit As Int32
limit = jResp.IntOf("limit")
Dim size As Int32
size = jResp.IntOf("size")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("results")
While i < count_i
    jResp.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
Wend

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