Sign in

v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Dashboards

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 have edit permisson of the dashboard.

put/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}

Path parameters

dashboardIdstring required

The ID of the dashboard.

itemIdstring required

The ID of the dashboard item.

propertyKeystring 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.

Request body

{"stackTrail":"paths:/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

Returned if the dashboard item property is updated.

{"stackTrail":"paths:/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}