Wekan¶

Node: wekan · Full type: n8n-nodes-base.wekan · Version: 1

Credentials¶

wekanApi (alias: @wekan)

CREDENTIAL @wekan = wekanApi "My Wekan"

Operations¶

Resource: `board`¶

`create`¶

Parameter	Type	Default	Details
`title`	string	""	required
`owner`	options	""	required
`additionalFields`	collection	{}	keys: `isActive`, `isAdmin`, `color`, `isCommentOnly`, `isNoComments`, `permission`, ...

`delete`¶

Parameter	Type	Default	Details
`boardId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`boardId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`IdUser`	options	""	required
`returnAll`	boolean	false
`limit`	number	100

Resource: `card`¶

`create`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`title`	string	""	required
`swimlaneId`	options	""	required
`authorId`	options	""	required
`additionalFields`	collection	{}	keys: `assignees`, `description`, `members`

`delete`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required

`get`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`fromObject`	options	""	required; `list`, `swimlane`
`listId`	options	""	required
`swimlaneId`	options	""
`returnAll`	boolean	false
`limit`	number	100

`update`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`updateFields`	collection	{}	keys: `authorId`, `assignees`, `color`, `description`, `dueAt`, `endAt`, ...

Resource: `cardComment`¶

`create`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`authorId`	options	""	required
`comment`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`commentId`	options	""	required

`get`¶

Parameter	Type	Default	Details
`boardId`	string	""	required
`listId`	options	""	required
`cardId`	options	""	required
`commentId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`returnAll`	boolean	false
`limit`	number	100

Resource: `checklist`¶

`create`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`title`	string	""	required
`items`	string	[]

`delete`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`checklistId`	options	""	required

`get`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`checklistId`	options	""	required

`getAll`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`returnAll`	boolean	false
`limit`	number	100

Resource: `checklistItem`¶

`delete`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`checklistId`	options	""	required
`checklistItemId`	options	""	required

`get`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`checklistId`	string	""	required
`checklistItemId`	options	""	required

`update`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required
`cardId`	options	""	required
`checklistId`	options	""	required
`checklistItemId`	options	""	required
`updateFields`	collection	{}	keys: `title`, `isFinished`

Resource: `list`¶

`create`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`title`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	options	""	required

`get`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`listId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`boardId`	options	""	required
`returnAll`	boolean	false
`limit`	number	100

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`isActive`	boolean	false
`isAdmin`	boolean	false
`color`	options	""	`belize`, `midnight`, `nephritis`, `pomegranate`, `pumpkin`, `wisteria`
`isCommentOnly`	boolean	false
`isNoComments`	boolean	false
`permission`	options	"private"	`private`, `public`
`isWorker`	boolean	false

updateFields children:

Parameter	Type	Default	Details
`authorId`	options	""
`assignees`	multiOptions	[]
`color`	options	""	`black`, `blue`, `crimson`, `darkgreen`, `gold`, `gray`, `green`, `indigo`, ... (25 total)
`description`	string	""
`dueAt`	dateTime	""
`endAt`	dateTime	""
`labelIds`	string	""
`listId`	options	""
`members`	multiOptions	[]
`isOverTime`	boolean	false
`parentId`	options	""
`receivedAt`	dateTime	""
`sort`	number	0
`spentTime`	number	""
`startAt`	dateTime	""
`swimlaneId`	options	""
`title`	string	""

Example¶

NODE "wekan" @wekan AS "Wekan" {
  resource: "board",
  operation: "get",
  title: {{ $json.title }},
  boardId: {{ $json.boardId }},
  comment: {{ $json.comment }}
}

Wekan¶

Credentials¶

Operations¶

Resource: board¶

create¶

delete¶

get¶

getAll¶

Resource: card¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: cardComment¶

create¶

delete¶

get¶

getAll¶

Resource: checklist¶

create¶

delete¶

get¶

getAll¶

Resource: checklistItem¶

delete¶

get¶

update¶

Resource: list¶

create¶

delete¶

get¶

getAll¶

Parameter Details¶

Example¶

Resource: `board`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

Resource: `card`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `cardComment`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

Resource: `checklist`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

Resource: `checklistItem`¶

`delete`¶

`get`¶

`update`¶

Resource: `list`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