Module dashboards_api 

Enums

CopyDashboardError

struct for typed errors of method copy_dashboard

CreateDashboardError

struct for typed errors of method create_dashboard

DeleteDashboardError

struct for typed errors of method delete_dashboard

DeleteDashboardItemPropertyError

struct for typed errors of method delete_dashboard_item_property

GetAllDashboardsError

struct for typed errors of method get_all_dashboards

GetDashboardError

struct for typed errors of method get_dashboard

GetDashboardItemPropertyError

struct for typed errors of method get_dashboard_item_property

GetDashboardItemPropertyKeysError

struct for typed errors of method get_dashboard_item_property_keys

GetDashboardsPaginatedError

struct for typed errors of method get_dashboards_paginated

SetDashboardItemPropertyError

struct for typed errors of method set_dashboard_item_property

UpdateDashboardError

struct for typed errors of method update_dashboard

Functions

copy_dashboard

Copies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard. Permissions required: None The dashboard to be copied must be owned by or shared with the user.

create_dashboard

Creates a dashboard. Permissions required: None.

delete_dashboard

Deletes a dashboard. Permissions required: None The dashboard to be deleted must be owned by the user.

delete_dashboard_item_property

Deletes a dashboard item property. This operation can be accessed anonymously. Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

get_all_dashboards

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. This operation can be accessed anonymously. Permissions required: None.

get_dashboard

Returns a dashboard. This operation can be accessed anonymously. Permissions required: None. However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

get_dashboard_item_property

Returns the key and value of a dashboard item property. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets. When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item’s content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation. There is no resource to set or get dashboard items. This operation can be accessed anonymously. Permissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

get_dashboard_item_property_keys

Returns the keys of all properties for a dashboard item. This operation can be accessed anonymously. Permissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

get_dashboards_paginated

Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously. Permissions required: The following dashboards that match the query parameters are returned: * Dashboards owned by the user. Not returned for anonymous users. * Dashboards shared with a group that the user is a member of. Not returned for anonymous users. * Dashboards shared with a private project that the user can browse. Not returned for anonymous users. * Dashboards shared with a public project. * Dashboards shared with the public.

set_dashboard_item_property

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets. When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item’s content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation. There is no resource to set or get dashboard items. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

update_dashboard

Updates a dashboard, replacing all the dashboard details with those provided. Permissions required: None The dashboard to be updated must be owned by the user.