Interface WekanNodeParameters

Source
interface WekanNodeParameters {
    additionalFields?:
        | {
            color?: | "belize"
            | "midnight"
            | "nephritis"
            | "pomegranate"
            | "pumpkin"
            | "wisteria";
            isActive?: boolean;
            isAdmin?: boolean;
            isCommentOnly?: boolean;
            isNoComments?: boolean;
            isWorker?: boolean;
            permission?: "public"
            | "private";
        }
        | {
            assignees?: unknown[];
            description?: string;
            members?: unknown[];
        };
    authorId?: string;
    boardId?: string;
    cardId?: string;
    checklistId?: string;
    checklistItemId?: string;
    comment?: string;
    commentId?: string;
    fromObject?: "list"
    | "swimlane";
    IdUser?: string;
    items?: string;
    limit?: number;
    listId?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete";
    owner?: string;
    resource?: | "list"
    | "checklist"
    | "checklistItem"
    | "board"
    | "card"
    | "cardComment";
    returnAll?: boolean;
    swimlaneId?: string;
    title?: string;
    updateFields?: | {
        assignees?: unknown[];
        authorId?: string;
        color?: | "gray"
        | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "purple"
        | "pink"
        | "red"
        | "magenta"
        | "black"
        | "lime"
        | "sky"
        | "crimson"
        | "darkgreen"
        | "gold"
        | "indigo"
        | "mistyrose"
        | "navy"
        | "paleturquoise"
        | "peachpuff"
        | "plum"
        | "saddlebrown"
        | "silver"
        | "slateblue"
        | "white";
        description?: string;
        dueAt?: string;
        endAt?: string;
        isOverTime?: boolean;
        labelIds?: string;
        listId?: string;
        members?: unknown[];
        parentId?: string;
        receivedAt?: string;
        sort?: number;
        spentTime?: number;
        startAt?: string;
        swimlaneId?: string;
        title?: string;
    }
    | { isFinished?: boolean; title?: string };
}

Properties§

Source§

readonly additionalFields?:
    | {
        color?: | "belize"
        | "midnight"
        | "nephritis"
        | "pomegranate"
        | "pumpkin"
        | "wisteria";
        isActive?: boolean;
        isAdmin?: boolean;
        isCommentOnly?: boolean;
        isNoComments?: boolean;
        isWorker?: boolean;
        permission?: "public"
        | "private";
    }
    | {
        assignees?: unknown[];
        description?: string;
        members?: unknown[];
    }

Default: {}

Source§

readonly authorId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getUsers"}

Source§

readonly boardId?: string

The ID of the board to delete

Source§

readonly cardId?: string

The ID of the card to delete. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getCards","loadOptionsDependsOn":["boardId","listId"]}

Source§

readonly checklistId?: string

The ID of the checklist to delete. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getChecklists","loadOptionsDependsOn":["boardId","cardId"]}

Source§

readonly checklistItemId?: string

The ID of the checklistItem item to get. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getChecklistItems","loadOptionsDependsOn":["boardId","cardId","checklistId"]}

Source§

readonly comment?: string

The comment text

Source§

readonly commentId?: string

The ID of the comment to delete. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getComments","loadOptionsDependsOn":["boardId","cardId"]}

Source§

readonly fromObject?: "list" | "swimlane"

Source§

readonly IdUser?: string

The ID of the user that boards are attached. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getUsers"}

Source§

readonly items?: string

Items to be added to the checklist Default: [] Type options: {"multipleValues":true,"multipleValueButtonText":"Add Item"}

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":200}

Source§

readonly listId?: string

The ID of the list to create card in. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getLists","loadOptionsDependsOn":["boardId"]}

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "create"

Source§

readonly owner?: string

The user ID in Wekan. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getUsers"}

Source§

readonly resource?:
    | "list"
    | "checklist"
    | "checklistItem"
    | "board"
    | "card"
    | "cardComment"

Default: "card"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly swimlaneId?: string

The swimlane ID of the new card. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getSwimlanes","loadOptionsDependsOn":["boardId"]}

Source§

readonly title?: string

The title of the board

Source§

readonly updateFields?:
    | {
        assignees?: unknown[];
        authorId?: string;
        color?: | "gray"
        | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "purple"
        | "pink"
        | "red"
        | "magenta"
        | "black"
        | "lime"
        | "sky"
        | "crimson"
        | "darkgreen"
        | "gold"
        | "indigo"
        | "mistyrose"
        | "navy"
        | "paleturquoise"
        | "peachpuff"
        | "plum"
        | "saddlebrown"
        | "silver"
        | "slateblue"
        | "white";
        description?: string;
        dueAt?: string;
        endAt?: string;
        isOverTime?: boolean;
        labelIds?: string;
        listId?: string;
        members?: unknown[];
        parentId?: string;
        receivedAt?: string;
        sort?: number;
        spentTime?: number;
        startAt?: string;
        swimlaneId?: string;
        title?: string;
    }
    | { isFinished?: boolean; title?: string }

Default: {}