public class

IssuePropertyResource

extends Object
java.lang.Object
   ↳ com.atlassian.jira.rest.v2.issue.IssuePropertyResource

Summary

Public Constructors
IssuePropertyResource(IssuePropertyService issuePropertyService, JiraAuthenticationContext authContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)
Public Methods
@ExperimentalApi Response deleteProperty(String issueIdOrKey, String propertyKey)
Removes the property from the issue identified by the key or by the id.
@ExperimentalApi Response getPropertiesKeys(String issueIdOrKey)
Returns the keys of all properties for the issue identified by the key or by the id.
@ExperimentalApi Response getProperty(String issueIdOrKey, String issuePropertyKey)
Returns the value of the property with a given key from the issue identified by the key or by the id.
@ExperimentalApi Response setProperty(String issueIdOrKey, String issuePropertyKey, HttpServletRequest request)
Sets the value of the specified issue's property.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public IssuePropertyResource (IssuePropertyService issuePropertyService, JiraAuthenticationContext authContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)

Public Methods

@ExperimentalApi public Response deleteProperty (String issueIdOrKey, String propertyKey)

@ExperimentalApi

This method is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Removes the property from the issue identified by the key or by the id. Ths user removing the property is required to have permissions to edit the issue.

Parameters
issueIdOrKey the issue from which the property will be removed.
propertyKey the key of the property to remove.
Returns
  • a 204 HTTP status if everything goes well.

@ExperimentalApi public Response getPropertiesKeys (String issueIdOrKey)

@ExperimentalApi

This method is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Returns the keys of all properties for the issue identified by the key or by the id.

Parameters
issueIdOrKey the issue from which keys will be returned.
Returns
  • a response containing EntityPropertiesKeysBean.

@ExperimentalApi public Response getProperty (String issueIdOrKey, String issuePropertyKey)

@ExperimentalApi

This method is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

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

Parameters
issueIdOrKey the issue from which the property will be returned.
issuePropertyKey the key of the property to return.
Returns

@ExperimentalApi public Response setProperty (String issueIdOrKey, String issuePropertyKey, HttpServletRequest request)

@ExperimentalApi

This method is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Sets the value of the specified issue's property.

You can use this resource to store a custom data against the issue identified by the key or by the id. The user who stores the data is required to have permissions to edit the issue.

Parameters
issueIdOrKey the issue on which the property will be set.
issuePropertyKey the key of the issue's property. The maximum length of the key is 255 bytes.
request the request containing value of the issue'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.