Spaces
Returns information about a number of spaces.
Table Specific Information
Select
The add-in will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in. You can also search for Attachments using CQL (Confluence Query Language).
- Key supports the '=,!=,IN,NOT IN' comparisons.
- Name supports the '=,LIKE,NOT LIKE' comparisons.
- Type supports the '=,!=,IN,NOT IN' comparisons.
- Excerpt supports the '=' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Spaces WHERE Key = 'abc'
SELECT * FROM Spaces WHERE Name IN ('name1', 'name2')
SELECT * FROM Spaces WHERE Excerpt = 'driver development'
SELECT * FROM Spaces WHERE Key = 'abc' AND Type = 'global'
CQL
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Spaces WHERE CQL = 'type = space AND space.title~"Driver Development"' AND Excerpt = 'indexed'
Columns
| Name | Type | References | SupportedOperators | Description |
| Id | String | Id of the space. | ||
| Key [KEY] | String | =,!=,IN,NOT IN | Unique key of the space. | |
| Name | String | =,!=,CONTAINS | Name of the space. | |
| IconPath | String | Path of the space icon. | ||
| IconWidth | Integer | Width of the space icon. | ||
| IconHeight | Integer | Height of the space icon. | ||
| IsIconDefault | Boolean | Indicator if the icon is default. | ||
| Excerpt | String | Excerpt of the space. | ||
| Type | String | =,!=,IN,NOT IN | Type of the space. | |
| Url | String | Url of the space. | ||
| LastModified | Datetime | Last modified datetime. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |