Update gadget on dashboard

Changes the title, position, and color of the gadget on a dashboard. **[Permissions](#permissions) required:** None.

Script jira Verified

by hugo697 ยท 11/2/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 396 days ago
1
type Jira = {
2
  username: string;
3
  password: string;
4
  domain: string;
5
};
6
/**
7
 * Update gadget on dashboard
8
 * Changes the title, position, and color of the gadget on a dashboard.
9

10
**[Permissions](#permissions) required:** None.
11
 */
12
export async function main(
13
  auth: Jira,
14
  dashboardId: string,
15
  gadgetId: string,
16
  body: {
17
    color?: string;
18
    position?: {
19
      "The column position of the gadget.": number;
20
      "The row position of the gadget.": number;
21
    };
22
    title?: string;
23
  }
24
) {
25
  const url = new URL(
26
    `https://${auth.domain}.atlassian.net/rest/api/2/dashboard/${dashboardId}/gadget/${gadgetId}`
27
  );
28

29
  const response = await fetch(url, {
30
    method: "PUT",
31
    headers: {
32
      "Content-Type": "application/json",
33
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
34
    },
35
    body: JSON.stringify(body),
36
  });
37
  if (!response.ok) {
38
    const text = await response.text();
39
    throw new Error(`${response.status} ${text}`);
40
  }
41
  return await response.json();
42
}
43