Pages
Get information about a specific page.
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 '=,!=,LIKE,NOT LIKE,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 | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT IN | Id of the page. | |
| Type | String | =,!=,IN,NOT IN | Type of the content. | |
| Title | String | =,!=,LIKE,IN,NOT IN | Title of the page. | |
| Status | String | Status of the page. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT IN | The key of the space that the page belongs to. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT IN | The type of the space that the page belongs to. |
| Position | String | Position of the page. | ||
| URL | String | URL of the page. | ||
| Excerpt | String | Excerpt of the page. | ||
| IsLatest | Boolean | Indicator if this is the latest version of the page. | ||
| CreatedByUserName | String | =,!=,IN,NOT IN | Username of the user who created the page. | |
| CreatedByUserType | String | Type of the user who created the page. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | Datetime for the creation of the page. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | Datetime of the last updated version of the page. | |
| LastUpdatedMessage | String | Message of the last updated version. | ||
| LastUpdatedNumber | Integer | Number of the last updated version. | ||
| LastUpdatedUserName | String | Username of the user who updated the latest version. | ||
| LastUpdatedUserType | String | Type of the user who updated the latest version. | ||
| LastUpdatedIsMinorEdit | Boolean | Indicator if this version is a minor edit. | ||
| LastUpdatedIsHidden | Boolean | Indicator if the last updated version is hidden or not. | ||
| PreviousVersionUserName | String | Username of the user who updated the previous version. | ||
| PreviousVersionUserType | String | Type of the user who updated the previous version. | ||
| PreviousVersionDatetime | Datetime | Datetime when the previous version was edited. | ||
| PreviousVersionMessage | String | Message for the previously edited version. | ||
| PreviousVersionNumber | String | Number of the previously edited version. | ||
| PreviousVersionIsMinorEdit | Boolean | Indicator if the previous version was a minor edit. | ||
| PreviousVersionIsHidden | Boolean | Indicator if the previous version was hidden or not. | ||
| LinksEditui | String | The LinksEditui of the page content. | ||
| LinksSelf | String | The LinksSelf of the content. | ||
| LinksTinyui | String | The LinksTinyui of the content. | ||
| LinksWebui | String | The LinksWebui of the content. |
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. |