From 3908fe0ab875cf4b793c884a3d82df2f1a3b2686 Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Sat, 25 Apr 2020 16:44:45 +0300 Subject: v3.98 --- public/api/wekan.html | 3795 ++++++++++--------------------------------------- public/api/wekan.yml | 471 +----- 2 files changed, 768 insertions(+), 3498 deletions(-) (limited to 'public') diff --git a/public/api/wekan.html b/public/api/wekan.html index d77257a9..148ceee5 100644 --- a/public/api/wekan.html +++ b/public/api/wekan.html @@ -1458,12 +1458,12 @@ Darkula color scheme from the JetBrains family of IDEs opacity: 0.5; } - + - + @@ -1477,498 +1477,434 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
- +
- - + + Shell - - - + + + HTTP - - - + + + JavaScript - - - + + + Node.js - - - + + + Ruby - - - + + + Python - - - + + + Java - - - + + + Go - - + +
- - + +
- +
- + - +
-

Wekan REST API v3.97

+

Wekan REST API v3.98

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

@@ -2106,7 +2042,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"application/x-www-form-urlencoded"}, "Accept": []string{"*/*"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -2381,7 +2317,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"application/x-www-form-urlencoded"}, "Accept": []string{"*/*"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -2664,7 +2600,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -2870,7 +2806,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3165,7 +3101,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3390,7 +3326,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3552,7 +3488,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3735,7 +3671,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3940,7 +3876,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4162,7 +4098,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4367,7 +4303,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4544,7 +4480,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4738,7 +4674,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4911,7 +4847,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5085,7 +5021,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5276,7 +5212,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5484,7 +5420,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5673,7 +5609,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5904,7 +5840,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6098,7 +6034,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6271,7 +6207,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6453,7 +6389,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6686,7 +6622,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6946,7 +6882,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7112,7 +7048,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7287,7 +7223,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7581,7 +7517,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7803,7 +7739,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8015,7 +7951,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8277,7 +8213,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8479,7 +8415,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8655,7 +8591,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8850,7 +8786,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9071,7 +9007,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9293,7 +9229,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9496,7 +9432,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9599,35 +9535,32 @@ The list is not put in the recycle bin.

To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity -

Users

-

add_board_member

-

+

Swimlanes

+

get_all_swimlanes

+

Code samples

# You can also use wget
-curl -X POST /api/boards/{board}/members/{user}/add \
-  -H 'Content-Type: multipart/form-data' \
+curl -X GET /api/boards/{board}/swimlanes \
   -H 'Accept: application/json' \
   -H 'Authorization: API_KEY'
-
POST /api/boards/{board}/members/{user}/add HTTP/1.1
+
GET /api/boards/{board}/swimlanes HTTP/1.1
 
-Content-Type: multipart/form-data
-Accept: application/json
+Accept: application/json
 
-

+
var headers = {
-  'Content-Type':'multipart/form-data',
   'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
 $.ajax({
-  url: '/api/boards/{board}/members/{user}/add',
-  method: 'post',
+  url: '/api/boards/{board}/swimlanes',
+  method: 'get',
 
   headers: headers,
   success: function(data) {
@@ -9637,23 +9570,17 @@ $.ajax({
 
 
const fetch = require('node-fetch');
-const inputBody = '{
-  "action": "string",
-  "isAdmin": true,
-  "isNoComments": true,
-  "isCommentOnly": true
-}';
+
 const headers = {
-  'Content-Type':'multipart/form-data',
   'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
-fetch('/api/boards/{board}/members/{user}/add',
+fetch('/api/boards/{board}/swimlanes',
 {
-  method: 'POST',
-  body: inputBody,
+  method: 'GET',
+
   headers: headers
 })
 .then(function(res) {
@@ -9667,12 +9594,11 @@ fetch('/api/boards/{board}/members/{user}/add',
 require 'json'
 
 headers = {
-  'Content-Type' => 'multipart/form-data',
   'Accept' => 'application/json',
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.post '/api/boards/{board}/members/{user}/add',
+result = RestClient.get '/api/boards/{board}/swimlanes',
   params: {
   }, headers: headers
 
@@ -9681,21 +9607,20 @@ p JSON.parse(result)
 
import requests
 headers = {
-  'Content-Type': 'multipart/form-data',
   'Accept': 'application/json',
   'Authorization': 'API_KEY'
 }
 
-r = requests.post('/api/boards/{board}/members/{user}/add', params={
+r = requests.get('/api/boards/{board}/swimlanes', params={
 
 }, headers = headers)
 
 print r.json()
-
URL obj = new URL("/api/boards/{board}/members/{user}/add");
+
URL obj = new URL("/api/boards/{board}/swimlanes");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("GET");
 int responseCode = con.getResponseCode();
 BufferedReader in = new BufferedReader(
     new InputStreamReader(con.getInputStream()));
@@ -9718,14 +9643,13 @@ System.out.println(response.toString());
 func main() {
 
     headers := map[string][]string{
-        "Content-Type": []string{"multipart/form-data"},
         "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-        
+
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/add", data)
+    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -9734,21 +9658,9 @@ System.out.println(response.toString());
 }
 
 

-
POST /api/boards/{board}/members/{user}/add

-
Add New Board Member with Role

-
Only the admin user (the first user) can call the REST API.

-
Note: see Boards.set_board_member_permission
-to later change the permissions.

-

-
Body parameter

-

-
action: string
-isAdmin: true
-isNoComments: true
-isCommentOnly: true
-
-

-
Parameters

+
GET /api/boards/{board}/swimlanes

+
Get the list of swimlanes attached to a board

+
Parameters

 
@@ -9765,67 +9677,26 @@ to later change the permissions.

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+

 
 

 path
 string
 truethe board ID
userpathstringtruethe user ID
bodybodyobjectfalsenone
» actionbodystringtruethe action value
» isAdminbodybooleantrueis the user an admin of the board
» isNoCommentsbodybooleantruedisable comments
» isCommentOnlybodybooleantrueonly enable commentsthe ID of the board
 

 
 

 
Detailed descriptions

-
board: the board ID

-
user: the user ID

+
board: the ID of the board

 

 
Example responses

 

 

 
200 Response

 

-
{
-  "_id": "string",
-  "title": "string"
-}
+
[
+  {
+    "_id": "string",
+    "title": "string"
+  }
+]
 

-
Responses

+
Responses

 
@@ -9844,7 +9715,7 @@ to later change the permissions.

 
 

 

 
 

-
Response Schema

+
Response Schema

 
Status Code 200

 
@@ -9877,30 +9748,33 @@ 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

-

+
new_swimlane

+

 
Code samples

 
# You can also use wget
-curl -X POST /api/boards/{board}/members/{user}/remove \
+curl -X POST /api/boards/{board}/swimlanes \
   -H 'Content-Type: multipart/form-data' \
+  -H 'Accept: application/json' \
   -H 'Authorization: API_KEY'
 
 

-
POST /api/boards/{board}/members/{user}/remove HTTP/1.1
+
POST /api/boards/{board}/swimlanes HTTP/1.1
 
 Content-Type: multipart/form-data
+Accept: application/json
 
 

 
var headers = {
   'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
 $.ajax({
-  url: '/api/boards/{board}/members/{user}/remove',
+  url: '/api/boards/{board}/swimlanes',
   method: 'post',
 
   headers: headers,
@@ -9912,15 +9786,16 @@ $.ajax({
 

 
const fetch = require('node-fetch');
 const inputBody = '{
-  "action": "string"
+  "title": "string"
 }';
 const headers = {
   'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
-fetch('/api/boards/{board}/members/{user}/remove',
+fetch('/api/boards/{board}/swimlanes',
 {
   method: 'POST',
   body: inputBody,
@@ -9938,10 +9813,11 @@ fetch('/api/boards/{board}/members/{user}/remove''Content-Type' => 'multipart/form-data',
+  'Accept' => 'application/json',
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.post '/api/boards/{board}/members/{user}/remove',
+result = RestClient.post '/api/boards/{board}/swimlanes',
   params: {
   }, headers: headers
 
@@ -9951,17 +9827,18 @@ p JSON.parse(result)
 
import requests
 headers = {
   'Content-Type': 'multipart/form-data',
+  'Accept': 'application/json',
   'Authorization': 'API_KEY'
 }
 
-r = requests.post('/api/boards/{board}/members/{user}/remove', params={
+r = requests.post('/api/boards/{board}/swimlanes', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/boards/{board}/members/{user}/remove");
+
URL obj = new URL("/api/boards/{board}/swimlanes");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
 con.setRequestMethod("POST");
 int responseCode = con.getResponseCode();
@@ -9987,12 +9864,13 @@ System.out.println(response.toString());
 
     headers := map[string][]string{
         "Content-Type": []string{"multipart/form-data"},
+        "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-        
+
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/remove", data)
+    req, err := http.NewRequest("POST", "/api/boards/{board}/swimlanes", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -10001,14 +9879,15 @@ System.out.println(response.toString());
 }
 
 

-
POST /api/boards/{board}/members/{user}/remove

+
POST /api/boards/{board}/swimlanes

+
Add a swimlane to a board

 

 
Body parameter

 

-
action: string
+
title: string
 
 

-
Parameters

+
Parameters

 

 
 
 

@@ -10025,14 +9904,7 @@ System.out.println(response.toString());
 
-
-
-
-
-
-
-
-
+
@@ -10042,15 +9914,27 @@ System.out.println(response.toString());
 
-
+
-
+

 
 
path
 string
 truethe board value
userpathstringtruethe user valuethe ID of the board
 

 

 bodynone
 

 
» action» title
 body
 string
 truethe action valuethe new title of the swimlane
 

 
 

-
Responses

+
Detailed descriptions

+
board: the ID of the board

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "_id": "string"
+}
+

+
Responses

 
@@ -10065,7 +9949,29 @@ System.out.println(response.toString());
 
-
+
+
+
+

 
 
200
 OK
 200 responseNoneInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
 

 
 

@@ -10073,18 +9979,18 @@ System.out.println(response.toString());
 To perform this operation, you must be authenticated by means of one of the following methods:
 UserSecurity
 
-
get_current_user

-

+
get_swimlane

+

 

 
Code samples

 

 
# You can also use wget
-curl -X GET /api/user \
+curl -X GET /api/boards/{board}/swimlanes/{swimlane} \
   -H 'Accept: application/json' \
   -H 'Authorization: API_KEY'
 
 

-
GET /api/user HTTP/1.1
+
GET /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
 
 Accept: application/json
 
@@ -10096,7 +10002,7 @@ curl -X GET /api/user \
 };
 
 $.ajax({
-  url: '/api/user',
+  url: '/api/boards/{board}/swimlanes/{swimlane}',
   method: 'get',
 
   headers: headers,
@@ -10114,7 +10020,7 @@ $.ajax({
 
 };
 
-fetch('/api/user',
+fetch('/api/boards/{board}/swimlanes/{swimlane}',
 {
   method: 'GET',
 
@@ -10135,7 +10041,7 @@ headers = {
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.get '/api/user',
+result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}',
   params: {
   }, headers: headers
 
@@ -10148,14 +10054,14 @@ headers = {
   'Authorization': 'API_KEY'
 }
 
-r = requests.get('/api/user', params={
+r = requests.get('/api/boards/{board}/swimlanes/{swimlane}', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/user");
+
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
 con.setRequestMethod("GET");
 int responseCode = con.getResponseCode();
@@ -10182,11 +10088,11 @@ System.out.println(response.toString());
     headers := map[string][]string{
         "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-        
+
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/user", data)
+    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -10195,8 +10101,39 @@ System.out.println(response.toString());
 }
 
 

-
GET /api/user

-
returns the current user

+
GET /api/boards/{board}/swimlanes/{swimlane}

+
Get a swimlane

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board
swimlanepathstringtruethe ID of the swimlane

+
Detailed descriptions

+
board: the ID of the board

+
swimlane: the ID of the swimlane

 

 
Example responses

 

@@ -10204,53 +10141,18 @@ System.out.println(response.toString());
 
200 Response

 
 
{
-  "username": "string",
-  "emails": [
-    {
-      "address": "string",
-      "verified": true
-    }
-  ],
+  "title": "string",
+  "archived": true,
+  "boardId": "string",
   "createdAt": "string",
+  "sort": 0,
+  "color": "white",
+  "updatedAt": "string",
   "modifiedAt": "string",
-  "profile": {
-    "avatarUrl": "string",
-    "emailBuffer": [
-      "string"
-    ],
-    "fullname": "string",
-    "showDesktopDragHandles": true,
-    "hiddenSystemMessages": true,
-    "hiddenMinicardLabelText": true,
-    "initials": "string",
-    "invitedBoards": [
-      "string"
-    ],
-    "language": "string",
-    "notifications": [],
-    "activity": "string",
-    "read": "string",
-    "showCardsCountAt": 0,
-    "starredBoards": [
-      "string"
-    ],
-    "icode": "string",
-    "boardView": "board-view-lists",
-    "listSortBy": "-modifiedat",
-    "templatesBoardId": "string",
-    "cardTemplatesSwimlaneId": "string",
-    "listTemplatesSwimlaneId": "string",
-    "boardTemplatesSwimlaneId": "string"
-  },
-  "services": {},
-  "heartbeat": "string",
-  "isAdmin": true,
-  "createdThroughApi": true,
-  "loginDisabled": true,
-  "authenticationMethod": "string"
+  "type": "string"
 }
 

-
Responses

+
Responses

 
@@ -10265,7 +10167,7 @@ System.out.println(response.toString());
 
-
+

 
 
200
 OK
 200 responseUsersSwimlanes
 

 
 

@@ -10273,31 +10175,27 @@ System.out.println(response.toString());
 To perform this operation, you must be authenticated by means of one of the following methods:
 UserSecurity
 
-
get_all_users

-

+
delete_board_swimlane

+

 

 
Code samples

 

 
# You can also use wget
-curl -X GET /api/users \
-  -H 'Accept: application/json' \
+curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
   -H 'Authorization: API_KEY'
 
 

-
GET /api/users HTTP/1.1
-
-Accept: application/json
+
DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
 
-

+

 
var headers = {
-  'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
 $.ajax({
-  url: '/api/users',
-  method: 'get',
+  url: '/api/boards/{board}/swimlanes/{swimlane}',
+  method: 'delete',
 
   headers: headers,
   success: function(data) {
@@ -10309,14 +10207,13 @@ $.ajax({
 
const fetch = require('node-fetch');
 
 const headers = {
-  'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
-fetch('/api/users',
+fetch('/api/boards/{board}/swimlanes/{swimlane}',
 {
-  method: 'GET',
+  method: 'DELETE',
 
   headers: headers
 })
@@ -10331,11 +10228,10 @@ fetch('/api/users',
 require 'json'
 
 headers = {
-  'Accept' => 'application/json',
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.get '/api/users',
+result = RestClient.delete '/api/boards/{board}/swimlanes/{swimlane}',
   params: {
   }, headers: headers
 
@@ -10344,20 +10240,19 @@ p JSON.parse(result)
 

 
import requests
 headers = {
-  'Accept': 'application/json',
   'Authorization': 'API_KEY'
 }
 
-r = requests.get('/api/users', params={
+r = requests.delete('/api/boards/{board}/swimlanes/{swimlane}', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/users");
+
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("DELETE");
 int responseCode = con.getResponseCode();
 BufferedReader in = new BufferedReader(
     new InputStreamReader(con.getInputStream()));
@@ -10380,1749 +10275,12 @@ System.out.println(response.toString());
 func main() {
 
     headers := map[string][]string{
-        "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-        
+
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/users", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
GET /api/users

-
return all the users

-
Only the admin user (the first user) can call the REST API.

-

-
Example responses

-

-

-
200 Response

-

-
[
-  {
-    "_id": "string",
-    "username": "string"
-  }
-]
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseInline

-
Response Schema

-
Status Code 200

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» usernamestringfalsenonenone

-
-
new_user

-

-

-
Code samples

-

-
# You can also use wget
-curl -X POST /api/users \
-  -H 'Content-Type: multipart/form-data' \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
POST /api/users HTTP/1.1
-
-Content-Type: multipart/form-data
-Accept: application/json
-
-

-
var headers = {
-  'Content-Type':'multipart/form-data',
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/users',
-  method: 'post',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-const inputBody = '{
-  "username": "string",
-  "email": "string",
-  "password": "string"
-}';
-const headers = {
-  'Content-Type':'multipart/form-data',
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/users',
-{
-  method: 'POST',
-  body: inputBody,
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Content-Type' => 'multipart/form-data',
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.post '/api/users',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Content-Type': 'multipart/form-data',
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.post('/api/users', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/users");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Content-Type": []string{"multipart/form-data"},
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("POST", "/api/users", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
POST /api/users

-
Create a new user

-
Only the admin user (the first user) can call the REST API.

-

-
Body parameter

-

-
username: string
-email: string
-password: string
-
-

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
bodybodyobjectfalsenone
» usernamebodystringtruethe new username
» emailbodystringtruethe email of the new user
» passwordbodystringtruethe password of the new user

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "_id": "string"
-}
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseInline

-
Response Schema

-
Status Code 200

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone

-
-
get_user

-

-

-
Code samples

-

-
# You can also use wget
-curl -X GET /api/users/{user} \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
GET /api/users/{user} HTTP/1.1
-
-Accept: application/json
-
-

-
var headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/users/{user}',
-  method: 'get',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-
-const headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/users/{user}',
-{
-  method: 'GET',
-
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.get '/api/users/{user}',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.get('/api/users/{user}', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/users/{user}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/users/{user}", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
GET /api/users/{user}

-
get a given user

-
Only the admin user (the first user) can call the REST API.

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
userpathstringtruethe user ID

-
Detailed descriptions

-
user: the user ID

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "username": "string",
-  "emails": [
-    {
-      "address": "string",
-      "verified": true
-    }
-  ],
-  "createdAt": "string",
-  "modifiedAt": "string",
-  "profile": {
-    "avatarUrl": "string",
-    "emailBuffer": [
-      "string"
-    ],
-    "fullname": "string",
-    "showDesktopDragHandles": true,
-    "hiddenSystemMessages": true,
-    "hiddenMinicardLabelText": true,
-    "initials": "string",
-    "invitedBoards": [
-      "string"
-    ],
-    "language": "string",
-    "notifications": [],
-    "activity": "string",
-    "read": "string",
-    "showCardsCountAt": 0,
-    "starredBoards": [
-      "string"
-    ],
-    "icode": "string",
-    "boardView": "board-view-lists",
-    "listSortBy": "-modifiedat",
-    "templatesBoardId": "string",
-    "cardTemplatesSwimlaneId": "string",
-    "listTemplatesSwimlaneId": "string",
-    "boardTemplatesSwimlaneId": "string"
-  },
-  "services": {},
-  "heartbeat": "string",
-  "isAdmin": true,
-  "createdThroughApi": true,
-  "loginDisabled": true,
-  "authenticationMethod": "string"
-}
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseUsers

-
-
edit_user

-

-

-
Code samples

-

-
# You can also use wget
-curl -X PUT /api/users/{user} \
-  -H 'Content-Type: multipart/form-data' \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
PUT /api/users/{user} HTTP/1.1
-
-Content-Type: multipart/form-data
-Accept: application/json
-
-

-
var headers = {
-  'Content-Type':'multipart/form-data',
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/users/{user}',
-  method: 'put',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-const inputBody = '{
-  "action": "string"
-}';
-const headers = {
-  'Content-Type':'multipart/form-data',
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/users/{user}',
-{
-  method: 'PUT',
-  body: inputBody,
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Content-Type' => 'multipart/form-data',
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.put '/api/users/{user}',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Content-Type': 'multipart/form-data',
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.put('/api/users/{user}', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/users/{user}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("PUT");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Content-Type": []string{"multipart/form-data"},
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("PUT", "/api/users/{user}", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
PUT /api/users/{user}

-
edit a given user

-
Only the admin user (the first user) can call the REST API.

-
Possible values for action:

-
    
-
  • takeOwnership: The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on.
    • 
-
  • disableLogin: Disable a user (the user is not allowed to login and his login tokens are purged)
    • 
-
  • enableLogin: Enable a user
    • 
-

-

-
Body parameter

-

-
action: string
-
-

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
userpathstringtruethe user ID
bodybodyobjectfalsenone
» actionbodystringtruethe action

-
Detailed descriptions

-
user: the user ID

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "_id": "string",
-  "title": "string"
-}
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseInline

-
Response Schema

-
Status Code 200

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» titlestringfalsenonenone

-
-
delete_user

-

-

-
Code samples

-

-
# You can also use wget
-curl -X DELETE /api/users/{user} \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
DELETE /api/users/{user} HTTP/1.1
-
-Accept: application/json
-
-

-
var headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/users/{user}',
-  method: 'delete',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-
-const headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/users/{user}',
-{
-  method: 'DELETE',
-
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.delete '/api/users/{user}',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.delete('/api/users/{user}', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/users/{user}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("DELETE", "/api/users/{user}", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
DELETE /api/users/{user}

-
Delete a user

-
Only the admin user (the first user) can call the REST API.

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
userpathstringtruethe ID of the user to delete

-
Detailed descriptions

-
user: the ID of the user to delete

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "_id": "string"
-}
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseInline

-
Response Schema

-
Status Code 200

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone

-
-
Swimlanes

-
get_all_swimlanes

-

-

-
Code samples

-

-
# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
GET /api/boards/{board}/swimlanes HTTP/1.1
-
-Accept: application/json
-
-

-
var headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/boards/{board}/swimlanes',
-  method: 'get',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-
-const headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes',
-{
-  method: 'GET',
-
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.get '/api/boards/{board}/swimlanes',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.get('/api/boards/{board}/swimlanes', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/boards/{board}/swimlanes");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
GET /api/boards/{board}/swimlanes

-
Get the list of swimlanes attached to a board

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board

-
Detailed descriptions

-
board: the ID of the board

-

-
Example responses

-

-

-
200 Response

-

-
[
-  {
-    "_id": "string",
-    "title": "string"
-  }
-]
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseInline

-
Response Schema

-
Status Code 200

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» titlestringfalsenonenone

-
-
new_swimlane

-

-

-
Code samples

-

-
# You can also use wget
-curl -X POST /api/boards/{board}/swimlanes \
-  -H 'Content-Type: multipart/form-data' \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
POST /api/boards/{board}/swimlanes HTTP/1.1
-
-Content-Type: multipart/form-data
-Accept: application/json
-
-

-
var headers = {
-  'Content-Type':'multipart/form-data',
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/boards/{board}/swimlanes',
-  method: 'post',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-const inputBody = '{
-  "title": "string"
-}';
-const headers = {
-  'Content-Type':'multipart/form-data',
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes',
-{
-  method: 'POST',
-  body: inputBody,
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Content-Type' => 'multipart/form-data',
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.post '/api/boards/{board}/swimlanes',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Content-Type': 'multipart/form-data',
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.post('/api/boards/{board}/swimlanes', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/boards/{board}/swimlanes");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Content-Type": []string{"multipart/form-data"},
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("POST", "/api/boards/{board}/swimlanes", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
POST /api/boards/{board}/swimlanes

-
Add a swimlane to a board

-

-
Body parameter

-

-
title: string
-
-

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board
bodybodyobjectfalsenone
» titlebodystringtruethe new title of the swimlane

-
Detailed descriptions

-
board: the ID of the board

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "_id": "string"
-}
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseInline

-
Response Schema

-
Status Code 200

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone

-
-
get_swimlane

-

-

-
Code samples

-

-
# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes/{swimlane} \
-  -H 'Accept: application/json' \
-  -H 'Authorization: API_KEY'
-
-

-
GET /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
-Accept: application/json
-
-

-
var headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/boards/{board}/swimlanes/{swimlane}',
-  method: 'get',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-
-const headers = {
-  'Accept':'application/json',
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes/{swimlane}',
-{
-  method: 'GET',
-
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Accept' => 'application/json',
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Accept': 'application/json',
-  'Authorization': 'API_KEY'
-}
-
-r = requests.get('/api/boards/{board}/swimlanes/{swimlane}', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Accept": []string{"application/json"},
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}", data)
-    req.Header = headers
-
-    client := &http.Client{}
-    resp, err := client.Do(req)
-    // ...
-}
-
-

-
GET /api/boards/{board}/swimlanes/{swimlane}

-
Get a swimlane

-
Parameters

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board
swimlanepathstringtruethe ID of the swimlane

-
Detailed descriptions

-
board: the ID of the board

-
swimlane: the ID of the swimlane

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "title": "string",
-  "archived": true,
-  "boardId": "string",
-  "createdAt": "string",
-  "sort": 0,
-  "color": "white",
-  "updatedAt": "string",
-  "modifiedAt": "string",
-  "type": "string"
-}
-

-
Responses

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
StatusMeaningDescriptionSchema
200OK200 responseSwimlanes

-
-
delete_board_swimlane

-

-

-
Code samples

-

-
# You can also use wget
-curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
-  -H 'Authorization: API_KEY'
-
-

-
DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
-

-
var headers = {
-  'Authorization':'API_KEY'
-
-};
-
-$.ajax({
-  url: '/api/boards/{board}/swimlanes/{swimlane}',
-  method: 'delete',
-
-  headers: headers,
-  success: function(data) {
-    console.log(JSON.stringify(data));
-  }
-})
-
-

-
const fetch = require('node-fetch');
-
-const headers = {
-  'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes/{swimlane}',
-{
-  method: 'DELETE',
-
-  headers: headers
-})
-.then(function(res) {
-    return res.json();
-}).then(function(body) {
-    console.log(body);
-});
-
-

-
require 'rest-client'
-require 'json'
-
-headers = {
-  'Authorization' => 'API_KEY'
-}
-
-result = RestClient.delete '/api/boards/{board}/swimlanes/{swimlane}',
-  params: {
-  }, headers: headers
-
-p JSON.parse(result)
-
-

-
import requests
-headers = {
-  'Authorization': 'API_KEY'
-}
-
-r = requests.delete('/api/boards/{board}/swimlanes/{swimlane}', params={
-
-}, headers = headers)
-
-print r.json()
-
-

-
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
-    new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
-    response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-

-
package main
-
-import (
-       "bytes"
-       "net/http"
-)
-
-func main() {
-
-    headers := map[string][]string{
-        "Authorization": []string{"API_KEY"},
-        
-    }
-
-    data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("DELETE", "/api/boards/{board}/swimlanes/{swimlane}", data)
+    req, err := http.NewRequest("DELETE", "/api/boards/{board}/swimlanes/{swimlane}", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -12989,252 +11147,14 @@ UserSecurity
 
{
   "cardId": "string",
   "title": "string",
-  "finishedAt": "string",
-  "createdAt": "string",
-  "modifiedAt": "string",
-  "sort": 0
-}
-
-

-
A Checklist

-
Properties

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
cardIdstringtruenoneThe ID of the card the checklist is in
titlestringtruenonethe title of the checklist
finishedAtstring|nullfalsenoneWhen was the checklist finished
createdAtstringtruenoneCreation date of the checklist
modifiedAtstringtruenonenone
sortnumbertruenonesorting value of the checklist

-
CustomFields

-

-
{
-  "boardIds": [
-    "string"
-  ],
-  "name": "string",
-  "type": "text",
-  "settings": {
-    "dropdownItems": [
-      {}
-    ]
-  },
-  "showOnCard": true,
-  "automaticallyOnCard": true,
-  "showLabelOnMiniCard": true,
-  "createdAt": "string",
-  "modifiedAt": "string"
-}
-
-

-
A custom field on a card in the board

-
Properties

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
boardIds[string]truenonethe ID of the board
namestringtruenonename of the custom field
typestringtruenonetype of the custom field
settingsCustomFieldsSettingstruenonesettings of the custom field
showOnCardbooleantruenoneshould we show on the cards this custom field
automaticallyOnCardbooleantruenoneshould the custom fields automatically be added on cards?
showLabelOnMiniCardbooleantruenoneshould the label of the custom field be shown on minicards?
createdAtstring|nullfalsenonenone
modifiedAtstringtruenonenone

-
Enumerated Values

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
PropertyValue
typetext
typenumber
typedate
typedropdown

-
CustomFieldsSettings

-

-
{
-  "dropdownItems": [
-    {}
-  ]
-}
-
-

-
Properties

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameTypeRequiredRestrictionsDescription
dropdownItems[CustomFieldsSettingsDropdownitems]falsenonelist of drop down items objects

-
CustomFieldsSettingsDropdownitems

-

-
{}
-
-

-
Properties

-
None

-
Integrations

-

-
{
-  "enabled": true,
-  "title": "string",
-  "type": "string",
-  "activities": [
-    "string"
-  ],
-  "url": "string",
-  "token": "string",
-  "boardId": "string",
+  "finishedAt": "string",
   "createdAt": "string",
   "modifiedAt": "string",
-  "userId": "string"
+  "sort": 0
 }
 
 

-
Integration with third-party applications

+
A Checklist

 
Properties

 
@@ -13248,60 +11168,32 @@ UserSecurity
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
+
-
+
@@ -13311,37 +11203,36 @@ UserSecurity
 
-
-
+
+
-
+

 
 
 
enabledbooleantruenoneis the integration enabled?
titlestring|nullfalsenonename of the integration
typecardId
 string
 true
 nonetype of the integratation (Default to 'outgoing-webhooks')
activities[string]truenoneactivities the integration gets triggered (list)The ID of the card the checklist is in
 

 
urltitle
 string
 true
 nonenonethe title of the checklist
 

 
tokenfinishedAt
 string|null
 false
 nonetoken of the integration
boardIdstringtruenoneBoard ID of the integrationWhen was the checklist finished
 

 

 createdAt
 string
 true
 noneCreation date of the integrationCreation date of the checklist
 

 

 modifiedAtnone
 

 
userIdstringsortnumber
 true
 noneuser ID who created the interationsorting value of the checklist
 

 
 

-
Lists

-

+
CustomFields

+

 
{
-  "title": "string",
-  "starred": true,
-  "archived": true,
-  "boardId": "string",
-  "swimlaneId": "string",
-  "createdAt": "string",
-  "sort": 0,
-  "updatedAt": "string",
-  "modifiedAt": "string",
-  "wipLimit": {
-    "value": 0,
-    "enabled": true,
-    "soft": true
+  "boardIds": [
+    "string"
+  ],
+  "name": "string",
+  "type": "text",
+  "settings": {
+    "dropdownItems": [
+      {}
+    ]
   },
-  "color": "white",
-  "type": "string"
+  "showOnCard": true,
+  "automaticallyOnCard": true,
+  "showLabelOnMiniCard": true,
+  "createdAt": "string",
+  "modifiedAt": "string"
 }
 
 

-
A list (column) in the Wekan board.

+
A custom field on a card in the board

 
Properties

 
@@ -13355,88 +11246,67 @@ UserSecurity
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
-
+
+
-
-
-
-
-
-
-
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
+
-
+
-
+
-
+

 
 
 
titlestringtruenonethe title of the list
starredboolean|nullfalsenoneif a list is stared then we put it on the top
archivedbooleanboardIds[string]
 true
 noneis the list archivedthe ID of the board
 

 
boardIdname
 string
 true
 nonethe board associated to this listname of the custom field
 

 
swimlaneIdtype
 string
 true
 nonethe swimlane associated to this list. Used for templatestype of the custom field
 

 
createdAtstringsettingsCustomFieldsSettings
 true
 nonecreation date
sortnumber|nullfalsenoneis the list sortedsettings of the custom field
 

 
updatedAtstring|nullfalseshowOnCardbooleantrue
 nonelast update of the listshould we show on the cards this custom field
 

 
modifiedAtstringautomaticallyOnCardboolean
 true
 nonenoneshould the custom fields automatically be added on cards?
 

 
wipLimitListsWiplimitfalseshowLabelOnMiniCardbooleantrue
 noneWIP object, see belowshould the label of the custom field be shown on minicards?
 

 
colorcreatedAt
 string|null
 false
 nonethe color of the listnone
 

 
typemodifiedAt
 string
 true
 noneThe type of listnone
 

 
 

@@ -13450,112 +11320,79 @@ UserSecurity
 
 
 
-color
-white
-
-
-color
-green
-
-
-color
-yellow
-
-
-color
-orange
-
-
-color
-red
-
-
-color
-purple
-
-
-color
-blue
-
-
-color
-sky
-
-
-color
-lime
-
-
-color
-pink
-
-
-color
-black
-
-
-color
-peachpuff
-
-
-color
-crimson
-
-
-color
-plum
-
-
-color
-darkgreen
-
-
-color
-slateblue
-
-
-color
-magenta
-
-
-color
-gold
-
-
-color
-navy
+type
+text
 
 
-color
-gray
+type
+number
 
 
-color
-saddlebrown
+type
+date
 
 
-color
-paleturquoise
+type
+dropdown
 
+
+
+
CustomFieldsSettings

+

+
{
+  "dropdownItems": [
+    {}
+  ]
+}
+
+

+
Properties

+
+
-
-
+
+
+
+
+
+
+
-
-
+
+
+
+
+

 
colormistyroseNameTypeRequiredRestrictionsDescription
 

 
colorindigodropdownItems[CustomFieldsSettingsDropdownitems]falsenonelist of drop down items objects
 

 
 

-
ListsWiplimit

-

+
CustomFieldsSettingsDropdownitems

+

+
{}
+
+

+
Properties

+
None

+
Integrations

+

 
{
-  "value": 0,
   "enabled": true,
-  "soft": true
+  "title": "string",
+  "type": "string",
+  "activities": [
+    "string"
+  ],
+  "url": "string",
+  "token": "string",
+  "boardId": "string",
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "userId": "string"
 }
 
 

+
Integration with third-party applications

 
Properties

 
@@ -13569,44 +11406,100 @@ UserSecurity
 
-
-
+
+
-
+
-
-
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
valuenumberenabledboolean
 true
 nonevalue of the WIPis the integration enabled?
 

 
enabledbooleantitlestring|nullfalsenonename of the integration
typestring
 true
 noneis the WIP enabledtype of the integratation (Default to 'outgoing-webhooks')
 

 
softbooleanactivities[string]
 true
 noneis the WIP a soft or hard requirementactivities the integration gets triggered (list)
urlstringtruenonenone
tokenstring|nullfalsenonetoken of the integration
boardIdstringtruenoneBoard ID of the integration
createdAtstringtruenoneCreation date of the integration
modifiedAtstringtruenonenone
userIdstringtruenoneuser ID who created the interation
 

 
 

-
Swimlanes

-

+
Lists

+

 
{
   "title": "string",
+  "starred": true,
   "archived": true,
   "boardId": "string",
+  "swimlaneId": "string",
   "createdAt": "string",
   "sort": 0,
-  "color": "white",
   "updatedAt": "string",
   "modifiedAt": "string",
+  "wipLimit": {
+    "value": 0,
+    "enabled": true,
+    "soft": true
+  },
+  "color": "white",
   "type": "string"
 }
 
 

-
A swimlane is an line in the kaban board.

+
A list (column) in the Wekan board.

 
Properties

 
@@ -13624,49 +11517,56 @@ UserSecurity
 
-
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
+
@@ -13676,11 +11576,25 @@ UserSecurity
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+

 
string
 true
 nonethe title of the swimlanethe title of the list
starredboolean|nullfalsenoneif a list is stared then we put it on the top
 

 

 archived
 boolean
 true
 noneis the swimlane archived?is the list archived
 

 

 boardId
 string
 true
 nonethe ID of the board the swimlane is attached tothe board associated to this list
 

 
createdAtswimlaneId
 string
 true
 nonecreation date of the swimlanethe swimlane associated to this list. Used for templates
 

 
sortnumber|nullfalsecreatedAtstringtrue
 nonethe sort value of the swimlanecreation date
 

 
colorstring|nullsortnumber|null
 false
 nonethe color of the swimlaneis the list sorted
 

 

 updatedAt
 string|null
 false
 nonewhen was the swimlane last editedlast update of the list
 

 

 modifiedAtnone
 

 
wipLimitListsWiplimitfalsenoneWIP object, see below
colorstring|nullfalsenonethe color of the list

 type
 string
 true
 noneThe type of swimlaneThe type of list
 

 
 

@@ -13755,189 +11669,48 @@ UserSecurity
 
 
 color
-slateblue
-
-
-color
-magenta
-
-
-color
-gold
-
-
-color
-navy
-
-
-color
-gray
-
-
-color
-saddlebrown
-
-
-color
-paleturquoise
-
-
-color
-mistyrose
-
-
-color
-indigo
-
-
-
-
Users

-

-
{
-  "username": "string",
-  "emails": [
-    {
-      "address": "string",
-      "verified": true
-    }
-  ],
-  "createdAt": "string",
-  "modifiedAt": "string",
-  "profile": {
-    "avatarUrl": "string",
-    "emailBuffer": [
-      "string"
-    ],
-    "fullname": "string",
-    "showDesktopDragHandles": true,
-    "hiddenSystemMessages": true,
-    "hiddenMinicardLabelText": true,
-    "initials": "string",
-    "invitedBoards": [
-      "string"
-    ],
-    "language": "string",
-    "notifications": [],
-    "activity": "string",
-    "read": "string",
-    "showCardsCountAt": 0,
-    "starredBoards": [
-      "string"
-    ],
-    "icode": "string",
-    "boardView": "board-view-lists",
-    "listSortBy": "-modifiedat",
-    "templatesBoardId": "string",
-    "cardTemplatesSwimlaneId": "string",
-    "listTemplatesSwimlaneId": "string",
-    "boardTemplatesSwimlaneId": "string"
-  },
-  "services": {},
-  "heartbeat": "string",
-  "isAdmin": true,
-  "createdThroughApi": true,
-  "loginDisabled": true,
-  "authenticationMethod": "string"
-}
-
-

-
A User in wekan

-
Properties

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
NameTypeRequiredRestrictionsDescription
usernamestring|nullfalsenonethe username of the user
emails[UsersEmails]|nullfalsenonethe list of emails attached to a user
createdAtstringtruenonecreation date of the userslateblue
 

 
modifiedAtstringtruenonenonecolormagenta
 

 
profileUsersProfilefalsenoneprofile settingscolorgold
 

 
servicesobject|nullfalsenoneservices field of the usercolornavy
 

 
heartbeatstring|nullfalsenonelast time the user has been seencolorgray
 

 
isAdminboolean|nullfalsenoneis the user an admin of the board?colorsaddlebrown
 

 
createdThroughApiboolean|nullfalsenonewas the user created through the API?colorpaleturquoise
 

 
loginDisabledboolean|nullfalsenoneloginDisabled field of the usercolormistyrose
 

 
authenticationMethodstringtruenoneauthentication method of the usercolorindigo
 

 
 

-
UsersEmails

-

+
ListsWiplimit

+

 
{
-  "address": "string",
-  "verified": true
+  "value": 0,
+  "enabled": true,
+  "soft": true
 }
 
 

@@ -13954,54 +11727,44 @@ UserSecurity
 
 
 
-address
-string
+value
+number
+true
+none
+value of the WIP
+
+
+enabled
+boolean
 true
 none
-The email address
+is the WIP enabled
 
 
-verified
+soft
 boolean
 true
 none
-Has the email been verified
+is the WIP a soft or hard requirement
 
 
 
-
UsersProfile

-

+
Swimlanes

+

 
{
-  "avatarUrl": "string",
-  "emailBuffer": [
-    "string"
-  ],
-  "fullname": "string",
-  "showDesktopDragHandles": true,
-  "hiddenSystemMessages": true,
-  "hiddenMinicardLabelText": true,
-  "initials": "string",
-  "invitedBoards": [
-    "string"
-  ],
-  "language": "string",
-  "notifications": [],
-  "activity": "string",
-  "read": "string",
-  "showCardsCountAt": 0,
-  "starredBoards": [
-    "string"
-  ],
-  "icode": "string",
-  "boardView": "board-view-lists",
-  "listSortBy": "-modifiedat",
-  "templatesBoardId": "string",
-  "cardTemplatesSwimlaneId": "string",
-  "listTemplatesSwimlaneId": "string",
-  "boardTemplatesSwimlaneId": "string"
+  "title": "string",
+  "archived": true,
+  "boardId": "string",
+  "createdAt": "string",
+  "sort": 0,
+  "color": "white",
+  "updatedAt": "string",
+  "modifiedAt": "string",
+  "type": "string"
 }
 
 

+
A swimlane is an line in the kaban board.

 
Properties

 
@@ -14015,241 +11778,217 @@ UserSecurity
 
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
+
-
-
+
-
+
-
+
+
+

 
 
 
avatarUrltitle
 stringfalsetrue
 noneURL of the avatar of the userthe title of the swimlane
 

 
emailBuffer[string]falsearchivedbooleantrue
 nonelist of email buffers of the useris the swimlane archived?
 

 
fullnameboardId
 stringfalsetrue
 nonefull name of the userthe ID of the board the swimlane is attached to
 

 
showDesktopDragHandlesbooleanfalsecreatedAtstringtrue
 nonedoes the user want to hide system messages?creation date of the swimlane
 

 
hiddenSystemMessagesbooleansortnumber|null
 false
 nonedoes the user want to hide system messages?the sort value of the swimlane
 

 
hiddenMinicardLabelTextbooleancolorstring|null
 false
 nonedoes the user want to hide minicard label texts?the color of the swimlane
 

 
initialsstringupdatedAtstring|null
 false
 noneinitials of the userwhen was the swimlane last edited
 

 
invitedBoards[string]falsemodifiedAtstringtruenone
 noneboard IDs the user has been invited to
 

 
languagetype
 stringfalsetrue
 nonelanguage of the userThe type of swimlane
 

+
Enumerated Values

+
+
-
-
-
-
-
+
+
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-
-
-
-
+
+
-
-

 
notifications[UsersProfileNotifications]falsenoneenabled notifications for the userPropertyValue
 

 
activitystringtruenoneThe id of the activity this notification referencescolorwhite
 

 
readstringfalsenonethe date on which this notification was readcolorgreen
 

 
showCardsCountAtnumberfalsenoneshowCardCountAt field of the usercoloryellow
 

 
starredBoards[string]falsenonelist of starred board IDscolororange
 

 
icodestringfalsenoneicodecolorred
 

 
boardViewstringfalsenoneboardView field of the usercolorpurple
 

 
listSortBystringfalsenonedefault sort list for usercolorblue
 

 
templatesBoardIdstringtruenoneReference to the templates boardcolorsky
 

 
cardTemplatesSwimlaneIdstringtruenoneReference to the card templates swimlane Idcolorlime
 

 
listTemplatesSwimlaneIdstringtruenoneReference to the list templates swimlane Idcolorpink
 

 
boardTemplatesSwimlaneIdstringtruenoneReference to the board templates swimlane Idcolorblack
 

-
Enumerated Values

-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
+
+
+
+

 
PropertyValuecolorpeachpuff
colorcrimson
colorplum
 

 
boardViewboard-view-listscolordarkgreen
 

 
boardViewboard-view-swimlanescolorslateblue
 

 
boardViewboard-view-calcolormagenta
 

 
listSortBy-modifiedatcolorgold
 

 
listSortBymodifiedatcolornavy
 

 
listSortBy-titlecolorgray
 

 
listSortBytitlecolorsaddlebrown
 

 
listSortBy-sortcolorpaleturquoise
 

 
listSortBysortcolormistyrose
colorindigo
- +
- - + + Shell - - - + + + HTTP - - - + + + JavaScript - - - + + + Node.js - - - + + + Ruby - - - + + + Python - - - + + + Java - - - + + + Go - - + +
- +
diff --git a/public/api/wekan.yml b/public/api/wekan.yml index 8cd4acfa..0d40ae99 100644 --- a/public/api/wekan.yml +++ b/public/api/wekan.yml @@ -1,7 +1,7 @@ swagger: '2.0' info: title: Wekan REST API - version: v3.97 + version: v3.98 description: | The REST API allows you to control and extend Wekan with ease. @@ -1276,104 +1276,6 @@ paths: '200': description: |- 200 response - /api/boards/{board}/members/{user}/add: - post: - operationId: add_board_member - summary: Add New Board Member with Role - description: | - Only the admin user (the first user) can call the REST API. - - **Note**: see [Boards.set_board_member_permission](#set_board_member_permission) - to later change the permissions. - tags: - - Users - - Boards - consumes: - - multipart/form-data - - application/json - parameters: - - name: action - in: formData - description: the action value - type: string - required: true - - name: isAdmin - in: formData - description: | - is the user an admin of the board - type: boolean - required: true - - name: isNoComments - in: formData - description: | - disable comments - type: boolean - required: true - - name: isCommentOnly - in: formData - description: | - only enable comments - type: boolean - required: true - - name: board - in: path - description: | - the board ID - type: string - required: true - - name: user - in: path - description: | - the user ID - type: string - required: true - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - type: object - properties: - _id: - type: string - title: - type: string - /api/boards/{board}/members/{user}/remove: - post: - operationId: post_board_user_remove - tags: - - Users - consumes: - - multipart/form-data - - application/json - parameters: - - name: action - in: formData - description: the action value - type: string - required: true - - name: board - in: path - description: the board value - type: string - required: true - - name: user - in: path - description: the user value - type: string - required: true - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response /api/boards/{board}/swimlanes: get: operationId: get_all_swimlanes @@ -1490,184 +1392,6 @@ paths: '200': description: |- 200 response - /api/user: - get: - operationId: get_current_user - summary: returns the current user - tags: - - Users - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - $ref: "#/definitions/Users" - /api/users: - get: - operationId: get_all_users - summary: return all the users - description: | - Only the admin user (the first user) can call the REST API. - tags: - - Users - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - type: array - items: - type: object - properties: - _id: - type: string - username: - type: string - post: - operationId: new_user - summary: Create a new user - description: | - Only the admin user (the first user) can call the REST API. - tags: - - Users - consumes: - - multipart/form-data - - application/json - parameters: - - name: username - in: formData - description: | - the new username - type: string - required: true - - name: email - in: formData - description: | - the email of the new user - type: string - required: true - - name: password - in: formData - description: | - the password of the new user - type: string - required: true - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - type: object - properties: - _id: - type: string - /api/users/{user}: - get: - operationId: get_user - summary: get a given user - description: | - Only the admin user (the first user) can call the REST API. - tags: - - Users - parameters: - - name: user - in: path - description: | - the user ID - type: string - required: true - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - $ref: "#/definitions/Users" - put: - operationId: edit_user - summary: edit a given user - description: | - Only the admin user (the first user) can call the REST API. - - Possible values for *action*: - - `takeOwnership`: The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on. - - `disableLogin`: Disable a user (the user is not allowed to login and his login tokens are purged) - - `enableLogin`: Enable a user - tags: - - Users - consumes: - - multipart/form-data - - application/json - parameters: - - name: action - in: formData - description: | - the action - type: string - required: true - - name: user - in: path - description: | - the user ID - type: string - required: true - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - type: object - properties: - _id: - type: string - title: - type: string - delete: - operationId: delete_user - summary: Delete a user - description: | - Only the admin user (the first user) can call the REST API. - tags: - - Users - parameters: - - name: user - in: path - description: | - the ID of the user to delete - type: string - required: true - produces: - - application/json - security: - - UserSecurity: [] - responses: - '200': - description: |- - 200 response - schema: - type: object - properties: - _id: - type: string /api/users/{user}/boards: get: operationId: get_boards_from_user @@ -2407,196 +2131,3 @@ definitions: - createdAt - modifiedAt - type - Users: - type: object - description: A User in wekan - properties: - username: - description: | - the username of the user - type: string - x-nullable: true - emails: - description: | - the list of emails attached to a user - type: array - items: - $ref: "#/definitions/UsersEmails" - x-nullable: true - createdAt: - description: | - creation date of the user - type: string - modifiedAt: - type: string - profile: - description: | - profile settings - $ref: "#/definitions/UsersProfile" - x-nullable: true - services: - description: | - services field of the user - type: object - x-nullable: true - heartbeat: - description: | - last time the user has been seen - type: string - x-nullable: true - isAdmin: - description: | - is the user an admin of the board? - type: boolean - x-nullable: true - createdThroughApi: - description: | - was the user created through the API? - type: boolean - x-nullable: true - loginDisabled: - description: | - loginDisabled field of the user - type: boolean - x-nullable: true - authenticationMethod: - description: | - authentication method of the user - type: string - required: - - createdAt - - modifiedAt - - authenticationMethod - UsersEmails: - type: object - properties: - address: - description: | - The email address - type: string - verified: - description: | - Has the email been verified - type: boolean - required: - - address - - verified - UsersProfile: - type: object - properties: - avatarUrl: - description: | - URL of the avatar of the user - type: string - emailBuffer: - description: | - list of email buffers of the user - type: array - items: - type: string - x-nullable: true - fullname: - description: | - full name of the user - type: string - showDesktopDragHandles: - description: | - does the user want to hide system messages? - type: boolean - hiddenSystemMessages: - description: | - does the user want to hide system messages? - type: boolean - hiddenMinicardLabelText: - description: | - does the user want to hide minicard label texts? - type: boolean - initials: - description: | - initials of the user - type: string - invitedBoards: - description: | - board IDs the user has been invited to - type: array - items: - type: string - x-nullable: true - language: - description: | - language of the user - type: string - notifications: - description: | - enabled notifications for the user - type: array - items: - $ref: "#/definitions/UsersProfileNotifications" - activity: - description: | - The id of the activity this notification references - type: string - read: - description: | - the date on which this notification was read - type: string - showCardsCountAt: - description: | - showCardCountAt field of the user - type: number - startDayOfWeek: - description: | - startDayOfWeek field of the user - type: number - starredBoards: - description: | - list of starred board IDs - type: array - items: - type: string - x-nullable: true - icode: - description: | - icode - type: string - boardView: - description: | - boardView field of the user - type: string - enum: - - board-view-lists - - board-view-swimlanes - - board-view-cal - listSortBy: - description: | - default sort list for user - type: string - enum: - - -modifiedat - - modifiedat - - -title - - title - - -sort - - sort - templatesBoardId: - description: | - Reference to the templates board - type: string - cardTemplatesSwimlaneId: - description: | - Reference to the card templates swimlane Id - type: string - listTemplatesSwimlaneId: - description: | - Reference to the list templates swimlane Id - type: string - boardTemplatesSwimlaneId: - description: | - Reference to the board templates swimlane Id - type: string - required: - - activity - - templatesBoardId - - cardTemplatesSwimlaneId - - listTemplatesSwimlaneId - - boardTemplatesSwimlaneId -- cgit v1.2.3-1-g7c22