Summary
Supplies information about Confluence content, such as pages, news items, attachments and comments.
 | Key names are case-sensitive. That is, you must supply a key of "id" rather than "ID". |
 | From version 3.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: | Reporting Plugin |
Keys Supported
The following are the list of keys which this supplier will return a value for.
| 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. Eg '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. If the content is itself a space, the space is returned. |
| excerpt | Pages, news items, space descriptions | Text | The excerpt for the content. |
| body | Pages, news items, space descriptions, comments | Text | 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. |
| comments | Pages, news items | List of Comments | (Until 3.0.0) A list of top-level comments attached to the supplied page or news item. These are comments which are not replies to other comments. |
| all comments | Pages, news items | List of Comments | (Until 3.0.0) A list of all comments attached to the supplied page or news item. This includes all replies in comment threads. |
| parent | Pages | Page | (Until 3.0.0) The parent of the current page. |
| ancestors | Pages | List of Pages | (Until 3.0.0) The list of ancestors of the current page. |
| children | Pages | List of Pages | (Until 3.0.0) The list of children belonging to the current page. |
| descendents | Pages | List of Pages | (Until 3.0.0) The list of all descendents belonging to the current page. |
| replies | Comments | List of Comments | (Until 3.0.0) The list of all comments replying directly to the current comment. |
| repliers | Comments | List of Users | (Until 3.0.0) The list of all users who replied to the current comment, directly or indirectly. |
| reply count | Comments | Number | (Until 3.0.0) The total number of all replies to this comment, directly or indirectly. |
| replying to | Comments | Comment | (Until 3.0.0) The comment that the current comment is replying to. Will be empty for top-level comments. |
| download path | Attachments | Text | (Until 3.0.0) The path to the download location for the attachment. |
| file name | Attachments | Text | (Until 3.0.0) The file name of the attachment. |
| file size | Attachments | Number | (Until 3.0.0) The length of the file in bytes. |
| nice file size | Attachments | Text | (Until 3.0.0) The length of the file, described in bytes, kilobytes or megabytes, depending what makes the most sense. |
| content type | Attachments | Text | (Until 3.0.0) The content (MIME) type. |
| comment | Attachments | Text | (Until 3.0.0) The attachment comment text. |
| attached to | Attachments | Page/News Item | (Until 3.0.0) The content the attachment is attached to. |
| attachment version | Attachments | Number | (Until 3.0.0) The attachment version number. |
| summary | Content | Text | Either the excerpt (as above), if it exists, or a short summary of the page content if it does not. (Since 1.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. (Since 2.0.0) Examples:
|
| version | Content | Number | The version number for the content. |
| version comment | Content | Text | The comment about the version, as set by the editor. (Since 2.1.0) |
| version history | Content | List of Content | The list of historical versions for the current content object. The most recent version will be listed first. (Since 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. May be the same content if this is the latest version. |
| images | Pages, News Items | [List\Collection Supplier] of Attachments | (Since 3.2.0) The list of attachments which are image files. |
Discussions