Atlassian: Dashboards schemas
17 Atlassian schemas with complete fields and constraints.
← Dashboards operations · All schemas
Add gadget to dashboard — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the settings for a dashboard gadget. Additional keys: not allowed |
color | string | Optional | The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`. write Only: true |
ignoreUriAndModuleKeyValidation | boolean | Optional | Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed. write Only: true |
moduleKey | string | Optional | The module key of the gadget type. Can't be provided with `uri`. write Only: true |
position | Model | Optional | Expand Add gadget to dashboard — request body — body position The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it. |
title | string | Optional | The title of the gadget. write Only: true |
uri | string | Optional | The URI of the gadget type. Can't be provided with `moduleKey`. write Only: true |
Referenced models: Add gadget to dashboard — request body — body position
Add gadget to dashboard — request body — body position
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a gadget position. write Only: true Additional keys: not allowed |
column | integer | Required within parent | The column position of the gadget. Format: int32 |
row | integer | Required within parent | The row position of the gadget. Format: int32 |
Add gadget to dashboard — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a gadget. |
color | JSON | Optional | |
color (anyOf 1) | string | Alternative | The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`. Known values: blue, red, yellow, green, cyan, purple, gray, white Read only: true |
color (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the gadget instance. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
moduleKey | JSON | Optional | |
moduleKey (anyOf 1) | string | Alternative | The module key of the gadget type. Read only: true |
moduleKey (anyOf 2) | null | Alternative | |
position | JSON | Optional | |
position (anyOf 1) | Model | Alternative | Expand Add gadget to dashboard — response body — position Details of a gadget position The position of the gadget. Read only: true |
position (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The title of the gadget. Read only: true |
title (anyOf 2) | null | Alternative | |
uri | JSON | Optional | |
uri (anyOf 1) | string | Alternative | The URI of the gadget type. Read only: true |
uri (anyOf 2) | null | Alternative |
Referenced models: Add gadget to dashboard — response body — position Details of a gadget position
Add gadget to dashboard — response body — position Details of a gadget position
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a gadget position. write Only: true |
column | JSON | Optional | |
column (anyOf 1) | JSON | Alternative | |
column (anyOf 1) (anyOf 1) | integer | Alternative | The column position of the gadget. Format: int32 |
column (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
column (anyOf 2) | null | Alternative | |
row | JSON | Optional | |
row (anyOf 1) | JSON | Alternative | |
row (anyOf 1) (anyOf 1) | integer | Alternative | The row position of the gadget. Format: int32 |
row (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
row (anyOf 2) | null | Alternative |
Bulk edit dashboards — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a request to bulk edit shareable entity. Additional keys: not allowed |
action | string | Required within parent | Allowed action for bulk edit shareable entity One of: changeOwner, changePermission, addPermission, removePermission |
changeOwnerDetails | Model | Optional | Expand Bulk edit dashboards — request body — body change Owner Details The details of change owner action. |
entityIds | array | Required within parent | The id list of shareable entities to be changed. Unique items: true |
entityIds[] | integer | Each item | Format: int64 |
extendAdminPermissions | boolean | Optional | Whether the actions are executed by users with Administer Jira global permission. |
permissionDetails | Model | Optional | Expand Bulk edit dashboards — request body — body permission Details The permission details to be changed. |
Referenced models: Bulk edit dashboards — request body — body change Owner Details, Bulk edit dashboards — request body — body permission Details
Bulk edit dashboards — request body — body change Owner Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details for changing owners of shareable entities Additional keys: not allowed |
autofixName | boolean | Required within parent | Whether the name is fixed automatically if it's duplicated after changing owner. |
newOwner | string | Required within parent | The account id of the new owner. |
Bulk edit dashboards — request body — body permission Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details for permissions of shareable entities Additional keys: not allowed |
editPermissions | array | Required within parent | The edit permissions for the shareable entities. |
editPermissions[] | Model | Each item | Expand Create filter — request body — body edit Permissions item |
sharePermissions | array | Required within parent | The share permissions for the shareable entities. |
sharePermissions[] | Model | Each item | Expand Create filter — request body — body edit Permissions item |
Referenced models: Create filter — request body — body edit Permissions item
Bulk edit dashboards — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a request to bulk edit shareable entity. |
action | JSON | Optional | |
action (anyOf 1) | string | Alternative | Allowed action for bulk edit shareable entity Known values: changeOwner, changePermission, addPermission, removePermission |
action (anyOf 2) | null | Alternative | |
entityErrors | JSON | Optional | |
entityErrors (anyOf 1) | object | Alternative | The mapping dashboard id to errors if any. Additional keys: see wildcard field |
entityErrors (anyOf 1).* | Model | Additional keys | Expand Bulk edit dashboards — response body — entity Errors The mapping dashboard id to errors if any value |
entityErrors (anyOf 2) | null | Alternative |
Referenced models: Bulk edit dashboards — response body — entity Errors The mapping dashboard id to errors if any value
Bulk edit dashboards — response body — entity Errors The mapping dashboard id to errors if any value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Errors of bulk edit action. |
errorMessages | JSON | Optional | |
errorMessages (anyOf 1) | array | Alternative | The error messages. |
errorMessages (anyOf 1)[] | string | Each item | |
errorMessages (anyOf 2) | null | Alternative | |
errors | JSON | Optional | |
errors (anyOf 1) | object | Alternative | The errors. Additional keys: see wildcard field |
errors (anyOf 1).* | string | Additional keys | |
errors (anyOf 2) | null | Alternative |
Copy dashboard — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a dashboard. Additional keys: not allowed |
description | string | Optional | The description of the dashboard. |
editPermissions | array | Required within parent | The edit permissions for the dashboard. |
editPermissions[] | Model | Each item | Expand Create filter — request body — body edit Permissions item |
name | string | Required within parent | The name of the dashboard. |
sharePermissions | array | Required within parent | The share permissions for the dashboard. |
sharePermissions[] | Model | Each item | Expand Create filter — request body — body edit Permissions item |
Referenced models: Create filter — request body — body edit Permissions item
Get all dashboards — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page containing dashboard details. |
dashboards | JSON | Optional | |
dashboards (anyOf 1) | array | Alternative | List of dashboards. Read only: true |
dashboards (anyOf 1)[] | Model | Each item | Expand Get dashboard — response body |
dashboards (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of results that could be on the page. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
next | JSON | Optional | |
next (anyOf 1) | string | Alternative | The URL of the next page of results, if any. Read only: true |
next (anyOf 2) | null | Alternative | |
prev | JSON | Optional | |
prev (anyOf 1) | string | Alternative | The URL of the previous page of results, if any. Read only: true |
prev (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned on the page. Format: int32 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of results on the page. Format: int32 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative |
Referenced models: Get dashboard — response body
Get available gadgets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of available gadgets. |
gadgets | JSON | Optional | |
gadgets (anyOf 1) | array | Alternative | The list of available gadgets. Read only: true |
gadgets (anyOf 1)[] | Model | Each item | Expand Get available gadgets — response body — gadgets The list of available gadgets item |
gadgets (anyOf 2) | null | Alternative |
Referenced models: Get available gadgets — response body — gadgets The list of available gadgets item
Get available gadgets — response body — gadgets The list of available gadgets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of the available dashboard gadget. |
moduleKey | JSON | Optional | |
moduleKey (anyOf 1) | string | Alternative | The module key of the gadget type. Read only: true |
moduleKey (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The title of the gadget. Read only: true |
title (anyOf 2) | null | Alternative | |
uri | JSON | Optional | |
uri (anyOf 1) | string | Alternative | The URI of the gadget type. Read only: true |
uri (anyOf 2) | null | Alternative |
Get dashboard — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a dashboard. |
automaticRefreshMs | JSON | Optional | |
automaticRefreshMs (anyOf 1) | JSON | Alternative | |
automaticRefreshMs (anyOf 1) (anyOf 1) | integer | Alternative | The automatic refresh interval for the dashboard in milliseconds. Format: int32 Read only: true |
automaticRefreshMs (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
automaticRefreshMs (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
editPermissions | JSON | Optional | |
editPermissions (anyOf 1) | array | Alternative | The details of any edit share permissions for the dashboard. Read only: true |
editPermissions (anyOf 1)[] | Model | Each item | Expand Get share permission — response body |
editPermissions (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the dashboard. Read only: true |
id (anyOf 2) | null | Alternative | |
isFavourite | JSON | Optional | |
isFavourite (anyOf 1) | boolean | Alternative | Whether the dashboard is selected as a favorite by the user. Read only: true |
isFavourite (anyOf 2) | null | Alternative | |
isWritable | JSON | Optional | |
isWritable (anyOf 1) | boolean | Alternative | Whether the current user has permission to edit the dashboard. Read only: true |
isWritable (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the dashboard. Read only: true |
name (anyOf 2) | null | Alternative | |
owner | JSON | Optional | |
owner (anyOf 1) | Model | Alternative | Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self The owner of the dashboard. Read only: true |
owner (anyOf 2) | null | Alternative | |
popularity | JSON | Optional | |
popularity (anyOf 1) | JSON | Alternative | |
popularity (anyOf 1) (anyOf 1) | integer | Alternative | The number of users who have this dashboard as a favorite. Format: int64 Read only: true |
popularity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
popularity (anyOf 2) | null | Alternative | |
rank | JSON | Optional | |
rank (anyOf 1) | JSON | Alternative | |
rank (anyOf 1) (anyOf 1) | integer | Alternative | The rank of this dashboard. Format: int32 Read only: true |
rank (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rank (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of these dashboard details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
sharePermissions | JSON | Optional | |
sharePermissions (anyOf 1) | array | Alternative | The details of any view share permissions for the dashboard. Read only: true |
sharePermissions (anyOf 1)[] | Model | Each item | Expand Get share permission — response body |
sharePermissions (anyOf 2) | null | Alternative | |
systemDashboard | JSON | Optional | |
systemDashboard (anyOf 1) | boolean | Alternative | Whether the current dashboard is system dashboard. Read only: true |
systemDashboard (anyOf 2) | null | Alternative | |
view | JSON | Optional | |
view (anyOf 1) | string | Alternative | The URL of the dashboard. Read only: true |
view (anyOf 2) | null | Alternative |
Referenced models: Get share permission — response body, Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self
Get gadgets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of gadgets on the dashboard. |
gadgets | JSON | Optional | |
gadgets (anyOf 1) | array | Alternative | The list of gadgets. Read only: true |
gadgets (anyOf 1)[] | Model | Each item | Expand Add gadget to dashboard — response body |
gadgets (anyOf 2) | null | Alternative |
Referenced models: Add gadget to dashboard — response body
Search for dashboards — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get dashboard — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get dashboard — response body
Update gadget on dashboard — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of the gadget to update. Additional keys: not allowed |
color | string | Optional | The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`. write Only: true |
position | Model | Optional | Expand Add gadget to dashboard — request body — body position The position of the gadget. |
title | string | Optional | The title of the gadget. write Only: true |
Referenced models: Add gadget to dashboard — request body — body position