Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"spaceKey","<string>")
CkJsonObject::ckUpdateString(queryParams,"spaceKey","<string>")
CkJsonObject::ckUpdateString(queryParams,"spaceId","<long>")
CkJsonObject::ckUpdateString(queryParams,"spaceId","<long>")
CkJsonObject::ckUpdateString(queryParams,"type","<string>")
CkJsonObject::ckUpdateString(queryParams,"status","<string>")
CkJsonObject::ckUpdateString(queryParams,"label","<string>")
CkJsonObject::ckUpdateString(queryParams,"label","<string>")
CkJsonObject::ckUpdateString(queryParams,"favourite","<boolean>")
CkJsonObject::ckUpdateString(queryParams,"favouriteUserKey","<string>")
CkJsonObject::ckUpdateString(queryParams,"expand","<string>")
CkJsonObject::ckUpdateString(queryParams,"expand","<string>")
CkJsonObject::ckUpdateInt(queryParams,"start",0)
CkJsonObject::ckUpdateInt(queryParams,"limit",25)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/space",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
id.i
key.s
name.s
v_type.s
status.s
Settings.s
Metadata.s
Operations.s
LookAndFeel.s
Permissions.s
Icon.s
Description.s
Theme.s
History.s
Homepage.s
Path.s
Width.i
Height.i
IsDefault.i
Value.s
Representation.s
ViewValue.s
ViewRepresentation.s
homepageValue.s
Start.i
Limit.i
Size.i
RouteOverrideEnabled.i
Color.s
LinksColor.s
HoverOrFocusValue.s
ColorValue.s
BackgroundColorValue.s
ButtonValue.s
PrimaryNavigationValue.s
SecondaryNavigationValue.s
SearchValue.s
ScreenValue.s
ContainerValue.s
HeaderValue.s
BodyValue.s
BordersAndDividersColor.s
CreatedDate.s
j.i
count_j.i
value.s
operation.s
targetType.s
v_expandableValue.s
UserValue.s
GroupValue.s
Operation.s
TargetType.s
anonymousAccess.i
unlicensedAccess.i
start.i = CkJsonObject::ckIntOf(jResp,"start")
limit.i = CkJsonObject::ckIntOf(jResp,"limit")
size.i = CkJsonObject::ckIntOf(jResp,"size")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckIntOf(jResp,"results[i].id")
key = CkJsonObject::ckStringOf(jResp,"results[i].key")
name = CkJsonObject::ckStringOf(jResp,"results[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"results[i].type")
status = CkJsonObject::ckStringOf(jResp,"results[i].status")
Settings = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.settings")
Metadata = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.metadata")
Operations = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.operations")
LookAndFeel = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.lookAndFeel")
Permissions = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.permissions")
Icon = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.icon")
Description = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.description")
Theme = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.theme")
History = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.history")
Homepage = CkJsonObject::ckStringOf(jResp,"results[i]._expandable.homepage")
Path = CkJsonObject::ckStringOf(jResp,"results[i].icon.path")
Width = CkJsonObject::ckIntOf(jResp,"results[i].icon.width")
Height = CkJsonObject::ckIntOf(jResp,"results[i].icon.height")
IsDefault = CkJsonObject::ckBoolOf(jResp,"results[i].icon.isDefault")
Value = CkJsonObject::ckStringOf(jResp,"results[i].description.plain.value")
Representation = CkJsonObject::ckStringOf(jResp,"results[i].description.plain.representation")
ViewValue = CkJsonObject::ckStringOf(jResp,"results[i].description.view.value")
ViewRepresentation = CkJsonObject::ckStringOf(jResp,"results[i].description.view.representation")
homepageValue = CkJsonObject::ckStringOf(jResp,"results[i].homepage.value")
Start = CkJsonObject::ckIntOf(jResp,"results[i].metadata.labels.start")
Limit = CkJsonObject::ckIntOf(jResp,"results[i].metadata.labels.limit")
Size = CkJsonObject::ckIntOf(jResp,"results[i].metadata.labels.size")
RouteOverrideEnabled = CkJsonObject::ckBoolOf(jResp,"results[i].settings.routeOverrideEnabled")
Color = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.headings.color")
LinksColor = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.links.color")
HoverOrFocusValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.menus.hoverOrFocus.value")
ColorValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.menus.color.value")
BackgroundColorValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.header.backgroundColor.value")
ButtonValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.header.button.value")
PrimaryNavigationValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.header.primaryNavigation.value")
SecondaryNavigationValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.header.secondaryNavigation.value")
SearchValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.header.search.value")
ScreenValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.content.screen.value")
ContainerValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.content.container.value")
HeaderValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.content.header.value")
BodyValue = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.content.body.value")
BordersAndDividersColor = CkJsonObject::ckStringOf(jResp,"results[i].lookAndFeel.bordersAndDividers.color")
CreatedDate = CkJsonObject::ckStringOf(jResp,"results[i].history.createdDate")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].description.plain.embeddedContent")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
value = CkJsonObject::ckStringOf(jResp,"results[i].description.plain.embeddedContent[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].description.view.embeddedContent")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
value = CkJsonObject::ckStringOf(jResp,"results[i].description.view.embeddedContent[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].metadata.labels.results")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
value = CkJsonObject::ckStringOf(jResp,"results[i].metadata.labels.results[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].operations")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
operation = CkJsonObject::ckStringOf(jResp,"results[i].operations[j].operation")
targetType = CkJsonObject::ckStringOf(jResp,"results[i].operations[j].targetType")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].permissions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
v_expandableValue = CkJsonObject::ckStringOf(jResp,"results[i].permissions[j].subjects._expandable.value")
UserValue = CkJsonObject::ckStringOf(jResp,"results[i].permissions[j].subjects.user.value")
GroupValue = CkJsonObject::ckStringOf(jResp,"results[i].permissions[j].subjects.group.value")
Operation = CkJsonObject::ckStringOf(jResp,"results[i].permissions[j].operation.operation")
TargetType = CkJsonObject::ckStringOf(jResp,"results[i].permissions[j].operation.targetType")
anonymousAccess = CkJsonObject::ckBoolOf(jResp,"results[i].permissions[j].anonymousAccess")
unlicensedAccess = CkJsonObject::ckBoolOf(jResp,"results[i].permissions[j].unlicensedAccess")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
