Wekan REST API v4.15
+Wekan REST API v4.16
@@ -4325,20 +4325,24 @@ To perform this operation, you must be authenticated by means of one of the foll UserSecurityScroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Checklists
-get_board_card_checklists
- +get_all_checklists
+Code samples
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/checklists \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/cards/{card}/checklists HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4357,6 +4361,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4378,6 +4383,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists'require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -4390,6 +4396,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -4425,6 +4432,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -4440,7 +4448,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/cards/{card}/checklists
-Parameters
+Get the list of checklists attached to a card
+Parameters
@@ -4457,18 +4466,34 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+
+Example responses
+
+
+200 Response
+
+[
+ {
+ "_id": "string",
+ "title": "string"
+ }
+]
+
+Responses
@@ -4483,7 +4508,36 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
@@ -4491,24 +4545,27 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-post_board_card_checklists
-
+new_checklist
+
Code samples
# You can also use wget
curl -X POST /api/boards/{board}/cards/{card}/checklists \
-H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
POST /api/boards/{board}/cards/{card}/checklists HTTP/1.1
Content-Type: multipart/form-data
+Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4531,6 +4588,7 @@ $.ajax({
}';
const headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4553,6 +4611,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists''Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -4566,6 +4625,7 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -4602,6 +4662,7 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -4617,6 +4678,7 @@ System.out.println(response.toString());
POST /api/boards/{board}/cards/{card}/checklists
+create a new checklist
Body parameter
@@ -4624,7 +4686,7 @@ System.out.println(response.toString());
items: string
-Parameters
+Parameters
@@ -4641,14 +4703,14 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
body
@@ -4662,18 +4724,31 @@ System.out.println(response.toString());
body
string
true
-the title value
+the title of the new checklist
» items
body
string
-true
-the items value
+false
+the list of items on the new checklist
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -4688,7 +4763,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -4696,20 +4793,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_card_checklist
-
+get_checklist
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/cards/{card}/checklists/{checklist} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4728,6 +4829,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4749,6 +4851,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -4761,6 +4864,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -4796,6 +4900,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -4811,7 +4916,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/cards/{card}/checklists/{checklist}
-Parameters
+Get a checklist
+Parameters
@@ -4828,25 +4934,50 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
checklist
path
string
true
-the checklist value
+the ID of the checklist
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+checklist: the ID of the checklist
+
+Example responses
+
+
+200 Response
+
+{
+ "cardId": "string",
+ "title": "string",
+ "finishedAt": "string",
+ "createdAt": "string",
+ "sort": 0,
+ "items": [
+ {
+ "_id": "string",
+ "title": "string",
+ "isFinished": true
+ }
+ ]
+}
+
+Responses
@@ -4861,7 +4992,85 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» cardId
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
+
+
+» finishedAt
+string
+false
+none
+none
+
+
+» createdAt
+string
+false
+none
+none
+
+
+» sort
+number
+false
+none
+none
+
+
+» items
+[object]
+false
+none
+none
+
+
+»» _id
+string
+false
+none
+none
+
+
+»» title
+string
+false
+none
+none
+
+
+»» isFinished
+boolean
+false
+none
+none
@@ -4869,20 +5078,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_card_checklist
-
+delete_checklist
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4901,6 +5114,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -4922,6 +5136,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -4934,6 +5149,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -4969,6 +5185,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -4984,7 +5201,9 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}
-Parameters
+Delete a checklist
+The checklist will be removed, not put in the recycle bin.
+Parameters
@@ -5001,25 +5220,39 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
checklist
path
string
true
-the checklist value
+the ID of the checklist to remove
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+checklist: the ID of the checklist to remove
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -5034,7 +5267,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -5043,20 +5298,24 @@ To perform this operation, you must be authenticated by means of one of the foll
UserSecurity
ChecklistItems
-get_board_card_checklist_item
-
+get_checklist_item
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5075,6 +5334,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5096,6 +5356,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -5108,6 +5369,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -5143,6 +5405,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -5158,7 +5421,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}
-Parameters
+Get a checklist item
+Parameters
@@ -5175,32 +5439,53 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
checklist
path
string
true
-the checklist value
+the checklist ID
item
path
string
true
-the item value
+the ID of the item
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+checklist: the checklist ID
+item: the ID of the item
+
+Example responses
+
+
+200 Response
+
+{
+ "title": "string",
+ "sort": 0,
+ "isFinished": true,
+ "checklistId": "string",
+ "cardId": "string",
+ "createdAt": "string",
+ "modifiedAt": "string"
+}
+
+Responses
@@ -5215,7 +5500,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+ChecklistItems
@@ -5223,24 +5508,27 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-put_board_card_checklist_item
-
+edit_checklist_item
+
Code samples
# You can also use wget
curl -X PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \
-H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
Content-Type: multipart/form-data
+Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5263,6 +5551,7 @@ $.ajax({
}';
const headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5285,6 +5574,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
headers = {
'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -5298,6 +5588,7 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -5334,6 +5625,7 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -5349,6 +5641,7 @@ System.out.println(response.toString());
PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}
+Edit a checklist item
Body parameter
@@ -5356,7 +5649,7 @@ System.out.println(response.toString());
title: string
-Parameters
+Parameters
@@ -5373,28 +5666,28 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
checklist
path
string
true
-the checklist value
+the checklist ID
item
path
string
true
-the item value
+the ID of the item
body
@@ -5407,19 +5700,34 @@ System.out.println(response.toString());
» isFinished
body
string
-true
-the isFinished value
+false
+is the item checked?
» title
body
string
-true
-the title value
+false
+the new text of the item
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+checklist: the checklist ID
+item: the ID of the item
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -5434,7 +5742,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -5442,20 +5772,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_card_checklist_item
-
+delete_checklist_item
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5474,6 +5808,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5495,6 +5830,7 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -5507,6 +5843,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -5542,6 +5879,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -5557,7 +5895,9 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}
-Parameters
+Delete a checklist item
+Note: this operation can't be reverted.
+Parameters
@@ -5574,32 +5914,47 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
card
path
string
true
-the card value
+the card ID
checklist
path
string
true
-the checklist value
+the checklist ID
item
path
string
true
-the item value
+the ID of the item to be removed
-Responses
+Detailed descriptions
+board: the board ID
+card: the card ID
+checklist: the checklist ID
+item: the ID of the item to be removed
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -5614,7 +5969,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -5851,24 +6228,27 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-post_board_card_comments
-
+new_comment
+
Code samples
# You can also use wget
curl -X POST /api/boards/{board}/cards/{card}/comments \
-H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
POST /api/boards/{board}/cards/{card}/comments HTTP/1.1
Content-Type: multipart/form-data
+Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5891,6 +6271,7 @@ $.ajax({
}';
const headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -5913,6 +6294,7 @@ fetch('/api/boards/{board}/cards/{card}/comments''Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -5926,6 +6308,7 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -5962,6 +6345,7 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -5977,6 +6361,7 @@ System.out.println(response.toString());
POST /api/boards/{board}/cards/{card}/comments
+Add a comment on a card
Body parameter
@@ -5984,7 +6369,7 @@ System.out.println(response.toString());
comment: string
-Parameters
+Parameters
@@ -6001,14 +6386,14 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID of the card
card
path
string
true
-the card value
+the ID of the card
body
@@ -6022,7 +6407,7 @@ System.out.println(response.toString());
body
string
true
-the authorId value
+the user who 'posted' the comment
» comment
@@ -6033,7 +6418,20 @@ System.out.println(response.toString());
-Responses
+Detailed descriptions
+board: the board ID of the card
+card: the ID of the card
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -6048,7 +6446,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -6056,20 +6476,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_card_comment
-
+get_comment
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/comments/{comment} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/cards/{card}/comments/{comment} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -6088,6 +6512,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -6109,6 +6534,7 @@ fetch('/api/boards/{board}/cards/{card}/comments/{comm
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -6121,6 +6547,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -6156,6 +6583,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -6171,7 +6599,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/cards/{card}/comments/{comment}
-Parameters
+Get a comment on a card
+Parameters
@@ -6188,25 +6617,44 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID of the card
card
path
string
true
-the card value
+the ID of the card
comment
path
string
true
-the comment value
+the ID of the comment to retrieve
-Responses
+Detailed descriptions
+board: the board ID of the card
+card: the ID of the card
+comment: the ID of the comment to retrieve
+
+Example responses
+
+
+200 Response
+
+{
+ "boardId": "string",
+ "cardId": "string",
+ "text": "string",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "userId": "string"
+}
+
+Responses
@@ -6221,7 +6669,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+CardComments
@@ -6229,20 +6677,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_card_comment
-
+delete_comment
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/cards/{card}/comments/{comment} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/cards/{card}/comments/{comment} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -6261,6 +6713,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -6282,6 +6735,7 @@ fetch('/api/boards/{board}/cards/{card}/comments/{comm
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -6294,6 +6748,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -6329,6 +6784,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -6344,7 +6800,8 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/cards/{card}/comments/{comment}
-Parameters
+Delete a comment on a card
+Parameters
@@ -6361,25 +6818,39 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID of the card
card
path
string
true
-the card value
+the ID of the card
comment
path
string
true
-the comment value
+the ID of the comment to delete
-Responses
+Detailed descriptions
+board: the board ID of the card
+card: the ID of the card
+comment: the ID of the comment to delete
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -6394,7 +6865,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -6403,20 +6896,24 @@ To perform this operation, you must be authenticated by means of one of the foll
UserSecurity
Cards
-get_board_customFieldValue
-
+get_cards_by_custom_field
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -6435,6 +6932,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -6456,6 +6954,7 @@ fetch('/api/boards/{board}/cardsByCustomField/{customF
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -6468,6 +6967,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -6503,6 +7003,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -6518,7 +7019,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}
-Parameters
+Get all Cards that matchs a value of a specific custom field
+Parameters
@@ -6535,25 +7037,45 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
customField
path
string
true
-the customField value
+the list ID
customFieldValue
path
string
true
-the customFieldValue value
+the value to look for
-Responses
+Detailed descriptions
+board: the board ID
+customField: the list ID
+customFieldValue: the value to look for
+
+Example responses
+
+
+200 Response
+
+[
+ {
+ "_id": "string",
+ "title": "string",
+ "description": "string",
+ "listId": "string",
+ "swinlaneId": "string"
+ }
+]
+
+Responses
@@ -6568,7 +7090,57 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
+
+
+» description
+string
+false
+none
+none
+
+
+» listId
+string
+false
+none
+none
+
+
+» swinlaneId
+string
+false
+none
+none
@@ -7088,20 +7660,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_list_card
-
+get_card
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7120,6 +7696,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7141,6 +7718,7 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -7153,6 +7731,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -7188,6 +7767,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -7203,7 +7783,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/lists/{list}/cards/{card}
-Parameters
+Get a Card
+Parameters
@@ -7220,25 +7801,87 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
list
path
string
true
-the list value
+the list ID of the card
card
path
string
true
-the card value
+the card ID
-Responses
+Detailed descriptions
+board: the board ID
+list: the list ID of the card
+card: the card ID
+
+Example responses
+
+
+200 Response
+
+{
+ "title": "string",
+ "archived": true,
+ "parentId": "string",
+ "listId": "string",
+ "swimlaneId": "string",
+ "boardId": "string",
+ "coverId": "string",
+ "color": "white",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "customFields": [
+ {}
+ ],
+ "dateLastActivity": "string",
+ "description": "string",
+ "requestedBy": "string",
+ "assignedBy": "string",
+ "labelIds": [
+ "string"
+ ],
+ "members": [
+ "string"
+ ],
+ "assignees": [
+ "string"
+ ],
+ "receivedAt": "string",
+ "startAt": "string",
+ "dueAt": "string",
+ "endAt": "string",
+ "spentTime": 0,
+ "isOvertime": true,
+ "userId": "string",
+ "sort": 0,
+ "subtaskSort": 0,
+ "type": "string",
+ "linkedId": "string",
+ "vote": {
+ "question": "string",
+ "positive": [
+ "string"
+ ],
+ "negative": [
+ "string"
+ ],
+ "end": "string",
+ "public": true,
+ "allowNonBoardMembers": true
+ }
+}
+
+Responses
@@ -7253,7 +7896,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Cards
@@ -7261,24 +7904,27 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-put_board_list_card
-
+edit_card
+
Code samples
# You can also use wget
curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \
-H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
PUT /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
Content-Type: multipart/form-data
+Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7302,7 +7948,7 @@ $.ajax({
"parentId": "string",
"description": "string",
"color": "string",
- "vote": "string",
+ "vote": {},
"labelIds": "string",
"requestedBy": "string",
"assignedBy": "string",
@@ -7311,7 +7957,7 @@ $.ajax({
"dueAt": "string",
"endAt": "string",
"spentTime": "string",
- "isOverTime": "string",
+ "isOverTime": true,
"customFields": "string",
"members": "string",
"assignees": "string",
@@ -7319,6 +7965,7 @@ $.ajax({
}';
const headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7341,6 +7988,7 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
headers = {
'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -7354,6 +8002,7 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -7390,6 +8039,7 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -7405,6 +8055,15 @@ System.out.println(response.toString());
PUT /api/boards/{board}/lists/{list}/cards/{card}
+Edit Fields in a Card
+Edit a card
+The color has to be chosen between 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:
+
+Note: setting the color to white has the same effect than removing it.
Body parameter
@@ -7414,7 +8073,7 @@ System.out.println(response.toString());
parentId: string
description: string
color: string
-vote: string
+vote: {}
labelIds: string
requestedBy: string
assignedBy: string
@@ -7423,14 +8082,14 @@ System.out.println(response.toString());
dueAt: string
endAt: string
spentTime: string
-isOverTime: string
+isOverTime: true
customFields: string
members: string
assignees: string
swimlaneId: string
-Parameters
+Parameters
@@ -7447,21 +8106,21 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID of the card
list
path
string
true
-the list value
+the list ID of the card
card
path
string
true
-the card value
+the ID of the card
body
@@ -7474,145 +8133,159 @@ System.out.println(response.toString());
» title
body
string
-true
-the title value
+false
+the new title of the card
» listId
body
string
-true
-the listId value
+false
+the new list ID of the card (move operation)
» authorId
body
string
-true
-the authorId value
+false
+change the owner of the card
» parentId
body
string
-true
-the parentId value
+false
+change the parent of the card
» description
body
string
-true
-the description value
+false
+the new description of the card
» color
body
string
-true
-the color value
+false
+the new color of the card
» vote
body
-string
-true
-the vote value
+object
+false
+the vote object
» labelIds
body
string
-true
-the labelIds value
+false
+the new list of label IDs attached to the card
» requestedBy
body
string
-true
-the requestedBy value
+false
+the new requestedBy field of the card
» assignedBy
body
string
-true
-the assignedBy value
+false
+the new assignedBy field of the card
» receivedAt
body
string
-true
-the receivedAt value
+false
+the new receivedAt field of the card
» startAt
body
string
-true
-the startAt value
+false
+the new startAt field of the card
» dueAt
body
string
-true
-the dueAt value
+false
+the new dueAt field of the card
» endAt
body
string
-true
-the endAt value
+false
+the new endAt field of the card
» spentTime
body
string
-true
-the spentTime value
+false
+the new spentTime field of the card
» isOverTime
body
-string
-true
-the isOverTime value
+boolean
+false
+the new isOverTime field of the card
» customFields
body
string
-true
-the customFields value
+false
+the new customFields value of the card
» members
body
string
-true
-the members value
+false
+the new list of member IDs attached to the card
» assignees
body
string
-true
-the assignees value
+false
+the array of maximum one ID of assignee attached to the card
» swimlaneId
body
string
-true
-the swimlaneId value
+false
+the new swimlane ID of the card
-Responses
+Detailed descriptions
+board: the board ID of the card
+list: the list ID of the card
+card: the ID of the card
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -7627,7 +8300,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -7635,20 +8330,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_list_card
-
+delete_card
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7667,6 +8366,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7688,6 +8388,7 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -7700,6 +8401,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -7735,6 +8437,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -7750,7 +8453,10 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/lists/{list}/cards/{card}
-Parameters
+Delete a card from a board
+This operation deletes a card, and therefore the card
+is not put in the recycle bin.
+Parameters
@@ -7767,25 +8473,39 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID of the card
list
path
string
true
-the list value
+the list ID of the card
card
path
string
true
-the card value
+the ID of the card
-Responses
+Detailed descriptions
+board: the board ID of the card
+list: the list ID of the card
+card: the ID of the card
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -7800,7 +8520,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -7808,20 +8550,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_swimlane_cards
-
+get_swimlane_cards
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/swimlanes/{swimlane}/cards HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7840,6 +8586,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -7861,6 +8608,7 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}/cards'
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -7873,6 +8621,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -7908,6 +8657,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -7923,7 +8673,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/swimlanes/{swimlane}/cards
-Parameters
+get all cards attached to a swimlane
+Parameters
@@ -7940,18 +8691,36 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
swimlane
path
string
true
-the swimlane value
+the swimlane ID
-Responses
+Detailed descriptions
+board: the board ID
+swimlane: the swimlane ID
+
+Example responses
+
+
+200 Response
+
+[
+ {
+ "_id": "string",
+ "title": "string",
+ "description": "string",
+ "listId": "string"
+ }
+]
+
+Responses
@@ -7966,7 +8735,50 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
+
+
+» description
+string
+false
+none
+none
+
+
+» listId
+string
+false
+none
+none
@@ -8476,20 +9288,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_customField
-
+get_custom_field
+
Code samples
# You can also use wget
curl -X GET /api/boards/{board}/custom-fields/{customField} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
GET /api/boards/{board}/custom-fields/{customField} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -8508,6 +9324,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -8529,6 +9346,7 @@ fetch('/api/boards/{board}/custom-fields/{customField}
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -8541,6 +9359,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -8576,6 +9395,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -8591,7 +9411,8 @@ System.out.println(response.toString());
GET /api/boards/{board}/custom-fields/{customField}
-Parameters
+Get a Custom Fields attached to a board
+Parameters
@@ -8615,11 +9436,38 @@ System.out.println(response.toString());
path
string
true
-the customField value
+the ID of the custom field
-Responses
+Detailed descriptions
+customField: the ID of the custom field
+
+Example responses
+
+
+200 Response
+
+{
+ "boardIds": [
+ "string"
+ ],
+ "name": "string",
+ "type": "text",
+ "settings": {
+ "currencyCode": "string",
+ "dropdownItems": [
+ {}
+ ]
+ },
+ "showOnCard": true,
+ "automaticallyOnCard": true,
+ "showLabelOnMiniCard": true,
+ "createdAt": "string",
+ "modifiedAt": "string"
+}
+
+Responses
@@ -8634,7 +9482,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+CustomFields
@@ -8642,20 +9490,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_customField
-
+delete_custom_field
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/custom-fields/{customField} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/custom-fields/{customField} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -8674,6 +9526,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -8695,6 +9548,7 @@ fetch('/api/boards/{board}/custom-fields/{customField}
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -8707,6 +9561,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -8742,6 +9597,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -8757,7 +9613,9 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/custom-fields/{customField}
-Parameters
+Delete a Custom Fields attached to a board
+The Custom Field can't be retrieved after this operation
+Parameters
@@ -8781,11 +9639,23 @@ System.out.println(response.toString());
path
string
true
-the customField value
+the ID of the custom field
-Responses
+Detailed descriptions
+customField: the ID of the custom field
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -8800,7 +9670,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -10009,20 +10901,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_int_activities
-
+delete_integration_activities
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/integrations/{int}/activities \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/integrations/{int}/activities HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -10041,6 +10937,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -10062,6 +10959,7 @@ fetch('/api/boards/{board}/integrations/{int}/activiti
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -10074,6 +10972,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -10109,6 +11008,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -10124,7 +11024,8 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/integrations/{int}/activities
-Parameters
+Delete subscribed activities
+Parameters
@@ -10141,18 +11042,42 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
int
path
string
true
-the int value
+the integration ID
-Responses
+Detailed descriptions
+board: the board ID
+int: the integration ID
+
+Example responses
+
+
+200 Response
+
+{
+ "enabled": true,
+ "title": "string",
+ "type": "string",
+ "activities": [
+ "string"
+ ],
+ "url": "string",
+ "token": "string",
+ "boardId": "string",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "userId": "string"
+}
+
+Responses
@@ -10167,7 +11092,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Integrations
@@ -10175,24 +11100,27 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-post_board_int_activities
-
+new_integration_activities
+
Code samples
# You can also use wget
curl -X POST /api/boards/{board}/integrations/{int}/activities \
-H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
POST /api/boards/{board}/integrations/{int}/activities HTTP/1.1
Content-Type: multipart/form-data
+Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -10214,6 +11142,7 @@ $.ajax({
}';
const headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -10236,6 +11165,7 @@ fetch('/api/boards/{board}/integrations/{int}/activiti
headers = {
'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -10249,6 +11179,7 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -10285,6 +11216,7 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -10300,13 +11232,14 @@ System.out.println(response.toString());
POST /api/boards/{board}/integrations/{int}/activities
+Add subscribed activities
Body parameter
activities: string
-Parameters
+Parameters
@@ -10323,14 +11256,14 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
int
path
string
true
-the int value
+the integration ID
body
@@ -10348,7 +11281,31 @@ System.out.println(response.toString());
-Responses
+Detailed descriptions
+board: the board ID
+int: the integration ID
+
+Example responses
+
+
+200 Response
+
+{
+ "enabled": true,
+ "title": "string",
+ "type": "string",
+ "activities": [
+ "string"
+ ],
+ "url": "string",
+ "token": "string",
+ "boardId": "string",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "userId": "string"
+}
+
+Responses
@@ -10363,7 +11320,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Integrations
@@ -11508,24 +12465,27 @@ to later change the permissions.
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-post_board_user_remove
-
+remove_board_member
+
Code samples
# You can also use wget
curl -X POST /api/boards/{board}/members/{user}/remove \
-H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
POST /api/boards/{board}/members/{user}/remove HTTP/1.1
Content-Type: multipart/form-data
+Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -11547,6 +12507,7 @@ $.ajax({
}'
;
const headers = {
'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -11569,6 +12530,7 @@ fetch('/api/boards/{board}/members/{user}/remove''Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -11582,6 +12544,7 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -11618,6 +12581,7 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -11633,13 +12597,15 @@ System.out.println(response.toString());
POST /api/boards/{board}/members/{user}/remove
+Remove Member from Board
+Only the admin user (the first user) can call the REST API.
Body parameter
action: string
-Parameters
+Parameters
@@ -11656,14 +12622,14 @@ System.out.println(response.toString());
path
string
true
-the board value
+the board ID
user
path
string
true
-the user value
+the user ID
body
@@ -11677,11 +12643,25 @@ System.out.println(response.toString());
body
string
true
-the action value
+the action (needs to be remove)
-Responses
+Detailed descriptions
+board: the board ID
+user: the user ID
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string",
+ "title": "string"
+}
+
+Responses
@@ -11696,7 +12676,36 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
@@ -13652,20 +14661,24 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_swimlane
-
+delete_swimlane
+
Code samples
# You can also use wget
curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -13684,6 +14697,7 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
@@ -13705,6 +14719,7 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}'require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
@@ -13717,6 +14732,7 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
@@ -13752,6 +14768,7 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
@@ -13767,7 +14784,9 @@ System.out.println(response.toString());
DELETE /api/boards/{board}/swimlanes/{swimlane}
-Parameters
+Delete a swimlane
+The swimlane will be deleted, not moved to the recycle bin
+Parameters
@@ -13784,18 +14803,31 @@ System.out.println(response.toString());
path
string
true
-the board value
+the ID of the board
swimlane
path
string
true
-the swimlane value
+the ID of the swimlane
-Responses
+Detailed descriptions
+board: the ID of the board
+swimlane: the ID of the swimlane
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -13810,7 +14842,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
diff --git a/public/api/wekan.yml b/public/api/wekan.yml
index 7e8041201..bfbe913d1 100644
--- a/public/api/wekan.yml
+++ b/public/api/wekan.yml
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Wekan REST API
- version: v4.15
+ version: v4.16
description: |
The REST API allows you to control and extend Wekan with ease.
@@ -290,18 +290,21 @@ paths:
200 response
/api/boards/{board}/cards/{card}/checklists:
get:
- operationId: get_board_card_checklists
+ operationId: get_all_checklists
+ summary: Get the list of checklists attached to a card
tags:
- Checklists
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
produces:
@@ -312,8 +315,18 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ _id:
+ type: string
+ title:
+ type: string
post:
- operationId: post_board_card_checklists
+ operationId: new_checklist
+ summary: create a new checklist
tags:
- Checklists
consumes:
@@ -322,22 +335,26 @@ paths:
parameters:
- name: title
in: formData
- description: the title value
+ description: |
+ the title of the new checklist
type: string
required: true
- name: items
in: formData
- description: the items value
+ description: |
+ the list of items on the new checklist
type: string
- required: true
+ required: false
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
produces:
@@ -348,25 +365,34 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/cards/{card}/checklists/{checklist}:
get:
- operationId: get_board_card_checklist
+ operationId: get_checklist
+ summary: Get a checklist
tags:
- Checklists
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
- name: checklist
in: path
- description: the checklist value
+ description: |
+ the ID of the checklist
type: string
required: true
produces:
@@ -377,24 +403,54 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ cardId:
+ type: string
+ title:
+ type: string
+ finishedAt:
+ type: string
+ createdAt:
+ type: string
+ sort:
+ type: number
+ items:
+ type: array
+ items:
+ type: object
+ properties:
+ _id:
+ type: string
+ title:
+ type: string
+ isFinished:
+ type: boolean
delete:
- operationId: delete_board_card_checklist
+ operationId: delete_checklist
+ summary: Delete a checklist
+ description: |
+ The checklist will be removed, not put in the recycle bin.
tags:
- Checklists
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
- name: checklist
in: path
- description: the checklist value
+ description: |
+ the ID of the checklist to remove
type: string
required: true
produces:
@@ -405,30 +461,41 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}:
get:
- operationId: get_board_card_checklist_item
+ operationId: get_checklist_item
+ summary: Get a checklist item
tags:
- ChecklistItems
+ - Checklists
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
- name: checklist
in: path
- description: the checklist value
+ description: |
+ the checklist ID
type: string
required: true
- name: item
in: path
- description: the item value
+ description: |
+ the ID of the item
type: string
required: true
produces:
@@ -439,42 +506,52 @@ paths:
'200':
description: |-
200 response
+ schema:
+ $ref: "#/definitions/ChecklistItems"
put:
- operationId: put_board_card_checklist_item
+ operationId: edit_checklist_item
+ summary: Edit a checklist item
tags:
- ChecklistItems
+ - Checklists
consumes:
- multipart/form-data
- application/json
parameters:
- name: isFinished
in: formData
- description: the isFinished value
+ description: |
+ is the item checked?
type: string
- required: true
+ required: false
- name: title
in: formData
- description: the title value
+ description: |
+ the new text of the item
type: string
- required: true
+ required: false
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
- name: checklist
in: path
- description: the checklist value
+ description: |
+ the checklist ID
type: string
required: true
- name: item
in: path
- description: the item value
+ description: |
+ the ID of the item
type: string
required: true
produces:
@@ -485,29 +562,42 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
delete:
- operationId: delete_board_card_checklist_item
+ operationId: delete_checklist_item
+ summary: Delete a checklist item
+ description: |
+ Note: this operation can't be reverted.
tags:
- ChecklistItems
+ - Checklists
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
- name: checklist
in: path
- description: the checklist value
+ description: |
+ the checklist ID
type: string
required: true
- name: item
in: path
- description: the item value
+ description: |
+ the ID of the item to be removed
type: string
required: true
produces:
@@ -518,6 +608,11 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/cards/{card}/comments:
get:
operationId: get_all_comments
@@ -557,7 +652,8 @@ paths:
authorId:
type: string
post:
- operationId: post_board_card_comments
+ operationId: new_comment
+ summary: Add a comment on a card
tags:
- CardComments
consumes:
@@ -566,7 +662,8 @@ paths:
parameters:
- name: authorId
in: formData
- description: the authorId value
+ description: |
+ the user who 'posted' the comment
type: string
required: true
- name: comment
@@ -576,12 +673,14 @@ paths:
required: true
- name: board
in: path
- description: the board value
+ description: |
+ the board ID of the card
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the ID of the card
type: string
required: true
produces:
@@ -592,25 +691,34 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/cards/{card}/comments/{comment}:
get:
- operationId: get_board_card_comment
+ operationId: get_comment
+ summary: Get a comment on a card
tags:
- CardComments
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID of the card
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the ID of the card
type: string
required: true
- name: comment
in: path
- description: the comment value
+ description: |
+ the ID of the comment to retrieve
type: string
required: true
produces:
@@ -621,24 +729,30 @@ paths:
'200':
description: |-
200 response
+ schema:
+ $ref: "#/definitions/CardComments"
delete:
- operationId: delete_board_card_comment
+ operationId: delete_comment
+ summary: Delete a comment on a card
tags:
- CardComments
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID of the card
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the ID of the card
type: string
required: true
- name: comment
in: path
- description: the comment value
+ description: |
+ the ID of the comment to delete
type: string
required: true
produces:
@@ -649,25 +763,34 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}:
get:
- operationId: get_board_customFieldValue
+ operationId: get_cards_by_custom_field
+ summary: Get all Cards that matchs a value of a specific custom field
tags:
- Cards
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: customField
in: path
- description: the customField value
+ description: |
+ the list ID
type: string
required: true
- name: customFieldValue
in: path
- description: the customFieldValue value
+ description: |
+ the value to look for
type: string
required: true
produces:
@@ -678,6 +801,21 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ _id:
+ type: string
+ title:
+ type: string
+ description:
+ type: string
+ listId:
+ type: string
+ swinlaneId:
+ type: string
/api/boards/{board}/custom-fields:
get:
operationId: get_all_custom_fields
@@ -779,7 +917,8 @@ paths:
type: string
/api/boards/{board}/custom-fields/{customField}:
get:
- operationId: get_board_customField
+ operationId: get_custom_field
+ summary: Get a Custom Fields attached to a board
tags:
- CustomFields
parameters:
@@ -790,7 +929,8 @@ paths:
required: true
- name: customField
in: path
- description: the customField value
+ description: |
+ the ID of the custom field
type: string
required: true
produces:
@@ -801,8 +941,13 @@ paths:
'200':
description: |-
200 response
+ schema:
+ $ref: "#/definitions/CustomFields"
delete:
- operationId: delete_board_customField
+ operationId: delete_custom_field
+ summary: Delete a Custom Fields attached to a board
+ description: |
+ The Custom Field can't be retrieved after this operation
tags:
- CustomFields
parameters:
@@ -813,7 +958,8 @@ paths:
required: true
- name: customField
in: path
- description: the customField value
+ description: |
+ the ID of the custom field
type: string
required: true
produces:
@@ -824,6 +970,11 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/export:
get:
operationId: exportJson
@@ -1036,18 +1187,21 @@ paths:
type: string
/api/boards/{board}/integrations/{int}/activities:
delete:
- operationId: delete_board_int_activities
+ operationId: delete_integration_activities
+ summary: Delete subscribed activities
tags:
- Integrations
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: int
in: path
- description: the int value
+ description: |
+ the integration ID
type: string
required: true
produces:
@@ -1058,8 +1212,11 @@ paths:
'200':
description: |-
200 response
+ schema:
+ $ref: "#/definitions/Integrations"
post:
- operationId: post_board_int_activities
+ operationId: new_integration_activities
+ summary: Add subscribed activities
tags:
- Integrations
consumes:
@@ -1073,12 +1230,14 @@ paths:
required: true
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: int
in: path
- description: the int value
+ description: |
+ the integration ID
type: string
required: true
produces:
@@ -1089,6 +1248,8 @@ paths:
'200':
description: |-
200 response
+ schema:
+ $ref: "#/definitions/Integrations"
/api/boards/{board}/labels:
put:
operationId: add_board_label
@@ -1359,23 +1520,27 @@ paths:
type: string
/api/boards/{board}/lists/{list}/cards/{card}:
get:
- operationId: get_board_list_card
+ operationId: get_card
+ summary: Get a Card
tags:
- Cards
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: list
in: path
- description: the list value
+ description: |
+ the list ID of the card
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the card ID
type: string
required: true
produces:
@@ -1386,8 +1551,23 @@ paths:
'200':
description: |-
200 response
+ schema:
+ $ref: "#/definitions/Cards"
put:
- operationId: put_board_list_card
+ operationId: edit_card
+ summary: Edit Fields in a Card
+ description: |
+ Edit a card
+
+ The color has to be chosen between `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`:
+
+
+
+ Note: setting the color to white has the same effect than removing it.
tags:
- Cards
consumes:
@@ -1396,117 +1576,140 @@ paths:
parameters:
- name: title
in: formData
- description: the title value
+ description: |
+ the new title of the card
type: string
- required: true
+ required: false
- name: listId
in: formData
- description: the listId value
+ description: |
+ the new list ID of the card (move operation)
type: string
- required: true
+ required: false
- name: authorId
in: formData
- description: the authorId value
+ description: |
+ change the owner of the card
type: string
- required: true
+ required: false
- name: parentId
in: formData
- description: the parentId value
+ description: |
+ change the parent of the card
type: string
- required: true
+ required: false
- name: description
in: formData
- description: the description value
+ description: |
+ the new description of the card
type: string
- required: true
+ required: false
- name: color
in: formData
- description: the color value
+ description: |
+ the new color of the card
type: string
- required: true
+ required: false
- name: vote
in: formData
- description: the vote value
- type: string
- required: true
+ description: |
+ the vote object
+ type: object
+ required: false
- name: labelIds
in: formData
- description: the labelIds value
+ description: |
+ the new list of label IDs attached to the card
type: string
- required: true
+ required: false
- name: requestedBy
in: formData
- description: the requestedBy value
+ description: |
+ the new requestedBy field of the card
type: string
- required: true
+ required: false
- name: assignedBy
in: formData
- description: the assignedBy value
+ description: |
+ the new assignedBy field of the card
type: string
- required: true
+ required: false
- name: receivedAt
in: formData
- description: the receivedAt value
+ description: |
+ the new receivedAt field of the card
type: string
- required: true
+ required: false
- name: startAt
in: formData
- description: the startAt value
+ description: |
+ the new startAt field of the card
type: string
- required: true
+ required: false
- name: dueAt
in: formData
- description: the dueAt value
+ description: |
+ the new dueAt field of the card
type: string
- required: true
+ required: false
- name: endAt
in: formData
- description: the endAt value
+ description: |
+ the new endAt field of the card
type: string
- required: true
+ required: false
- name: spentTime
in: formData
- description: the spentTime value
+ description: |
+ the new spentTime field of the card
type: string
- required: true
+ required: false
- name: isOverTime
in: formData
- description: the isOverTime value
- type: string
- required: true
+ description: |
+ the new isOverTime field of the card
+ type: boolean
+ required: false
- name: customFields
in: formData
- description: the customFields value
+ description: |
+ the new customFields value of the card
type: string
- required: true
+ required: false
- name: members
in: formData
- description: the members value
+ description: |
+ the new list of member IDs attached to the card
type: string
- required: true
+ required: false
- name: assignees
in: formData
- description: the assignees value
+ description: |
+ the array of maximum one ID of assignee attached to the card
type: string
- required: true
+ required: false
- name: swimlaneId
in: formData
- description: the swimlaneId value
+ description: |
+ the new swimlane ID of the card
type: string
- required: true
+ required: false
- name: board
in: path
- description: the board value
+ description: |
+ the board ID of the card
type: string
required: true
- name: list
in: path
- description: the list value
+ description: |
+ the list ID of the card
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the ID of the card
type: string
required: true
produces:
@@ -1517,24 +1720,36 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
delete:
- operationId: delete_board_list_card
+ operationId: delete_card
+ summary: Delete a card from a board
+ description: |
+ This operation **deletes** a card, and therefore the card
+ is not put in the recycle bin.
tags:
- Cards
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID of the card
type: string
required: true
- name: list
in: path
- description: the list value
+ description: |
+ the list ID of the card
type: string
required: true
- name: card
in: path
- description: the card value
+ description: |
+ the ID of the card
type: string
required: true
produces:
@@ -1545,6 +1760,11 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/members/{member}:
post:
operationId: set_board_member_permission
@@ -1668,26 +1888,33 @@ paths:
type: string
/api/boards/{board}/members/{user}/remove:
post:
- operationId: post_board_user_remove
+ operationId: remove_board_member
+ summary: Remove Member from Board
+ description: |
+ Only the admin user (the first user) can call the REST API.
tags:
- Users
+ - Boards
consumes:
- multipart/form-data
- application/json
parameters:
- name: action
in: formData
- description: the action value
+ description: |
+ the action (needs to be `remove`)
type: string
required: true
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: user
in: path
- description: the user value
+ description: |
+ the user ID
type: string
required: true
produces:
@@ -1698,6 +1925,13 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
+ title:
+ type: string
/api/boards/{board}/swimlanes:
get:
operationId: get_all_swimlanes
@@ -1792,18 +2026,23 @@ paths:
schema:
$ref: "#/definitions/Swimlanes"
delete:
- operationId: delete_board_swimlane
+ operationId: delete_swimlane
+ summary: Delete a swimlane
+ description: |
+ The swimlane will be deleted, not moved to the recycle bin
tags:
- Swimlanes
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the ID of the board
type: string
required: true
- name: swimlane
in: path
- description: the swimlane value
+ description: |
+ the ID of the swimlane
type: string
required: true
produces:
@@ -1814,20 +2053,28 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: object
+ properties:
+ _id:
+ type: string
/api/boards/{board}/swimlanes/{swimlane}/cards:
get:
- operationId: get_board_swimlane_cards
+ operationId: get_swimlane_cards
+ summary: get all cards attached to a swimlane
tags:
- Cards
parameters:
- name: board
in: path
- description: the board value
+ description: |
+ the board ID
type: string
required: true
- name: swimlane
in: path
- description: the swimlane value
+ description: |
+ the swimlane ID
type: string
required: true
produces:
@@ -1838,6 +2085,19 @@ paths:
'200':
description: |-
200 response
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ _id:
+ type: string
+ title:
+ type: string
+ description:
+ type: string
+ listId:
+ type: string
/api/user:
get:
operationId: get_current_user
diff --git a/sandstorm-pkgdef.capnp b/sandstorm-pkgdef.capnp
index 27dc1be51..fab8f1d64 100644
--- a/sandstorm-pkgdef.capnp
+++ b/sandstorm-pkgdef.capnp
@@ -22,10 +22,10 @@ const pkgdef :Spk.PackageDefinition = (
appTitle = (defaultText = "Wekan"),
# The name of the app as it is displayed to the user.
- appVersion = 415,
+ appVersion = 416,
# Increment this for every release.
- appMarketingVersion = (defaultText = "4.15.0~2020-06-16"),
+ appMarketingVersion = (defaultText = "4.16.0~2020-06-17"),
# Human-readable presentation of the app version.
minUpgradableAppVersion = 0,