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

Class DashboardItemPropertyResource

java.lang.Object

com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource

@Path("dashboard/{dashboardId}/items/{itemId}/properties")
@Consumes("application/json")
@Produces("application/json")
public final class DashboardItemPropertyResource
extends Object

Constructor Summary

Constructors

Constructor	Description
DashboardItemPropertyResource(DashboardItemPropertyService dashboardItemPropertyService, com.atlassian.gadgets.dashboard.DashboardService dashboardService, JiraAuthenticationContext authenticationContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n, I18nHelper i18nHelper)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	deleteProperty(String dashboardId, String itemId, String propertyKey)	Removes the property from the dashboard item identified by the key or by the id.
javax.ws.rs.core.Response	getPropertiesKeys(String dashboardId, String itemId)	Returns the keys of all properties for the dashboard item identified by the id.
javax.ws.rs.core.Response	getProperty(String dashboardId, String itemId, String propertyKey)	Returns the value of the property with a given key from the dashboard item identified by the id.
javax.ws.rs.core.Response	setProperty(String dashboardId, String itemId, String propertyKey, javax.servlet.http.HttpServletRequest request)	Sets the value of the specified dashboard item's property.

Methods inherited from class java.lang.Object

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

Constructor Details

DashboardItemPropertyResource

@Inject
public DashboardItemPropertyResource(DashboardItemPropertyService dashboardItemPropertyService,
 com.atlassian.gadgets.dashboard.DashboardService dashboardService,
 JiraAuthenticationContext authenticationContext,
 JiraBaseUrls jiraBaseUrls,
 I18nHelper i18n,
 I18nHelper i18nHelper)

Method Details

getPropertiesKeys

@GET
public javax.ws.rs.core.Response getPropertiesKeys(@PathParam("dashboardId")
 String dashboardId,
 @PathParam("itemId")
 String itemId)

Returns the keys of all properties for the dashboard item identified by the id.

Parameters:

itemId - the dashboard item from which keys will be returned.

Returns:

a response containing EntityPropertiesKeysBean.

setProperty

@PUT
@Path("/{propertyKey}")
public javax.ws.rs.core.Response setProperty(@PathParam("dashboardId")
 String dashboardId,
 @PathParam("itemId")
 String itemId,
 @PathParam("propertyKey")
 String propertyKey,
 @Context
 javax.servlet.http.HttpServletRequest request)

Sets the value of the specified dashboard item's property.

You can use this resource to store a custom data against the dashboard item identified by the id. The user who stores the data is required to have permissions to administer the dashboard item.

Parameters:

itemId - the dashboard item on which the property will be set.

propertyKey - the key of the dashboard item's property. The maximum length of the key is 255 bytes.

request - the request containing value of the dashboard item's property. The value has to be a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.

getProperty

@GET
@Path("/{propertyKey}")
public javax.ws.rs.core.Response getProperty(@PathParam("dashboardId")
 String dashboardId,
 @PathParam("itemId")
 String itemId,
 @PathParam("propertyKey")
 String propertyKey)

Returns the value of the property with a given key from the dashboard item identified by the id. The user who retrieves the property is required to have permissions to read the dashboard item.

Parameters:

itemId - the dashboard item from which the property will be returned.

propertyKey - the key of the property to return.

Returns:

a response containing EntityPropertyBean.

deleteProperty

@DELETE
@Path("/{propertyKey}")
public javax.ws.rs.core.Response deleteProperty(@PathParam("dashboardId")
 String dashboardId,
 @PathParam("itemId")
 String itemId,
 @PathParam("propertyKey")
 String propertyKey)

Removes the property from the dashboard item identified by the key or by the id. Ths user removing the property is required to have permissions to administer the dashboard item.

Parameters:

itemId - the dashboard item from which the property will be removed.

propertyKey - the key of the property to remove.

Returns:

a 204 HTTP status if everything goes well.