Chilkat Online Tools

PowerBuilder / Atlassian Confluence Cloud / Get spaces

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Id
string ls_Key
string ls_Name
string ls_V_type
string ls_Status
string ls_Settings
string ls_Metadata
string ls_Operations
string ls_LookAndFeel
string ls_Permissions
string ls_Icon
string ls_Description
string ls_Theme
string ls_History
string ls_Homepage
string ls_Path
integer li_Width
integer li_Height
integer li_IsDefault
string ls_Value
string ls_Representation
string ls_ViewValue
string ls_ViewRepresentation
string ls_HomepageValue
integer li_Start
integer li_Limit
integer li_Size
integer li_RouteOverrideEnabled
string ls_Color
string ls_LinksColor
string ls_HoverOrFocusValue
string ls_ColorValue
string ls_BackgroundColorValue
string ls_ButtonValue
string ls_PrimaryNavigationValue
string ls_SecondaryNavigationValue
string ls_SearchValue
string ls_ScreenValue
string ls_ContainerValue
string ls_HeaderValue
string ls_BodyValue
string ls_BordersAndDividersColor
string ls_CreatedDate
integer j
integer li_Count_j
string ls_Value
string ls_Operation
string ls_TargetType
string ls_V_expandableValue
string ls_UserValue
string ls_GroupValue
string ls_Operation
string ls_TargetType
integer li_AnonymousAccess
integer li_UnlicensedAccess
integer li_Start
integer li_Limit
integer li_Size
integer i
integer li_Count_i

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_QueryParams.UpdateString("spaceKey","<string>")
loo_QueryParams.UpdateString("spaceKey","<string>")
loo_QueryParams.UpdateString("spaceId","<long>")
loo_QueryParams.UpdateString("spaceId","<long>")
loo_QueryParams.UpdateString("type","<string>")
loo_QueryParams.UpdateString("status","<string>")
loo_QueryParams.UpdateString("label","<string>")
loo_QueryParams.UpdateString("label","<string>")
loo_QueryParams.UpdateString("favourite","<boolean>")
loo_QueryParams.UpdateString("favouriteUserKey","<string>")
loo_QueryParams.UpdateString("expand","<string>")
loo_QueryParams.UpdateString("expand","<string>")
loo_QueryParams.UpdateInt("start",0)
loo_QueryParams.UpdateInt("limit",25)

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/space",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "results": [
//     {
//       "id": 26764331,
//       "key": "laborum",
//       "name": "in adipisicing nisi",
//       "type": "sunt",
//       "status": "laborum voluptate",
//       "_expandable": {
//         "settings": "sit occaecat",
//         "metadata": "",
//         "operations": "sunt do culpa ullamco",
//         "lookAndFeel": "Lorem occaecat",
//         "permissions": "cupidatat dolore elit et",
//         "icon": "occaecat Excepteur",
//         "description": "consectetur id Excepteur mollit",
//         "theme": "volupt",
//         "history": "est laboris adipisicing occaecat non",
//         "homepage": "in laboris"
//       },
//       "_links": {},
//       "icon": {
//         "path": "irure ut",
//         "width": 74794118,
//         "height": 55813977,
//         "isDefault": false
//       },
//       "description": {
//         "plain": {
//           "value": "Lorem",
//           "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>"
//             }
//           ]
//         },
//         "view": {
//           "value": "officia sunt velit",
//           "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": -83054779,
//           "limit": 97968975,
//           "size": -70611604,
//           "_links": {}
//         }
//       },
//       "operations": [
//         {
//           "operation": "copy",
//           "targetType": "blogpost"
//         },
//         {
//           "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": "administer",
//             "targetType": "application"
//           },
//           "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": "move",
//             "targetType": "comment"
//           },
//           "anonymousAccess": false,
//           "unlicensedAccess": false
//         }
//       ],
//       "settings": {
//         "routeOverrideEnabled": false,
//         "_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": "1999-07-22T04:19:16.365Z"
//       }
//     },
//     {
//       "id": -19509015,
//       "key": "tempor veniam commodo aute pariatur",
//       "name": "id velit ex sit",
//       "type": "quis officia cillum",
//       "status": "officia ipsum proident irure culpa",
//       "_expandable": {
//         "settings": "aute non",
//         "metadata": "laborum do deserunt",
//         "operations": "Duis occaecat Excepteur",
//         "lookAndFeel": "esse",
//         "permissions": "mollit id in Excepteur",
//         "icon": "elit velit m",
//         "description": "magna ipsum dolor nisi",
//         "theme": "cupidatat ex ",
//         "history": "ipsum esse",
//         "homepage": "ipsum commodo officia"
//       },
//       "_links": {},
//       "icon": {
//         "path": "occaecat enim mollit",
//         "width": 28738893,
//         "height": 88604543,
//         "isDefault": true
//       },
//       "description": {
//         "plain": {
//           "value": "amet Excepteur aliquip qui",
//           "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>"
//             }
//           ]
//         },
//         "view": {
//           "value": "in tempor",
//           "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": 33084561,
//           "limit": -91985267,
//           "size": -56212284,
//           "_links": {}
//         }
//       },
//       "operations": [
//         {
//           "operation": "move",
//           "targetType": "space"
//         },
//         {
//           "operation": "administer",
//           "targetType": "space"
//         }
//       ],
//       "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": "restore",
//             "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": "purge",
//             "targetType": "blogpost"
//           },
//           "anonymousAccess": false,
//           "unlicensedAccess": false
//         }
//       ],
//       "settings": {
//         "routeOverrideEnabled": false,
//         "_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": "1988-11-10T03:26:30.943Z"
//       }
//     }
//   ],
//   "start": -704604,
//   "limit": 17139756,
//   "size": 86679250,
//   "_links": {}
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

