Function createBoard

createBoard(
    client: Client,
    parameters: { filterId?: number; name?: string; type?: string },
    options?: RequestOptions,
): Promise<
    {
        id?: number;
        name?: string;
        self?: string;
        type?: string;
        [key: string]: unknown;
    },
>
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). 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; name?: string; type?: string }
- Optionaloptions: RequestOptions
Returns Promise<
    {
        id?: number;
        name?: string;
        self?: string;
        type?: string;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/board.ts:77

Function createBoard

Parameters

Returns Promise< { id?: number; name?: string; self?: string; type?: string; [key: string]: unknown; },>

Settings

Returns Promise<
{
id?: number;
name?: string;
self?: string;
type?: string;
[key: string]: unknown;
},
>