Package com.atlassian.jira.rest.v2.issue

Class IssuePropertyResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.IssuePropertyResource

@Path("issue/{issueIdOrKey}/properties")
@Consumes("application/json")
@Produces("application/json")
public class IssuePropertyResource
extends Object

Since:

v6.2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	deleteProperty(String issueIdOrKey, String propertyKey)	Removes the property from the issue identified by the key or by the id.
jakarta.ws.rs.core.Response	getPropertiesKeys(String issueIdOrKey)	Returns the keys of all properties for the issue identified by the key or by the id.
jakarta.ws.rs.core.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.
jakarta.ws.rs.core.Response	setProperty(String issueIdOrKey, String issuePropertyKey, jakarta.servlet.http.HttpServletRequest request)	Sets the value of the specified issue's property.

Methods inherited from class java.lang.Object

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

Constructor Details

IssuePropertyResource

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

Method Details

getPropertiesKeys

@ExperimentalApi
@GET
public jakarta.ws.rs.core.Response getPropertiesKeys(@PathParam("issueIdOrKey")
 String issueIdOrKey)

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.

setProperty

@ExperimentalApi
@PUT
@Path("/{propertyKey}")
public jakarta.ws.rs.core.Response setProperty(@PathParam("issueIdOrKey")
 String issueIdOrKey,
 @PathParam("propertyKey")
 String issuePropertyKey,
 @Context
 jakarta.servlet.http.HttpServletRequest request)

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

@ExperimentalApi
@GET
@Path("/{propertyKey}")
public jakarta.ws.rs.core.Response getProperty(@PathParam("issueIdOrKey")
 String issueIdOrKey,
 @PathParam("propertyKey")
 String issuePropertyKey)

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:

a response containing EntityPropertyBean.

deleteProperty

@ExperimentalApi
@DELETE
@Path("/{propertyKey}")
public jakarta.ws.rs.core.Response deleteProperty(@PathParam("issueIdOrKey")
 String issueIdOrKey,
 @PathParam("propertyKey")
 String propertyKey)

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.