Function: getEpic()

function getEpic(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?:   | string & object
        | "color_1"
        | "color_2"
        | "color_3"
        | "color_4"
        | "color_5"
        | "color_6"
        | "color_7"
        | "color_8"
        | "color_9"
        | "color_10"
        | "color_11"
        | "color_12"
        | "color_13"
        | "color_14";
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;

Defined in: src/server/api/epic.ts:62

Returns the epic for a given epic Id. This epic will only be returned if the user has permission to view it.

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 & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"; }; done?: boolean; id?: number; key?: string; name?: string; self?: string; summary?: string; }>