+
+## 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 ba9d299e0..33f885ea6 100644
--- a/docs/Login/LDAP.md
+++ b/docs/Login/LDAP.md
@@ -52,7 +52,15 @@ sudo snap set wekan ldap-authentication-userdn='CN=LDAP-User,OU=Service Accounts
sudo snap set wekan ldap-authentication-password='Wekan REST API v7.80
+Wekan REST API v7.84
@@ -2100,28 +1995,47 @@ 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':'*/*'
-
-const inputBody = '{
- "username": "string",
- "password": "pa$$word"
-}';
-const headers = {
- 'Content-Type':'application/x-www-form-urlencoded',
- 'Accept':'*/*'
};
-fetch('/users/login',
+$.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 headers = {
+ 'Content-Type':'application/x-www-form-urlencoded',
+ 'Accept':'*/*'
+
+};
+
+fetch('/users/login',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -2132,38 +2046,15 @@ fetch('/users/login',
});
-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'
+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
@@ -2172,18 +2063,20 @@ 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', headers = headers)
+r = requests.post('/users/login', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -2199,19 +2092,20 @@ 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{}
@@ -2219,31 +2113,6 @@ 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
@@ -2270,7 +2139,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -2400,29 +2269,48 @@ 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':'*/*'
-
-const inputBody = '{
- "username": "string",
- "password": "pa$$word",
- "email": "string"
-}';
-const headers = {
- 'Content-Type':'application/x-www-form-urlencoded',
- 'Accept':'*/*'
};
-fetch('/users/register',
+$.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 headers = {
+ 'Content-Type':'application/x-www-form-urlencoded',
+ 'Accept':'*/*'
+
+};
+
+fetch('/users/register',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -2433,39 +2321,15 @@ fetch('/users/register',
});
-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'
+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
@@ -2474,18 +2338,20 @@ 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', headers = headers)
+r = requests.post('/users/register', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -2501,19 +2367,20 @@ 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{}
@@ -2521,31 +2388,6 @@ 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
@@ -2577,7 +2419,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -2708,1323 +2550,6 @@ System.out.println(response.toString());
This operation does not require authentication
Boards
-get_public_boards
-
-
-Code samples
-
-# You can also use wget
-curl -X GET /api/boards \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-GET /api/boards HTTP/1.1
-
-Accept: application/json
-
-
-
-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);
-});
-
-
-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 = {
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.get '/api/boards',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.get('/api/boards', headers = headers)
-
-print(r.json())
-
-
-URL obj = new URL("/api/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/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/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
@@ -4032,20 +2557,38 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/export \
- -H 'Authorization: API_KEY'
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/export HTTP/1.1
+GET /api/boards/{board}/export HTTP/1.1
+
+
+var headers = {
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/export',
+$.ajax({
+ url: '/api/boards/{board}/export',
+ method: 'get',
+
+ headers: headers,
+ success: function(data) {
+ console.log(JSON.stringify(data));
+ }
+})
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/export',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -4056,33 +2599,14 @@ fetch('/api/boards/{board}/export',
});
-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'
+require 'rest-client'
+require 'json'
headers = {
- 'Authorization' => 'API_KEY'
+ 'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/export',
+result = RestClient.get '/api/boards/{board}/export',
params: {
}, headers: headers
@@ -4091,17 +2615,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Authorization': 'API_KEY'
+ 'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/export', headers = headers)
+r = requests.get('/api/boards/{board}/export', params={
-print(r.json())
+}, headers = headers)
+
+print r.json()
-URL obj = new URL("/api/boards/{board}/export");
+URL obj = new URL("/api/boards/{board}/export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -4117,18 +2643,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"},
+ "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/{board}/export", data)
req.Header = headers
client := &http.Client{}
@@ -4136,30 +2663,6 @@ System.out.println(response.toString());
// ...
}
-
- '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.
@@ -4188,7 +2691,7 @@ for detailed explanations
-Detailed descriptions
+Detailed descriptions
board: the ID of the board we are exporting
Responses
@@ -4213,1393 +2716,6 @@ for detailed explanations
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-copy_board
-
-
-Code samples
-
-# You can also use wget
-curl -X POST /api/boards/{board}/copy \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-POST /api/boards/{board}/copy HTTP/1.1
-
-Content-Type: multipart/form-data
-Accept: application/json
-
-
-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: 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',
- '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 = {
- 'Content-Type' => 'multipart/form-data',
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.post '/api/boards/{board}/copy',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.post('/api/boards/{board}/copy', headers = headers)
-
-print(r.json())
-
-
-URL obj = new URL("/api/boards/{board}/copy");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
- }
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/api/boards/{board}/copy", 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/{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
@@ -5608,24 +2724,43 @@ UserSecurity
# You can also use wget
curl -X GET /api/boards/{board}/cards/{card}/checklists \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
-GET /api/boards/{board}/cards/{card}/checklists HTTP/1.1
+GET /api/boards/{board}/cards/{card}/checklists HTTP/1.1
-Accept: application/json
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -5636,35 +2771,15 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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',
+result = RestClient.get '/api/boards/{board}/cards/{card}/checklists',
params: {
}, headers: headers
@@ -5673,18 +2788,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/cards/{card}/checklists', params={
-print(r.json())
+}, headers = headers)
+
+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("GET");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -5700,19 +2817,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"},
+ "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("GET", "/api/boards/{board}/cards/{card}/checklists", data)
req.Header = headers
client := &http.Client{}
@@ -5720,31 +2838,6 @@ 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', 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
@@ -5776,7 +2869,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
@@ -5787,8 +2880,8 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string"
+ "_id": "string",
+ "title": "string"
}
]
@@ -5851,30 +2944,50 @@ 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
-const inputBody = '{
- "title": "string",
- "items": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/cards/{card}/checklists',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -5885,40 +2998,16 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -5927,19 +3016,21 @@ 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', headers = headers)
+r = requests.post('/api/boards/{board}/cards/{card}/checklists', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -5955,20 +3046,21 @@ 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{}
@@ -5976,32 +3068,6 @@ 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
@@ -6042,7 +3108,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -6061,7 +3127,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
@@ -6071,7 +3137,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -6126,24 +3192,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -6154,35 +3239,15 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -6191,18 +3256,20 @@ 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}', headers = headers)
+r = requests.get('/api/boards/{board}/cards/{card}/checklists/{checklist}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -6218,19 +3285,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"},
+ "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{}
@@ -6238,31 +3306,6 @@ 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
@@ -6301,7 +3344,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the ID of the checklist
@@ -6312,16 +3355,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
}
]
}
@@ -6434,24 +3477,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -6462,35 +3524,15 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -6499,18 +3541,20 @@ 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}', headers = headers)
+r = requests.delete('/api/boards/{board}/cards/{card}/checklists/{checklist}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -6526,19 +3570,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"},
+ "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{}
@@ -6546,31 +3591,6 @@ 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
@@ -6610,7 +3630,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
@@ -6621,7 +3641,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -6677,29 +3697,49 @@ 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
-const inputBody = '{
- "title": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -6710,39 +3750,16 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -6751,19 +3768,21 @@ 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', headers = headers)
+r = requests.post('/api/boards/{board}/cards/{card}/checklists/{checklist}/items', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -6779,20 +3798,21 @@ 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{}
@@ -6800,32 +3820,6 @@ 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
@@ -6872,7 +3866,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -6884,7 +3878,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the ID of the checklist
@@ -6895,7 +3889,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -6950,24 +3944,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -6978,35 +3991,15 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -7015,18 +4008,20 @@ 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}', headers = headers)
+r = requests.get('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -7042,19 +4037,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"},
+ "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{}
@@ -7062,31 +4058,6 @@ 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
@@ -7132,7 +4103,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the checklist ID
@@ -7144,13 +4115,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
@@ -7183,30 +4154,50 @@ 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
-const inputBody = '{
- "isFinished": "string",
- "title": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
{
- method: 'PUT',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -7217,40 +4208,16 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -7259,19 +4226,21 @@ 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}', headers = headers)
+r = requests.put('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -7287,20 +4256,21 @@ 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{}
@@ -7308,32 +4278,6 @@ 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
@@ -7407,7 +4351,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the checklist ID
@@ -7419,7 +4363,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -7474,24 +4418,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -7502,35 +4465,15 @@ fetch('/api/boards/{board}/cards/{card}/checklist
});
-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'
+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
@@ -7539,18 +4482,20 @@ 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}', headers = headers)
+r = requests.delete('/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -7566,19 +4511,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"},
+ "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{}
@@ -7586,31 +4532,6 @@ 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
@@ -7657,7 +4578,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
card: the card ID
checklist: the checklist ID
@@ -7669,7 +4590,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -7725,24 +4646,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -7753,35 +4693,15 @@ fetch('/api/boards/{board}/cards/{card}/comments&
});
-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'
+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
@@ -7790,18 +4710,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/cards/{card}/comments', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -7817,19 +4739,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"},
+ "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{}
@@ -7837,31 +4760,6 @@ 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
@@ -7893,7 +4791,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
card: the ID of the card
@@ -7904,9 +4802,9 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "comment": "string",
- "authorId": "string"
+ "_id": "string",
+ "comment": "string",
+ "authorId": "string"
}
]
@@ -7976,30 +4874,50 @@ 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
-const inputBody = '{
- "authorId": "string",
- "comment": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/cards/{card}/comments',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -8010,40 +4928,16 @@ fetch('/api/boards/{board}/cards/{card}/comments&
});
-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'
+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
@@ -8052,19 +4946,21 @@ 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', headers = headers)
+r = requests.post('/api/boards/{board}/cards/{card}/comments', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -8080,20 +4976,21 @@ 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{}
@@ -8101,32 +4998,6 @@ 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
@@ -8167,7 +5038,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -8186,7 +5057,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID of the card
card: the ID of the card
@@ -8196,7 +5067,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -8251,24 +5122,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -8279,35 +5169,15 @@ fetch('/api/boards/{board}/cards/{card}/comments/
});
-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'
+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
@@ -8316,18 +5186,20 @@ 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}', headers = headers)
+r = requests.get('/api/boards/{board}/cards/{card}/comments/{comment}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -8343,19 +5215,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"},
+ "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{}
@@ -8363,31 +5236,6 @@ 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
@@ -8426,7 +5274,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
@@ -8437,12 +5285,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
@@ -8475,24 +5323,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards/{card}/comments/{comment}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -8503,35 +5370,15 @@ fetch('/api/boards/{board}/cards/{card}/comments/
});
-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'
+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
@@ -8540,18 +5387,20 @@ 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}', headers = headers)
+r = requests.delete('/api/boards/{board}/cards/{card}/comments/{comment}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -8567,19 +5416,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"},
+ "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{}
@@ -8587,31 +5437,6 @@ 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
@@ -8650,7 +5475,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
@@ -8661,7 +5486,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -8717,24 +5542,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -8745,35 +5589,15 @@ fetch('/api/boards/{board}/cardsByCustomField/{cu
});
-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'
+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
@@ -8782,18 +5606,20 @@ 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}', headers = headers)
+r = requests.get('/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -8809,19 +5635,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"},
+ "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{}
@@ -8829,31 +5656,6 @@ 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
@@ -8892,7 +5694,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
customField: the list ID
customFieldValue: the value to look for
@@ -8904,11 +5706,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"
}
]
@@ -8992,24 +5794,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/cards_count',
+$.ajax({
+ url: '/api/boards/{board}/cards_count',
+ method: 'get',
+
+ headers: headers,
+ success: function(data) {
+ console.log(JSON.stringify(data));
+ }
+})
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/cards_count',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -9020,35 +5841,15 @@ fetch('/api/boards/{board}/cards_count'
-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'
+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
@@ -9057,18 +5858,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/cards_count', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -9084,19 +5887,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"},
+ "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{}
@@ -9104,31 +5908,6 @@ 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
@@ -9153,7 +5932,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
Example responses
@@ -9162,7 +5941,7 @@ System.out.println(response.toString());
200 Response
{
- "board_cards_count": 0
+ "board_cards_count": 0
}
Responses
@@ -9217,24 +5996,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -9245,35 +6043,15 @@ fetch('/api/boards/{board}/lists/{list}/cards
});
-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'
+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
@@ -9282,18 +6060,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/lists/{list}/cards', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -9309,19 +6089,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"},
+ "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{}
@@ -9329,31 +6110,6 @@ 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
@@ -9385,7 +6141,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
list: the list ID
@@ -9396,9 +6152,9 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string",
- "description": "string"
+ "_id": "string",
+ "title": "string",
+ "description": "string"
}
]
@@ -9468,34 +6224,54 @@ 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
-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'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/lists/{list}/cards',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -9506,44 +6282,16 @@ fetch('/api/boards/{board}/lists/{list}/cards
});
-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'
+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
@@ -9552,19 +6300,21 @@ 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', headers = headers)
+r = requests.post('/api/boards/{board}/lists/{list}/cards', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -9580,20 +6330,21 @@ 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{}
@@ -9601,32 +6352,6 @@ 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
@@ -9671,7 +6396,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -9718,7 +6443,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
@@ -9728,7 +6453,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -9783,24 +6508,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -9811,35 +6555,15 @@ fetch('/api/boards/{board}/lists/{list}/cards/{ca
});
-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'
+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
@@ -9848,18 +6572,20 @@ 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}', headers = headers)
+r = requests.get('/api/boards/{board}/lists/{list}/cards/{card}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -9875,19 +6601,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"},
+ "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{}
@@ -9895,31 +6622,6 @@ 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
@@ -9958,7 +6660,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
@@ -9969,102 +6671,104 @@ 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
+ "cardNumber": 0,
+ "showActivities": true,
+ "hideFinishedChecklistIfItemsAreHidden": true
}
Responses
@@ -10097,54 +6801,74 @@ 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
-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'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
{
- method: 'PUT',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -10155,64 +6879,16 @@ fetch('/api/boards/{board}/lists/{list}/cards/{ca
});
-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'
+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
@@ -10221,19 +6897,21 @@ 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}', headers = headers)
+r = requests.put('/api/boards/{board}/lists/{list}/cards/{card}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -10249,20 +6927,21 @@ 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{}
@@ -10270,32 +6949,6 @@ 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
@@ -10318,8 +6971,8 @@ System.out.println(response.toString());
parentId: string
description: string
color: string
-vote: {}
-poker: {}
+vote: {}
+poker: {}
labelIds: string
requestedBy: string
assignedBy: string
@@ -10375,7 +7028,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -10562,7 +7215,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
@@ -10573,7 +7226,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -10628,24 +7281,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -10656,35 +7328,15 @@ fetch('/api/boards/{board}/lists/{list}/cards/{ca
});
-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'
+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
@@ -10693,18 +7345,20 @@ 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}', headers = headers)
+r = requests.delete('/api/boards/{board}/lists/{list}/cards/{card}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -10720,19 +7374,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"},
+ "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{}
@@ -10740,31 +7395,6 @@ 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
@@ -10805,7 +7435,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
@@ -10816,7 +7446,7 @@ is not put in the recycle bin.
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -10871,29 +7501,49 @@ 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
-const inputBody = '{
- "value": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -10904,39 +7554,16 @@ fetch('/api/boards/{board}/lists/{list}/cards/{ca
});
-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'
+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
@@ -10945,19 +7572,21 @@ 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}', headers = headers)
+r = requests.post('/api/boards/{board}/lists/{list}/cards/{card}/customFields/{customField}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -10973,20 +7602,21 @@ 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{}
@@ -10994,32 +7624,6 @@ 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
@@ -11074,7 +7678,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -11086,7 +7690,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
@@ -11098,8 +7702,8 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string",
- "customFields": {}
+ "_id": "string",
+ "customFields": {}
}
Responses
@@ -11161,24 +7765,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards_count',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards_count',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -11189,35 +7812,15 @@ fetch('/api/boards/{board}/lists/{list}/cards_cou
});
-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'
+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
@@ -11226,18 +7829,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/lists/{list}/cards_count', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -11253,19 +7858,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"},
+ "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{}
@@ -11273,31 +7879,6 @@ 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
@@ -11329,7 +7910,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
list: the List ID
@@ -11339,7 +7920,7 @@ System.out.println(response.toString());
200 Response
{
- "list_cards_count": 0
+ "list_cards_count": 0
}
Responses
@@ -11394,24 +7975,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -11422,35 +8022,15 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}/c
});
-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'
+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
@@ -11459,18 +8039,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/swimlanes/{swimlane}/cards', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -11486,19 +8068,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"},
+ "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{}
@@ -11506,31 +8089,6 @@ 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
@@ -11562,7 +8120,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
board: the board ID
swimlane: the swimlane ID
@@ -11573,10 +8131,10 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "title": "string",
- "description": "string",
- "listId": "string"
+ "_id": "string",
+ "title": "string",
+ "description": "string",
+ "listId": "string"
}
]
@@ -11654,24 +8212,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields',
+$.ajax({
+ url: '/api/boards/{board}/custom-fields',
+ method: 'get',
+
+ headers: headers,
+ success: function(data) {
+ console.log(JSON.stringify(data));
+ }
+})
+
+
+const fetch = require('node-fetch');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/custom-fields',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -11682,35 +8259,15 @@ fetch('/api/boards/{board}/custom-fields'
-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'
+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
@@ -11719,18 +8276,20 @@ 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', headers = headers)
+r = requests.get('/api/boards/{board}/custom-fields', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -11746,19 +8305,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"},
+ "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{}
@@ -11766,31 +8326,6 @@ 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
@@ -11823,9 +8358,9 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "name": "string",
- "type": "string"
+ "_id": "string",
+ "name": "string",
+ "type": "string"
}
]
@@ -11895,36 +8430,56 @@ 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
-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'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/custom-fields',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/custom-fields',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -11935,46 +8490,16 @@ fetch('/api/boards/{board}/custom-fields'
-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'
+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
@@ -11983,19 +8508,21 @@ 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', headers = headers)
+r = requests.post('/api/boards/{board}/custom-fields', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -12011,20 +8538,21 @@ 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{}
@@ -12032,32 +8560,6 @@ 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
@@ -12097,7 +8599,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -12165,7 +8667,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -12220,24 +8722,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields/{customField}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}',
{
- method: 'GET',
+ method: 'GET',
headers: headers
})
@@ -12248,35 +8769,15 @@ fetch('/api/boards/{board}/custom-fields/{customF
});
-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'
+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
@@ -12285,18 +8786,20 @@ 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}', headers = headers)
+r = requests.get('/api/boards/{board}/custom-fields/{customField}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -12312,19 +8815,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"},
+ "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{}
@@ -12332,31 +8836,6 @@ 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
@@ -12388,7 +8867,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
customField: the ID of the custom field
Example responses
@@ -12398,8 +8877,8 @@ System.out.println(response.toString());
[
{
- "_id": "string",
- "boardIds": "string"
+ "_id": "string",
+ "boardIds": "string"
}
]
@@ -12462,36 +8941,56 @@ 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
-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'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/custom-fields/{customField}',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}',
{
- method: 'PUT',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -12502,46 +9001,16 @@ fetch('/api/boards/{board}/custom-fields/{customF
});
-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'
+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
@@ -12550,19 +9019,21 @@ 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}', headers = headers)
+r = requests.put('/api/boards/{board}/custom-fields/{customField}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -12578,20 +9049,21 @@ 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{}
@@ -12599,32 +9071,6 @@ 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
@@ -12671,7 +9117,7 @@ System.out.println(response.toString());
body
body
object
-true
+false
none
@@ -12739,7 +9185,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -12794,24 +9240,43 @@ 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
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
-
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/custom-fields/{customField}',
+$.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');
+
+const headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}',
{
- method: 'DELETE',
+ method: 'DELETE',
headers: headers
})
@@ -12822,35 +9287,15 @@ fetch('/api/boards/{board}/custom-fields/{customF
});
-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'
+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
@@ -12859,18 +9304,20 @@ 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}', headers = headers)
+r = requests.delete('/api/boards/{board}/custom-fields/{customField}', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -12886,19 +9333,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"},
+ "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{}
@@ -12906,31 +9354,6 @@ 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
@@ -12963,7 +9386,7 @@ System.out.println(response.toString());
-Detailed descriptions
+Detailed descriptions
customField: the ID of the custom field
Example responses
@@ -12972,7 +9395,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -13027,29 +9450,49 @@ 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
-const inputBody = '{
- "items": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
+var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
};
-fetch('/api/boards/{board}/custom-fields/{customField}/dropdown-items',
+$.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 headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/custom-fields/{customField}/dropdown-items',
{
- method: 'POST',
+ method: 'POST',
body: inputBody,
headers: headers
})
@@ -13060,39 +9503,16 @@ fetch('/api/boards/{board}/custom-fields/{customF
});
-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'
+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
@@ -13101,19 +9521,21 @@ 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', headers = headers)
+r = requests.post('/api/boards/{board}/custom-fields/{customField}/dropdown-items', params={
-print(r.json())
+}, headers = headers)
+
+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()));
@@ -13129,20 +9551,21 @@ 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{}
@@ -13150,32 +9573,6 @@ 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
@@ -13234,7 +9631,7 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "_id": "string"
}
Responses
@@ -13289,29 +9686,49 @@ 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
+