public class

IssueTypePropertyResource

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

Class Overview

This resource allows to store custom properties for issue types.

Summary

Public Constructors
IssueTypePropertyResource(IssueTypePropertyService issueTypePropertyService, JiraAuthenticationContext authenticationContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)
Public Methods
@ExperimentalApi Response deleteProperty(String issueTypeId, String propertyKey)
Removes the property from the issue type identified by the id.
@ExperimentalApi Response getProperty(String issueTypeId, String propertyKey)
Returns the value of the property with a given key from the issue type identified by the id.
@ExperimentalApi Response getPropertyKeys(String issueTypeId)
Returns the keys of all properties for the issue type identified by the id.
@ExperimentalApi Response setProperty(String issueTypeId, String propertyKey, HttpServletRequest request)
Sets the value of the specified issue type's property.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

Public Methods

@ExperimentalApi public Response deleteProperty (String issueTypeId, 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 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

@ExperimentalApi public Response getProperty (String issueTypeId, 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.

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

@ExperimentalApi public Response getPropertyKeys (String issueTypeId)

@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 type identified by the id.

Parameters
issueTypeId the issue type from which the keys will be returned
Returns
  • a response containing EntityPropertiesKeysBean

@ExperimentalApi public Response setProperty (String issueTypeId, String propertyKey, 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 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 a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.