Interface CreateBoard

Details about a board.

interface CreateBoard {
    admins?: {
        groups?: {
            name?: string;
            self?: string;
        }[];
        users?: {
            accountId?: string;
            active?: boolean;
            avatarUrls?: Agile.AgileModels.AvatarUrls;
            displayName?: string;
            self?: string;
        }[];
    };
    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;
    };
    name?: string;
    self?: string;
    type?: string;
}

Properties

admins? canEdit? favourite? id? isPrivate? location? name? self? type?

Properties

Optional admins

admins?: {
    groups?: {
        name?: string;
        self?: string;
    }[];
    users?: {
        accountId?: string;
        active?: boolean;
        avatarUrls?: Agile.AgileModels.AvatarUrls;
        displayName?: string;
        self?: string;
    }[];
}

The users and groups who own the board.

Type declaration

  • Optional groups?: {
        name?: string;
        self?: string;
    }[]
  • Optional users?: {
        accountId?: string;
        active?: boolean;
        avatarUrls?: Agile.AgileModels.AvatarUrls;
        displayName?: string;
        self?: string;
    }[]

Optional canEdit

canEdit?: boolean

Whether the board can be edited.

Optional favourite

favourite?: boolean

Whether the board is selected as a favorite.

Optional id

id?: number

The ID of the board.

Optional isPrivate

isPrivate?: boolean

Whether the board is private.

Optional location

location?: {
    avatarURI?: string;
    displayName?: string;
    name?: string;
    projectId?: number;
    projectKey?: string;
    projectName?: string;
    projectTypeKey?: string;
    userAccountId?: string;
    userId?: number;
}

The container that the board is located in.

Type declaration

  • Optional avatarURI?: string
  • Optional displayName?: string
  • Optional name?: string
  • Optional projectId?: number
  • Optional projectKey?: string
  • Optional projectName?: string
  • Optional projectTypeKey?: string
  • Optional userAccountId?: string
  • Optional userId?: number

Optional name

name?: string

The name of the board.

Optional self

self?: string

The URL of the board.

Optional type

type?: string

The type the board.

Settings

Member Visibility

Theme

On This Page

adminscanEditfavouriteidisPrivatelocationnameselftype