Interface BoardPayload

The payload for creating a board

interface BoardPayload {
    boardFilterJQL?: string;
    cardColorStrategy?:
        | "ISSUE_TYPE"
        | "REQUEST_TYPE"
        | "ASSIGNEE"
        | "PRIORITY"
        | "NONE"
        | "CUSTOM";
    cardLayout?: CardLayout;
    cardLayouts?: CardLayoutField[];
    columns?: BoardColumnPayload[];
    features?: BoardFeaturePayload[];
    name?: string;
    pcri?: ProjectCreateResourceIdentifier;
    quickFilters?: QuickFilterPayload[];
    supportsSprint?: boolean;
    swimlanes?: SwimlanesPayload;
    workingDaysConfig?: WorkingDaysConfig;
}

Properties

boardFilterJQL? cardColorStrategy? cardLayout? cardLayouts? columns? features? name? pcri? quickFilters? supportsSprint? swimlanes? workingDaysConfig?

Properties

OptionalboardFilterJQL

boardFilterJQL?: string

Takes in a JQL string to create a new filter. If no value is provided, it'll default to a JQL filter for the project creating

Example

project= 'My Project'

OptionalcardColorStrategy

cardColorStrategy?:
    | "ISSUE_TYPE"
    | "REQUEST_TYPE"
    | "ASSIGNEE"
    | "PRIORITY"
    | "NONE"
    | "CUSTOM"

Card color settings of the board

OptionalcardLayout

cardLayout?: CardLayout

Card layout configuration.

OptionalcardLayouts

cardLayouts?: CardLayoutField[]

Card layout settings of the board

Optionalcolumns

columns?: BoardColumnPayload[]

The columns of the board

Optionalfeatures

features?: BoardFeaturePayload[]

Feature settings for the board

Optionalname

name?: string

The name of the board

Optionalpcri

pcri?: ProjectCreateResourceIdentifier

Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

Example

pcri:permissionScheme:id:10001

OptionalquickFilters

quickFilters?: QuickFilterPayload[]

The quick filters for the board.

OptionalsupportsSprint

supportsSprint?: boolean

Whether sprints are supported on the board

Optionalswimlanes

swimlanes?: SwimlanesPayload

The payload for customising a swimlanes on a board

OptionalworkingDaysConfig

workingDaysConfig?: WorkingDaysConfig

Working days configuration

Settings

Member Visibility

On This Page

Properties