Function getEpic

getEpic(
    client: Client,
    parameters: { epicIdOrKey: string },
    options?: RequestOptions,
): Promise<
    {
        color?: {
            key?: | string & {}
            | "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";
            [key: string]: unknown;
        };
        done?: boolean;
        id?: number;
        key?: string;
        name?: string;
        self?: string;
        summary?: string;
        [key: string]: unknown;
    },
>
Returns the epic for a given epic Id. This epic will only be returned if the user has permission to view it.
Parameters
- client: Client
- parameters: { epicIdOrKey: string }
  - epicIdOrKey: string
    
    The id or key of the requested epic.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        color?: {
            key?: | string & {}
            | "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";
            [key: string]: unknown;
        };
        done?: boolean;
        id?: number;
        key?: string;
        name?: string;
        self?: string;
        summary?: string;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/epic.ts:62

Function getEpic

Parameters

epicIdOrKey: string

Settings