Function: getDashboard()

function getDashboard(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  automaticRefreshMs?: number;
  description?: string;
  editPermissions?: object[];
  id?: string;
  isFavourite?: boolean;
  isWritable?: boolean;
  name?: string;
  owner?: {
   [key: string]: unknown;
     accountId?: string;
     active?: boolean;
     avatarUrls?: {
      [key: string]: unknown;
        16x16?: string;
        24x24?: string;
        32x32?: string;
        48x48?: string;
     };
     displayName?: string;
     self?: string;
  };
  popularity?: number;
  rank?: number;
  self?: string;
  sharePermissions?: object[];
  systemDashboard?: boolean;
  view?: string;
}>;

Defined in: src/cloud/api/dashboards.ts:220

Returns a dashboard.

This operation can be accessed anonymously.

Permissions required: None.

However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: string; }	-
parameters.id	string	The ID of the dashboard.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; automaticRefreshMs?: number; description?: string; editPermissions?: object[]; id?: string; isFavourite?: boolean; isWritable?: boolean; name?: string; owner?: { [key: string]: unknown; accountId?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; self?: string; }; popularity?: number; rank?: number; self?: string; sharePermissions?: object[]; systemDashboard?: boolean; view?: string; }>