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

Class IssueTypePropertyResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.IssueTypePropertyResource

@Path("issuetype/{issueTypeId}/properties")
@Consumes("application/json")
@Produces("application/json")
public class IssueTypePropertyResource
extends Object

This resource allows to store custom properties for issue types.

Since:

7.0

Constructor Summary

Constructors

Constructor	Description
IssueTypePropertyResource(IssueTypePropertyService issueTypePropertyService, JiraAuthenticationContext authenticationContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

IssueTypePropertyResource

@Inject
public IssueTypePropertyResource(IssueTypePropertyService issueTypePropertyService,
 JiraAuthenticationContext authenticationContext,
 JiraBaseUrls jiraBaseUrls,
 I18nHelper i18n)

Method Details

getPropertyKeys

@ExperimentalApi
@GET
public javax.ws.rs.core.Response getPropertyKeys(@PathParam("issueTypeId")
 String issueTypeId)

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

Parameters:

issueTypeId - the issue type from which the keys will be returned

Returns:

a response containing EntityPropertiesKeysBean

setProperty

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

Sets the value of the specified issue type's property.

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

Parameters:

issueTypeId - the issue type on which the property will be set

propertyKey - the key of the issue type's property. The maximum length of the key is 255 bytes

request - the request containing value of the issue type'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 javax.ws.rs.core.Response getProperty(@PathParam("issueTypeId")
 String issueTypeId,
 @PathParam("propertyKey")
 String propertyKey)

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

Parameters:

issueTypeId - the issue type from which the property will be returned

propertyKey - the key of the property to return

Returns:

a response containing EntityPropertyBean

deleteProperty

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

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

Parameters:

issueTypeId - the issue type from which the property will be removed

propertyKey - the key of the property to remove

Returns:

a 204 HTTP status if everything goes well