setDashboardItemProperty method

Future setDashboardItemProperty({ required String dashboardId, required String itemId, required String propertyKey, required dynamic body, })

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.

Implementation

Future<dynamic> setDashboardItemProperty(
    {required String dashboardId,
    required String itemId,
    required String propertyKey,
    required dynamic body}) async {
  return await _client.send(
    'put',
    'rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}',
    pathParameters: {
      'dashboardId': dashboardId,
      'itemId': itemId,
      'propertyKey': propertyKey,
    },
    body: body,
  );
}