org.everit.atlassian.restclient.jiracloud.v2.api

Class DashboardsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.DashboardsApi

public class DashboardsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DashboardsApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<DashboardGadget>	addGadget(Long dashboardId, DashboardGadgetSettings dashboardGadgetSettings, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add gadget to dashboard Adds a gadget to a dashboard.
io.reactivex.Single<BulkEditShareableEntityResponse>	bulkEditDashboards(BulkEditShareableEntityRequest bulkEditShareableEntityRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk edit dashboards Bulk edit dashboards.
io.reactivex.Single<Dashboard>	copyDashboard(String id, DashboardDetails dashboardDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Copy dashboard Copies a dashboard.
io.reactivex.Single<Dashboard>	createDashboard(DashboardDetails dashboardDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create dashboard Creates a dashboard.
io.reactivex.Completable	deleteDashboard(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete dashboard Deletes a dashboard.
io.reactivex.Completable	deleteDashboardItemProperty(String dashboardId, String itemId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete dashboard item property Deletes a dashboard item property.
io.reactivex.Single<AvailableDashboardGadgetsResponse>	getAllAvailableDashboardGadgets(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get available gadgets Gets a list of all available gadgets that can be added to all dashboards.
io.reactivex.Single<PageOfDashboards>	getAllDashboards(Optional<String> filter, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all dashboards Returns a list of dashboards owned by or shared with the user.
io.reactivex.Single<DashboardGadgetResponse>	getAllGadgets(Long dashboardId, Optional<List<String>> moduleKey, Optional<List<String>> uri, Optional<List<Long>> gadgetId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get gadgets Returns a list of dashboard gadgets on a dashboard.
io.reactivex.Single<Dashboard>	getDashboard(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dashboard Returns a dashboard.
io.reactivex.Single<EntityProperty>	getDashboardItemProperty(String dashboardId, String itemId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dashboard item property Returns the key and value of a dashboard item property.
io.reactivex.Single<PropertyKeys>	getDashboardItemPropertyKeys(String dashboardId, String itemId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dashboard item property keys Returns the keys of all properties for a dashboard item.
io.reactivex.Single<PageBeanDashboard>	getDashboardsPaginated(Optional<String> dashboardName, Optional<String> accountId, Optional<String> owner, Optional<String> groupname, Optional<String> groupId, Optional<Long> projectId, Optional<String> orderBy, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> status, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search for dashboards Returns a [paginated](#pagination) list of dashboards.
io.reactivex.Single<Object>	removeGadget(Long dashboardId, Long gadgetId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove gadget from dashboard Removes a dashboard gadget from a dashboard.
io.reactivex.Single<Object>	setDashboardItemProperty(String dashboardId, String itemId, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set dashboard item property Sets the value of a dashboard item property.
io.reactivex.Single<Dashboard>	updateDashboard(String id, DashboardDetails dashboardDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update dashboard Updates a dashboard, replacing all the dashboard details with those provided.
io.reactivex.Single<Object>	updateGadget(Long dashboardId, Long gadgetId, DashboardGadgetUpdateRequest dashboardGadgetUpdateRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update gadget on dashboard Changes the title, position, and color of the gadget on a dashboard.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DashboardsApi

public DashboardsApi(org.everit.http.restclient.RestClient restClient)

Method Detail

addGadget

public io.reactivex.Single<DashboardGadget> addGadget(Long dashboardId,
                                                      DashboardGadgetSettings dashboardGadgetSettings,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add gadget to dashboard Adds a gadget to a dashboard. **[Permissions](#permissions) required:** None.

Parameters:

dashboardId - The ID of the dashboard. (required)

dashboardGadgetSettings - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<DashboardGadget>

bulkEditDashboards

public io.reactivex.Single<BulkEditShareableEntityResponse> bulkEditDashboards(BulkEditShareableEntityRequest bulkEditShareableEntityRequest,
                                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk edit dashboards Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100. **[Permissions](#permissions) required:** None The dashboards to be updated must be owned by the user, or the user must be an administrator.

Parameters:

bulkEditShareableEntityRequest - The details of dashboards being updated in bulk. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<BulkEditShareableEntityResponse>

copyDashboard

public io.reactivex.Single<Dashboard> copyDashboard(String id,
                                                    DashboardDetails dashboardDetails,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Copy dashboard Copies a dashboard. Any values provided in the `dashboard` parameter replace those in the copied dashboard. **[Permissions](#permissions) required:** None The dashboard to be copied must be owned by or shared with the user.

Parameters:

id - (required)

dashboardDetails - Dashboard details. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Dashboard>

createDashboard

public io.reactivex.Single<Dashboard> createDashboard(DashboardDetails dashboardDetails,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create dashboard Creates a dashboard. **[Permissions](#permissions) required:** None.

Parameters:

dashboardDetails - Dashboard details. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Dashboard>

deleteDashboard

public io.reactivex.Completable deleteDashboard(String id,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete dashboard Deletes a dashboard. **[Permissions](#permissions) required:** None The dashboard to be deleted must be owned by the user.

Parameters:

id - The ID of the dashboard. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

deleteDashboardItemProperty

public io.reactivex.Completable deleteDashboardItemProperty(String dashboardId,
                                                            String itemId,
                                                            String propertyKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete dashboard item property Deletes a dashboard item property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard.

Parameters:

dashboardId - The ID of the dashboard. (required)

itemId - The ID of the dashboard item. (required)

propertyKey - The key of the dashboard item property. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getAllAvailableDashboardGadgets

public io.reactivex.Single<AvailableDashboardGadgetsResponse> getAllAvailableDashboardGadgets(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get available gadgets Gets a list of all available gadgets that can be added to all dashboards. **[Permissions](#permissions) required:** None.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AvailableDashboardGadgetsResponse>

getAllDashboards

public io.reactivex.Single<PageOfDashboards> getAllDashboards(Optional<String> filter,
                                                              Optional<Integer> startAt,
                                                              Optional<Integer> maxResults,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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](#permissions) required:** None.

Parameters:

filter - The filter applied to the list of dashboards. Valid values are: * `favourite` Returns dashboards the user has marked as favorite. * `my` Returns dashboards owned by the user. (optional)

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0)

maxResults - The maximum number of items to return per page. (optional, default to 20)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageOfDashboards>

getAllGadgets

public io.reactivex.Single<DashboardGadgetResponse> getAllGadgets(Long dashboardId,
                                                                  Optional<List<String>> moduleKey,
                                                                  Optional<List<String>> uri,
                                                                  Optional<List<Long>> gadgetId,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get gadgets Returns a list of dashboard gadgets on a dashboard. This operation returns: * Gadgets from a list of IDs, when `id` is set. * Gadgets with a module key, when `moduleKey` is set. * Gadgets from a list of URIs, when `uri` is set. * All gadgets, when no other parameters are set. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

Parameters:

dashboardId - The ID of the dashboard. (required)

moduleKey - The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`. (optional, default to new ArrayList<>())

uri - The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`. (optional, default to new ArrayList<>())

gadgetId - The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`. (optional, default to new ArrayList<>())

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<DashboardGadgetResponse>

getDashboard

public io.reactivex.Single<Dashboard> getDashboard(String id,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get dashboard Returns a dashboard. This operation can be accessed anonymously. **[Permissions](#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](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Parameters:

id - The ID of the dashboard. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Dashboard>

getDashboardItemProperty

public io.reactivex.Single<EntityProperty> getDashboardItemProperty(String dashboardId,
                                                                    String itemId,
                                                                    String propertyKey,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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](https://confluence.atlassian.com/x/7AeiLQ). 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](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation. There is no resource to set or get dashboard items. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira’s anonymous access is permitted.

Parameters:

dashboardId - The ID of the dashboard. (required)

itemId - The ID of the dashboard item. (required)

propertyKey - The key of the dashboard item property. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<EntityProperty>

getDashboardItemPropertyKeys

public io.reactivex.Single<PropertyKeys> getDashboardItemPropertyKeys(String dashboardId,
                                                                      String itemId,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get dashboard item property keys Returns the keys of all properties for a dashboard item. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira’s anonymous access is permitted.

Parameters:

dashboardId - The ID of the dashboard. (required)

itemId - The ID of the dashboard item. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PropertyKeys>

getDashboardsPaginated

public io.reactivex.Single<PageBeanDashboard> getDashboardsPaginated(Optional<String> dashboardName,
                                                                     Optional<String> accountId,
                                                                     Optional<String> owner,
                                                                     Optional<String> groupname,
                                                                     Optional<String> groupId,
                                                                     Optional<Long> projectId,
                                                                     Optional<String> orderBy,
                                                                     Optional<Long> startAt,
                                                                     Optional<Integer> maxResults,
                                                                     Optional<String> status,
                                                                     Optional<String> expand,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Search for dashboards Returns a [paginated](#pagination) list of dashboards. This operation is similar to [Get dashboards](#api-rest-api-2-dashboard-get) 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](#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.

Parameters:

dashboardName - String used to perform a case-insensitive partial match with `name`. (optional)

accountId - User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter. (optional)

owner - This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter. (optional)

groupname - As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` parameter. (optional)

groupId - Group ID used to return dashboards that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter. (optional)

projectId - Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`. (optional)

orderBy - [Order](#ordering) the results by a field: * `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * `favourite_count` Sorts by dashboard popularity. * `id` Sorts by dashboard ID. * `is_favourite` Sorts by whether the dashboard is marked as a favorite. * `name` Sorts by dashboard name. * `owner` Sorts by dashboard owner name. (optional, default to name)

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 50)

status - The status to filter by. It may be active, archived or deleted. (optional, default to active)

expand - Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * `description` Returns the description of the dashboard. * `owner` Returns the owner of the dashboard. * `viewUrl` Returns the URL that is used to view the dashboard. * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite. * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite. * `sharePermissions` Returns details of the share permissions defined for the dashboard. * `editPermissions` Returns details of the edit permissions defined for the dashboard. * `isWritable` Returns whether the current user has permission to edit the dashboard. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanDashboard>

removeGadget

public io.reactivex.Single<Object> removeGadget(Long dashboardId,
                                                Long gadgetId,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove gadget from dashboard Removes a dashboard gadget from a dashboard. When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position. **[Permissions](#permissions) required:** None.

Parameters:

dashboardId - The ID of the dashboard. (required)

gadgetId - The ID of the gadget. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

setDashboardItemProperty

public io.reactivex.Single<Object> setDashboardItemProperty(String dashboardId,
                                                            String itemId,
                                                            String propertyKey,
                                                            Object body,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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](https://confluence.atlassian.com/x/7AeiLQ). 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](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation. There is no resource to set or get dashboard items. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard.

Parameters:

dashboardId - The ID of the dashboard. (required)

itemId - The ID of the dashboard item. (required)

propertyKey - The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to \"config\", the request body's JSON must be an object with all keys and values as strings. (required)

body - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

updateDashboard

public io.reactivex.Single<Dashboard> updateDashboard(String id,
                                                      DashboardDetails dashboardDetails,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update dashboard Updates a dashboard, replacing all the dashboard details with those provided. **[Permissions](#permissions) required:** None The dashboard to be updated must be owned by the user.

Parameters:

id - The ID of the dashboard to update. (required)

dashboardDetails - Replacement dashboard details. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Dashboard>

updateGadget

public io.reactivex.Single<Object> updateGadget(Long dashboardId,
                                                Long gadgetId,
                                                DashboardGadgetUpdateRequest dashboardGadgetUpdateRequest,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update gadget on dashboard Changes the title, position, and color of the gadget on a dashboard. **[Permissions](#permissions) required:** None.

Parameters:

dashboardId - The ID of the dashboard. (required)

gadgetId - The ID of the gadget. (required)

dashboardGadgetUpdateRequest - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>