Macro Input Parameter

Describes a parameter input field for a macro.

Any declared parameters must also be included in the URL value of the macro in order to serialise this value, for example, for a macro with a parameter view it should be added to the macro url as follows:

1
2
3
4
5
6
"dynamicContentMacros": [{
   ...
   "url": "/render-map?pageTitle={page.title}&viewChoice={view}",
   ...
}]

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "parameters": [
    {
      "identifier": "view",
      "name": {
        "value": "Map View"
      },
      "description": {
        "value": "Allows switching between view types"
      },
      "type": "enum",
      "required": true,
      "multiple": false,
      "defaultValue": "Map",
      "values": [
        "Map",
        "Satellite"
      ],
      "hidden": false
    }
  ]
}

Properties

identifier

Type
string
Required
Yes
Pattern
[-_a-z0-9\.]+
Description

A unique identifier for the parameter. It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces. This identifier will be used in the query parameters of the add-on URL.

name

Type
object
Required
Yes
Description

The human readable name of the parameter which will be displayed in the UI.

type

Type
string
Max length
50
Required
Yes
Description

The type of parameter.

Currently the following parameter types are supported in the macro browser's UI:

  • attachment: displays an autocomplete field for search on attachment filenames.
  • boolean: displays a check box.
  • confluence-content: displays an autocomplete field for search on page and blog titles.
  • enum: displays a select field.
  • spacekey: displays an autocomplete field for search on space names.
  • string: displays an input field (this is the default if unknown type).
  • username: displays an autocomplete field for search on username and full name currently, and will be overridden by Atlassian AccountId after GDPR deprecation period ends. During the deprecation only, a companion parameter with ".accountId" suffix of the original parameter name will be added.

aliases

Type
[string, ...]
Description

Aliases for the macro parameter.

defaultValue

Type
string
Max length
1000
Description

The default value for the parameter.

description

Type
object
Description

The description of the parameter

hidden

Type
boolean
Defaults to
false
Description

Determines if the parameter will be displayed in the macro editor.

multiple

Type
boolean
Defaults to
false
Description

Whether it takes multiple values.

required

Type
boolean
Defaults to
false
Description

Whether it is a required parameter.

values

Type
[string, ...]
Description

Describes the enum values - only applicable for enum typed parameters.