Content Supplier
Overview
Supplies information about Confluence content, such as pages, news items, attachments and comments.
Key names are case-sensitive. For example, you must supply a key of id rather than ID.
From v3.0.0 of Reporting onwards, you should use the more specific Page, News Item, Comment and Attachment suppliers to access the type specific keys for content, such as 'children' or 'space'. Shared values such as id can still be accessed here for more general queries. The existing type-specific keys will work for the moment, but may be removed in a future version for efficiency.
Details
Name: | Content Supplier |
---|---|
Prefix: | content(optional) |
Supported Content: | Confluence pages, news items, attachments, comments and space descriptions. |
Provided By: |
Supported Keys
List of keys that this supplier returns a value for.
Key | Content Types | Return Type | Description |
---|---|---|---|
id | All | The unique identifier for the content. | |
title | All | The title of the content. | |
type | All | The name of the content type. e.g.: "Page" or "News". | |
url | All | The server-relative URL to view the content. | |
creator | All | The user who created the content. | |
creation date | All | The date the content was created. | |
modifier | All | The user who most recently modified the content. | |
modification date | All | The date the content was most recently modified. | |
icon | All | The server-relative URL of the icon for this content type. | |
space | All | The space the content exists in. If the content is itself a space, the space is returned. | |
excerpt | Pages, news items, space descriptions | The excerpt for the content. Inheritance is not valid with Attachment Supplier. | |
body | Pages, news items, space descriptions, comments | The main body text of the content. Inheritance is not valid with Attachment Supplier. | |
labels | Pages, news items, space descriptions | 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 | A list of links to content which links to the supplied content. | |
outgoing links | Pages, news items | A list of links to content which the supplied content links to. | |
summary | Content | 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 | Tests if the current context is equal to that specified by X, where X is a standard link to Confluence content. Examples:
| |
version | Content | The version number for the content. | |
version comment | Content | The comment about the version, as set by the editor. from v2.1.0 | |
version history | Content | The list of historical versions for the current content object. The most recent version will be listed first. from v2.1.0 | |
is latest version | Content | Checks if the content is the latest version. | |
latest version | Content | Returns the latest version of the content. May be the same content if this is the latest version. | |
images | Pages, News Items | List of Attachments | The list of attachments which are image files. from v3.2.0 |