Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'start', 0
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 100
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @Value nvarchar(4000)
DECLARE @nameValue nvarchar(4000)
DECLARE @descriptionValue nvarchar(4000)
DECLARE @iconValue nvarchar(4000)
DECLARE @start int
EXEC sp_OAMethod @jResp, 'IntOf', @start OUT, 'start'
DECLARE @limit int
EXEC sp_OAMethod @jResp, 'IntOf', @limit OUT, 'limit'
DECLARE @size int
EXEC sp_OAMethod @jResp, 'IntOf', @size OUT, 'size'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'results'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'results[i].themeKey.value'
EXEC sp_OAMethod @jResp, 'StringOf', @nameValue OUT, 'results[i].name.value'
EXEC sp_OAMethod @jResp, 'StringOf', @descriptionValue OUT, 'results[i].description.value'
EXEC sp_OAMethod @jResp, 'StringOf', @iconValue OUT, 'results[i].icon.value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