li_Start = loo_JResp.IntOf("start")
li_Limit = loo_JResp.IntOf("limit")
li_Size = loo_JResp.IntOf("size")
i = 0
li_Count_i = loo_JResp.SizeOfArray("results")
do while i < li_Count_i
    loo_JResp.I = i
    li_Id = loo_JResp.IntOf("results[i].id")
    ls_Key = loo_JResp.StringOf("results[i].key")
    ls_Name = loo_JResp.StringOf("results[i].name")
    ls_V_type = loo_JResp.StringOf("results[i].type")
    ls_Status = loo_JResp.StringOf("results[i].status")
    ls_Settings = loo_JResp.StringOf("results[i]._expandable.settings")
    ls_Metadata = loo_JResp.StringOf("results[i]._expandable.metadata")
    ls_Operations = loo_JResp.StringOf("results[i]._expandable.operations")
    ls_LookAndFeel = loo_JResp.StringOf("results[i]._expandable.lookAndFeel")
    ls_Permissions = loo_JResp.StringOf("results[i]._expandable.permissions")
    ls_Icon = loo_JResp.StringOf("results[i]._expandable.icon")
    ls_Description = loo_JResp.StringOf("results[i]._expandable.description")
    ls_Theme = loo_JResp.StringOf("results[i]._expandable.theme")
    ls_History = loo_JResp.StringOf("results[i]._expandable.history")
    ls_Homepage = loo_JResp.StringOf("results[i]._expandable.homepage")
    ls_Path = loo_JResp.StringOf("results[i].icon.path")
    li_Width = loo_JResp.IntOf("results[i].icon.width")
    li_Height = loo_JResp.IntOf("results[i].icon.height")
    li_IsDefault = loo_JResp.BoolOf("results[i].icon.isDefault")
    ls_Value = loo_JResp.StringOf("results[i].description.plain.value")
    ls_Representation = loo_JResp.StringOf("results[i].description.plain.representation")
    ls_ViewValue = loo_JResp.StringOf("results[i].description.view.value")
    ls_ViewRepresentation = loo_JResp.StringOf("results[i].description.view.representation")
    ls_HomepageValue = loo_JResp.StringOf("results[i].homepage.value")
    li_Start = loo_JResp.IntOf("results[i].metadata.labels.start")
    li_Limit = loo_JResp.IntOf("results[i].metadata.labels.limit")
    li_Size = loo_JResp.IntOf("results[i].metadata.labels.size")
    li_RouteOverrideEnabled = loo_JResp.BoolOf("results[i].settings.routeOverrideEnabled")
    ls_Color = loo_JResp.StringOf("results[i].lookAndFeel.headings.color")
    ls_LinksColor = loo_JResp.StringOf("results[i].lookAndFeel.links.color")
    ls_HoverOrFocusValue = loo_JResp.StringOf("results[i].lookAndFeel.menus.hoverOrFocus.value")
    ls_ColorValue = loo_JResp.StringOf("results[i].lookAndFeel.menus.color.value")
    ls_BackgroundColorValue = loo_JResp.StringOf("results[i].lookAndFeel.header.backgroundColor.value")
    ls_ButtonValue = loo_JResp.StringOf("results[i].lookAndFeel.header.button.value")
    ls_PrimaryNavigationValue = loo_JResp.StringOf("results[i].lookAndFeel.header.primaryNavigation.value")
    ls_SecondaryNavigationValue = loo_JResp.StringOf("results[i].lookAndFeel.header.secondaryNavigation.value")
    ls_SearchValue = loo_JResp.StringOf("results[i].lookAndFeel.header.search.value")
    ls_ScreenValue = loo_JResp.StringOf("results[i].lookAndFeel.content.screen.value")
    ls_ContainerValue = loo_JResp.StringOf("results[i].lookAndFeel.content.container.value")
    ls_HeaderValue = loo_JResp.StringOf("results[i].lookAndFeel.content.header.value")
    ls_BodyValue = loo_JResp.StringOf("results[i].lookAndFeel.content.body.value")
    ls_BordersAndDividersColor = loo_JResp.StringOf("results[i].lookAndFeel.bordersAndDividers.color")
    ls_CreatedDate = loo_JResp.StringOf("results[i].history.createdDate")
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("results[i].description.plain.embeddedContent")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_Value = loo_JResp.StringOf("results[i].description.plain.embeddedContent[j].value")
        j = j + 1
    loop
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("results[i].description.view.embeddedContent")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_Value = loo_JResp.StringOf("results[i].description.view.embeddedContent[j].value")
        j = j + 1
    loop
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("results[i].metadata.labels.results")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_Value = loo_JResp.StringOf("results[i].metadata.labels.results[j].value")
        j = j + 1
    loop
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("results[i].operations")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_Operation = loo_JResp.StringOf("results[i].operations[j].operation")
        ls_TargetType = loo_JResp.StringOf("results[i].operations[j].targetType")
        j = j + 1
    loop
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("results[i].permissions")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_V_expandableValue = loo_JResp.StringOf("results[i].permissions[j].subjects._expandable.value")
        ls_UserValue = loo_JResp.StringOf("results[i].permissions[j].subjects.user.value")
        ls_GroupValue = loo_JResp.StringOf("results[i].permissions[j].subjects.group.value")
        ls_Operation = loo_JResp.StringOf("results[i].permissions[j].operation.operation")
        ls_TargetType = loo_JResp.StringOf("results[i].permissions[j].operation.targetType")
        li_AnonymousAccess = loo_JResp.BoolOf("results[i].permissions[j].anonymousAccess")
        li_UnlicensedAccess = loo_JResp.BoolOf("results[i].permissions[j].unlicensedAccess")
        j = j + 1
    loop
    i = i + 1
