Label Supplier

Overview

Provides information about Confluence content labels.

Details

Name:

Label Supplier

Prefix:

label(optional)

Supported Content:

Labels

Provided By:

Supported Keys

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

Key

Content Types

Return Type

Description

title
Label
The title of the label.
owner
Label
The user who owns the label. Generally this will either be the current user or nobody, since other user's personal labels are not visible to most users.
url
Label
The URL to the page which lists the content which has been labelled with this label.
content
Label
The list of content which has been labelled with this label.
content count
Label
The number of content items which have been labelled with this label. More efficient than getting the content list size.
related
Label
Labels
The list of labels which are related to this label.
is team
Label
Tests if the label is a team label. That is, it is used to mark a space as being related to a specific team in the dashboard.
is personal
Label

(Since 2.1.0) Tests if the label is a personal label. That is, it was prefixed with 'my:'.

Personal label has been removed since Confluence 5.7.

is global
Label
(Since 2.1.0) Tests if the label is a global label. That is, it is not a team or personal label.
namespace
Label

The namespace value for the label. One of:

  • global - A global label
  • team - A team label
  • my - A personal label (Since 2.1.0)
creation date
Label
(Since 3.4.0) The date the label was created on.

Examples