GET

Get properties keys of a commentExperimental

Returns the keys of all properties for the comment identified by the key or by the id.

Request

Path parameters

commentId

string

Required

Responses

Returns a list of all properties in the comment.

application/json

EntityPropertiesKeysBean
GET/api/2/comment/{commentId}/properties
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/comment/{commentId}/properties' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get a property from a commentExperimental

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.

Request

Path parameters

propertyKey

string

Required
commentId

string

Required

Responses

Returns the value of the property with a given key from the comment.

application/json

EntityPropertyBean
GET/api/2/comment/{commentId}/properties/{propertyKey}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/comment/{commentId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Set a property on a commentExperimental

Sets the value of the specified comment's property.

Request

Path parameters

propertyKey

string

Required
commentId

string

Required

Request bodyapplication/json

the request containing value of the comment'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.

any

Responses

Returned if the comment property is successfully updated.

PUT/api/2/comment/{commentId}/properties/{propertyKey}
1 2 3 4 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/comment/{commentId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
DEL

Delete a property from a commentExperimental

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.

Request

Path parameters

propertyKey

string

Required
commentId

string

Required

Responses

Returned if the comment property was removed successfully.

DEL/api/2/comment/{commentId}/properties/{propertyKey}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/comment/{commentId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>'

Rate this page: