Internal
Create a new instance of the service.
Deletes an app's property.
Permissions required: Only a Connect app whose key matches
addonKey
can make this request.
Additionally, Forge apps can access Connect app properties (stored against the
same app.connect.key
).
The key of the app, as defined in its descriptor.
The key of the property.
Gets all the properties of an app.
Permissions required: Only a Connect app whose key matches
addonKey
can make this request.
Additionally, Forge apps can access Connect app properties (stored against the
same app.connect.key
).
The key of the app, as defined in its descriptor.
Returned if the request is successful.
example:
{
"keys": [
{
"self": "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey",
"key": "propertyKey"
}
]
}
Returns the key and value of an app's property.
Permissions required: Only a Connect app whose key matches
addonKey
can make this request.
Additionally, Forge apps can access Connect app properties (stored against the
same app.connect.key
).
The key of the app, as defined in its descriptor.
The key of the property.
Returned if the request is successful.
example:
{
"self": "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey",
"key": "propertyKey",
"value": "propertyValue"
}
Sets the value of an app's property. Use this resource to store custom data for your app.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: Only a Connect app whose key matches
addonKey
can make this request.
Additionally, Forge apps can access Connect app properties (stored against the
same app.connect.key
).
The key of the app, as defined in its descriptor.
The key of the property.
status: 200, mediaType: application/json
Returned if the property is updated.
example:
{
"message": "Property updated.",
"statusCode": 200
}
status: 201, mediaType: application/json
Returned is the property is created.
example:
{
"message": "Property created.",
"statusCode": 201
}
Deletes a Forge app's property.
Permissions required: Only Forge apps can make this request.
The new write:app-data:jira
OAuth scope is 100% optional now, and not using
it won't break your app. However, we recommend adding it to your app's scope
list because we will eventually make it mandatory.
The key of the property.
Sets the value of a Forge app's property.
These values can be retrieved in Jira
expressions
through the app
context
variable.
They are also available in entity property display
conditions.
For other use cases, use the Storage API.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: Only Forge apps can make this request.
The new write:app-data:jira
OAuth scope is 100% optional now, and not using
it won't break your app. However, we recommend adding it to your app's scope
list because we will eventually make it mandatory.
The key of the property.
status: 200, mediaType: application/json
Returned if the property is updated.
example:
{
"message": "Property updated.",
"statusCode": 200
}
status: 201, mediaType: application/json
Returned is the property is created.
example:
{
"message": "Property created.",
"statusCode": 201
}
Protected
Static
initialize
This resource represents app properties. Use it to store arbitrary data for your Connect app.
See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties