jira.js
    Preparing search index...

    Function createBoard

    • Creates a new board. Board name, type and filter ID is required.

      • name - Must be less than 255 characters.
      • type - Valid values: scrum, kanban
      • filterId - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).
      • location - The container that the board will be located in. location must include the type property (Valid values: project, user). If choosing 'project', then a project must be specified by a projectKeyOrId property in location. If choosing 'user', the current user is chosen by default. The projectKeyOrId property should not be provided.

      Note:

      • If you want to create a new project with an associated board, use the Jira platform REST API. For more information, see the Create project method. The projectTypeKey for software boards must be 'software' and the projectTemplateKey must be either com.pyxis.greenhopper.jira:gh-kanban-template or com.pyxis.greenhopper.jira:gh-scrum-template.
      • You can create a filter using the Jira REST API. For more information, see the Create filter method.
      • If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.

      Parameters

      • client: Client
      • parameters: {
            filterId?: number;
            location?: {
                projectKeyOrId?: string;
                type?: "user" | string & {} | "project";
                [key: string]: unknown;
            };
            name?: string;
            type?: string & {}
            | "scrum"
            | "kanban"
            | "agility";
        }
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              admins?: {
                  groups?: { name?: string; self?: string; [key: string]: unknown }[];
                  users?: {
                      accountId?: string;
                      active?: boolean;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      self?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              canEdit?: boolean;
              favourite?: boolean;
              id?: number;
              isPrivate?: boolean;
              location?: {
                  avatarURI?: string;
                  displayName?: string;
                  name?: string;
                  projectId?: number;
                  projectKey?: string;
                  projectName?: string;
                  projectTypeKey?: string;
                  userAccountId?: string;
                  userId?: number;
                  [key: string]: unknown;
              };
              name?: string;
              self?: string;
              type?: string & {}
              | "simple"
              | "scrum"
              | "kanban";
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility