-
-## Edit titles and descriptions of Many Cards
-```
-[ {"title": "First card title", "description":"First card description"},
-{"title":"Second card title","description":"Second card description"},
-{"title":"Last card title","description":"Last card description"} ]
-```
-
-
-
diff --git a/docs/Login/LDAP.md b/docs/Login/LDAP.md
index 33f885ea6..ba9d299e0 100644
--- a/docs/Login/LDAP.md
+++ b/docs/Login/LDAP.md
@@ -52,15 +52,7 @@ sudo snap set wekan ldap-authentication-userdn='CN=LDAP-User,OU=Service Accounts
sudo snap set wekan ldap-authentication-password='Wekan REST API v7.85
+Wekan REST API v7.80
@@ -1995,47 +2100,28 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reducScroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
# You can also use wget
curl -X POST /users/login \
- -H 'Content-Type: application/x-www-form-urlencoded' \
- -H 'Accept: */*'
+ -H 'Content-Type: application/x-www-form-urlencoded' \
+ -H 'Accept: */*'
POST /users/login HTTP/1.1
+POST /users/login HTTP/1.1
-Content-Type: application/x-www-form-urlencoded
-Accept: */*
+Content-Type: application/x-www-form-urlencoded
+Accept: */*
-
-var headers = {
- 'Content-Type':'application/x-www-form-urlencoded',
- 'Accept':'*/*'
-
-};
-
-$.ajax({
- url: '/users/login',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "username": "string",
- "password": "pa$$word"
-}';
+
+const inputBody = '{
+ "username": "string",
+ "password": "pa$$word"
+}';
const headers = {
- 'Content-Type':'application/x-www-form-urlencoded',
- 'Accept':'*/*'
-
+ 'Content-Type':'application/x-www-form-urlencoded',
+ 'Accept':'*/*'
};
-fetch('/users/login',
+fetch('/users/login',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -2046,15 +2132,38 @@ fetch('/users/login',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "username": "string",
+ "password": "pa$$word"
+};
+const headers = {
+ 'Content-Type':'application/x-www-form-urlencoded',
+ 'Accept':'*/*'
+};
+
+fetch('/users/login',
+{
+ method: 'POST',
+ body: JSON.stringify(inputBody),
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+require 'rest-client'
+require 'json'
headers = {
- 'Content-Type' => 'application/x-www-form-urlencoded',
- 'Accept' => '*/*'
+ 'Content-Type' => 'application/x-www-form-urlencoded',
+ 'Accept' => '*/*'
}
-result = RestClient.post '/users/login',
+result = RestClient.post '/users/login',
params: {
}, headers: headers
@@ -2063,20 +2172,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'application/x-www-form-urlencoded',
- 'Accept': '*/*'
+ 'Content-Type': 'application/x-www-form-urlencoded',
+ 'Accept': '*/*'
}
-r = requests.post('/users/login', params={
+r = requests.post('/users/login', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/users/login");
+URL obj = new URL("/users/login");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -2092,20 +2199,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"application/x-www-form-urlencoded"},
- "Accept": []string{"*/*"},
-
+ "Content-Type": []string{"application/x-www-form-urlencoded"},
+ "Accept": []string{"*/*"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/users/login", data)
+ req, err := http.NewRequest("POST", "/users/login", data)
req.Header = headers
client := &http.Client{}
@@ -2113,6 +2219,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/x-www-form-urlencoded',
+ 'Accept' => '*/*',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/users/login', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /users/login
Login with REST API
@@ -2139,7 +2270,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -2269,48 +2400,29 @@ This operation does not require authentication
# You can also use wget
curl -X POST /users/register \
- -H 'Content-Type: application/x-www-form-urlencoded' \
- -H 'Accept: */*'
+ -H 'Content-Type: application/x-www-form-urlencoded' \
+ -H 'Accept: */*'
-POST /users/register HTTP/1.1
+POST /users/register HTTP/1.1
-Content-Type: application/x-www-form-urlencoded
-Accept: */*
+Content-Type: application/x-www-form-urlencoded
+Accept: */*
-
-var headers = {
- 'Content-Type':'application/x-www-form-urlencoded',
- 'Accept':'*/*'
-
-};
-
-$.ajax({
- url: '/users/register',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "username": "string",
- "password": "pa$$word",
- "email": "string"
-}';
+
+const inputBody = '{
+ "username": "string",
+ "password": "pa$$word",
+ "email": "string"
+}';
const headers = {
- 'Content-Type':'application/x-www-form-urlencoded',
- 'Accept':'*/*'
-
+ 'Content-Type':'application/x-www-form-urlencoded',
+ 'Accept':'*/*'
};
-fetch('/users/register',
+fetch('/users/register',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -2321,15 +2433,39 @@ fetch('/users/register',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "username": "string",
+ "password": "pa$$word",
+ "email": "string"
+};
+const headers = {
+ 'Content-Type':'application/x-www-form-urlencoded',
+ 'Accept':'*/*'
+};
+
+fetch('/users/register',
+{
+ method: 'POST',
+ body: JSON.stringify(inputBody),
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+require 'rest-client'
+require 'json'
headers = {
- 'Content-Type' => 'application/x-www-form-urlencoded',
- 'Accept' => '*/*'
+ 'Content-Type' => 'application/x-www-form-urlencoded',
+ 'Accept' => '*/*'
}
-result = RestClient.post '/users/register',
+result = RestClient.post '/users/register',
params: {
}, headers: headers
@@ -2338,20 +2474,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'application/x-www-form-urlencoded',
- 'Accept': '*/*'
+ 'Content-Type': 'application/x-www-form-urlencoded',
+ 'Accept': '*/*'
}
-r = requests.post('/users/register', params={
+r = requests.post('/users/register', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/users/register");
+URL obj = new URL("/users/register");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -2367,20 +2501,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"application/x-www-form-urlencoded"},
- "Accept": []string{"*/*"},
-
+ "Content-Type": []string{"application/x-www-form-urlencoded"},
+ "Accept": []string{"*/*"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/users/register", data)
+ req, err := http.NewRequest("POST", "/users/register", data)
req.Header = headers
client := &http.Client{}
@@ -2388,6 +2521,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/x-www-form-urlencoded',
+ 'Accept' => '*/*',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/users/register', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /users/register
Register with REST API
@@ -2419,7 +2577,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -2550,45 +2708,31 @@ System.out.println(response.toString());
This operation does not require authentication
Boards
-exportJson
-
+get_public_boards
+
Code samples
# You can also use wget
-curl -X GET /api/boards/{board}/export \
- -H 'Authorization: API_KEY'
+curl -X GET /api/boards \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/export HTTP/1.1
+GET /api/boards HTTP/1.1
-
-var headers = {
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/export',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/export',
+fetch('/api/boards',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -2599,14 +2743,35 @@ fetch('/api/boards/{board}/export',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+require 'rest-client'
+require 'json'
headers = {
- 'Authorization' => 'API_KEY'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/export',
+result = RestClient.get '/api/boards',
params: {
}, headers: headers
@@ -2615,19 +2780,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/export', params={
+r = requests.get('/api/boards', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/export");
+URL obj = new URL("/api/boards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -2643,19 +2807,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/export", data)
+ req, err := http.NewRequest("GET", "/api/boards", data)
req.Header = headers
client := &http.Client{}
@@ -2663,6 +2827,1339 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+GET /api/boards
+Get all public boards
+
+Example responses
+
+
+200 Response
+
+[
+ {
+ "_id": "string",
+ "title": "string"
+ }
+]
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
+
+
+
+
+new_board
+
+
+Code samples
+
+# You can also use wget
+curl -X POST /api/boards \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+POST /api/boards HTTP/1.1
+
+Content-Type: multipart/form-data
+Accept: application/json
+
+
+const inputBody = '{
+ "title": "string",
+ "owner": "string",
+ "isAdmin": true,
+ "isActive": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true,
+ "permission": "string",
+ "color": "string"
+}';
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards',
+{
+ method: 'POST',
+ body: inputBody,
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+const inputBody = {
+ "title": "string",
+ "owner": "string",
+ "isAdmin": true,
+ "isActive": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true,
+ "permission": "string",
+ "color": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards',
+{
+ method: 'POST',
+ body: JSON.stringify(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',
+ 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', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards");
+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", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+POST /api/boards
+Create a board
+This allows to create a board.
+The color has to be chosen between belize, nephritis, pomegranate,
+pumpkin, wisteria, moderatepink, strongcyan,
+limegreen, midnight, dark, relax, corteza:
+ 
+
+Body parameter
+
+title: string
+owner: string
+isAdmin: true
+isActive: true
+isNoComments: true
+isCommentOnly: true
+isWorker: true
+permission: string
+color: string
+
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+body
+body
+object
+true
+none
+
+
+» title
+body
+string
+true
+the new title of the board
+
+
+» owner
+body
+string
+true
+"ABCDE12345" <= User ID in Wekan.
+
+
+» isAdmin
+body
+boolean
+false
+is the owner an admin of the board (default true)
+
+
+» isActive
+body
+boolean
+false
+is the board active (default true)
+
+
+» isNoComments
+body
+boolean
+false
+disable comments (default false)
+
+
+» isCommentOnly
+body
+boolean
+false
+only enable comments (default false)
+
+
+» isWorker
+body
+boolean
+false
+only move cards, assign himself to card and comment (default false)
+
+
+» permission
+body
+string
+false
+"private" board <== Set to "public" if you
+
+
+» color
+body
+string
+false
+the color of the board
+
+
+
+Detailed descriptions
+» owner: "ABCDE12345" <= User ID in Wekan.
+(Not username or email)
+» permission: "private" board <== Set to "public" if you
+want public Wekan board
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string",
+ "defaultSwimlaneId": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» defaultSwimlaneId
+string
+false
+none
+none
+
+
+
+
+get_board
+
+
+Code samples
+
+# You can also use wget
+curl -X GET /api/boards/{board} \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+GET /api/boards/{board} HTTP/1.1
+
+Accept: application/json
+
+
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}',
+{
+ 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}',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}");
+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}", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+GET /api/boards/{board}
+Get the board with that particular ID
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the ID of the board to retrieve the data
+
+
+
+Detailed descriptions
+board: the ID of the board to retrieve the data
+
+Example responses
+
+
+200 Response
+
+{
+ "title": "string",
+ "slug": "string",
+ "archived": true,
+ "archivedAt": "string",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "stars": 0,
+ "labels": [
+ {
+ "_id": "string",
+ "name": "string",
+ "color": "white"
+ }
+ ],
+ "members": [
+ {
+ "userId": "string",
+ "isAdmin": true,
+ "isActive": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true
+ }
+ ],
+ "permission": "public",
+ "orgs": [
+ {
+ "orgId": "string",
+ "orgDisplayName": "string",
+ "isActive": true
+ }
+ ],
+ "teams": [
+ {
+ "teamId": "string",
+ "teamDisplayName": "string",
+ "isActive": true
+ }
+ ],
+ "color": "belize",
+ "backgroundImageURL": "string",
+ "allowsCardCounterList": true,
+ "allowsBoardMemberList": true,
+ "description": "string",
+ "subtasksDefaultBoardId": "string",
+ "subtasksDefaultListId": "string",
+ "dateSettingsDefaultBoardId": "string",
+ "dateSettingsDefaultListId": "string",
+ "allowsSubtasks": true,
+ "allowsAttachments": true,
+ "allowsChecklists": true,
+ "allowsComments": true,
+ "allowsDescriptionTitle": true,
+ "allowsDescriptionText": true,
+ "allowsDescriptionTextOnMinicard": true,
+ "allowsCoverAttachmentOnMinicard": true,
+ "allowsBadgeAttachmentOnMinicard": true,
+ "allowsCardSortingByNumberOnMinicard": true,
+ "allowsCardNumber": true,
+ "allowsActivities": true,
+ "allowsLabels": true,
+ "allowsCreator": true,
+ "allowsCreatorOnMinicard": true,
+ "allowsAssignee": true,
+ "allowsMembers": true,
+ "allowsRequestedBy": true,
+ "allowsCardSortingByNumber": true,
+ "allowsShowLists": true,
+ "allowsAssignedBy": true,
+ "allowsReceivedDate": true,
+ "allowsStartDate": true,
+ "allowsEndDate": true,
+ "allowsDueDate": true,
+ "presentParentTask": "prefix-with-full-path",
+ "receivedAt": "string",
+ "startAt": "string",
+ "dueAt": "string",
+ "endAt": "string",
+ "spentTime": 0,
+ "isOvertime": true,
+ "type": "board",
+ "sort": 0
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Boards
+
+
+
+
+delete_board
+
+
+Code samples
+
+# You can also use wget
+curl -X DELETE /api/boards/{board} \
+ -H 'Authorization: API_KEY'
+
+
+DELETE /api/boards/{board} HTTP/1.1
+
+
+
+const headers = {
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}',
+{
+ method: 'DELETE',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}',
+{
+ 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}',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.delete('/api/boards/{board}', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}");
+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}", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('DELETE','/api/boards/{board}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+DELETE /api/boards/{board}
+Delete a board
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the ID of the board
+
+
+
+Detailed descriptions
+board: the ID of the board
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+None
+
+
+
+
+get_board_attachments
+
+
+Code samples
+
+# You can also use wget
+curl -X GET /api/boards/{board}/attachments \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+GET /api/boards/{board}/attachments HTTP/1.1
+
+Accept: application/json
+
+
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/attachments',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/attachments',
+{
+ 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}/attachments',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}/attachments', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}/attachments");
+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}/attachments", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/attachments', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+GET /api/boards/{board}/attachments
+Get the list of attachments of a board
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the board ID
+
+
+
+Detailed descriptions
+board: the board ID
+
+Example responses
+
+
+200 Response
+
+[
+ {
+ "attachmentId": "string",
+ "attachmentName": "string",
+ "attachmentType": "string",
+ "url": "string",
+ "urlDownload": "string",
+ "boardId": "string",
+ "swimlaneId": "string",
+ "listId": "string",
+ "cardId": "string"
+ }
+]
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» attachmentId
+string
+false
+none
+none
+
+
+» attachmentName
+string
+false
+none
+none
+
+
+» attachmentType
+string
+false
+none
+none
+
+
+» url
+string
+false
+none
+none
+
+
+» urlDownload
+string
+false
+none
+none
+
+
+» boardId
+string
+false
+none
+none
+
+
+» swimlaneId
+string
+false
+none
+none
+
+
+» listId
+string
+false
+none
+none
+
+
+» cardId
+string
+false
+none
+none
+
+
+
+
+exportJson
+
+
+Code samples
+
+# You can also use wget
+curl -X GET /api/boards/{board}/export \
+ -H 'Authorization: API_KEY'
+
+
+GET /api/boards/{board}/export HTTP/1.1
+
+
+
+const headers = {
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/export',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/export',
+{
+ method: 'GET',
+
+ 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.get '/api/boards/{board}/export',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}/export', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}/export");
+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{
+ "Authorization": []string{"API_KEY"},
+ }
+
+ data := bytes.NewBuffer([]byte{jsonReq})
+ req, err := http.NewRequest("GET", "/api/boards/{board}/export", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/export', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/export
This route is used to export the board to a json file format.
@@ -2691,7 +4188,7 @@ for detailed explanations
-Detailed descriptions
+Detailed descriptions
board: the ID of the board we are exporting
Responses
@@ -2716,52 +4213,37 @@ for detailed explanations
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-Checklists
-get_all_checklists
-
+copy_board
+
Code samples
# You can also use wget
-curl -X GET /api/boards/{board}/cards/{card}/checklists \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+curl -X POST /api/boards/{board}/copy \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards/{card}/checklists HTTP/1.1
+POST /api/boards/{board}/copy HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Content-Type: multipart/form-data
+Accept: application/json
+
+const inputBody = '{
+ "title": "string"
+}';
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists',
+fetch('/api/boards/{board}/copy',
{
- method: 'GET',
-
+ method: 'POST',
+ body: inputBody,
headers: headers
})
.then(function(res) {
@@ -2771,15 +4253,39 @@ fetch('/api/boards/{board}/cards/{card}/checklists'
-require 'rest-client'
-require 'json'
+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}/copy',
+{
+ method: 'POST',
+ body: JSON.stringify(inputBody),
+ 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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cards/{card}/checklists',
+result = RestClient.post '/api/boards/{board}/copy',
params: {
}, headers: headers
@@ -2788,20 +4294,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cards/{card}/checklists', params={
+r = requests.post('/api/boards/{board}/copy', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists");
+URL obj = new URL("/api/boards/{board}/copy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -2817,20 +4322,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/checklists", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/copy", data)
req.Header = headers
client := &http.Client{}
@@ -2838,6 +4343,1408 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/copy', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+POST /api/boards/{board}/copy
+Copy a board to a new one
+If your are board admin or wekan admin, this copies the
+given board to a new one.
+
+Body parameter
+
+title: string
+
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the board
+
+
+body
+body
+object
+true
+none
+
+
+» title
+body
+string
+true
+the title of the new board (default to old one)
+
+
+
+Detailed descriptions
+board: the board
+
+Example responses
+
+
+200 Response
+
+"string"
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+string
+
+
+
+
+add_board_label
+
+
+Code samples
+
+# You can also use wget
+curl -X PUT /api/boards/{board}/labels \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+PUT /api/boards/{board}/labels HTTP/1.1
+
+Content-Type: multipart/form-data
+Accept: application/json
+
+
+const inputBody = '{
+ "label": "string"
+}';
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/labels',
+{
+ method: 'PUT',
+ body: inputBody,
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+const inputBody = {
+ "label": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/labels',
+{
+ method: 'PUT',
+ body: JSON.stringify(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/boards/{board}/labels',
+ 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/boards/{board}/labels', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}/labels");
+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/boards/{board}/labels", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('PUT','/api/boards/{board}/labels', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+PUT /api/boards/{board}/labels
+Add a label to a board
+If the board doesn't have the name/color label, this function
+adds the label to the board.
+
+Body parameter
+
+label: string
+
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the board
+
+
+body
+body
+object
+true
+none
+
+
+» label
+body
+string
+true
+the label value
+
+
+
+Detailed descriptions
+board: the board
+
+Example responses
+
+
+200 Response
+
+"string"
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+string
+
+
+
+
+set_board_member_permission
+
+
+Code samples
+
+# You can also use wget
+curl -X POST /api/boards/{board}/members/{member} \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Authorization: API_KEY'
+
+
+POST /api/boards/{board}/members/{member} HTTP/1.1
+
+Content-Type: multipart/form-data
+
+
+const inputBody = '{
+ "isAdmin": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true
+}';
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/members/{member}',
+{
+ method: 'POST',
+ body: inputBody,
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+const inputBody = {
+ "isAdmin": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/members/{member}',
+{
+ method: 'POST',
+ body: JSON.stringify(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',
+ 'Authorization' => 'API_KEY'
+}
+
+result = RestClient.post '/api/boards/{board}/members/{member}',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Content-Type': 'multipart/form-data',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.post('/api/boards/{board}/members/{member}', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}/members/{member}");
+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"},
+ "Authorization": []string{"API_KEY"},
+ }
+
+ data := bytes.NewBuffer([]byte{jsonReq})
+ req, err := http.NewRequest("POST", "/api/boards/{board}/members/{member}", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'multipart/form-data',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/members/{member}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+POST /api/boards/{board}/members/{member}
+Change the permission of a member of a board
+
+Body parameter
+
+isAdmin: true
+isNoComments: true
+isCommentOnly: true
+isWorker: true
+
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the ID of the board that we are changing
+
+
+member
+path
+string
+true
+the ID of the user to change permissions
+
+
+body
+body
+object
+true
+none
+
+
+» isAdmin
+body
+boolean
+true
+admin capability
+
+
+» isNoComments
+body
+boolean
+true
+NoComments capability
+
+
+» isCommentOnly
+body
+boolean
+true
+CommentsOnly capability
+
+
+» isWorker
+body
+boolean
+true
+Worker capability
+
+
+
+Detailed descriptions
+board: the ID of the board that we are changing
+member: the ID of the user to change permissions
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+None
+
+
+
+
+update_board_title
+
+
+Code samples
+
+# You can also use wget
+curl -X PUT /api/boards/{board}/title \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Authorization: API_KEY'
+
+
+PUT /api/boards/{board}/title HTTP/1.1
+
+Content-Type: multipart/form-data
+
+
+const inputBody = '{
+ "title": "string"
+}';
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/title',
+{
+ method: 'PUT',
+ body: inputBody,
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+const inputBody = {
+ "title": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/title',
+{
+ method: 'PUT',
+ body: JSON.stringify(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',
+ 'Authorization' => 'API_KEY'
+}
+
+result = RestClient.put '/api/boards/{board}/title',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Content-Type': 'multipart/form-data',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.put('/api/boards/{board}/title', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}/title");
+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"},
+ "Authorization": []string{"API_KEY"},
+ }
+
+ data := bytes.NewBuffer([]byte{jsonReq})
+ req, err := http.NewRequest("PUT", "/api/boards/{board}/title", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'multipart/form-data',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('PUT','/api/boards/{board}/title', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+PUT /api/boards/{board}/title
+Update the title of a board
+
+Body parameter
+
+title: string
+
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the ID of the board to update
+
+
+body
+body
+object
+true
+none
+
+
+» title
+body
+string
+true
+the new title for the board
+
+
+
+Detailed descriptions
+board: the ID of the board to update
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+None
+
+
+
+
+get_boards_count
+
+
+Code samples
+
+# You can also use wget
+curl -X GET /api/boards_count \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+GET /api/boards_count HTTP/1.1
+
+Accept: application/json
+
+
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards_count',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards_count',
+{
+ 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_count',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards_count', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards_count");
+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_count", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards_count', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+GET /api/boards_count
+Get public and private boards count
+
+Example responses
+
+
+200 Response
+
+{
+ "private": 0,
+ "public": 0
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» private
+integer
+false
+none
+none
+
+
+» public
+integer
+false
+none
+none
+
+
+
+
+get_boards_from_user
+
+
+Code samples
+
+# You can also use wget
+curl -X GET /api/users/{user}/boards \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+GET /api/users/{user}/boards HTTP/1.1
+
+Accept: application/json
+
+
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/users/{user}/boards',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/users/{user}/boards',
+{
+ 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}/boards',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/users/{user}/boards', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/users/{user}/boards");
+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}/boards", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/users/{user}/boards', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
+
+GET /api/users/{user}/boards
+Get all boards attached to a user
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+user
+path
+string
+true
+the ID of the user to retrieve the data
+
+
+
+Detailed descriptions
+user: the ID of the user to retrieve the data
+
+Example responses
+
+
+200 Response
+
+[
+ {
+ "_id": "string",
+ "title": "string"
+ }
+]
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
+
+
+
+
+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
+
+
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists',
+{
+ method: 'GET',
+
+ headers: headers
+})
+.then(function(res) {
+ return res.json();
+}).then(function(body) {
+ console.log(body);
+});
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists',
+{
+ 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}/cards/{card}/checklists',
+ params: {
+ }, headers: headers
+
+p JSON.parse(result)
+
+
+import requests
+headers = {
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}/cards/{card}/checklists', headers = headers)
+
+print(r.json())
+
+
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists");
+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}/cards/{card}/checklists", data)
+ req.Header = headers
+
+ client := &http.Client{}
+ resp, err := client.Do(req)
+ // ...
+}
+
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cards/{card}/checklists', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cards/{card}/checklists
Get the list of checklists attached to a card
@@ -2869,7 +5776,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
@@ -2880,8 +5787,8 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string"
+ "_id": "string",
+ "title": "string"
}
]
@@ -2944,50 +5851,30 @@ UserSecurity
# 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'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/cards/{card}/checklists HTTP/1.1
+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'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "title": "string",
- "items": "string"
-}';
+const inputBody = '{
+ "title": "string",
+ "items": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists',
+fetch('/api/boards/{board}/cards/{card}/checklists',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -2998,16 +5885,40 @@ fetch('/api/boards/{board}/cards/{card}/checklists'
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "title": "string",
+ "items": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/cards/{card}/checklists',
+result = RestClient.post '/api/boards/{board}/cards/{card}/checklists',
params: {
}, headers: headers
@@ -3016,21 +5927,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/cards/{card}/checklists', params={
+r = requests.post('/api/boards/{board}/cards/{card}/checklists', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -3046,21 +5955,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/cards/{card}/checklists", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/cards/{card}/checklists", data)
req.Header = headers
client := &http.Client{}
@@ -3068,6 +5976,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/cards/{card}/checklists', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/cards/{card}/checklists
create a new checklist
@@ -3108,7 +6042,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -3127,7 +6061,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
@@ -3137,7 +6071,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -3192,43 +6126,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards/{card}/checklists/{checklist} HTTP/1.1
+GET /api/boards/{board}/cards/{card}/checklists/{checklist} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists/{checklist}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -3239,15 +6154,35 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cards/{card}/checklists/{checklist}',
+result = RestClient.get '/api/boards/{board}/cards/{card}/checklists/{checklist}',
params: {
}, headers: headers
@@ -3256,20 +6191,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cards/{card}/checklists/{checklist}', params={
+r = requests.get('/api/boards/{board}/cards/{card}/checklists/{checklist}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -3285,20 +6218,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/checklists/{checklist}", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/checklists/{checklist}", data)
req.Header = headers
client := &http.Client{}
@@ -3306,6 +6238,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cards/{card}/checklists/{checklist}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cards/{card}/checklists/{checklist}
Get a checklist
@@ -3344,7 +6301,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the ID of the checklist
@@ -3355,16 +6312,16 @@ System.out.println(response.toString());
200 Response
{
- "cardId": "string",
- "title": "string",
- "finishedAt": "string",
- "createdAt": "string",
- "sort": 0,
- "items": [
+ "cardId": "string",
+ "title": "string",
+ "finishedAt": "string",
+ "createdAt": "string",
+ "sort": 0,
+ "items": [
{
- "_id": "string",
- "title": "string",
- "isFinished": true
+ "_id": "string",
+ "title": "string",
+ "isFinished": true
}
]
}
@@ -3477,43 +6434,24 @@ UserSecurity
# You can also use wget
curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} HTTP/1.1
+DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists/{checklist}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -3524,15 +6462,35 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.delete '/api/boards/{board}/cards/{card}/checklists/{checklist}',
+result = RestClient.delete '/api/boards/{board}/cards/{card}/checklists/{checklist}',
params: {
}, headers: headers
@@ -3541,20 +6499,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.delete('/api/boards/{board}/cards/{card}/checklists/{checklist}', params={
+r = requests.delete('/api/boards/{board}/cards/{card}/checklists/{checklist}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -3570,20 +6526,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/cards/{card}/checklists/{checklist}", data)
+ req, err := http.NewRequest("DELETE", "/api/boards/{board}/cards/{card}/checklists/{checklist}", data)
req.Header = headers
client := &http.Client{}
@@ -3591,6 +6546,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('DELETE','/api/boards/{board}/cards/{card}/checklists/{checklist}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}
Delete a checklist
@@ -3630,7 +6610,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the ID of the checklist to remove
@@ -3641,7 +6621,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -3697,49 +6677,29 @@ UserSecurity
# You can also use wget
curl -X POST /api/boards/{board}/cards/{card}/checklists/{checklist}/items \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/cards/{card}/checklists/{checklist}/items HTTP/1.1
+POST /api/boards/{board}/cards/{card}/checklists/{checklist}/items 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}/cards/{card}/checklists/{checklist}/items',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "title": "string"
-}';
+const inputBody = '{
+ "title": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items',
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -3750,16 +6710,39 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
});
-require 'rest-client'
-require 'json'
+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}/cards/{card}/checklists/{checklist}/items',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/cards/{card}/checklists/{checklist}/items',
+result = RestClient.post '/api/boards/{board}/cards/{card}/checklists/{checklist}/items',
params: {
}, headers: headers
@@ -3768,21 +6751,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/cards/{card}/checklists/{checklist}/items', params={
+r = requests.post('/api/boards/{board}/cards/{card}/checklists/{checklist}/items', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -3798,21 +6779,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/cards/{card}/checklists/{checklist}/items", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/cards/{card}/checklists/{checklist}/items", data)
req.Header = headers
client := &http.Client{}
@@ -3820,6 +6800,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/cards/{card}/checklists/{checklist}/items', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/cards/{card}/checklists/{checklist}/items
add a new item to a checklist
@@ -3866,7 +6872,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -3878,7 +6884,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the ID of the checklist
@@ -3889,7 +6895,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -3944,43 +6950,24 @@ UserSecurity
# 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'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
+GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -3991,15 +6978,35 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+result = RestClient.get '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
params: {
}, headers: headers
@@ -4008,20 +7015,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', params={
+r = requests.get('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -4037,20 +7042,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}", data)
req.Header = headers
client := &http.Client{}
@@ -4058,6 +7062,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}
Get a checklist item
@@ -4103,7 +7132,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the checklist ID
@@ -4115,13 +7144,13 @@ System.out.println(response.toString());
200 Response
{
- "title": "string",
- "sort": 0,
- "isFinished": true,
- "checklistId": "string",
- "cardId": "string",
- "createdAt": "string",
- "modifiedAt": "string"
+ "title": "string",
+ "sort": 0,
+ "isFinished": true,
+ "checklistId": "string",
+ "cardId": "string",
+ "createdAt": "string",
+ "modifiedAt": "string"
}
Responses
@@ -4154,50 +7183,30 @@ UserSecurity
# 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'
+ -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
+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'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
- method: 'put',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "isFinished": "string",
- "title": "string"
-}';
+const inputBody = '{
+ "isFinished": "string",
+ "title": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
{
- method: 'PUT',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -4208,16 +7217,40 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "isFinished": "string",
+ "title": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+{
+ method: 'PUT',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.put '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+result = RestClient.put '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
params: {
}, headers: headers
@@ -4226,21 +7259,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.put('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', params={
+r = requests.put('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("PUT");
+con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -4256,21 +7287,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}", data)
+ req, err := http.NewRequest("PUT", "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}", data)
req.Header = headers
client := &http.Client{}
@@ -4278,6 +7308,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('PUT','/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}
Edit a checklist item
@@ -4351,7 +7407,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the checklist ID
@@ -4363,7 +7419,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -4418,43 +7474,24 @@ UserSecurity
# 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'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
+DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -4465,15 +7502,35 @@ fetch('/api/boards/{board}/cards/{card}/checklists/{ch
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.delete '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+result = RestClient.delete '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
params: {
}, headers: headers
@@ -4482,20 +7539,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.delete('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', params={
+r = requests.delete('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -4511,20 +7566,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}", data)
+ req, err := http.NewRequest("DELETE", "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}", data)
req.Header = headers
client := &http.Client{}
@@ -4532,6 +7586,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('DELETE','/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}
Delete a checklist item
@@ -4578,7 +7657,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the checklist ID
@@ -4590,7 +7669,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -4646,43 +7725,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/comments \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards/{card}/comments HTTP/1.1
+GET /api/boards/{board}/cards/{card}/comments HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/comments',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments',
+fetch('/api/boards/{board}/cards/{card}/comments',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -4693,15 +7753,35 @@ fetch('/api/boards/{board}/cards/{card}/comments'
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cards/{card}/comments',
+result = RestClient.get '/api/boards/{board}/cards/{card}/comments',
params: {
}, headers: headers
@@ -4710,20 +7790,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cards/{card}/comments', params={
+r = requests.get('/api/boards/{board}/cards/{card}/comments', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/comments");
+URL obj = new URL("/api/boards/{board}/cards/{card}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -4739,20 +7817,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/comments", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/comments", data)
req.Header = headers
client := &http.Client{}
@@ -4760,6 +7837,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cards/{card}/comments', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cards/{card}/comments
Get all comments attached to a card
@@ -4791,7 +7893,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
card: the ID of the card
@@ -4802,9 +7904,9 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "comment": "string",
- "authorId": "string"
+ "_id": "string",
+ "comment": "string",
+ "authorId": "string"
}
]
@@ -4874,50 +7976,30 @@ UserSecurity
# 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'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/cards/{card}/comments HTTP/1.1
+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'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/comments',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "authorId": "string",
- "comment": "string"
-}';
+const inputBody = '{
+ "authorId": "string",
+ "comment": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments',
+fetch('/api/boards/{board}/cards/{card}/comments',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -4928,16 +8010,40 @@ fetch('/api/boards/{board}/cards/{card}/comments'
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "authorId": "string",
+ "comment": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/cards/{card}/comments',
+result = RestClient.post '/api/boards/{board}/cards/{card}/comments',
params: {
}, headers: headers
@@ -4946,21 +8052,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/cards/{card}/comments', params={
+r = requests.post('/api/boards/{board}/cards/{card}/comments', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/comments");
+URL obj = new URL("/api/boards/{board}/cards/{card}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -4976,21 +8080,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/cards/{card}/comments", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/cards/{card}/comments", data)
req.Header = headers
client := &http.Client{}
@@ -4998,6 +8101,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/cards/{card}/comments', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/cards/{card}/comments
Add a comment on a card
@@ -5038,7 +8167,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -5057,7 +8186,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
card: the ID of the card
@@ -5067,7 +8196,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -5122,43 +8251,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/comments/{comment} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards/{card}/comments/{comment} HTTP/1.1
+GET /api/boards/{board}/cards/{card}/comments/{comment} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/comments/{comment}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
+fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -5169,15 +8279,35 @@ fetch('/api/boards/{board}/cards/{card}/comments/{comm
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cards/{card}/comments/{comment}',
+result = RestClient.get '/api/boards/{board}/cards/{card}/comments/{comment}',
params: {
}, headers: headers
@@ -5186,20 +8316,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cards/{card}/comments/{comment}', params={
+r = requests.get('/api/boards/{board}/cards/{card}/comments/{comment}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/comments/{comment}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/comments/{comment}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -5215,20 +8343,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/comments/{comment}", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/cards/{card}/comments/{comment}", data)
req.Header = headers
client := &http.Client{}
@@ -5236,6 +8363,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cards/{card}/comments/{comment}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cards/{card}/comments/{comment}
Get a comment on a card
@@ -5274,7 +8426,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
card: the ID of the card
comment: the ID of the comment to retrieve
@@ -5285,12 +8437,12 @@ System.out.println(response.toString());
200 Response
{
- "boardId": "string",
- "cardId": "string",
- "text": "string",
- "createdAt": "string",
- "modifiedAt": "string",
- "userId": "string"
+ "boardId": "string",
+ "cardId": "string",
+ "text": "string",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "userId": "string"
}
Responses
@@ -5323,43 +8475,24 @@ UserSecurity
# You can also use wget
curl -X DELETE /api/boards/{board}/cards/{card}/comments/{comment} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-DELETE /api/boards/{board}/cards/{card}/comments/{comment} HTTP/1.1
+DELETE /api/boards/{board}/cards/{card}/comments/{comment} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards/{card}/comments/{comment}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
+fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -5370,15 +8503,35 @@ fetch('/api/boards/{board}/cards/{card}/comments/{comm
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.delete '/api/boards/{board}/cards/{card}/comments/{comment}',
+result = RestClient.delete '/api/boards/{board}/cards/{card}/comments/{comment}',
params: {
}, headers: headers
@@ -5387,20 +8540,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.delete('/api/boards/{board}/cards/{card}/comments/{comment}', params={
+r = requests.delete('/api/boards/{board}/cards/{card}/comments/{comment}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards/{card}/comments/{comment}");
+URL obj = new URL("/api/boards/{board}/cards/{card}/comments/{comment}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -5416,20 +8567,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/cards/{card}/comments/{comment}", data)
+ req, err := http.NewRequest("DELETE", "/api/boards/{board}/cards/{card}/comments/{comment}", data)
req.Header = headers
client := &http.Client{}
@@ -5437,6 +8587,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('DELETE','/api/boards/{board}/cards/{card}/comments/{comment}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
DELETE /api/boards/{board}/cards/{card}/comments/{comment}
Delete a comment on a card
@@ -5475,7 +8650,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
card: the ID of the card
comment: the ID of the comment to delete
@@ -5486,7 +8661,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -5542,43 +8717,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} HTTP/1.1
+GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
+fetch('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -5589,15 +8745,35 @@ fetch('/api/boards/{board}/cardsByCustomField/{customF
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
+result = RestClient.get '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
params: {
}, headers: headers
@@ -5606,20 +8782,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}', params={
+r = requests.get('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}");
+URL obj = new URL("/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -5635,20 +8809,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}", data)
req.Header = headers
client := &http.Client{}
@@ -5656,6 +8829,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}
Get all Cards that matchs a value of a specific custom field
@@ -5694,7 +8892,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
customField: the list ID
customFieldValue: the value to look for
@@ -5706,11 +8904,11 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string",
- "description": "string",
- "listId": "string",
- "swinlaneId": "string"
+ "_id": "string",
+ "title": "string",
+ "description": "string",
+ "listId": "string",
+ "swinlaneId": "string"
}
]
@@ -5794,43 +8992,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/cards_count \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards_count HTTP/1.1
+GET /api/boards/{board}/cards_count HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/cards_count',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards_count',
+fetch('/api/boards/{board}/cards_count',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -5841,15 +9020,35 @@ fetch('/api/boards/{board}/cards_count',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/cards_count',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/cards_count',
+result = RestClient.get '/api/boards/{board}/cards_count',
params: {
}, headers: headers
@@ -5858,20 +9057,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/cards_count', params={
+r = requests.get('/api/boards/{board}/cards_count', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/cards_count");
+URL obj = new URL("/api/boards/{board}/cards_count");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -5887,20 +9084,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/cards_count", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/cards_count", data)
req.Header = headers
client := &http.Client{}
@@ -5908,6 +9104,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/cards_count', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/cards_count
Get a cards count to a board
@@ -5932,7 +9153,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
Example responses
@@ -5941,7 +9162,7 @@ System.out.println(response.toString());
200 Response
{
- "board_cards_count": 0
+ "board_cards_count": 0
}
Responses
@@ -5996,43 +9217,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/lists/{list}/cards \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/lists/{list}/cards HTTP/1.1
+GET /api/boards/{board}/lists/{list}/cards HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards',
+fetch('/api/boards/{board}/lists/{list}/cards',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -6043,15 +9245,35 @@ fetch('/api/boards/{board}/lists/{list}/cards',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/lists/{list}/cards',
+result = RestClient.get '/api/boards/{board}/lists/{list}/cards',
params: {
}, headers: headers
@@ -6060,20 +9282,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/lists/{list}/cards', params={
+r = requests.get('/api/boards/{board}/lists/{list}/cards', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -6089,20 +9309,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards", data)
req.Header = headers
client := &http.Client{}
@@ -6110,6 +9329,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/lists/{list}/cards', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/lists/{list}/cards
Get all Cards attached to a List
@@ -6141,7 +9385,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
list: the list ID
@@ -6152,9 +9396,9 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string",
- "description": "string"
+ "_id": "string",
+ "title": "string",
+ "description": "string"
}
]
@@ -6224,54 +9468,34 @@ UserSecurity
# You can also use wget
curl -X POST /api/boards/{board}/lists/{list}/cards \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/lists/{list}/cards HTTP/1.1
+POST /api/boards/{board}/lists/{list}/cards 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}/lists/{list}/cards',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "authorId": "string",
- "members": "string",
- "assignees": "string",
- "title": "string",
- "description": "string",
- "swimlaneId": "string"
-}';
+const inputBody = '{
+ "authorId": "string",
+ "members": "string",
+ "assignees": "string",
+ "title": "string",
+ "description": "string",
+ "swimlaneId": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards',
+fetch('/api/boards/{board}/lists/{list}/cards',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -6282,16 +9506,44 @@ fetch('/api/boards/{board}/lists/{list}/cards',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "authorId": "string",
+ "members": "string",
+ "assignees": "string",
+ "title": "string",
+ "description": "string",
+ "swimlaneId": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/lists/{list}/cards',
+result = RestClient.post '/api/boards/{board}/lists/{list}/cards',
params: {
}, headers: headers
@@ -6300,21 +9552,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/lists/{list}/cards', params={
+r = requests.post('/api/boards/{board}/lists/{list}/cards', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -6330,21 +9580,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/lists/{list}/cards", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/lists/{list}/cards", data)
req.Header = headers
client := &http.Client{}
@@ -6352,6 +9601,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/lists/{list}/cards', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/lists/{list}/cards
Create a new Card
@@ -6396,7 +9671,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -6443,7 +9718,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the new card
list: the list ID of the new card
@@ -6453,7 +9728,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -6508,43 +9783,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
+GET /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards/{card}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -6555,15 +9811,35 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/lists/{list}/cards/{card}',
+result = RestClient.get '/api/boards/{board}/lists/{list}/cards/{card}',
params: {
}, headers: headers
@@ -6572,20 +9848,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/lists/{list}/cards/{card}', params={
+r = requests.get('/api/boards/{board}/lists/{list}/cards/{card}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -6601,20 +9875,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards/{card}", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards/{card}", data)
req.Header = headers
client := &http.Client{}
@@ -6622,6 +9895,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/lists/{list}/cards/{card}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/lists/{list}/cards/{card}
Get a Card
@@ -6660,7 +9958,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
list: the list ID of the card
card: the card ID
@@ -6671,104 +9969,102 @@ System.out.println(response.toString());
200 Response
{
- "title": "string",
- "archived": true,
- "archivedAt": "string",
- "parentId": "string",
- "listId": "string",
- "swimlaneId": "string",
- "boardId": "string",
- "coverId": "string",
- "color": "white",
- "createdAt": "string",
- "modifiedAt": "string",
- "customFields": [
+ "title": "string",
+ "archived": true,
+ "archivedAt": "string",
+ "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"
+ "dateLastActivity": "string",
+ "description": "string",
+ "requestedBy": "string",
+ "assignedBy": "string",
+ "labelIds": [
+ "string"
],
- "members": [
- "string"
+ "members": [
+ "string"
],
- "assignees": [
- "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"
+ "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"
+ "negative": [
+ "string"
],
- "end": "string",
- "public": true,
- "allowNonBoardMembers": true
+ "end": "string",
+ "public": true,
+ "allowNonBoardMembers": true
},
- "poker": {
- "question": true,
- "one": [
- "string"
+ "poker": {
+ "question": true,
+ "one": [
+ "string"
],
- "two": [
- "string"
+ "two": [
+ "string"
],
- "three": [
- "string"
+ "three": [
+ "string"
],
- "five": [
- "string"
+ "five": [
+ "string"
],
- "eight": [
- "string"
+ "eight": [
+ "string"
],
- "thirteen": [
- "string"
+ "thirteen": [
+ "string"
],
- "twenty": [
- "string"
+ "twenty": [
+ "string"
],
- "forty": [
- "string"
+ "forty": [
+ "string"
],
- "oneHundred": [
- "string"
+ "oneHundred": [
+ "string"
],
- "unsure": [
- "string"
+ "unsure": [
+ "string"
],
- "end": "string",
- "allowNonBoardMembers": true,
- "estimation": 0
+ "end": "string",
+ "allowNonBoardMembers": true,
+ "estimation": 0
},
- "targetId_gantt": [
- "string"
+ "targetId_gantt": [
+ "string"
],
- "linkType_gantt": [
+ "linkType_gantt": [
0
],
- "linkId_gantt": [
- "string"
+ "linkId_gantt": [
+ "string"
],
- "cardNumber": 0,
- "showActivities": true,
- "hideFinishedChecklistIfItemsAreHidden": true
+ "cardNumber": 0
}
Responses
@@ -6801,74 +10097,54 @@ UserSecurity
# 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'
+ -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
+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'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards/{card}',
- method: 'put',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "newBoardId": "string",
- "newSwimlaneId": "string",
- "newListId": "string",
- "title": "string",
- "sort": "string",
- "parentId": "string",
- "description": "string",
- "color": "string",
- "vote": {},
- "poker": {},
- "labelIds": "string",
- "requestedBy": "string",
- "assignedBy": "string",
- "receivedAt": "string",
- "startAt": "string",
- "dueAt": "string",
- "endAt": "string",
- "spentTime": "string",
- "isOverTime": true,
- "customFields": "string",
- "members": "string",
- "assignees": "string",
- "swimlaneId": "string",
- "listId": "string",
- "authorId": "string",
- "archive": "string"
-}';
+const inputBody = '{
+ "newBoardId": "string",
+ "newSwimlaneId": "string",
+ "newListId": "string",
+ "title": "string",
+ "sort": "string",
+ "parentId": "string",
+ "description": "string",
+ "color": "string",
+ "vote": {},
+ "poker": {},
+ "labelIds": "string",
+ "requestedBy": "string",
+ "assignedBy": "string",
+ "receivedAt": "string",
+ "startAt": "string",
+ "dueAt": "string",
+ "endAt": "string",
+ "spentTime": "string",
+ "isOverTime": true,
+ "customFields": "string",
+ "members": "string",
+ "assignees": "string",
+ "swimlaneId": "string",
+ "listId": "string",
+ "authorId": "string",
+ "archive": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
{
- method: 'PUT',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -6879,16 +10155,64 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "newBoardId": "string",
+ "newSwimlaneId": "string",
+ "newListId": "string",
+ "title": "string",
+ "sort": "string",
+ "parentId": "string",
+ "description": "string",
+ "color": "string",
+ "vote": {},
+ "poker": {},
+ "labelIds": "string",
+ "requestedBy": "string",
+ "assignedBy": "string",
+ "receivedAt": "string",
+ "startAt": "string",
+ "dueAt": "string",
+ "endAt": "string",
+ "spentTime": "string",
+ "isOverTime": true,
+ "customFields": "string",
+ "members": "string",
+ "assignees": "string",
+ "swimlaneId": "string",
+ "listId": "string",
+ "authorId": "string",
+ "archive": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+{
+ method: 'PUT',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.put '/api/boards/{board}/lists/{list}/cards/{card}',
+result = RestClient.put '/api/boards/{board}/lists/{list}/cards/{card}',
params: {
}, headers: headers
@@ -6897,21 +10221,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.put('/api/boards/{board}/lists/{list}/cards/{card}', params={
+r = requests.put('/api/boards/{board}/lists/{list}/cards/{card}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("PUT");
+con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -6927,21 +10249,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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/boards/{board}/lists/{list}/cards/{card}", data)
+ req, err := http.NewRequest("PUT", "/api/boards/{board}/lists/{list}/cards/{card}", data)
req.Header = headers
client := &http.Client{}
@@ -6949,6 +10270,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('PUT','/api/boards/{board}/lists/{list}/cards/{card}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
PUT /api/boards/{board}/lists/{list}/cards/{card}
Edit Fields in a Card
@@ -6971,8 +10318,8 @@ System.out.println(response.toString());
parentId: string
description: string
color: string
-vote: {}
-poker: {}
+vote: {}
+poker: {}
labelIds: string
requestedBy: string
assignedBy: string
@@ -7028,7 +10375,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -7215,7 +10562,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
list: the list ID of the card
card: the ID of the card
@@ -7226,7 +10573,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -7281,43 +10628,24 @@ UserSecurity
# You can also use wget
curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-DELETE /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
+DELETE /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards/{card}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -7328,15 +10656,35 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.delete '/api/boards/{board}/lists/{list}/cards/{card}',
+result = RestClient.delete '/api/boards/{board}/lists/{list}/cards/{card}',
params: {
}, headers: headers
@@ -7345,20 +10693,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.delete('/api/boards/{board}/lists/{list}/cards/{card}', params={
+r = requests.delete('/api/boards/{board}/lists/{list}/cards/{card}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -7374,20 +10720,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/lists/{list}/cards/{card}", data)
+ req, err := http.NewRequest("DELETE", "/api/boards/{board}/lists/{list}/cards/{card}", data)
req.Header = headers
client := &http.Client{}
@@ -7395,6 +10740,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('DELETE','/api/boards/{board}/lists/{list}/cards/{card}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
DELETE /api/boards/{board}/lists/{list}/cards/{card}
Delete a card from a board
@@ -7435,7 +10805,7 @@ is not put in the recycle bin.
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
list: the list ID of the card
card: the ID of the card
@@ -7446,7 +10816,7 @@ is not put in the recycle bin.
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -7501,49 +10871,29 @@ UserSecurity
# You can also use wget
curl -X POST /api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField} \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField} HTTP/1.1
+POST /api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField} 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}/lists/{list}/cards/{card}/customFields/{customField}',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "value": "string"
-}';
+const inputBody = '{
+ "value": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
+fetch('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -7554,16 +10904,39 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}/c
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "value": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
+result = RestClient.post '/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
params: {
}, headers: headers
@@ -7572,21 +10945,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}', params={
+r = requests.post('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -7602,21 +10973,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/lists/{list}/cards/{card}/customFields/{customField}", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}", data)
req.Header = headers
client := &http.Client{}
@@ -7624,6 +10994,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}
Edit Custom Field in a Card
@@ -7678,7 +11074,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -7690,7 +11086,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
list: the list ID of the card
card: the ID of the card
@@ -7702,8 +11098,8 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string",
- "customFields": {}
+ "_id": "string",
+ "customFields": {}
}
Responses
@@ -7765,43 +11161,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/lists/{list}/cards_count \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/lists/{list}/cards_count HTTP/1.1
+GET /api/boards/{board}/lists/{list}/cards_count HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards_count',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards_count',
+fetch('/api/boards/{board}/lists/{list}/cards_count',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -7812,15 +11189,35 @@ fetch('/api/boards/{board}/lists/{list}/cards_count'
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards_count',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/lists/{list}/cards_count',
+result = RestClient.get '/api/boards/{board}/lists/{list}/cards_count',
params: {
}, headers: headers
@@ -7829,20 +11226,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/lists/{list}/cards_count', params={
+r = requests.get('/api/boards/{board}/lists/{list}/cards_count', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards_count");
+URL obj = new URL("/api/boards/{board}/lists/{list}/cards_count");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -7858,20 +11253,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards_count", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards_count", data)
req.Header = headers
client := &http.Client{}
@@ -7879,6 +11273,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/lists/{list}/cards_count', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/lists/{list}/cards_count
Get a cards count to a list
@@ -7910,7 +11329,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
list: the List ID
@@ -7920,7 +11339,7 @@ System.out.println(response.toString());
200 Response
{
- "list_cards_count": 0
+ "list_cards_count": 0
}
Responses
@@ -7975,43 +11394,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/swimlanes/{swimlane}/cards HTTP/1.1
+GET /api/boards/{board}/swimlanes/{swimlane}/cards HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/swimlanes/{swimlane}/cards',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
+fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -8022,15 +11422,35 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}/cards'
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}/cards',
+result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}/cards',
params: {
}, headers: headers
@@ -8039,20 +11459,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/swimlanes/{swimlane}/cards', params={
+r = requests.get('/api/boards/{board}/swimlanes/{swimlane}/cards', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}/cards");
+URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}/cards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -8068,20 +11486,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}/cards", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}/cards", data)
req.Header = headers
client := &http.Client{}
@@ -8089,6 +11506,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/swimlanes/{swimlane}/cards', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/swimlanes/{swimlane}/cards
get all cards attached to a swimlane
@@ -8120,7 +11562,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
swimlane: the swimlane ID
@@ -8131,10 +11573,10 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string",
- "description": "string",
- "listId": "string"
+ "_id": "string",
+ "title": "string",
+ "description": "string",
+ "listId": "string"
}
]
@@ -8212,43 +11654,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/custom-fields \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/custom-fields HTTP/1.1
+GET /api/boards/{board}/custom-fields HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/custom-fields',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields',
+fetch('/api/boards/{board}/custom-fields',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -8259,15 +11682,35 @@ fetch('/api/boards/{board}/custom-fields',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/custom-fields',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/custom-fields',
+result = RestClient.get '/api/boards/{board}/custom-fields',
params: {
}, headers: headers
@@ -8276,20 +11719,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/custom-fields', params={
+r = requests.get('/api/boards/{board}/custom-fields', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/custom-fields");
+URL obj = new URL("/api/boards/{board}/custom-fields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -8305,20 +11746,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/custom-fields", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/custom-fields", data)
req.Header = headers
client := &http.Client{}
@@ -8326,6 +11766,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/custom-fields', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/custom-fields
Get the list of Custom Fields attached to a board
@@ -8358,9 +11823,9 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "name": "string",
- "type": "string"
+ "_id": "string",
+ "name": "string",
+ "type": "string"
}
]
@@ -8430,56 +11895,36 @@ UserSecurity
# You can also use wget
curl -X POST /api/boards/{board}/custom-fields \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/custom-fields HTTP/1.1
+POST /api/boards/{board}/custom-fields 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}/custom-fields',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "name": "string",
- "type": "string",
- "settings": "string",
- "showOnCard": true,
- "automaticallyOnCard": true,
- "showLabelOnMiniCard": true,
- "showSumAtTopOfList": true,
- "authorId": "string"
-}';
+const inputBody = '{
+ "name": "string",
+ "type": "string",
+ "settings": "string",
+ "showOnCard": true,
+ "automaticallyOnCard": true,
+ "showLabelOnMiniCard": true,
+ "showSumAtTopOfList": true,
+ "authorId": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields',
+fetch('/api/boards/{board}/custom-fields',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -8490,16 +11935,46 @@ fetch('/api/boards/{board}/custom-fields',
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "name": "string",
+ "type": "string",
+ "settings": "string",
+ "showOnCard": true,
+ "automaticallyOnCard": true,
+ "showLabelOnMiniCard": true,
+ "showSumAtTopOfList": true,
+ "authorId": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/custom-fields',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/custom-fields',
+result = RestClient.post '/api/boards/{board}/custom-fields',
params: {
}, headers: headers
@@ -8508,21 +11983,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/custom-fields', params={
+r = requests.post('/api/boards/{board}/custom-fields', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/custom-fields");
+URL obj = new URL("/api/boards/{board}/custom-fields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -8538,21 +12011,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/custom-fields", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/custom-fields", data)
req.Header = headers
client := &http.Client{}
@@ -8560,6 +12032,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/custom-fields', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/custom-fields
Create a Custom Field
@@ -8599,7 +12097,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -8667,7 +12165,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -8722,43 +12220,24 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/custom-fields/{customField} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/custom-fields/{customField} HTTP/1.1
+GET /api/boards/{board}/custom-fields/{customField} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/custom-fields/{customField}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields/{customField}',
+fetch('/api/boards/{board}/custom-fields/{customField}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -8769,15 +12248,35 @@ fetch('/api/boards/{board}/custom-fields/{customField}
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/custom-fields/{customField}',
+result = RestClient.get '/api/boards/{board}/custom-fields/{customField}',
params: {
}, headers: headers
@@ -8786,20 +12285,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/custom-fields/{customField}', params={
+r = requests.get('/api/boards/{board}/custom-fields/{customField}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/custom-fields/{customField}");
+URL obj = new URL("/api/boards/{board}/custom-fields/{customField}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -8815,20 +12312,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/custom-fields/{customField}", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/custom-fields/{customField}", data)
req.Header = headers
client := &http.Client{}
@@ -8836,6 +12332,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('GET','/api/boards/{board}/custom-fields/{customField}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
GET /api/boards/{board}/custom-fields/{customField}
Get a Custom Fields attached to a board
@@ -8867,7 +12388,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
customField: the ID of the custom field
Example responses
@@ -8877,8 +12398,8 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "boardIds": "string"
+ "_id": "string",
+ "boardIds": "string"
}
]
@@ -8941,56 +12462,36 @@ UserSecurity
# You can also use wget
curl -X PUT /api/boards/{board}/custom-fields/{customField} \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-PUT /api/boards/{board}/custom-fields/{customField} HTTP/1.1
+PUT /api/boards/{board}/custom-fields/{customField} 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}/custom-fields/{customField}',
- method: 'put',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "name": "string",
- "type": "string",
- "settings": "string",
- "showOnCard": true,
- "automaticallyOnCard": true,
- "alwaysOnCard": "string",
- "showLabelOnMiniCard": true,
- "showSumAtTopOfList": true
-}';
+const inputBody = '{
+ "name": "string",
+ "type": "string",
+ "settings": "string",
+ "showOnCard": true,
+ "automaticallyOnCard": true,
+ "alwaysOnCard": "string",
+ "showLabelOnMiniCard": true,
+ "showSumAtTopOfList": true
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields/{customField}',
+fetch('/api/boards/{board}/custom-fields/{customField}',
{
- method: 'PUT',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -9001,16 +12502,46 @@ fetch('/api/boards/{board}/custom-fields/{customField}
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "name": "string",
+ "type": "string",
+ "settings": "string",
+ "showOnCard": true,
+ "automaticallyOnCard": true,
+ "alwaysOnCard": "string",
+ "showLabelOnMiniCard": true,
+ "showSumAtTopOfList": true
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}',
+{
+ method: 'PUT',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.put '/api/boards/{board}/custom-fields/{customField}',
+result = RestClient.put '/api/boards/{board}/custom-fields/{customField}',
params: {
}, headers: headers
@@ -9019,21 +12550,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.put('/api/boards/{board}/custom-fields/{customField}', params={
+r = requests.put('/api/boards/{board}/custom-fields/{customField}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/custom-fields/{customField}");
+URL obj = new URL("/api/boards/{board}/custom-fields/{customField}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("PUT");
+con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -9049,21 +12578,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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/boards/{board}/custom-fields/{customField}", data)
+ req, err := http.NewRequest("PUT", "/api/boards/{board}/custom-fields/{customField}", data)
req.Header = headers
client := &http.Client{}
@@ -9071,6 +12599,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('PUT','/api/boards/{board}/custom-fields/{customField}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
PUT /api/boards/{board}/custom-fields/{customField}
Update a Custom Field
@@ -9117,7 +12671,7 @@ System.out.println(response.toString());
body
body
object
-false
+true
none
@@ -9185,7 +12739,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -9240,43 +12794,24 @@ UserSecurity
# You can also use wget
curl -X DELETE /api/boards/{board}/custom-fields/{customField} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-DELETE /api/boards/{board}/custom-fields/{customField} HTTP/1.1
+DELETE /api/boards/{board}/custom-fields/{customField} HTTP/1.1
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/custom-fields/{customField}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
+Accept: application/json
+
+
const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields/{customField}',
+fetch('/api/boards/{board}/custom-fields/{customField}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -9287,15 +12822,35 @@ fetch('/api/boards/{board}/custom-fields/{customField}
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}',
+{
+ 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'
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.delete '/api/boards/{board}/custom-fields/{customField}',
+result = RestClient.delete '/api/boards/{board}/custom-fields/{customField}',
params: {
}, headers: headers
@@ -9304,20 +12859,18 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.delete('/api/boards/{board}/custom-fields/{customField}', params={
+r = requests.delete('/api/boards/{board}/custom-fields/{customField}', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/custom-fields/{customField}");
+URL obj = new URL("/api/boards/{board}/custom-fields/{customField}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -9333,20 +12886,19 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "Accept": []string{"application/json"},
+ "Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/custom-fields/{customField}", data)
+ req, err := http.NewRequest("DELETE", "/api/boards/{board}/custom-fields/{customField}", data)
req.Header = headers
client := &http.Client{}
@@ -9354,6 +12906,31 @@ System.out.println(response.toString());
// ...
}
+
+ 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('DELETE','/api/boards/{board}/custom-fields/{customField}', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
DELETE /api/boards/{board}/custom-fields/{customField}
Delete a Custom Fields attached to a board
@@ -9386,7 +12963,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
customField: the ID of the custom field
Example responses
@@ -9395,7 +12972,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -9450,49 +13027,29 @@ UserSecurity
# You can also use wget
curl -X POST /api/boards/{board}/custom-fields/{customField}/dropdown-items \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-POST /api/boards/{board}/custom-fields/{customField}/dropdown-items HTTP/1.1
+POST /api/boards/{board}/custom-fields/{customField}/dropdown-items 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}/custom-fields/{customField}/dropdown-items',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "items": "string"
-}';
+const inputBody = '{
+ "items": "string"
+}';
const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields/{customField}/dropdown-items',
+fetch('/api/boards/{board}/custom-fields/{customField}/dropdown-items',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -9503,16 +13060,39 @@ fetch('/api/boards/{board}/custom-fields/{customField}
});
-require 'rest-client'
-require 'json'
+const fetch = require('node-fetch');
+const inputBody = {
+ "items": "string"
+};
+const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}/dropdown-items',
+{
+ method: 'POST',
+ body: JSON.stringify(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'
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/custom-fields/{customField}/dropdown-items',
+result = RestClient.post '/api/boards/{board}/custom-fields/{customField}/dropdown-items',
params: {
}, headers: headers
@@ -9521,21 +13101,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
+ 'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/custom-fields/{customField}/dropdown-items', params={
+r = requests.post('/api/boards/{board}/custom-fields/{customField}/dropdown-items', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-URL obj = new URL("/api/boards/{board}/custom-fields/{customField}/dropdown-items");
+URL obj = new URL("/api/boards/{board}/custom-fields/{customField}/dropdown-items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -9551,21 +13129,20 @@ System.out.println(response.toString());
package main
import (
- "bytes"
- "net/http"
+ "bytes"
+ "net/http"
)
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "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}/custom-fields/{customField}/dropdown-items", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/custom-fields/{customField}/dropdown-items", data)
req.Header = headers
client := &http.Client{}
@@ -9573,6 +13150,32 @@ System.out.println(response.toString());
// ...
}
+
+ 'multipart/form-data',
+ 'Accept' => 'application/json',
+ 'Authorization' => 'API_KEY',
+);
+
+$client = new \GuzzleHttp\Client();
+
+// Define array of request body.
+$request_body = array();
+
+try {
+ $response = $client->request('POST','/api/boards/{board}/custom-fields/{customField}/dropdown-items', array(
+ 'headers' => $headers,
+ 'json' => $request_body,
+ )
+ );
+ print_r($response->getBody()->getContents());
+ }
+ catch (\GuzzleHttp\Exception\BadResponseException $e) {
+ // handle exception or api errors.
+ print_r($e->getMessage());
+ }
+
+ // ...
+
POST /api/boards/{board}/custom-fields/{customField}/dropdown-items
Update a Custom Field's dropdown items
@@ -9631,7 +13234,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -9686,49 +13289,29 @@ UserSecurity
# You can also use wget
curl -X PUT /api/boards/{board}/custom-fields/{customField}/dropdown-items/{dropdownItem} \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-PUT /api/boards/{board}/custom-fields/{customField}/dropdown-items/{dropdownItem} HTTP/1.1
+