Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateInt("start",0)
$oQueryParams.UpdateInt("limit",100)

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

Local $oResp = $oHttp.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/settings/theme",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sValue
Local $sNameValue
Local $sDescriptionValue
Local $sIconValue

Local $iStart = $oJResp.IntOf("start")
Local $iLimit = $oJResp.IntOf("limit")
Local $iSize = $oJResp.IntOf("size")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("results")
While $i < $iCount_i
    $oJResp.I = $i
    $sValue = $oJResp.StringOf("results[i].themeKey.value")
    $sNameValue = $oJResp.StringOf("results[i].name.value")
    $sDescriptionValue = $oJResp.StringOf("results[i].description.value")
    $sIconValue = $oJResp.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}"
    }
  ]
}