Jira REST API for configuring dashboard gadget

[EddieCM_Chuang]

My goal is to create dashboard gadgets automatically and programatically. I tried to create dashboard gadget, filter results, using jira rest api. However, there isn't any parameters to set 'saved filter', 'Number of results' or 'Columns to display' for gadget in api ('add gadget to dashboard', 'update gadget to dashboard'). The only thing I can do with api is create an empty gadget.
How can I configure gadgets using api? If it isn't possible, any alternative solution or workaround?

[Fabio Racobaldo _Herzum_ · Accepted solution]

Hi @EddieCM_Chuang ,

welcome to the Atlassian community!

You should use the following rest api https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-put in order to setup a gadget on a dashboard using api.

Hope this helps,

Fabio

[EddieCM_Chuang]

Thanks a lot! I will study the dashboard item.

I'm curious about why Jira provides the rest api to add/update gadgets, but not to configure gadgets.

[Arun]

Hi @Fabio Racobaldo _Herzum_

import ForgeUI, { render, Fragment, Macro, Text, useState } from "@forge/ui";

import api, { route } from "@forge/api";

const getDashoardDetails = async () => {

  var bodyData = `{

    "description": "A dashboard to help auditors identify sample of issues to check.",

    "editPermissions": [],

    "name": "Auditors dashboard",

    "sharePermissions": [

      {

        "type": "global"

      }

    ]

  }`;

  const response = await api.asUser().requestJira(route`/rest/api/3/dashboard`, {

    method: 'POST',

    headers: {

      'Accept': 'application/json',

      'Content-Type': 'application/json'

    },

    body: bodyData

  });

  console.log(`Response: ${response.status} ${response.statusText}`);

  console.log(await response.json());

}

const App = () => {

  const dashboards = useState(async () => await getDashoardDetails());

  console.log('--> dashboardDetails', dashboards);

  return (

    <Fragment>

      <Text>Hello world!</Text>

    </Fragment>

  );

};

export const run = render(

  <Macro

    app={<App />}

  />

);

my forge app code is here am trying to create a dashboard on forge app here am facing some issues on server after deployed on server it returning an null value on the logs

[ null, "[Function]" ]

[EddieCM_Chuang]

Thanks for @Fabio Racobaldo _Herzum_ suggestion.

My python implementation using jira api `set dashboard item properties`.

payload = json.dumps({
    "filterId": "10711",
    "num": "50",
    "columnNames": "issuetype|summary|issuekey",
    "refresh": "true",
    "isConfigured": "true"
})

res = requests.request(
    "PUT",
    f"{HOST}/rest/api/3/dashboard/{dashboard_id}/items/{item_id}/properties/config",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data=payload,
    auth=HTTPBasicAuth(EMAIL, TOKEN)
)

[Fabio Racobaldo _Herzum_]

you're welcome @EddieCM_Chuang