Page Supplier
- Robert Alexander Marshall
- Ted Mahsun (Deactivated)
- Suba Veeriah (Unlicensed)
Overview
Supplies information about Confluence pages.
Key names are case-sensitive. You must supply a key of id rather than ID.
You can also use any key from the Content Supplier using the page: prefix.
For example, you can use page:id, instead of content:id, even though id is not listed explicitly below.
Details
Name: | Page Supplier |
|---|---|
Prefix: | page(optional) |
Supported Content: | Confluence Pages |
Provided By: | Reporting for Confluence From v3.0.0 |
Supported Keys
List of keys that this supplier returns a value for.
Key | Content Types | Return Type | Description |
|---|---|---|---|
parent | Pages | Page | The parent of the current page. |
ancestors | Pages | List of Pages | The list of ancestors of the current page. |
children | Pages | List of Pages | The list of pages belonging to the current page. |
grandchildren | Pages | List of Pages | A list of pages that belong to the children pages of the current page. From v6.14.0 |
descendents/descendants | Pages | List of Pages | The list of all descendants belonging to the current page. |
sorted children | Pages | List of Pages | The list of children of the current page, in their manual sort order if specified. |
sorted descendents/sorted descendants | Pages | List of Pages | (Since 4.0.0) Provides a list of all descendants of the current page. From v4.0.0 Lists
|
comments | Pages | List of Comments | A list of top-level comments attached to the supplied page. These are comments that are not replies to other comments. |
all comments | Pages | List of Comments | A list of all comments attached to the supplied page. Includes all replies in comment threads. |
is favourite | Pages | Boolean | Is true if the page is a favorite of the current user. |
space | Pages | Space | The space the page belongs to. |
tiny url | Pages | Text | The context-relative path for the short URL for this page. From v3.4.0 |
Inherited Keys
The following keys are inherited from other suppliers but work using the same prefix (page:) as this supplier.
From Content Supplier
Key | Content Types | Return Type | Description |
|---|---|---|---|
id | All | Number | The unique identifier for the content. |
title | All | Text | The title of the content. |
type | All | Text | The name of the content type. e.g.: "Page" or "News". |
url | All | Text | The server-relative URL to view the content. |
creator | All | User | The user who created the content. |
creation date | All | Date | The date the content was created. |
modifier | All | User | The user who most recently modified the content. |
modification date | All | Date | The date the content was most recently modified. |
icon | All | Text | The server-relative URL of the icon for this content type. |
space | All | Space | The space the content exists in. |
excerpt | Pages, news items, space descriptions | Text | The excerpt for the content. |
body | Pages, news items, space descriptions, comments | Body | The main body text of the content. |
labels | Pages, news items, space descriptions | List of Labels | A list of the labels attached to this content. |
attachments | Pages, news items | List of Attachments | A list of the attachments on the supplied content. |
incoming links | Pages, news items | List of Links | A list of links to content which links to the supplied content. |
outgoing links | Pages, news items | List of Links | A list of links to content which the supplied content links to. |
summary | Content | Text | Either the excerpt (as above), if it exists, or a short summary of the page content if it does not. From v1.3 |
equals [X] | Content | Boolean | Tests if the current context is equal to that specified by X, where X is a standard link to Confluence content. Examples:
|
version | Content | Number | The version number for the content. |
version comment | Content | Text | The comment about the version, as set by the editor. From 2.1.0 |
version history | Content | List of Content | The list of historical versions for the current content object. From 2.1.0 |
is latest version | Content | Boolean | Checks if the content is the latest version. |
latest version | Content | Content | Returns the latest version of the content. |
images | Pages, News Items | List of Attachments | The list of attachments which are image files.From 3.2.0 |