Set dashboard item property

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/dashboard//items//properties/' \ --header 'Content-Type: application/json' \ --data-raw '{ "number": 5, "string": "string-value" }'

Request

Path Params

dashboardId

string

required

The ID of the dashboard.

itemId

string

required

The ID of the dashboard item.

propertyKey

string

required

The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an object with all keys and values as strings.

Body Params application/json

No schema defined

Examples

Responses

🟢200Returned if the dashboard item property is updated.

application/json

Body

No schema defined

🟢201Returned if the dashboard item property is created.

🟠400Returned if: * Request is invalid * Or if all of these conditions are met in the request: * The dashboard item has a spec URI and no complete module key * The value of propertyKey is equal to "config" * The request body contain

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user is not the owner of the dashboard.

🟠404Returned if the dashboard item is not found or the dashboard is not shared with the user.