loop


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -G -d "spaceKey=%3Cstring%3E"
	-d "spaceKey=%3Cstring%3E"
	-d "spaceId=%3Clong%3E"
	-d "spaceId=%3Clong%3E"
	-d "type=%3Cstring%3E"
	-d "status=%3Cstring%3E"
	-d "label=%3Cstring%3E"
	-d "label=%3Cstring%3E"
	-d "favourite=%3Cboolean%3E"
	-d "favouriteUserKey=%3Cstring%3E"
	-d "expand=%3Cstring%3E"
	-d "expand=%3Cstring%3E"
	-d "start=0"
	-d "limit=25"
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/space

Postman Collection Item JSON

{
  "name": "Get spaces",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/space?spaceKey=<string>&spaceKey=<string>&spaceId=<long>&spaceId=<long>&type=<string>&status=<string>&label=<string>&label=<string>&favourite=<boolean>&favouriteUserKey=<string>&expand=<string>&expand=<string>&start=0&limit=25",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "space"
      ],
      "query": [
        {
          "key": "spaceKey",
          "value": "<string>",
          "description": "The key of the space to be returned. To return multiple spaces,\nspecify this parameter multiple times with different values."
        },
        {
          "key": "spaceKey",
          "value": "<string>",
          "description": "The key of the space to be returned. To return multiple spaces,\nspecify this parameter multiple times with different values."
        },
        {
          "key": "spaceId",
          "value": "<long>",
          "description": "The id of the space to be returned. To return multiple spaces,\nspecify this parameter multiple times with different values."
        },
        {
          "key": "spaceId",
          "value": "<long>",
          "description": "The id of the space to be returned. To return multiple spaces,\nspecify this parameter multiple times with different values."
        },
        {
          "key": "type",
          "value": "<string>",
          "description": "Filter the results to spaces based on their type."
        },
        {
          "key": "status",
          "value": "<string>",
          "description": "Filter the results to spaces based on their status."
        },
        {
          "key": "label",
          "value": "<string>",
          "description": "Filter the results to spaces based on their label."
        },
        {
          "key": "label",
          "value": "<string>",
          "description": "Filter the results to spaces based on their label."
        },
        {
          "key": "favourite",
          "value": "<boolean>",
          "description": "Filter the results to the favourite spaces of the user specified by\n`favouriteUserKey`. Note, 'favourite' spaces are also\nknown as 'saved for later' spaces."
        },
        {
          "key": "favouriteUserKey",
          "value": "<string>",
          "description": "The userKey of the user, whose favourite spaces are used to filter\nthe results when using the `favourite` parameter.\n\nLeave blank for the current user. Use [Get user](#api-user-get) to\nget the userKey for a user."
        },
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the spaces to\nexpand, where:\n\n  - `settings` returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get).\n  - `metadata.labels` returns the space labels, which are used to categorize the space.\n  - `operations` returns the operations for a space, which are used when setting permissions.\n  - `lookAndFeel` returns information about the look and feel of the space, including the color scheme.\n  - `permissions` returns the permissions for the space. Note that this may return permissions for deleted groups,\n  because deleting a group doesn't remove associated space permissions.\n  - `icon` returns information about space icon.\n  - `description.plain` returns the description of the space.\n  - `description.view` returns the description of the space.\n  - `theme` returns information about the space theme.\n  - `homepage` returns information about the space homepage."
        },
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the spaces to\nexpand, where:\n\n  - `settings` returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get).\n  - `metadata.labels` returns the space labels, which are used to categorize the space.\n  - `operations` returns the operations for a space, which are used when setting permissions.\n  - `lookAndFeel` returns information about the look and feel of the space, including the color scheme.\n  - `permissions` returns the permissions for the space. Note that this may return permissions for deleted groups,\n  because deleting a group doesn't remove associated space permissions.\n  - `icon` returns information about space icon.\n  - `description.plain` returns the description of the space.\n  - `description.view` returns the description of the space.\n  - `theme` returns information about the space theme.\n  - `homepage` returns information about the space homepage."
        },
        {
          "key": "start",
          "value": "0",
          "description": "The starting index of the returned spaces."
        },
        {
          "key": "limit",
          "value": "25",
          "description": "The maximum number of spaces to return per page. Note, this may be\nrestricted by fixed system limits."
        }
      ]
    },
    "description": "Returns all spaces. The returned spaces are ordered alphabetically in\nascending order by space key.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).\nNote, the returned list will only contain spaces that the current user\nhas permission to view."
  },
  "response": [
    {
      "name": "Returned if the requested spaces 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/space?spaceKey=<string>&spaceKey=<string>&spaceId=<long>&spaceId=<long>&type=<string>&status=<string>&label=<string>&label=<string>&favourite=<boolean>&favouriteUserKey=<string>&expand=<string>&expand=<string>&start=0&limit=25",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space"
          ],
          "query": [
            {
              "key": "spaceKey",
              "value": "<string>"
            },
            {
              "key": "spaceKey",
              "value": "<string>"
            },
            {
              "key": "spaceId",
              "value": "<long>"
            },
            {
              "key": "spaceId",
              "value": "<long>"
            },
            {
              "key": "type",
              "value": "<string>"
            },
            {
              "key": "status",
              "value": "<string>"
            },
            {
              "key": "label",
              "value": "<string>"
            },
            {
              "key": "label",
              "value": "<string>"
            },
            {
              "key": "favourite",
              "value": "<boolean>"
            },
            {
              "key": "favouriteUserKey",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "25"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"results\": [\n  {\n   \"id\": 26764331,\n   \"key\": \"laborum\",\n   \"name\": \"in adipisicing nisi\",\n   \"type\": \"sunt\",\n   \"status\": \"laborum voluptate\",\n   \"_expandable\": {\n    \"settings\": \"sit occaecat\",\n    \"metadata\": \"\",\n    \"operations\": \"sunt do culpa ullamco\",\n    \"lookAndFeel\": \"Lorem occaecat\",\n    \"permissions\": \"cupidatat dolore elit et\",\n    \"icon\": \"occaecat Excepteur\",\n    \"description\": \"consectetur id Excepteur mollit\",\n    \"theme\": \"volupt\",\n    \"history\": \"est laboris adipisicing occaecat non\",\n    \"homepage\": \"in laboris\"\n   },\n   \"_links\": {},\n   \"icon\": {\n    \"path\": \"irure ut\",\n    \"width\": 74794118,\n    \"height\": 55813977,\n    \"isDefault\": false\n   },\n   \"description\": {\n    \"plain\": {\n     \"value\": \"Lorem\",\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    \"view\": {\n     \"value\": \"officia sunt velit\",\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\": -83054779,\n     \"limit\": 97968975,\n     \"size\": -70611604,\n     \"_links\": {}\n    }\n   },\n   \"operations\": [\n    {\n     \"operation\": \"copy\",\n     \"targetType\": \"blogpost\"\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\": \"administer\",\n      \"targetType\": \"application\"\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\": \"move\",\n      \"targetType\": \"comment\"\n     },\n     \"anonymousAccess\": false,\n     \"unlicensedAccess\": false\n    }\n   ],\n   \"settings\": {\n    \"routeOverrideEnabled\": false,\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\": \"1999-07-22T04:19:16.365Z\"\n   }\n  },\n  {\n   \"id\": -19509015,\n   \"key\": \"tempor veniam commodo aute pariatur\",\n   \"name\": \"id velit ex sit\",\n   \"type\": \"quis officia cillum\",\n   \"status\": \"officia ipsum proident irure culpa\",\n   \"_expandable\": {\n    \"settings\": \"aute non\",\n    \"metadata\": \"laborum do deserunt\",\n    \"operations\": \"Duis occaecat Excepteur\",\n    \"lookAndFeel\": \"esse\",\n    \"permissions\": \"mollit id in Excepteur\",\n    \"icon\": \"elit velit m\",\n    \"description\": \"magna ipsum dolor nisi\",\n    \"theme\": \"cupidatat ex \",\n    \"history\": \"ipsum esse\",\n    \"homepage\": \"ipsum commodo officia\"\n   },\n   \"_links\": {},\n   \"icon\": {\n    \"path\": \"occaecat enim mollit\",\n    \"width\": 28738893,\n    \"height\": 88604543,\n    \"isDefault\": true\n   },\n   \"description\": {\n    \"plain\": {\n     \"value\": \"amet Excepteur aliquip qui\",\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    \"view\": {\n     \"value\": \"in tempor\",\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\": 33084561,\n     \"limit\": -91985267,\n     \"size\": -56212284,\n     \"_links\": {}\n    }\n   },\n   \"operations\": [\n    {\n     \"operation\": \"move\",\n     \"targetType\": \"space\"\n    },\n    {\n     \"operation\": \"administer\",\n     \"targetType\": \"space\"\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\": \"restore\",\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\": \"purge\",\n      \"targetType\": \"blogpost\"\n     },\n     \"anonymousAccess\": false,\n     \"unlicensedAccess\": false\n    }\n   ],\n   \"settings\": {\n    \"routeOverrideEnabled\": false,\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\": \"1988-11-10T03:26:30.943Z\"\n   }\n  }\n ],\n \"start\": -704604,\n \"limit\": 17139756,\n \"size\": 86679250,\n \"_links\": {}\n}"
    },
    {
      "name": "Returned if the authentication credentials are incorrect or missing\nfrom the request.",
      "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/space?spaceKey=<string>&spaceKey=<string>&spaceId=<long>&spaceId=<long>&type=<string>&status=<string>&label=<string>&label=<string>&favourite=<boolean>&favouriteUserKey=<string>&expand=<string>&expand=<string>&start=0&limit=25",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space"
          ],
          "query": [
            {
              "key": "spaceKey",
              "value": "<string>"
            },
            {
              "key": "spaceKey",
              "value": "<string>"
            },
            {
              "key": "spaceId",
              "value": "<long>"
            },
            {
              "key": "spaceId",
              "value": "<long>"
            },
            {
              "key": "type",
              "value": "<string>"
            },
            {
              "key": "status",
              "value": "<string>"
            },
            {
              "key": "label",
              "value": "<string>"
            },
            {
              "key": "label",
              "value": "<string>"
            },
            {
              "key": "favourite",
              "value": "<boolean>"
            },
            {
              "key": "favouriteUserKey",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "25"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}