public class

ProjectPropertyResource

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

Summary

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

Public Constructors

public ProjectPropertyResource (ProjectPropertyService projectPropertyService, JiraAuthenticationContext authContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)

Public Methods

@ExperimentalApi public Response deleteProperty (String projectIdOrKey, 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 project identified by the key or by the id. Ths user removing the property is required to have permissions to administer the project.

Parameters
projectIdOrKey the project 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 projectIdOrKey)

@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 project identified by the key or by the id.

Parameters
projectIdOrKey the project from which keys will be returned.
Returns
  • a response containing EntityPropertiesKeysBean.

@ExperimentalApi public Response getProperty (String projectIdOrKey, 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 project identified by the key or by the id. The user who retrieves the property is required to have permissions to read the project.

Parameters
projectIdOrKey the project from which the property will be returned.
propertyKey the key of the property to return.
Returns

@ExperimentalApi public Response setProperty (String projectIdOrKey, 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 project's property.

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

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