|
|
@@ -1,7 +1,7 @@
|
|
|
swagger: '2.0'
|
|
|
info:
|
|
|
title: Wekan REST API
|
|
|
- version: v3.93
|
|
|
+ version: v3.94
|
|
|
description: |
|
|
|
The REST API allows you to control and extend Wekan with ease.
|
|
|
|
|
|
@@ -1221,296 +1221,6 @@ paths:
|
|
|
properties:
|
|
|
_id:
|
|
|
type: string
|
|
|
- /api/boards/{board}/lists/{list}/cards:
|
|
|
- get:
|
|
|
- operationId: get_all_cards
|
|
|
- summary: Get all Cards attached to a List
|
|
|
- tags:
|
|
|
- - Cards
|
|
|
- parameters:
|
|
|
- - name: board
|
|
|
- in: path
|
|
|
- description: |
|
|
|
- the board ID
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: list
|
|
|
- in: path
|
|
|
- description: |
|
|
|
- the list ID
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- produces:
|
|
|
- - application/json
|
|
|
- security:
|
|
|
- - UserSecurity: []
|
|
|
- responses:
|
|
|
- '200':
|
|
|
- description: |-
|
|
|
- 200 response
|
|
|
- schema:
|
|
|
- type: array
|
|
|
- items:
|
|
|
- type: object
|
|
|
- properties:
|
|
|
- _id:
|
|
|
- type: string
|
|
|
- title:
|
|
|
- type: string
|
|
|
- description:
|
|
|
- type: string
|
|
|
- post:
|
|
|
- operationId: new_card
|
|
|
- summary: Create a new Card
|
|
|
- tags:
|
|
|
- - Cards
|
|
|
- consumes:
|
|
|
- - multipart/form-data
|
|
|
- - application/json
|
|
|
- parameters:
|
|
|
- - name: authorId
|
|
|
- in: formData
|
|
|
- description: the authorId value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: members
|
|
|
- in: formData
|
|
|
- description: |
|
|
|
- the member IDs list of the new card
|
|
|
- type: string
|
|
|
- required: false
|
|
|
- - name: assignees
|
|
|
- in: formData
|
|
|
- description: |
|
|
|
- the array of maximum one ID of assignee of the new card
|
|
|
- type: string
|
|
|
- required: false
|
|
|
- - name: title
|
|
|
- in: formData
|
|
|
- description: |
|
|
|
- the title of the new card
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: description
|
|
|
- in: formData
|
|
|
- description: |
|
|
|
- the description of the new card
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: swimlaneId
|
|
|
- in: formData
|
|
|
- description: |
|
|
|
- the swimlane ID of the new card
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: board
|
|
|
- in: path
|
|
|
- description: |
|
|
|
- the board ID of the new card
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: list
|
|
|
- in: path
|
|
|
- description: |
|
|
|
- the list ID of the new card
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- produces:
|
|
|
- - application/json
|
|
|
- security:
|
|
|
- - UserSecurity: []
|
|
|
- responses:
|
|
|
- '200':
|
|
|
- description: |-
|
|
|
- 200 response
|
|
|
- schema:
|
|
|
- type: object
|
|
|
- properties:
|
|
|
- _id:
|
|
|
- type: string
|
|
|
- /api/boards/{board}/lists/{list}/cards/{card}:
|
|
|
- get:
|
|
|
- operationId: get_board_list_card
|
|
|
- tags:
|
|
|
- - Cards
|
|
|
- parameters:
|
|
|
- - name: board
|
|
|
- in: path
|
|
|
- description: the board value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: list
|
|
|
- in: path
|
|
|
- description: the list value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: card
|
|
|
- in: path
|
|
|
- description: the card value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- produces:
|
|
|
- - application/json
|
|
|
- security:
|
|
|
- - UserSecurity: []
|
|
|
- responses:
|
|
|
- '200':
|
|
|
- description: |-
|
|
|
- 200 response
|
|
|
- put:
|
|
|
- operationId: put_board_list_card
|
|
|
- tags:
|
|
|
- - Cards
|
|
|
- consumes:
|
|
|
- - multipart/form-data
|
|
|
- - application/json
|
|
|
- parameters:
|
|
|
- - name: title
|
|
|
- in: formData
|
|
|
- description: the title value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: listId
|
|
|
- in: formData
|
|
|
- description: the listId value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: authorId
|
|
|
- in: formData
|
|
|
- description: the authorId value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: parentId
|
|
|
- in: formData
|
|
|
- description: the parentId value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: description
|
|
|
- in: formData
|
|
|
- description: the description value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: color
|
|
|
- in: formData
|
|
|
- description: the color value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: labelIds
|
|
|
- in: formData
|
|
|
- description: the labelIds value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: requestedBy
|
|
|
- in: formData
|
|
|
- description: the requestedBy value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: assignedBy
|
|
|
- in: formData
|
|
|
- description: the assignedBy value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: receivedAt
|
|
|
- in: formData
|
|
|
- description: the receivedAt value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: startAt
|
|
|
- in: formData
|
|
|
- description: the startAt value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: dueAt
|
|
|
- in: formData
|
|
|
- description: the dueAt value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: endAt
|
|
|
- in: formData
|
|
|
- description: the endAt value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: spentTime
|
|
|
- in: formData
|
|
|
- description: the spentTime value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: isOverTime
|
|
|
- in: formData
|
|
|
- description: the isOverTime value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: customFields
|
|
|
- in: formData
|
|
|
- description: the customFields value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: members
|
|
|
- in: formData
|
|
|
- description: the members value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: assignees
|
|
|
- in: formData
|
|
|
- description: the assignees value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: swimlaneId
|
|
|
- in: formData
|
|
|
- description: the swimlaneId value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: board
|
|
|
- in: path
|
|
|
- description: the board value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: list
|
|
|
- in: path
|
|
|
- description: the list value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: card
|
|
|
- in: path
|
|
|
- description: the card value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- produces:
|
|
|
- - application/json
|
|
|
- security:
|
|
|
- - UserSecurity: []
|
|
|
- responses:
|
|
|
- '200':
|
|
|
- description: |-
|
|
|
- 200 response
|
|
|
- delete:
|
|
|
- operationId: delete_board_list_card
|
|
|
- tags:
|
|
|
- - Cards
|
|
|
- parameters:
|
|
|
- - name: board
|
|
|
- in: path
|
|
|
- description: the board value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: list
|
|
|
- in: path
|
|
|
- description: the list value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: card
|
|
|
- in: path
|
|
|
- description: the card value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- produces:
|
|
|
- - application/json
|
|
|
- security:
|
|
|
- - UserSecurity: []
|
|
|
- responses:
|
|
|
- '200':
|
|
|
- description: |-
|
|
|
- 200 response
|
|
|
/api/boards/{board}/members/{member}:
|
|
|
post:
|
|
|
operationId: set_board_member_permission
|
|
|
@@ -1780,30 +1490,6 @@ paths:
|
|
|
'200':
|
|
|
description: |-
|
|
|
200 response
|
|
|
- /api/boards/{board}/swimlanes/{swimlane}/cards:
|
|
|
- get:
|
|
|
- operationId: get_board_swimlane_cards
|
|
|
- tags:
|
|
|
- - Cards
|
|
|
- parameters:
|
|
|
- - name: board
|
|
|
- in: path
|
|
|
- description: the board value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- - name: swimlane
|
|
|
- in: path
|
|
|
- description: the swimlane value
|
|
|
- type: string
|
|
|
- required: true
|
|
|
- produces:
|
|
|
- - application/json
|
|
|
- security:
|
|
|
- - UserSecurity: []
|
|
|
- responses:
|
|
|
- '200':
|
|
|
- description: |-
|
|
|
- 200 response
|
|
|
/api/user:
|
|
|
get:
|
|
|
operationId: get_current_user
|
|
|
@@ -2349,219 +2035,6 @@ definitions:
|
|
|
- createdAt
|
|
|
- modifiedAt
|
|
|
- userId
|
|
|
- Cards:
|
|
|
- type: object
|
|
|
- properties:
|
|
|
- title:
|
|
|
- description: |
|
|
|
- the title of the card
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- archived:
|
|
|
- description: |
|
|
|
- is the card archived
|
|
|
- type: boolean
|
|
|
- parentId:
|
|
|
- description: |
|
|
|
- ID of the parent card
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- listId:
|
|
|
- description: |
|
|
|
- List ID where the card is
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- swimlaneId:
|
|
|
- description: |
|
|
|
- Swimlane ID where the card is
|
|
|
- type: string
|
|
|
- boardId:
|
|
|
- description: |
|
|
|
- Board ID of the card
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- coverId:
|
|
|
- description: |
|
|
|
- Cover ID of the card
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- color:
|
|
|
- type: string
|
|
|
- enum:
|
|
|
- - white
|
|
|
- - green
|
|
|
- - yellow
|
|
|
- - orange
|
|
|
- - red
|
|
|
- - purple
|
|
|
- - blue
|
|
|
- - sky
|
|
|
- - lime
|
|
|
- - pink
|
|
|
- - black
|
|
|
- - silver
|
|
|
- - peachpuff
|
|
|
- - crimson
|
|
|
- - plum
|
|
|
- - darkgreen
|
|
|
- - slateblue
|
|
|
- - magenta
|
|
|
- - gold
|
|
|
- - navy
|
|
|
- - gray
|
|
|
- - saddlebrown
|
|
|
- - paleturquoise
|
|
|
- - mistyrose
|
|
|
- - indigo
|
|
|
- x-nullable: true
|
|
|
- createdAt:
|
|
|
- description: |
|
|
|
- creation date
|
|
|
- type: string
|
|
|
- modifiedAt:
|
|
|
- type: string
|
|
|
- customFields:
|
|
|
- description: |
|
|
|
- list of custom fields
|
|
|
- type: array
|
|
|
- items:
|
|
|
- $ref: "#/definitions/CardsCustomfields"
|
|
|
- x-nullable: true
|
|
|
- dateLastActivity:
|
|
|
- description: |
|
|
|
- Date of last activity
|
|
|
- type: string
|
|
|
- description:
|
|
|
- description: |
|
|
|
- description of the card
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- requestedBy:
|
|
|
- description: |
|
|
|
- who requested the card (ID of the user)
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- assignedBy:
|
|
|
- description: |
|
|
|
- who assigned the card (ID of the user)
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- labelIds:
|
|
|
- description: |
|
|
|
- list of labels ID the card has
|
|
|
- type: array
|
|
|
- items:
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- x-nullable: true
|
|
|
- members:
|
|
|
- description: |
|
|
|
- list of members (user IDs)
|
|
|
- type: array
|
|
|
- items:
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- x-nullable: true
|
|
|
- assignees:
|
|
|
- description: |
|
|
|
- who is assignee of the card (user ID),
|
|
|
- maximum one ID of assignee in array.
|
|
|
- type: array
|
|
|
- items:
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- x-nullable: true
|
|
|
- receivedAt:
|
|
|
- description: |
|
|
|
- Date the card was received
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- startAt:
|
|
|
- description: |
|
|
|
- Date the card was started to be worked on
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- dueAt:
|
|
|
- description: |
|
|
|
- Date the card is due
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- endAt:
|
|
|
- description: |
|
|
|
- Date the card ended
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- spentTime:
|
|
|
- description: |
|
|
|
- How much time has been spent on this
|
|
|
- type: number
|
|
|
- x-nullable: true
|
|
|
- isOvertime:
|
|
|
- description: |
|
|
|
- is the card over time?
|
|
|
- type: boolean
|
|
|
- x-nullable: true
|
|
|
- userId:
|
|
|
- description: |
|
|
|
- user ID of the author of the card
|
|
|
- type: string
|
|
|
- sort:
|
|
|
- description: |
|
|
|
- Sort value
|
|
|
- type: number
|
|
|
- subtaskSort:
|
|
|
- description: |
|
|
|
- subtask sort value
|
|
|
- type: number
|
|
|
- x-nullable: true
|
|
|
- type:
|
|
|
- description: |
|
|
|
- type of the card
|
|
|
- type: string
|
|
|
- linkedId:
|
|
|
- description: |
|
|
|
- ID of the linked card
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- vote:
|
|
|
- description: |
|
|
|
- vote object, see below
|
|
|
- $ref: "#/definitions/CardsVote"
|
|
|
- x-nullable: true
|
|
|
- required:
|
|
|
- - archived
|
|
|
- - swimlaneId
|
|
|
- - createdAt
|
|
|
- - modifiedAt
|
|
|
- - dateLastActivity
|
|
|
- - userId
|
|
|
- - sort
|
|
|
- - type
|
|
|
- CardsVote:
|
|
|
- type: object
|
|
|
- properties:
|
|
|
- question:
|
|
|
- type: string
|
|
|
- positive:
|
|
|
- description: |
|
|
|
- list of members (user IDs)
|
|
|
- type: array
|
|
|
- items:
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- negative:
|
|
|
- description: |
|
|
|
- list of members (user IDs)
|
|
|
- type: array
|
|
|
- items:
|
|
|
- type: string
|
|
|
- x-nullable: true
|
|
|
- end:
|
|
|
- type: string
|
|
|
- required:
|
|
|
- - question
|
|
|
- CardsCustomfields:
|
|
|
- type: object
|
|
|
ChecklistItems:
|
|
|
type: object
|
|
|
description: An item in a checklist
|
Lauri Ojansivu