Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

This supplier provides key values for Confluence Spaces.

Info

All key names are case-sensitive.

...

For example, you must use

...

id

...

rather than

...

ID

...

.

Details

Name:

Space Supplier

Prefix:

space(optional)

Supported Content:

Confluence Spaces

Provided By:

Reporting for Confluence

Supported Keys

The following are the list List of keys which that this supplier will return returns a value for.

Key

Content Types

Return Type

Description

name/title

Space

Text

The name of the space

.

Info

You can use either name or title as the key.

key

Space

Text

The space key.

type

Space

Text

The type name for the space

("Space")

.

url

Space

Text

The server-relative URL for the space.

Will generally direct

Info

Generally directs the user to the space homepage.

creator

Space

User

The user who created the space.

creation date

Space

Date

The date the space was created.

modifier

Space

User

The user who most recently modified the space.

modification date

Space

Date

The date the space was most recently modified.

icon

Space

Text

The server-relative URL for the space's icon.

homepage

Space

Page

The page which is the homepage for the space.

description

Space

Text

The space description for the space.

is personal

Space

Boolean

Tests if the space is personal (is attached to a user).

is global

Space

Boolean

Tests if the space is global (that is, not a personal space).

all pages

Space

List of Pages

The list of all pages contained in the space.

pages

Space

List of Pages

The list of pages with no parent contained in the space.

attachments

Space

List of Attachments

The list of all attachments contained in the space.

news

Space

List of News Items

The list of news items contained in the space.

undefined pages/undefined links

Space

List of Links

The list of links to pages which have links defined, but for which no actual page has been created.

 You

Info

You can use either undefined pages or undefined links as the key.

orphaned pages

Space

List of Pages

The list of pages in this space which are not linked to by any other content.

This feature is deprecated due to changes in Confluence by Atlassian, and is likely to be removed in the future.

As an alternative, consider using the Orphaned Links macro

which is part of 

from the Linking for Confluence app.

labels/categories

Space

List of Labels

The list of labels or categories attached to this space.

 You

Info

You can use either labels or categories as the key.

labels in content

Space

List of Labels

The list of labels attached to content contained in this space.

space type

Space

Text

The name of the space type

(

  • Personal/Global

).

is favourite

Space

Boolean

(Since 1.0.1) Is true if

Is true if the current user has marked the space as a favorite.

Status
colourBlue
titleFrom v1.0.1

mail

Space

List of Mail

(Since 3.0.0) The

The list of mail items in this space.

 Removed

Status
colourBlue
titleFrom v3.0.0

Info

Removed in Reporting

6

v6.15.0 due to feature changes in Confluence 7. 

theme key

Space

Text

(Since 3.4.0) The

The unique key of the current theme.

Status
colourBlue
titleFrom v3.4.0

Info

May be blank if using the 'Default Global Theme'.

theme name

Space

Text

(Since 3.4.0) The

The user-friendly name of the current theme.

Status
colourBlue
titleFrom v3.4.0

Examples

List All Labels for All Spaces

{report-block}  {space-reporter:space=@all}    {text-sort:space:title}  {space-reporter} {report-body}  {report-info:space:title|link=true} - {report-info:space:labels for content}{report-body} {report-block}