Page Supplier

Overview

Supplies information about Confluence pages.

(warning) Key names are case-sensitive. That is, 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 version 3.0.0

Supported Keys

The following are the list of keys which this supplier will return 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
(Since 6.14.0) A list of pages that belong to the children pages of the current page.
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, with each child, then each of its children, and so on, in 'sorted' order.
comments
Pages
A list of top-level comments attached to the supplied page. These are comments which are not replies to other comments.
all comments
Pages
A list of all comments attached to the supplied page. This includes all replies in comment threads.
is favourite
is favorite
Pages
Is true if the page is a favorite of the current user.
space
Pages
The space the page belongs to.
tiny url
Pages
(Since 3.4.0) The context-relative path for the short URL for this page.

Inherited Keys

The following keys are inherited from other suppliers, but will work using the same prefix ('page:') as this supplier.

From Content Supplier

KeyContent TypesReturn TypeDescription
id AllNumberThe unique identifier for the content.
title AllTextThe title of the content.
type AllTextThe name of the content type. e.g.: "Page" or "News".
url AllTextThe server-relative URL to view the content.
creator AllUserThe user who created the content.
creation date AllDateThe date the content was created.
modifier AllUserThe user who most recently modified the content.
modification date AllDateThe date the content was most recently modified.
icon AllTextThe server-relative URL of the icon for this content type.
space AllSpaceThe space the content exists in. If the content is itself a space, the space is returned.
excerpt Pages, news items, space descriptionsTextThe excerpt for the content. (Inheritance is not valid with Attachment Supplier.)
body Pages, news items, space descriptions, commentsBodyThe main body text of the content. (Inheritance is not valid with Attachment Supplier.)
labels Pages, news items, space descriptionsList of LabelsA list of the labels attached to this content. (Inheritance is not valid with Attachment Supplier.)
attachments Pages, news itemsList of AttachmentsA list of the attachments on the supplied content.
incoming links Pages, news itemsList of LinksA list of links to content which links to the supplied content. (Inheritance is not valid with Attachment Supplier.)
outgoing links Pages, news itemsList of LinksA list of links to content which the supplied content links to. (Inheritance is not valid with Attachment Supplier.)
summary ContentText

Either the excerpt (as above), if it exists, or a short summary of the page content if it does not. (Since 1.3)

(Inheritance is not valid with Attachment Supplier.)

equals [X] ContentBoolean

Tests if the current context is equal to that specified by X, where X is a standard link to Confluence content.

Examples:

  • equals My Page - compares to 'My Page' in the current space.
  • equals @self - compares to the current context.
  • equals @parent - compares to the parent page of the current context.
  • equals ^attachment.ext - compares to the file attached to the current page.
  • content:equals KEY:Page - compares to a page in another space.

The 'content:' prefix is required for tests on pages in other spaces, due to the ':' character in the value.

version ContentNumberThe version number for the content.
version comment ContentText

The comment about the version, as set by the editor. (Since 2.1.0)

(Inheritance is not valid with Attachment Supplier.)

version history ContentList of ContentThe list of historical versions for the current content object. The most recent version will be listed first. (Since 2.1.0)
is latest version ContentBooleanChecks if the content is the latest version.
latest version ContentContentReturns the latest version of the content. May be the same content if this is the latest version.
images Pages, News ItemsList of Attachments(Since 3.2.0) The list of attachments which are image files.

Examples