nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Using JIRA REST API how to update gadgets

Vishal Biyani

i have been able to add a gadget in the dashboard using REST APIs

url = "https://your-domain.atlassian.net/rest/api/3/dashboard"

and

url = "https://your-domain.atlassian.net/rest/api/3/dashboard/{dashboardId}/gadget"

Once a gadget is added, which REST API to use to populate the gadget?

e.g. i added Filter Count gadget. Now how do i add using REST API

1. filter

2. specify the counts

Accepted answers

Martin Bayer _MoroSystems_ s_r_o__

Hi @Vishal Biyani , I think you will need to use following rest endpoint:

/rest/api/3/dashboard/{dashboardid}/items/{gadgetid}/properties
- for GET - it will return your properties (there will be e.g. property "config")
/rest/api/3/dashboard/{dashboardid}/items/{gadgetid}/properties/config
- for GET - it will return your configuration and for example something like
  - ```
  {"key":"config","value":{"filterId":"10004","isConfigured":"true","columnNames":"issuetype|issuekey|summary|priority|customfield_10058","isPopup":"false","num":"10","refresh":"false"}}
```
- you can change your configuration using PUT method
  - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-put

All comments

Martin Bayer _MoroSystems_ s_r_o__

Hi @Vishal Biyani , I think you will need to use following rest endpoint:

/rest/api/3/dashboard/{dashboardid}/items/{gadgetid}/properties
- for GET - it will return your properties (there will be e.g. property "config")
/rest/api/3/dashboard/{dashboardid}/items/{gadgetid}/properties/config
- for GET - it will return your configuration and for example something like
  - ```
  {"key":"config","value":{"filterId":"10004","isConfigured":"true","columnNames":"issuetype|issuekey|summary|priority|customfield_10058","isPopup":"false","num":"10","refresh":"false"}}
```
- you can change your configuration using PUT method
  - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-put

Vishal Biyani

@Martin Bayer _MoroSystems_ s_r_o__

i added the dashboard gadget using

url = "https://your-domain.atlassian.net/rest/api/3/dashboard/{dashboardId}/gadget"

got the itemId using =

response.json()["id"]

Now when i try to run below API, replacing dashboardId and itemId received from above

url = "https://your-domain.atlassian.net/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties"

getting 404

b'{"message":"null for uri: https://your-domain.atlassian.net/rest/api/3/10671/items/39921/properties","status-code":404}'

Not sure why is that happening. i even added a sleep of 5 seconds to ensure the gadget is getting added to the dashboard

Vishal Biyani

@Martin Bayer _MoroSystems_ s_r_o__

never mind. i had missed dashboard and hence was getting 404 :-(

The issue is resolved now. thanks for your guidance though

Martin Bayer _MoroSystems_ s_r_o__

Hi @Vishal Biyani , sorry for the late reply, but I'm happy that you were able to resolve the problem yourself

You can accept the answer if you think it could help other users...

Vishal Biyani

@Martin Bayer _MoroSystems_ s_r_o__

I am able to add "Filter Results" gadget using put method.

However, I am struggling to add "Filter Counts" gadget. i am not sure what is the right payload to use.

I tried using two calls with below payload

for projectFilterDetails i used

payload_value={"id": "11860", "type": "filter",}

for countOptions i used

{
"hasTrigger": False,
"trigger":
        {
"display": "warning",
"triggerEquality": "above",
"triggerOn": "undefined"
        },
"name": "High+ Open",
"jql": "priority in (Critical, High, 'Show Stopper') and status in (Open, 'In Progress')",
"id": "c976"
}

When i call put API i get 201 and i can browse the end point

But on dashboard, the gadget shows error and does not allow me to edit it also.

Any guidance with this will be helpful.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

cloud

jira-cloud