jira.js
    Preparing search index...

    Function getBoardConfiguration

    • Get the board configuration. The response contains the following fields:

      • Id - Id of the board.
      • Name - Name of the board.
      • Filter - Reference to the filter used by the given board.
      • SubQuery (Kanban only) - JQL subquery used by the given board.
      • ColumnConfig - The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues in that column will be marked as already completed.
      • Estimation (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is "field", the Id and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/2/issue/{issueIdOrKey} request, however the fields must be on the screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
      • Ranking - Contains information about custom field used for ranking in the given board.

      Parameters

      • client: Client
      • parameters: { boardId: number }
        • boardId: number

          The id of the board for which configuration is requested.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              columnConfig?: {
                  columns?: {
                      max?: number;
                      min?: number;
                      name?: string;
                      statuses?: {
                          id?: (...)
                          | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  }[];
                  constraintType?: string;
                  [key: string]: unknown;
              };
              estimation?: {
                  field?: {
                      displayName?: string;
                      fieldId?: string;
                      [key: string]: unknown;
                  };
                  type?: string;
                  [key: string]: unknown;
              };
              filter?: { id?: string; self?: string; [key: string]: unknown };
              id?: number;
              name?: string;
              ranking?: { rankCustomFieldId?: number; [key: string]: unknown };
              self?: string;
              subQuery?: { query?: string; [key: string]: unknown };
              type?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility