Function: getBoard()

function getBoard(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  admins?: {
   [key: string]: unknown;
     groups?: object[];
     users?: object[];
  };
  canEdit?: boolean;
  favourite?: boolean;
  id?: number;
  isPrivate?: boolean;
  location?: {
   [key: string]: unknown;
     avatarURI?: string;
     displayName?: string;
     name?: string;
     projectId?: number;
     projectKey?: string;
     projectName?: string;
     projectTypeKey?: string;
     userAccountId?: string;
     userId?: number;
  };
  name?: string;
  self?: string;
  type?: string & object | "simple" | "scrum" | "kanban";
}>;

Defined in: src/agile/api/board.ts:160

Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ boardId: number; }	-
parameters.boardId	number	The ID of the requested board.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; admins?: { [key: string]: unknown; groups?: object[]; users?: object[]; }; canEdit?: boolean; favourite?: boolean; id?: number; isPrivate?: boolean; location?: { [key: string]: unknown; avatarURI?: string; displayName?: string; name?: string; projectId?: number; projectKey?: string; projectName?: string; projectTypeKey?: string; userAccountId?: string; userId?: number; }; name?: string; self?: string; type?: string & object | "simple" | "scrum" | "kanban"; }>