DashboardResource

extends Object

java.lang.Object
↳	com.atlassian.jira.rest.v2.dashboard.DashboardResource

Class Overview

The /dashboard resource.

Public Constructors
	DashboardResource(JiraAuthenticationContext jiraAuthenticationContext, PortalPageService portalPageService, I18nHelper.BeanFactory i18nFactory, JiraBaseUrls jiraBaseUrls, ContextUriInfo uriInfo)

Public Methods
Response	getDashboard(String id) Returns a single dashboard.
Response	list(String filter, Integer startAtParam, Integer maxResultsParam) Returns a list of all dashboards, optionally filtering them.

Inherited Methods

From class java.lang.Object

Returns a single dashboard.

id	the dashboard id

Returns a list of all dashboards, optionally filtering them.

filter	an optional filter that is applied to the list of dashboards. Valid values include `"favourite"` for returning only favourite dashboards, and `"my"` for returning dashboards that are owned by the calling user.
startAtParam	the index of the first dashboard to return (0-based). must be 0 or a multiple of `maxResults`
maxResultsParam	a hint as to the the maximum number of dashboards to return in each call. Note that the JIRA server reserves the right to impose a `maxResults` limit that is lower than the value that a client provides, dues to lack or resources or any other condition. When this happens, your results will be truncated. Callers should always check the returned `maxResults` to determine the value that is effectively being used.