jira.js
    Preparing search index...

    Function getEpics

    • Returns all epics from the board, for the given board Id. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.

      Parameters

      • client: Client
      • parameters: { boardId: number; done?: string; maxResults?: number; startAt?: number }
        • boardId: number

          The Id of the board that contains the requested epics.

        • Optionaldone?: string

          Filters results to epics that are either done or not done. Valid values: true, false.

        • OptionalmaxResults?: number

          The maximum number of epics to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.

        • OptionalstartAt?: number

          The starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              startAt: number;
              total?: number;
              values: {
                  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;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility