Function: getEpic()

function getEpic(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?: string;
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;

Defined in: src/agile/api/epic.ts:73

Returns the epic for a given epic ID. This epic will only be returned if the user has permission to view it. Note: This operation does not work for epics in next-gen projects.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ epicIdOrKey: string; }	-
parameters.epicIdOrKey	string	The id or key of the requested epic.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; color?: { [key: string]: unknown; key?: string; }; done?: boolean; id?: number; key?: string; name?: string; self?: string; summary?: string; }>