Allow add-ons to define a new report, which is linked from a project page.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
{
"modules": {
"jiraReports": [
{
"url": "/report?projectKey={project.key}",
"description": {
"value": "This is an example report"
},
"reportCategory": "agile",
"thumbnailUrl": "http://example.com/images/report-example-thumbnail.png",
"name": {
"value": "Example Report"
},
"key": "report-example"
}
]
}
}
description
Type | |
Required | Yes |
Description | A human-readable description of this report module. This description is displayed on the reports list. Represents a string that can be resolved via a localization properties file. You can use the same Example1 2 3 4
|
value |
| ||||||||
i18n |
|
key
Type | |
Max length | 100 |
Required | Yes |
Pattern | ^[a-zA-Z0-9-]+$ |
Description | A key to identify this module. This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes. The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like: 1 2 3 4 5 6 7 8 9
Will have a configuration page module with a URL of |
name
Type | |
Required | Yes |
Description | A human readable name. Represents a string that can be resolved via a localization properties file. You can use the same Example1 2 3 4
|
value |
| ||||||||
i18n |
|
url
Type | |
Format | uri-template |
Required | Yes |
Description | Specifies the URL targeted by the report. The URL is relative to the add-on's base URL. |
reportCategory
Type | |
Defaults to | other |
Allowed values |
|
Description | The category of the report. The default category is other. |
thumbnailUrl
Type | |
Format | uri-template |
Description | Specifies the URL of the report thumbnail. The URL is relative to the add-on's base URL. |
Rate this page: