Get gadgets - JIRA 7.6.1

Returns a list of dashboard gadgets on a dashboard.

This operation returns:

Gadgets from a list of IDs, when id is set.

Gadgets with a module key, when moduleKey is set.

Gadgets from a list of URIs, when uri is set.

All gadgets, when no other parameters are set.

This operation can be accessed anonymously.

Permissions required: None.

{ "gadgets": [ { "id": 10001, "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item", "color": "blue", "position": { "row": 0, "column": 0 }, "title": "Issue statistics" }, { "id": 10002, "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph", "color": "red", "position": { "row": 1, "column": 0 }, "title": "Activity stream" }, { "id": 10003, "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item", "color": "yellow", "position": { "row": 0, "column": 1 }, "title": "Bubble chart" } ] }

Request

Path Params

dashboardId

integer

required

The ID of the dashboard.

Query Params

moduleKey

array[string]

optional

The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: moduleKey=key:one&moduleKey=key:two.

uri

array[string]

optional

The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: uri=/rest/example/uri/1&uri=/rest/example/uri/2.

gadgetId

array[string]

optional

The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: gadgetId=10000&gadgetId=10001.

Responses

🟢200Returned if the request is successful.

application/json

Body

The list of gadgets on the dashboard.

gadgets

array[object (DashboardGadget) {6}]

read-onlyrequired

The list of gadgets.

color

enum<string>

read-onlyrequired

The color of the gadget. Should be one of blue, red, yellow, green, cyan, purple, gray, or white.

Allowed values:

blueredyellowgreencyanpurplegraywhite

integer <int64>

read-onlyrequired

The ID of the gadget instance.

moduleKey

string

read-onlyoptional

The module key of the gadget type.

position

object

required

The position of the gadget.

title

string

read-onlyrequired

The title of the gadget.

uri

string

read-onlyoptional

The URI of the gadget type.

🟠401Returned if the authentication credentials are incorrect.

🟠404Returned if the dashboard is not found.