public class

CommentPropertyResource

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

Summary

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

Public Constructors

public CommentPropertyResource (CommentPropertyService commentPropertyService, JiraAuthenticationContext authenticationContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)

Public Methods

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

Parameters
commentId the comment 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 commentId)

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

Parameters
commentId the comment from which keys will be returned.
Returns
  • a response containing EntityPropertiesKeysBean.

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

Parameters
commentId the comment from which the property will be returned.
propertyKey the key of the property to return.
Returns

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

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

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