public final class DashboardItemPropertyResource extends Object
Constructor and Description |
---|
DashboardItemPropertyResource(DashboardItemPropertyService dashboardItemPropertyService,
com.atlassian.gadgets.dashboard.DashboardService dashboardService,
JiraAuthenticationContext authenticationContext,
JiraBaseUrls jiraBaseUrls,
I18nHelper i18n,
I18nHelper i18nHelper) |
Modifier and Type | Method and 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.
|
public DashboardItemPropertyResource(DashboardItemPropertyService dashboardItemPropertyService, com.atlassian.gadgets.dashboard.DashboardService dashboardService, JiraAuthenticationContext authenticationContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n, I18nHelper i18nHelper)
public javax.ws.rs.core.Response getPropertiesKeys(String dashboardId, String itemId)
itemId
- the dashboard item from which keys will be returned.public javax.ws.rs.core.Response setProperty(String dashboardId, String itemId, String propertyKey, @Context javax.servlet.http.HttpServletRequest request)
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.
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 a valid, non-empty JSON conforming
to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.public javax.ws.rs.core.Response getProperty(String dashboardId, String itemId, String propertyKey)
itemId
- the dashboard item from which the property will be returned.propertyKey
- the key of the property to return.EntityPropertyBean
.public javax.ws.rs.core.Response deleteProperty(String dashboardId, String itemId, String propertyKey)
itemId
- the dashboard item from which the property will be removed.propertyKey
- the key of the property to remove.Copyright © 2002-2019 Atlassian. All Rights Reserved.