provider Dashboards GET
/rest/api/3/dashboard/{dashboardId}/gadget @utdk/jira
/rest/api/3/dashboard/{dashboardId}/gadget Get gadgets
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](#permissions) required:** None.
- dashboardId path required
- The ID of the dashboard.
- integer
- moduleKey query
- The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.
- array
- uri query
- The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.
- array
- gadgetId query
- The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.
- array
Try it
Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import jira from '@utdk/jira';
await jira.getallgadgets()