GET .../addons/{addonKey}/properties/{propertyKey}

Returns a property for the given property key.

Parameters:

LocationTypeNameDescription
PathaddonKeystring

The key of the add-on, as defined in its descriptor

PathpropertyKeystring

The key of the property

QueryjsonValueboolean

Set to 'true' to have the 'value' field return as a json object. If false it will return the 'value' field as a string containing escaped json. This will be deprecated during June 2016 and the behaviour will default to true.

Response representations:

200 - application/json
{
  "key" : "abcd",
  "value" : true,
  "self" : "/rest/api/atlassian-connect/${addonKey}/properties/abcd"
}
400 - application/json

Property key longer than 127 characters.

401 - application/json

Request without credentials or with invalid credentials, e.g. by an uninstalled add-on.

404 - application/json

Request to get a property that does not exist.

404 - application/json

Request issued by a user with insufficient credentials, e.g. for an add-on's data by anyone but the add-on itself, or for a plugin that does not exist.