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

Class DashboardApi

java.lang.Object

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

public class DashboardApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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<Dashboard>	getDashboard(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dashboard Returns a dashboard.
io.reactivex.Single<PageBeanDashboard>	getDashboardsPaginated(Optional<String> dashboardName, Optional<String> accountId, Optional<String> owner, Optional<String> groupname, Optional<Long> projectId, Optional<String> orderBy, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search for dashboards Searches for dashboards.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardApi

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

Method Detail

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 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. The maximum is 1000.

(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>

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 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.

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>

getDashboardsPaginated

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

Search for dashboards

Searches for 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.

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 for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.

(optional)

groupname -

Group name used to returns dashboards that are shared with a group that matches sharePermissions.group.name.

(optional)

projectId -

Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

(optional)

orderBy -

Orders the results using one of these dashboard properties:

• id Orders by dashboard id.
• name Orders by dashboard name.
• description Orders by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.
• owner Orders by owner name.
• favourite_count Orders by popularity.
• is_favourite Orders by isFavourite.

(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. The maximum is 100.

(optional, default to 50)

expand -

Use expand to include additional information about dashboard in the response. This parameter accepts multiple values separated by a comma:

• 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.

(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>