Ctrl K

Search for dashboards

Returns a [paginated](#pagination) list of dashboards.

Script jira Verified

by hugo697 · 11/2/2023

Use in Windmill

The script

Submitted by hugo697 Typescript (fetch-only)

Verified 396 days ago

All edits

Permalink

type Jira = {
  username: string;
  password: string;
  domain: string;
};
/**
 * Search for dashboards
 * Returns a [paginated](#pagination) list of dashboards.
 */
export async function main(
  auth: Jira,
  dashboardName: string | undefined,
  accountId: string | undefined,
  owner: string | undefined,
  groupname: string | undefined,
  groupId: string | undefined,
  projectId: string | undefined,
  orderBy:
    | "description"
    | "-description"
    | "+description"
    | "favorite_count"
    | "-favorite_count"
    | "+favorite_count"
    | "id"
    | "-id"
    | "+id"
    | "is_favorite"
    | "-is_favorite"
    | "+is_favorite"
    | "name"
    | "-name"
    | "+name"
    | "owner"
    | "-owner"
    | "+owner"
    | undefined,
  startAt: string | undefined,
  maxResults: string | undefined,
  status: "active" | "archived" | "deleted" | undefined,
  expand: string | undefined
) {
  const url = new URL(
    `https://${auth.domain}.atlassian.net/rest/api/2/dashboard/search`
  );
  for (const [k, v] of [
    ["dashboardName", dashboardName],
    ["accountId", accountId],
    ["owner", owner],
    ["groupname", groupname],
    ["groupId", groupId],
    ["projectId", projectId],
    ["orderBy", orderBy],
    ["startAt", startAt],
    ["maxResults", maxResults],
    ["status", status],
    ["expand", expand],
  ]) {
    if (v !== undefined && v !== "") {
      url.searchParams.append(k, v);
    }
  }
  const response = await fetch(url, {
    method: "GET",
    headers: {
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
    },
    body: undefined,
  });
  if (!response.ok) {
    const text = await response.text();
    throw new Error(`${response.status} ${text}`);
  }
  return await response.json();
}


`1`	`type Jira = {`
`2`	`username: string;`
`3`	`password: string;`
`4`	`domain: string;`
`5`	`};`
`6`	`/**`
`7`	`* Search for dashboards`
`8`	`* Returns a [paginated](#pagination) list of dashboards.`
`9`	`*/`
`10`	`export async function main(`
`11`	`auth: Jira,`
`12`	`dashboardName: string \| undefined,`
`13`	`accountId: string \| undefined,`
`14`	`owner: string \| undefined,`
`15`	`groupname: string \| undefined,`
`16`	`groupId: string \| undefined,`
`17`	`projectId: string \| undefined,`
`18`	`orderBy:`
`19`	`\| "description"`
`20`	`\| "-description"`
`21`	`\| "+description"`
`22`	`\| "favorite_count"`
`23`	`\| "-favorite_count"`
`24`	`\| "+favorite_count"`
`25`	`\| "id"`
`26`	`\| "-id"`
`27`	`\| "+id"`
`28`	`\| "is_favorite"`
`29`	`\| "-is_favorite"`
`30`	`\| "+is_favorite"`
`31`	`\| "name"`
`32`	`\| "-name"`
`33`	`\| "+name"`
`34`	`\| "owner"`
`35`	`\| "-owner"`
`36`	`\| "+owner"`
`37`	`\| undefined,`
`38`	`startAt: string \| undefined,`
`39`	`maxResults: string \| undefined,`
`40`	`status: "active" \| "archived" \| "deleted" \| undefined,`
`41`	`expand: string \| undefined`
`42`	`) {`
`43`	`const url = new URL(`
`44`	`https://${auth.domain}.atlassian.net/rest/api/2/dashboard/search`
`45`	`);`
`46`	`for (const [k, v] of [`
`47`	`["dashboardName", dashboardName],`
`48`	`["accountId", accountId],`
`49`	`["owner", owner],`
`50`	`["groupname", groupname],`
`51`	`["groupId", groupId],`
`52`	`["projectId", projectId],`
`53`	`["orderBy", orderBy],`
`54`	`["startAt", startAt],`
`55`	`["maxResults", maxResults],`
`56`	`["status", status],`
`57`	`["expand", expand],`
`58`	`]) {`
`59`	`if (v !== undefined && v !== "") {`
`60`	`url.searchParams.append(k, v);`
`61`	`}`
`62`	`}`
`63`	`const response = await fetch(url, {`
`64`	`method: "GET",`
`65`	`headers: {`
`66`	Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
`67`	`},`
`68`	`body: undefined,`
`69`	`});`
`70`	`if (!response.ok) {`
`71`	`const text = await response.text();`
`72`	throw new Error(`${response.status} ${text}`);
`73`	`}`
`74`	`return await response.json();`
`75`	`}`
`76`