Pages
Get information about a page within a space.
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).
- Id supports the '=,!=,IN,NOT IN' comparisons.
- Type supports the '=,!=,IN,NOT IN' comparisons.
- Title supports the '=,!=,IN,NOT IN' comparisons.
- SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
- SpaceType supports the '=,!=,IN,NOT IN' comparisons.
- CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
- CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
- LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Pages WHERE Id = '1234'
SELECT * FROM Pages WHERE Id IN ('1234', '2345')
SELECT * FROM Pages WHERE Id = '294922' OR Type = 'page'
SELECT * FROM Pages WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Pages ORDER BY Id DESC SELECT * FROM Pages ORDER BY CreatedByUserName ASC
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 Pages WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| Id [KEY] | String | False | =,!=,IN,NOT_IN |
Id of the content. | |
| Type | String | True | =,!=,IN,NOT_IN |
Type of the content. | |
| Title | String | False | =,!=,IN,NOT_IN |
Title of the content. | |
| Status | String | False | = |
Status of the content. | |
| Storage | String | False |
The body content storage of the page.. | ||
| AtlasDocFormat | String | False |
The body content in atlas doc format of the page. | ||
| Position | String | True |
Position of the content. | ||
| OwnerId | String | False |
Id of the owner of the page. | ||
| ParentId | Long | False |
The Id of the parent page. | ||
| SpaceId | String | False |
The Id of the space the page rests. | ||
| SpaceKey | String | True |
Spaces.Key | =,!=,IN,NOT_IN |
The key of the space that the content belongs to. |
| SpaceType | String | True |
Spaces.Type | =,!=,IN,NOT_IN |
The type of the space that the content belongs to. |
| URL | String | True |
URL of the content. | ||
| Excerpt | String | True |
Excerpt of the content. | ||
| IsLatest | Boolean | True |
Indicator if this is the latest version of the content. | ||
| CreatedByUserName | String | True | =,!=,IN,NOT_IN |
Username of the user who created the content. | |
| CreatedByUserType | String | True |
Type of the user who created the content. | ||
| CreatedDate | Datetime | True | =,>,>=,<,<= |
Datetime for the creation of the content. | |
| LastUpdatedDatetime | Datetime | True | =,>,>=,<,<= |
Datetime of the last updated version of the content. | |
| LastUpdatedMessage | String | True |
Message of the last updated version. | ||
| LastUpdatedNumber | Integer | True |
Number of the last updated version. | ||
| LastUpdatedUserName | String | True |
Username of the user who updated the latest version. | ||
| LastUpdatedUserType | String | True |
Type of the user who updated the latest version. | ||
| LastUpdatedIsMinorEdit | Boolean | True |
Indicator if this version is a minor edit. | ||
| LastUpdatedIsHidden | Boolean | True |
Indicator if the last updated version is hidden or not. | ||
| PreviousVersionUserName | String | True |
Username of the user who updated the previous version. | ||
| PreviousVersionUserType | String | True |
Type of the user who updated the previous version. | ||
| PreviousVersionDatetime | Datetime | True |
Datetime when the previous version was edited. | ||
| PreviousVersionMessage | String | True |
Message for the previously edited version. | ||
| PreviousVersionNumber | String | True |
Number of the previously edited version. | ||
| PreviousVersionIsMinorEdit | Boolean | True |
Indicator if the previous version was a minor edit. | ||
| PreviousVersionIsHidden | Boolean | True |
Indicator if the previous version was hidden or not. | ||
| VersionUserName | String | True |
Username of the user who updated the previous version. | ||
| VersionUserType | String | True |
Type of the user who updated the previous version. | ||
| VersionDatetime | Datetime | True |
Datetime when the previous version was edited. | ||
| VersionMessage | String | False |
Message for the previously edited version. | ||
| VersionNumber | Integer | False |
Number of the previously edited version. | ||
| VersionIsMinorEdit | Boolean | True |
Indicator if the previous version was a minor edit. | ||
| VersionIsHidden | Boolean | True |
Indicator if the previous version was hidden or not. | ||
| LinksEditui | String | True |
The LinksEditui of the page content. | ||
| LinksSelf | String | True |
The LinksSelf of the content. | ||
| LinksTinyui | String | True |
The LinksTinyui of the content. | ||
| LinksWebui | String | True |
The LinksWebui of the content. | ||
| ItemURL | String | True |
The URL reference of the element in UI. |
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. |