v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Dashboards

Get dashboard item property

Returns the key and value of a dashboard item property.

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.

This operation can be accessed anonymously.

Permissions required: The user must have read permission of the dashboard or have the dashboard shared with them.

get/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.

Response

Returned if the request is successful.

keystring

The key of the property. Required on create and update.

{"stackTrail":"components:schemas:EntityProperty:properties:value","oasType":"schema","type":"unknown","description":"The value of the property. Required on create and update."}