Package com.atlassian.jira.rest.v2.dashboard

Class DashboardResource

java.lang.Object

com.atlassian.jira.rest.v2.dashboard.DashboardResource

@Path("dashboard")
@Consumes("application/json")
@Produces("application/json")
public class DashboardResource
extends Object

Since:

v5.0

Constructor Summary

Constructors

Constructor	Description
DashboardResource(JiraAuthenticationContext jiraAuthenticationContext, PortalPageService portalPageService, I18nHelper.BeanFactory i18nFactory, JiraBaseUrls jiraBaseUrls, javax.ws.rs.core.UriInfo uriInfo, FeatureManager featureManager, GlobalPermissionManager permissionManager)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getDashboard(String id)	Returns a single dashboard.
javax.ws.rs.core.Response	list(String filter, Integer startAtParam, Integer maxResultsParam)	Returns a list of all dashboards, optionally filtering them.

Methods inherited from class java.lang.Object

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

Constructor Details

DashboardResource

@Inject
public DashboardResource(JiraAuthenticationContext jiraAuthenticationContext,
 PortalPageService portalPageService,
 I18nHelper.BeanFactory i18nFactory,
 JiraBaseUrls jiraBaseUrls,
 javax.ws.rs.core.UriInfo uriInfo,
 FeatureManager featureManager,
 GlobalPermissionManager permissionManager)

Method Details

list

@GET
public javax.ws.rs.core.Response list(@QueryParam("filter")
 String filter,
 @QueryParam("startAt")
 Integer startAtParam,
 @QueryParam("maxResults")
 Integer maxResultsParam)

Returns a list of all dashboards, optionally filtering them.

Parameters:

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

Returns:

a list of Dashboards

getDashboard

@GET
@Path("{id}")
public javax.ws.rs.core.Response getDashboard(@PathParam("id")
 String id)

Returns a single dashboard.

Parameters:

id - the dashboard id

Returns:

a dashboard