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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'accountId', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'expand', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'expand', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'limit', '<integer>'
-- 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/bulk', @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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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": [
-- {
-- "type": "user",
-- "accountId": "elit est ullamco in officia",
-- "accountType": "exercitation fugiat labo",
-- "email": "Excepteur in cillum officia",
-- "publicName": "ullamco occaecat",
-- "profilePicture": {
-- "path": "cupidatat dolore et labore ad",
-- "width": -99848841,
-- "height": 55035562,
-- "isDefault": true
-- },
-- "displayName": "amet",
-- "_expandable": {
-- "operations": "labore ut Duis id culpa",
-- "details": "in irure voluptate Duis magna",
-- "personalSpace": "n"
-- },
-- "_links": {},
-- "username": "est sunt dolor nostrud",
-- "userKey": "labo",
-- "operations": [
-- {
-- "operation": "update",
-- "targetType": "attachment"
-- },
-- {
-- "operation": "administer",
-- "targetType": "attachment"
-- }
-- ],
-- "details": {
-- "business": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "personal": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "personalSpace": {
-- "id": -93610124,
-- "key": "in eiusmod",
-- "name": "ut minim Excepteur",
-- "type": "sunt qui amet",
-- "status": "null",
-- "_expandable": {
-- "settings": "pariatur deserunt anim",
-- "metadata": "anim occaecat aliqua",
-- "operations": "aute nostrud in",
-- "lookAndFeel": "est irure aute labore",
-- "permissions": "in cupidatat qui",
-- "icon": "voluptate Duis",
-- "description": "culpa veniam Lorem velit",
-- "theme": "consequat sunt reprehenderit",
-- "history": "ex officia veniam sit do",
-- "homepage": "dolore dolore"
-- },
-- "_links": {},
-- "icon": {
-- "path": "dolore Lorem magna sunt",
-- "width": 3933679,
-- "height": -17426468,
-- "isDefault": false
-- },
-- "description": {
-- "plain": {
-- "value": "consequat consectetur laborum labore occaecat",
-- "representation": "view",
-- "embeddedContent": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ]
-- },
-- "view": {
-- "value": "Duis reprehenderit anim ut",
-- "representation": "view",
-- "embeddedContent": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ]
-- }
-- },
-- "homepage": {
-- "value": "<Circular reference to #/components/schemas/Content detected>"
-- },
-- "metadata": {
-- "labels": {
-- "results": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ],
-- "start": 23981894,
-- "limit": -68365223,
-- "size": -97521792,
-- "_links": {}
-- }
-- },
-- "operations": [
-- {
-- "operation": "administer",
-- "targetType": "blogpost"
-- },
-- {
-- "operation": "delete",
-- "targetType": "blogpost"
-- }
-- ],
-- "permissions": [
-- {
-- "subjects": {
-- "_expandable": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "user": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "group": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "operation": {
-- "operation": "read",
-- "targetType": "space"
-- },
-- "anonymousAccess": false,
-- "unlicensedAccess": false
-- },
-- {
-- "subjects": {
-- "_expandable": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "user": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "group": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "operation": {
-- "operation": "restore",
-- "targetType": "blogpost"
-- },
-- "anonymousAccess": false,
-- "unlicensedAccess": false
-- }
-- ],
-- "settings": {
-- "routeOverrideEnabled": true,
-- "_links": {}
-- },
-- "theme": {},
-- "lookAndFeel": {
-- "headings": {
-- "color": "<string>"
-- },
-- "links": {
-- "color": "<string>"
-- },
-- "menus": {
-- "hoverOrFocus": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "color": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "header": {
-- "backgroundColor": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "button": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "primaryNavigation": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "secondaryNavigation": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "search": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "content": {
-- "screen": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "container": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "header": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "body": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "bordersAndDividers": {
-- "color": "<string>"
-- }
-- },
-- "history": {
-- "createdDate": "2004-03-14T14:56:20.738Z"
-- }
-- }
-- },
-- {
-- "type": "user",
-- "accountId": "aliquip ex aute occaecat minim",
-- "accountType": "cupidatat dolore",
-- "email": "tempor non",
-- "publicName": "Lorem",
-- "profilePicture": {
-- "path": "fugiat ex sit sunt",
-- "width": 86996840,
-- "height": -45552232,
-- "isDefault": false
-- },
-- "displayName": "eu qui mollit",
-- "_expandable": {
-- "operations": "laborum dolor magna adipisicing",
-- "details": "culpa quis a",
-- "personalSpace": "id in"
-- },
-- "_links": {},
-- "username": "proident minim et ipsum",
-- "userKey": "est conseq",
-- "operations": [
-- {
-- "operation": "copy",
-- "targetType": "comment"
-- },
-- {
-- "operation": "purge_version",
-- "targetType": "application"
-- }
-- ],
-- "details": {
-- "business": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "personal": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "personalSpace": {
-- "id": -77236660,
-- "key": "mollit",
-- "name": "mollit reprehenderit",
-- "type": "ipsum eu",
-- "status": "id magna esse",
-- "_expandable": {
-- "settings": "Lorem cupidatat fugiat id",
-- "metadata": "ut non",
-- "operations": "m",
-- "lookAndFeel": "elit ",
-- "permissions": "proident labore",
-- "icon": "ut fugiat esse do",
-- "description": "sunt",
-- "theme": "ea consequat aliqua",
-- "history": "ullamco culpa",
-- "homepage": "eu esse ut amet"
-- },
-- "_links": {},
-- "icon": {
-- "path": "laborum magna Dui",
-- "width": -87940522,
-- "height": -74576861,
-- "isDefault": true
-- },
-- "description": {
-- "plain": {
-- "value": "adipisicing proident magna nulla",
-- "representation": "view",
-- "embeddedContent": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ]
-- },
-- "view": {
-- "value": "quis enim ex adipisicing",
-- "representation": "plain",
-- "embeddedContent": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ]
-- }
-- },
-- "homepage": {
-- "value": "<Circular reference to #/components/schemas/Content detected>"
-- },
-- "metadata": {
-- "labels": {
-- "results": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ],
-- "start": 12150462,
-- "limit": -13231996,
-- "size": -79881326,
-- "_links": {}
-- }
-- },
-- "operations": [
-- {
-- "operation": "create",
-- "targetType": "page"
-- },
-- {
-- "operation": "update",
-- "targetType": "blogpost"
-- }
-- ],
-- "permissions": [
-- {
-- "subjects": {
-- "_expandable": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "user": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "group": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "operation": {
-- "operation": "purge",
-- "targetType": "attachment"
-- },
-- "anonymousAccess": false,
-- "unlicensedAccess": false
-- },
-- {
-- "subjects": {
-- "_expandable": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "user": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "group": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "operation": {
-- "operation": "delete",
-- "targetType": "application"
-- },
-- "anonymousAccess": false,
-- "unlicensedAccess": false
-- }
-- ],
-- "settings": {
-- "routeOverrideEnabled": true,
-- "_links": {}
-- },
-- "theme": {},
-- "lookAndFeel": {
-- "headings": {
-- "color": "<string>"
-- },
-- "links": {
-- "color": "<string>"
-- },
-- "menus": {
-- "hoverOrFocus": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "color": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "header": {
-- "backgroundColor": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "button": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "primaryNavigation": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "secondaryNavigation": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "search": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "content": {
-- "screen": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "container": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "header": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "body": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "bordersAndDividers": {
-- "color": "<string>"
-- }
-- },
-- "history": {
-- "createdDate": "1965-11-18T11:33:14.736Z"
-- }
-- }
-- }
-- ],
-- "start": -77819495,
-- "limit": -88196390,
-- "size": -80415169,
-- "_links": {}
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @v_type nvarchar(4000)
DECLARE @accountId nvarchar(4000)
DECLARE @accountType nvarchar(4000)
DECLARE @email nvarchar(4000)
DECLARE @publicName nvarchar(4000)
DECLARE @Path nvarchar(4000)
DECLARE @Width int
DECLARE @Height int
DECLARE @IsDefault int
DECLARE @displayName nvarchar(4000)
DECLARE @Operations nvarchar(4000)
DECLARE @Details nvarchar(4000)
DECLARE @PersonalSpace nvarchar(4000)
DECLARE @username nvarchar(4000)
DECLARE @userKey nvarchar(4000)
DECLARE @Value nvarchar(4000)
DECLARE @PersonalValue nvarchar(4000)
DECLARE @Id int
DECLARE @Key nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @Status nvarchar(4000)
DECLARE @Settings nvarchar(4000)
DECLARE @Metadata nvarchar(4000)
DECLARE @v_expandableOperations nvarchar(4000)
DECLARE @LookAndFeel nvarchar(4000)
DECLARE @Permissions nvarchar(4000)
DECLARE @Icon nvarchar(4000)
DECLARE @Description nvarchar(4000)
DECLARE @Theme nvarchar(4000)
DECLARE @History nvarchar(4000)
DECLARE @Homepage nvarchar(4000)
DECLARE @IconPath nvarchar(4000)
DECLARE @IconWidth int
DECLARE @IconHeight int
DECLARE @IconIsDefault int
DECLARE @PlainValue nvarchar(4000)
DECLARE @Representation nvarchar(4000)
DECLARE @ViewValue nvarchar(4000)
DECLARE @ViewRepresentation nvarchar(4000)
DECLARE @HomepageValue nvarchar(4000)
DECLARE @Start int
DECLARE @Limit int
DECLARE @Size int
DECLARE @RouteOverrideEnabled int
DECLARE @Color nvarchar(4000)
DECLARE @LinksColor nvarchar(4000)
DECLARE @HoverOrFocusValue nvarchar(4000)
DECLARE @ColorValue nvarchar(4000)
DECLARE @BackgroundColorValue nvarchar(4000)
DECLARE @ButtonValue nvarchar(4000)
DECLARE @PrimaryNavigationValue nvarchar(4000)
DECLARE @SecondaryNavigationValue nvarchar(4000)
DECLARE @SearchValue nvarchar(4000)
DECLARE @ScreenValue nvarchar(4000)
DECLARE @ContainerValue nvarchar(4000)
DECLARE @HeaderValue nvarchar(4000)
DECLARE @BodyValue nvarchar(4000)
DECLARE @BordersAndDividersColor nvarchar(4000)
DECLARE @CreatedDate nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @operation nvarchar(4000)
DECLARE @targetType nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @v_expandableValue nvarchar(4000)
DECLARE @UserValue nvarchar(4000)
DECLARE @GroupValue nvarchar(4000)
DECLARE @Operation nvarchar(4000)
DECLARE @TargetType nvarchar(4000)
DECLARE @anonymousAccess int
DECLARE @unlicensedAccess int
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', @v_type OUT, 'results[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @accountId OUT, 'results[i].accountId'
EXEC sp_OAMethod @jResp, 'StringOf', @accountType OUT, 'results[i].accountType'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'results[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @publicName OUT, 'results[i].publicName'
EXEC sp_OAMethod @jResp, 'StringOf', @Path OUT, 'results[i].profilePicture.path'
EXEC sp_OAMethod @jResp, 'IntOf', @Width OUT, 'results[i].profilePicture.width'
EXEC sp_OAMethod @jResp, 'IntOf', @Height OUT, 'results[i].profilePicture.height'
EXEC sp_OAMethod @jResp, 'BoolOf', @IsDefault OUT, 'results[i].profilePicture.isDefault'
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'results[i].displayName'
EXEC sp_OAMethod @jResp, 'StringOf', @Operations OUT, 'results[i]._expandable.operations'
EXEC sp_OAMethod @jResp, 'StringOf', @Details OUT, 'results[i]._expandable.details'
EXEC sp_OAMethod @jResp, 'StringOf', @PersonalSpace OUT, 'results[i]._expandable.personalSpace'
EXEC sp_OAMethod @jResp, 'StringOf', @username OUT, 'results[i].username'
EXEC sp_OAMethod @jResp, 'StringOf', @userKey OUT, 'results[i].userKey'
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'results[i].details.business.value'
EXEC sp_OAMethod @jResp, 'StringOf', @PersonalValue OUT, 'results[i].details.personal.value'
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'results[i].personalSpace.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Key OUT, 'results[i].personalSpace.key'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'results[i].personalSpace.name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'results[i].personalSpace.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'results[i].personalSpace.status'
EXEC sp_OAMethod @jResp, 'StringOf', @Settings OUT, 'results[i].personalSpace._expandable.settings'
EXEC sp_OAMethod @jResp, 'StringOf', @Metadata OUT, 'results[i].personalSpace._expandable.metadata'
EXEC sp_OAMethod @jResp, 'StringOf', @v_expandableOperations OUT, 'results[i].personalSpace._expandable.operations'
EXEC sp_OAMethod @jResp, 'StringOf', @LookAndFeel OUT, 'results[i].personalSpace._expandable.lookAndFeel'
EXEC sp_OAMethod @jResp, 'StringOf', @Permissions OUT, 'results[i].personalSpace._expandable.permissions'
EXEC sp_OAMethod @jResp, 'StringOf', @Icon OUT, 'results[i].personalSpace._expandable.icon'
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'results[i].personalSpace._expandable.description'
EXEC sp_OAMethod @jResp, 'StringOf', @Theme OUT, 'results[i].personalSpace._expandable.theme'
EXEC sp_OAMethod @jResp, 'StringOf', @History OUT, 'results[i].personalSpace._expandable.history'
EXEC sp_OAMethod @jResp, 'StringOf', @Homepage OUT, 'results[i].personalSpace._expandable.homepage'
EXEC sp_OAMethod @jResp, 'StringOf', @IconPath OUT, 'results[i].personalSpace.icon.path'
EXEC sp_OAMethod @jResp, 'IntOf', @IconWidth OUT, 'results[i].personalSpace.icon.width'
EXEC sp_OAMethod @jResp, 'IntOf', @IconHeight OUT, 'results[i].personalSpace.icon.height'
EXEC sp_OAMethod @jResp, 'BoolOf', @IconIsDefault OUT, 'results[i].personalSpace.icon.isDefault'
EXEC sp_OAMethod @jResp, 'StringOf', @PlainValue OUT, 'results[i].personalSpace.description.plain.value'
EXEC sp_OAMethod @jResp, 'StringOf', @Representation OUT, 'results[i].personalSpace.description.plain.representation'
EXEC sp_OAMethod @jResp, 'StringOf', @ViewValue OUT, 'results[i].personalSpace.description.view.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ViewRepresentation OUT, 'results[i].personalSpace.description.view.representation'
EXEC sp_OAMethod @jResp, 'StringOf', @HomepageValue OUT, 'results[i].personalSpace.homepage.value'
EXEC sp_OAMethod @jResp, 'IntOf', @Start OUT, 'results[i].personalSpace.metadata.labels.start'
EXEC sp_OAMethod @jResp, 'IntOf', @Limit OUT, 'results[i].personalSpace.metadata.labels.limit'
EXEC sp_OAMethod @jResp, 'IntOf', @Size OUT, 'results[i].personalSpace.metadata.labels.size'
EXEC sp_OAMethod @jResp, 'BoolOf', @RouteOverrideEnabled OUT, 'results[i].personalSpace.settings.routeOverrideEnabled'
EXEC sp_OAMethod @jResp, 'StringOf', @Color OUT, 'results[i].personalSpace.lookAndFeel.headings.color'
EXEC sp_OAMethod @jResp, 'StringOf', @LinksColor OUT, 'results[i].personalSpace.lookAndFeel.links.color'
EXEC sp_OAMethod @jResp, 'StringOf', @HoverOrFocusValue OUT, 'results[i].personalSpace.lookAndFeel.menus.hoverOrFocus.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ColorValue OUT, 'results[i].personalSpace.lookAndFeel.menus.color.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BackgroundColorValue OUT, 'results[i].personalSpace.lookAndFeel.header.backgroundColor.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ButtonValue OUT, 'results[i].personalSpace.lookAndFeel.header.button.value'
EXEC sp_OAMethod @jResp, 'StringOf', @PrimaryNavigationValue OUT, 'results[i].personalSpace.lookAndFeel.header.primaryNavigation.value'
EXEC sp_OAMethod @jResp, 'StringOf', @SecondaryNavigationValue OUT, 'results[i].personalSpace.lookAndFeel.header.secondaryNavigation.value'
EXEC sp_OAMethod @jResp, 'StringOf', @SearchValue OUT, 'results[i].personalSpace.lookAndFeel.header.search.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ScreenValue OUT, 'results[i].personalSpace.lookAndFeel.content.screen.value'
EXEC sp_OAMethod @jResp, 'StringOf', @ContainerValue OUT, 'results[i].personalSpace.lookAndFeel.content.container.value'
EXEC sp_OAMethod @jResp, 'StringOf', @HeaderValue OUT, 'results[i].personalSpace.lookAndFeel.content.header.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BodyValue OUT, 'results[i].personalSpace.lookAndFeel.content.body.value'
EXEC sp_OAMethod @jResp, 'StringOf', @BordersAndDividersColor OUT, 'results[i].personalSpace.lookAndFeel.bordersAndDividers.color'
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedDate OUT, 'results[i].personalSpace.history.createdDate'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].operations'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @operation OUT, 'results[i].operations[j].operation'
EXEC sp_OAMethod @jResp, 'StringOf', @targetType OUT, 'results[i].operations[j].targetType'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].personalSpace.description.plain.embeddedContent'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'results[i].personalSpace.description.plain.embeddedContent[j].value'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].personalSpace.description.view.embeddedContent'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'results[i].personalSpace.description.view.embeddedContent[j].value'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].personalSpace.metadata.labels.results'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'results[i].personalSpace.metadata.labels.results[j].value'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].personalSpace.operations'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @operation OUT, 'results[i].personalSpace.operations[j].operation'
EXEC sp_OAMethod @jResp, 'StringOf', @targetType OUT, 'results[i].personalSpace.operations[j].targetType'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].personalSpace.permissions'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @v_expandableValue OUT, 'results[i].personalSpace.permissions[j].subjects._expandable.value'
EXEC sp_OAMethod @jResp, 'StringOf', @UserValue OUT, 'results[i].personalSpace.permissions[j].subjects.user.value'
EXEC sp_OAMethod @jResp, 'StringOf', @GroupValue OUT, 'results[i].personalSpace.permissions[j].subjects.group.value'
EXEC sp_OAMethod @jResp, 'StringOf', @Operation OUT, 'results[i].personalSpace.permissions[j].operation.operation'
EXEC sp_OAMethod @jResp, 'StringOf', @TargetType OUT, 'results[i].personalSpace.permissions[j].operation.targetType'
EXEC sp_OAMethod @jResp, 'BoolOf', @anonymousAccess OUT, 'results[i].personalSpace.permissions[j].anonymousAccess'
EXEC sp_OAMethod @jResp, 'BoolOf', @unlicensedAccess OUT, 'results[i].personalSpace.permissions[j].unlicensedAccess'
SELECT @j = @j + 1
END
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 "accountId=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "limit=%3Cinteger%3E"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user/bulk
Postman Collection Item JSON
{
"name": "Get multiple users using ids",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk"
],
"query": [
{
"key": "accountId",
"value": "<string>",
"description": "(Required) A list of accountId's of users to be returned."
},
{
"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.\n - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - personalSpace returns the user's personal space, if it exists."
},
{
"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.\n - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - personalSpace returns the user's personal space, if it exists."
},
{
"key": "limit",
"value": "<integer>",
"description": "The maximum number of results returned.\nCurrently API returns 200 results max.\nIf more that 200 ids are passed first 200 will be returned."
}
]
},
"description": "Returns user details for the ids provided in request.\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 list of users 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/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk"
],
"query": [
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "limit",
"value": "<integer>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"type\": \"user\",\n \"accountId\": \"elit est ullamco in officia\",\n \"accountType\": \"exercitation fugiat labo\",\n \"email\": \"Excepteur in cillum officia\",\n \"publicName\": \"ullamco occaecat\",\n \"profilePicture\": {\n \"path\": \"cupidatat dolore et labore ad\",\n \"width\": -99848841,\n \"height\": 55035562,\n \"isDefault\": true\n },\n \"displayName\": \"amet\",\n \"_expandable\": {\n \"operations\": \"labore ut Duis id culpa\",\n \"details\": \"in irure voluptate Duis magna\",\n \"personalSpace\": \"n\"\n },\n \"_links\": {},\n \"username\": \"est sunt dolor nostrud\",\n \"userKey\": \"labo\",\n \"operations\": [\n {\n \"operation\": \"update\",\n \"targetType\": \"attachment\"\n },\n {\n \"operation\": \"administer\",\n \"targetType\": \"attachment\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": -93610124,\n \"key\": \"in eiusmod\",\n \"name\": \"ut minim Excepteur\",\n \"type\": \"sunt qui amet\",\n \"status\": \"null\",\n \"_expandable\": {\n \"settings\": \"pariatur deserunt anim\",\n \"metadata\": \"anim occaecat aliqua\",\n \"operations\": \"aute nostrud in\",\n \"lookAndFeel\": \"est irure aute labore\",\n \"permissions\": \"in cupidatat qui\",\n \"icon\": \"voluptate Duis\",\n \"description\": \"culpa veniam Lorem velit\",\n \"theme\": \"consequat sunt reprehenderit\",\n \"history\": \"ex officia veniam sit do\",\n \"homepage\": \"dolore dolore\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"dolore Lorem magna sunt\",\n \"width\": 3933679,\n \"height\": -17426468,\n \"isDefault\": false\n },\n \"description\": {\n \"plain\": {\n \"value\": \"consequat consectetur laborum labore occaecat\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"Duis reprehenderit anim ut\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 23981894,\n \"limit\": -68365223,\n \"size\": -97521792,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"administer\",\n \"targetType\": \"blogpost\"\n },\n {\n \"operation\": \"delete\",\n \"targetType\": \"blogpost\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"read\",\n \"targetType\": \"space\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"restore\",\n \"targetType\": \"blogpost\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": true,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"<string>\"\n }\n },\n \"history\": {\n \"createdDate\": \"2004-03-14T14:56:20.738Z\"\n }\n }\n },\n {\n \"type\": \"user\",\n \"accountId\": \"aliquip ex aute occaecat minim\",\n \"accountType\": \"cupidatat dolore\",\n \"email\": \"tempor non\",\n \"publicName\": \"Lorem\",\n \"profilePicture\": {\n \"path\": \"fugiat ex sit sunt\",\n \"width\": 86996840,\n \"height\": -45552232,\n \"isDefault\": false\n },\n \"displayName\": \"eu qui mollit\",\n \"_expandable\": {\n \"operations\": \"laborum dolor magna adipisicing\",\n \"details\": \"culpa quis a\",\n \"personalSpace\": \"id in\"\n },\n \"_links\": {},\n \"username\": \"proident minim et ipsum\",\n \"userKey\": \"est conseq\",\n \"operations\": [\n {\n \"operation\": \"copy\",\n \"targetType\": \"comment\"\n },\n {\n \"operation\": \"purge_version\",\n \"targetType\": \"application\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": -77236660,\n \"key\": \"mollit\",\n \"name\": \"mollit reprehenderit\",\n \"type\": \"ipsum eu\",\n \"status\": \"id magna esse\",\n \"_expandable\": {\n \"settings\": \"Lorem cupidatat fugiat id\",\n \"metadata\": \"ut non\",\n \"operations\": \"m\",\n \"lookAndFeel\": \"elit \",\n \"permissions\": \"proident labore\",\n \"icon\": \"ut fugiat esse do\",\n \"description\": \"sunt\",\n \"theme\": \"ea consequat aliqua\",\n \"history\": \"ullamco culpa\",\n \"homepage\": \"eu esse ut amet\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"laborum magna Dui\",\n \"width\": -87940522,\n \"height\": -74576861,\n \"isDefault\": true\n },\n \"description\": {\n \"plain\": {\n \"value\": \"adipisicing proident magna nulla\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"quis enim ex adipisicing\",\n \"representation\": \"plain\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 12150462,\n \"limit\": -13231996,\n \"size\": -79881326,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"create\",\n \"targetType\": \"page\"\n },\n {\n \"operation\": \"update\",\n \"targetType\": \"blogpost\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"purge\",\n \"targetType\": \"attachment\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"delete\",\n \"targetType\": \"application\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": true,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"<string>\"\n }\n },\n \"history\": {\n \"createdDate\": \"1965-11-18T11:33:14.736Z\"\n }\n }\n }\n ],\n \"start\": -77819495,\n \"limit\": -88196390,\n \"size\": -80415169,\n \"_links\": {}\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/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk"
],
"query": [
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "limit",
"value": "<integer>"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
