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, 'UpdateString', @success OUT, 'expand', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'expand', '<string>'
-- 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/user/anonymous', @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)
-- {
-- "type": "non ut",
-- "profilePicture": {
-- "path": "id pariatur occaecat cillum",
-- "width": 98006898,
-- "height": 65551585,
-- "isDefault": true
-- },
-- "displayName": "eiusmod",
-- "_expandable": {
-- "operations": "Duis"
-- },
-- "_links": {},
-- "operations": [
-- {
-- "operation": "purge",
-- "targetType": "page"
-- },
-- {
-- "operation": "purge",
-- "targetType": "attachment"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @operation nvarchar(4000)
DECLARE @targetType nvarchar(4000)
DECLARE @v_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'type'
DECLARE @Path nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Path OUT, 'profilePicture.path'
DECLARE @Width int
EXEC sp_OAMethod @jResp, 'IntOf', @Width OUT, 'profilePicture.width'
DECLARE @Height int
EXEC sp_OAMethod @jResp, 'IntOf', @Height OUT, 'profilePicture.height'
DECLARE @IsDefault int
EXEC sp_OAMethod @jResp, 'BoolOf', @IsDefault OUT, 'profilePicture.isDefault'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @Operations nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Operations OUT, '_expandable.operations'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'operations'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @operation OUT, 'operations[i].operation'
EXEC sp_OAMethod @jResp, 'StringOf', @targetType OUT, 'operations[i].targetType'
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 "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user/anonymous
Postman Collection Item JSON
{
"name": "Get anonymous user",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user/anonymous?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"anonymous"
],
"query": [
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do."
}
]
},
"description": "Returns information about how anonymous users are represented, like the\nprofile picture and display name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
},
"response": [
{
"name": "Returned if the anonymous user representation is 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/user/anonymous?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"anonymous"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"type\": \"non ut\",\n \"profilePicture\": {\n \"path\": \"id pariatur occaecat cillum\",\n \"width\": 98006898,\n \"height\": 65551585,\n \"isDefault\": true\n },\n \"displayName\": \"eiusmod\",\n \"_expandable\": {\n \"operations\": \"Duis\"\n },\n \"_links\": {},\n \"operations\": [\n {\n \"operation\": \"purge\",\n \"targetType\": \"page\"\n },\n {\n \"operation\": \"purge\",\n \"targetType\": \"attachment\"\n }\n ]\n}"
},
{
"name": "Returned if the calling user does not have permission to use\nConfluence.",
"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/user/anonymous?expand=<string>&expand=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"anonymous"
],
"query": [
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
