GET /rest/api/2/dashboard/{dashboardId}/gadget
Returns a list of dashboard gadgets on a dashboard.
This operation returns:
- Gadgets from a list of IDs, when
idis set. - Gadgets with a module key, when
moduleKeyis set. - Gadgets from a list of URIs, when
uriis set. - All gadgets, when no other parameters are set.
This operation can be accessed anonymously.
Permissions required: None.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
dashboardId |
Integer | Yes |
The ID of the dashboard. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
uri[] |
Array | No |
The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: |
moduleKey[] |
Array | No |
The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: |
gadgetId[] |
Array | No |
The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.