summaryrefslogtreecommitdiffstats
path: root/public
diff options
context:
space:
mode:
authorLauri Ojansivu <x@xet7.org>2020-04-12 00:01:07 +0300
committerLauri Ojansivu <x@xet7.org>2020-04-12 00:01:07 +0300
commit58ce859368f751c30f264890cc75298dd792834f (patch)
tree6b569c77efedb5555dc9a1e893b565d33b7d4eda /public
parente23aacedb3fa55194c5341fe95d1114ba735e2c3 (diff)
downloadwekan-58ce859368f751c30f264890cc75298dd792834f.tar.gz
wekan-58ce859368f751c30f264890cc75298dd792834f.tar.bz2
wekan-58ce859368f751c30f264890cc75298dd792834f.zip
v3.94v3.94
Diffstat (limited to 'public')
-rw-r--r--public/api/wekan.html1899
-rw-r--r--public/api/wekan.yml529
2 files changed, 3 insertions, 2425 deletions
diff --git a/public/api/wekan.html b/public/api/wekan.html
index 49f90a38..ff586d41 100644
--- a/public/api/wekan.html
+++ b/public/api/wekan.html
@@ -1524,7 +1524,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h1">
<li>
- <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v3.93">Wekan REST API v3.93</a>
+ <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v3.94">Wekan REST API v3.94</a>
</li>
@@ -1791,45 +1791,6 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
</li>
<li>
- <a href="#wekan-rest-api-cards" class="toc-h1 toc-link" data-title="Cards">Cards</a>
-
- <ul class="toc-list-h2">
-
- <li>
- <a href="#get_all_cards" class="toc-h2 toc-link" data-title="get_all_cards">get_all_cards</a>
-
- </li>
-
- <li>
- <a href="#new_card" class="toc-h2 toc-link" data-title="new_card">new_card</a>
-
- </li>
-
- <li>
- <a href="#get_board_list_card" class="toc-h2 toc-link" data-title="get_board_list_card">get_board_list_card</a>
-
- </li>
-
- <li>
- <a href="#put_board_list_card" class="toc-h2 toc-link" data-title="put_board_list_card">put_board_list_card</a>
-
- </li>
-
- <li>
- <a href="#delete_board_list_card" class="toc-h2 toc-link" data-title="delete_board_list_card">delete_board_list_card</a>
-
- </li>
-
- <li>
- <a href="#get_board_swimlane_cards" class="toc-h2 toc-link" data-title="get_board_swimlane_cards">get_board_swimlane_cards</a>
-
- </li>
-
- </ul>
-
- </li>
-
- <li>
<a href="#wekan-rest-api-users" class="toc-h1 toc-link" data-title="Users">Users</a>
<ul class="toc-list-h2">
@@ -1933,21 +1894,6 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
</li>
<li>
- <a href="#tocscards" class="toc-h2 toc-link" data-title="Cards">Cards</a>
-
- </li>
-
- <li>
- <a href="#tocscardsvote" class="toc-h2 toc-link" data-title="CardsVote">CardsVote</a>
-
- </li>
-
- <li>
- <a href="#tocscardscustomfields" class="toc-h2 toc-link" data-title="CardsCustomfields">CardsCustomfields</a>
-
- </li>
-
- <li>
<a href="#tocschecklistitems" class="toc-h2 toc-link" data-title="ChecklistItems">ChecklistItems</a>
</li>
@@ -2022,7 +1968,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
- <h1 id="wekan-rest-api">Wekan REST API v3.93</h1>
+ <h1 id="wekan-rest-api">Wekan REST API v3.94</h1>
<blockquote>
<p>Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.</p>
</blockquote>
@@ -9652,1396 +9598,6 @@ The list is not put in the recycle bin.</p>
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
</aside>
-<h1 id="wekan-rest-api-cards">Cards</h1>
-<h2 id="get_all_cards">get_all_cards</h2>
-<p><a id="opIdget_all_cards"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET /api/boards/{board}/lists/{list}/cards \
- -H <span class="hljs-string">'Accept: application/json'</span> \
- -H <span class="hljs-string">'Authorization: API_KEY'</span>
-
-</code></pre>
-<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards</span> HTTP/1.1
-
-<span class="http"><span class="hljs-attribute">Accept</span>: application/json
-
-<span class="undefined"></span></span></code></pre>
-<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = {
- <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-$.ajax({
- <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>,
- <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>,
-
- <span class="hljs-attr">headers</span>: headers,
- <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{
- <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data));
- }
-})
-
-</code></pre>
-<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>);
-
-<span class="hljs-keyword">const</span> headers = {
- <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>,
-{
- <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>,
-
- <span class="hljs-attr">headers</span>: headers
-})
-.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{
- <span class="hljs-keyword">return</span> res.json();
-}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{
- <span class="hljs-built_in">console</span>.log(body);
-});
-
-</code></pre>
-<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span>
-<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>
-
-headers = {
- <span class="hljs-string">'Accept'</span> =&gt; <span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span> =&gt; <span class="hljs-string">'API_KEY'</span>
-}
-
-result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>,
- <span class="hljs-symbol">params:</span> {
- }, <span class="hljs-symbol">headers:</span> headers
-
-p JSON.parse(result)
-
-</code></pre>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span>
-}
-
-r = requests.get(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards"</span>);
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod(<span class="hljs-string">"GET"</span>);
-<span class="hljs-keyword">int</span> responseCode = con.getResponseCode();
-BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader(
- <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer();
-<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-</code></pre>
-<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main
-
-<span class="hljs-keyword">import</span> (
- <span class="hljs-string">"bytes"</span>
- <span class="hljs-string">"net/http"</span>
-)
-
-<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> {
-
- headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{
- <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>},
- <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>},
-
- }
-
- data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq})
- req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards"</span>, data)
- req.Header = headers
-
- client := &amp;http.Client{}
- resp, err := client.Do(req)
- <span class="hljs-comment">// ...</span>
-}
-
-</code></pre>
-<p><code>GET /api/boards/{board}/lists/{list}/cards</code></p>
-<p><em>Get all Cards attached to a List</em></p>
-<h3 id="get_all_cards-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>board</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the board ID</td>
-</tr>
-<tr>
-<td>list</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the list ID</td>
-</tr>
-</tbody>
-</table>
-<h4 id="detailed-descriptions">Detailed descriptions</h4>
-<p><strong>board</strong>: the board ID</p>
-<p><strong>list</strong>: the list ID</p>
-<blockquote>
-<p>Example responses</p>
-</blockquote>
-<blockquote>
-<p>200 Response</p>
-</blockquote>
-<pre class="highlight tab tab-json"><code>[
- {
- <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>
- }
-]
-</code></pre>
-<h3 id="get_all_cards-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>200 response</td>
-<td>Inline</td>
-</tr>
-</tbody>
-</table>
-<h3 id="get_all_cards-responseschema">Response Schema</h3>
-<p>Status Code <strong>200</strong></p>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>Type</th>
-<th>Required</th>
-<th>Restrictions</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>» _id</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>» title</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>» description</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-</tbody>
-</table>
-<aside class="warning">
-To perform this operation, you must be authenticated by means of one of the following methods:
-UserSecurity
-</aside>
-<h2 id="new_card">new_card</h2>
-<p><a id="opIdnew_card"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X POST /api/boards/{board}/lists/{list}/cards \
- -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \
- -H <span class="hljs-string">'Accept: application/json'</span> \
- -H <span class="hljs-string">'Authorization: API_KEY'</span>
-
-</code></pre>
-<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards</span> HTTP/1.1
-
-<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span>
-Accept: application/json
-
-</span></code></pre>
-<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = {
- <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-$.ajax({
- <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>,
- <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>,
-
- <span class="hljs-attr">headers</span>: headers,
- <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{
- <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data));
- }
-})
-
-</code></pre>
-<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>);
-<span class="hljs-keyword">const</span> inputBody = <span class="hljs-string">'{
- "authorId": "string",
- "members": "string",
- "assignees": "string",
- "title": "string",
- "description": "string",
- "swimlaneId": "string"
-}'</span>;
-<span class="hljs-keyword">const</span> headers = {
- <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>,
-{
- <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>,
- <span class="hljs-attr">body</span>: inputBody,
- <span class="hljs-attr">headers</span>: headers
-})
-.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{
- <span class="hljs-keyword">return</span> res.json();
-}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{
- <span class="hljs-built_in">console</span>.log(body);
-});
-
-</code></pre>
-<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span>
-<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>
-
-headers = {
- <span class="hljs-string">'Content-Type'</span> =&gt; <span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Accept'</span> =&gt; <span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span> =&gt; <span class="hljs-string">'API_KEY'</span>
-}
-
-result = RestClient.post <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>,
- <span class="hljs-symbol">params:</span> {
- }, <span class="hljs-symbol">headers:</span> headers
-
-p JSON.parse(result)
-
-</code></pre>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>,
- <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span>
-}
-
-r = requests.post(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards"</span>);
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod(<span class="hljs-string">"POST"</span>);
-<span class="hljs-keyword">int</span> responseCode = con.getResponseCode();
-BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader(
- <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer();
-<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-</code></pre>
-<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main
-
-<span class="hljs-keyword">import</span> (
- <span class="hljs-string">"bytes"</span>
- <span class="hljs-string">"net/http"</span>
-)
-
-<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> {
-
- headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{
- <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>},
- <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>},
- <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>},
-
- }
-
- data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq})
- req, err := http.NewRequest(<span class="hljs-string">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards"</span>, data)
- req.Header = headers
-
- client := &amp;http.Client{}
- resp, err := client.Do(req)
- <span class="hljs-comment">// ...</span>
-}
-
-</code></pre>
-<p><code>POST /api/boards/{board}/lists/{list}/cards</code></p>
-<p><em>Create a new Card</em></p>
-<blockquote>
-<p>Body parameter</p>
-</blockquote>
-<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">members:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">assignees:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">title:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">description:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">swimlaneId:</span> <span class="hljs-string">string</span>
-
-</code></pre>
-<h3 id="new_card-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>board</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the board ID of the new card</td>
-</tr>
-<tr>
-<td>list</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the list ID of the new card</td>
-</tr>
-<tr>
-<td>body</td>
-<td>body</td>
-<td>object</td>
-<td>false</td>
-<td>none</td>
-</tr>
-<tr>
-<td>» authorId</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the authorId value</td>
-</tr>
-<tr>
-<td>» members</td>
-<td>body</td>
-<td>string</td>
-<td>false</td>
-<td>the member IDs list of the new card</td>
-</tr>
-<tr>
-<td>» assignees</td>
-<td>body</td>
-<td>string</td>
-<td>false</td>
-<td>the array of maximum one ID of assignee of the new card</td>
-</tr>
-<tr>
-<td>» title</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the title of the new card</td>
-</tr>
-<tr>
-<td>» description</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the description of the new card</td>
-</tr>
-<tr>
-<td>» swimlaneId</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the swimlane ID of the new card</td>
-</tr>
-</tbody>
-</table>
-<h4 id="detailed-descriptions">Detailed descriptions</h4>
-<p><strong>board</strong>: the board ID of the new card</p>
-<p><strong>list</strong>: the list ID of the new card</p>
-<blockquote>
-<p>Example responses</p>
-</blockquote>
-<blockquote>
-<p>200 Response</p>
-</blockquote>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>
-}
-</code></pre>
-<h3 id="new_card-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>200 response</td>
-<td>Inline</td>
-</tr>
-</tbody>
-</table>
-<h3 id="new_card-responseschema">Response Schema</h3>
-<p>Status Code <strong>200</strong></p>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>Type</th>
-<th>Required</th>
-<th>Restrictions</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>» _id</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-</tbody>
-</table>
-<aside class="warning">
-To perform this operation, you must be authenticated by means of one of the following methods:
-UserSecurity
-</aside>
-<h2 id="get_board_list_card">get_board_list_card</h2>
-<p><a id="opIdget_board_list_card"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \
- -H <span class="hljs-string">'Authorization: API_KEY'</span>
-
-</code></pre>
-<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1
-
-<span class="undefined"></span></code></pre>
-<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = {
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-$.ajax({
- <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
- <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>,
-
- <span class="hljs-attr">headers</span>: headers,
- <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{
- <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data));
- }
-})
-
-</code></pre>
-<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>);
-
-<span class="hljs-keyword">const</span> headers = {
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
-{
- <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>,
-
- <span class="hljs-attr">headers</span>: headers
-})
-.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{
- <span class="hljs-keyword">return</span> res.json();
-}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{
- <span class="hljs-built_in">console</span>.log(body);
-});
-
-</code></pre>
-<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span>
-<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>
-
-headers = {
- <span class="hljs-string">'Authorization'</span> =&gt; <span class="hljs-string">'API_KEY'</span>
-}
-
-result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
- <span class="hljs-symbol">params:</span> {
- }, <span class="hljs-symbol">headers:</span> headers
-
-p JSON.parse(result)
-
-</code></pre>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span>
-}
-
-r = requests.get(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>);
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod(<span class="hljs-string">"GET"</span>);
-<span class="hljs-keyword">int</span> responseCode = con.getResponseCode();
-BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader(
- <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer();
-<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-</code></pre>
-<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main
-
-<span class="hljs-keyword">import</span> (
- <span class="hljs-string">"bytes"</span>
- <span class="hljs-string">"net/http"</span>
-)
-
-<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> {
-
- headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{
- <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>},
-
- }
-
- data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq})
- req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data)
- req.Header = headers
-
- client := &amp;http.Client{}
- resp, err := client.Do(req)
- <span class="hljs-comment">// ...</span>
-}
-
-</code></pre>
-<p><code>GET /api/boards/{board}/lists/{list}/cards/{card}</code></p>
-<h3 id="get_board_list_card-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>board</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the board value</td>
-</tr>
-<tr>
-<td>list</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the list value</td>
-</tr>
-<tr>
-<td>card</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the card value</td>
-</tr>
-</tbody>
-</table>
-<h3 id="get_board_list_card-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>200 response</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<aside class="warning">
-To perform this operation, you must be authenticated by means of one of the following methods:
-UserSecurity
-</aside>
-<h2 id="put_board_list_card">put_board_list_card</h2>
-<p><a id="opIdput_board_list_card"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \
- -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \
- -H <span class="hljs-string">'Authorization: API_KEY'</span>
-
-</code></pre>
-<pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1
-
-<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span>
-
-</span></code></pre>
-<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = {
- <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-$.ajax({
- <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
- <span class="hljs-attr">method</span>: <span class="hljs-string">'put'</span>,
-
- <span class="hljs-attr">headers</span>: headers,
- <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{
- <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data));
- }
-})
-
-</code></pre>
-<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>);
-<span class="hljs-keyword">const</span> inputBody = <span class="hljs-string">'{
- "title": "string",
- "listId": "string",
- "authorId": "string",
- "parentId": "string",
- "description": "string",
- "color": "string",
- "labelIds": "string",
- "requestedBy": "string",
- "assignedBy": "string",
- "receivedAt": "string",
- "startAt": "string",
- "dueAt": "string",
- "endAt": "string",
- "spentTime": "string",
- "isOverTime": "string",
- "customFields": "string",
- "members": "string",
- "assignees": "string",
- "swimlaneId": "string"
-}'</span>;
-<span class="hljs-keyword">const</span> headers = {
- <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
-{
- <span class="hljs-attr">method</span>: <span class="hljs-string">'PUT'</span>,
- <span class="hljs-attr">body</span>: inputBody,
- <span class="hljs-attr">headers</span>: headers
-})
-.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{
- <span class="hljs-keyword">return</span> res.json();
-}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{
- <span class="hljs-built_in">console</span>.log(body);
-});
-
-</code></pre>
-<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span>
-<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>
-
-headers = {
- <span class="hljs-string">'Content-Type'</span> =&gt; <span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Authorization'</span> =&gt; <span class="hljs-string">'API_KEY'</span>
-}
-
-result = RestClient.put <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
- <span class="hljs-symbol">params:</span> {
- }, <span class="hljs-symbol">headers:</span> headers
-
-p JSON.parse(result)
-
-</code></pre>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>,
- <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span>
-}
-
-r = requests.put(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>);
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod(<span class="hljs-string">"PUT"</span>);
-<span class="hljs-keyword">int</span> responseCode = con.getResponseCode();
-BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader(
- <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer();
-<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-</code></pre>
-<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main
-
-<span class="hljs-keyword">import</span> (
- <span class="hljs-string">"bytes"</span>
- <span class="hljs-string">"net/http"</span>
-)
-
-<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> {
-
- headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{
- <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>},
- <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>},
-
- }
-
- data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq})
- req, err := http.NewRequest(<span class="hljs-string">"PUT"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data)
- req.Header = headers
-
- client := &amp;http.Client{}
- resp, err := client.Do(req)
- <span class="hljs-comment">// ...</span>
-}
-
-</code></pre>
-<p><code>PUT /api/boards/{board}/lists/{list}/cards/{card}</code></p>
-<blockquote>
-<p>Body parameter</p>
-</blockquote>
-<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">title:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">listId:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">parentId:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">description:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">color:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">labelIds:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">requestedBy:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">assignedBy:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">receivedAt:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">startAt:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">dueAt:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">endAt:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">spentTime:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">isOverTime:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">customFields:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">members:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">assignees:</span> <span class="hljs-string">string</span>
-<span class="hljs-attr">swimlaneId:</span> <span class="hljs-string">string</span>
-
-</code></pre>
-<h3 id="put_board_list_card-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>board</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the board value</td>
-</tr>
-<tr>
-<td>list</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the list value</td>
-</tr>
-<tr>
-<td>card</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the card value</td>
-</tr>
-<tr>
-<td>body</td>
-<td>body</td>
-<td>object</td>
-<td>false</td>
-<td>none</td>
-</tr>
-<tr>
-<td>» title</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the title value</td>
-</tr>
-<tr>
-<td>» listId</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the listId value</td>
-</tr>
-<tr>
-<td>» authorId</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the authorId value</td>
-</tr>
-<tr>
-<td>» parentId</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the parentId value</td>
-</tr>
-<tr>
-<td>» description</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the description value</td>
-</tr>
-<tr>
-<td>» color</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the color value</td>
-</tr>
-<tr>
-<td>» labelIds</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the labelIds value</td>
-</tr>
-<tr>
-<td>» requestedBy</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the requestedBy value</td>
-</tr>
-<tr>
-<td>» assignedBy</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the assignedBy value</td>
-</tr>
-<tr>
-<td>» receivedAt</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the receivedAt value</td>
-</tr>
-<tr>
-<td>» startAt</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the startAt value</td>
-</tr>
-<tr>
-<td>» dueAt</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the dueAt value</td>
-</tr>
-<tr>
-<td>» endAt</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the endAt value</td>
-</tr>
-<tr>
-<td>» spentTime</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the spentTime value</td>
-</tr>
-<tr>
-<td>» isOverTime</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the isOverTime value</td>
-</tr>
-<tr>
-<td>» customFields</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the customFields value</td>
-</tr>
-<tr>
-<td>» members</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the members value</td>
-</tr>
-<tr>
-<td>» assignees</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the assignees value</td>
-</tr>
-<tr>
-<td>» swimlaneId</td>
-<td>body</td>
-<td>string</td>
-<td>true</td>
-<td>the swimlaneId value</td>
-</tr>
-</tbody>
-</table>
-<h3 id="put_board_list_card-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>200 response</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<aside class="warning">
-To perform this operation, you must be authenticated by means of one of the following methods:
-UserSecurity
-</aside>
-<h2 id="delete_board_list_card">delete_board_list_card</h2>
-<p><a id="opIddelete_board_list_card"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \
- -H <span class="hljs-string">'Authorization: API_KEY'</span>
-
-</code></pre>
-<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1
-
-<span class="undefined"></span></code></pre>
-<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = {
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-$.ajax({
- <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
- <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>,
-
- <span class="hljs-attr">headers</span>: headers,
- <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{
- <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data));
- }
-})
-
-</code></pre>
-<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>);
-
-<span class="hljs-keyword">const</span> headers = {
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
-{
- <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>,
-
- <span class="hljs-attr">headers</span>: headers
-})
-.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{
- <span class="hljs-keyword">return</span> res.json();
-}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{
- <span class="hljs-built_in">console</span>.log(body);
-});
-
-</code></pre>
-<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span>
-<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>
-
-headers = {
- <span class="hljs-string">'Authorization'</span> =&gt; <span class="hljs-string">'API_KEY'</span>
-}
-
-result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>,
- <span class="hljs-symbol">params:</span> {
- }, <span class="hljs-symbol">headers:</span> headers
-
-p JSON.parse(result)
-
-</code></pre>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span>
-}
-
-r = requests.delete(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>);
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod(<span class="hljs-string">"DELETE"</span>);
-<span class="hljs-keyword">int</span> responseCode = con.getResponseCode();
-BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader(
- <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer();
-<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-</code></pre>
-<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main
-
-<span class="hljs-keyword">import</span> (
- <span class="hljs-string">"bytes"</span>
- <span class="hljs-string">"net/http"</span>
-)
-
-<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> {
-
- headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{
- <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>},
-
- }
-
- data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq})
- req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data)
- req.Header = headers
-
- client := &amp;http.Client{}
- resp, err := client.Do(req)
- <span class="hljs-comment">// ...</span>
-}
-
-</code></pre>
-<p><code>DELETE /api/boards/{board}/lists/{list}/cards/{card}</code></p>
-<h3 id="delete_board_list_card-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>board</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the board value</td>
-</tr>
-<tr>
-<td>list</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the list value</td>
-</tr>
-<tr>
-<td>card</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the card value</td>
-</tr>
-</tbody>
-</table>
-<h3 id="delete_board_list_card-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>200 response</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<aside class="warning">
-To perform this operation, you must be authenticated by means of one of the following methods:
-UserSecurity
-</aside>
-<h2 id="get_board_swimlane_cards">get_board_swimlane_cards</h2>
-<p><a id="opIdget_board_swimlane_cards"></a></p>
-<blockquote>
-<p>Code samples</p>
-</blockquote>
-<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span>
-curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \
- -H <span class="hljs-string">'Authorization: API_KEY'</span>
-
-</code></pre>
-<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/swimlanes/{swimlane}/cards</span> HTTP/1.1
-
-<span class="undefined"></span></code></pre>
-<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = {
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-$.ajax({
- <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>,
- <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>,
-
- <span class="hljs-attr">headers</span>: headers,
- <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{
- <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data));
- }
-})
-
-</code></pre>
-<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>);
-
-<span class="hljs-keyword">const</span> headers = {
- <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span>
-
-};
-
-fetch(<span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>,
-{
- <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>,
-
- <span class="hljs-attr">headers</span>: headers
-})
-.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{
- <span class="hljs-keyword">return</span> res.json();
-}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{
- <span class="hljs-built_in">console</span>.log(body);
-});
-
-</code></pre>
-<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span>
-<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span>
-
-headers = {
- <span class="hljs-string">'Authorization'</span> =&gt; <span class="hljs-string">'API_KEY'</span>
-}
-
-result = RestClient.get <span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>,
- <span class="hljs-symbol">params:</span> {
- }, <span class="hljs-symbol">headers:</span> headers
-
-p JSON.parse(result)
-
-</code></pre>
-<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests
-headers = {
- <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span>
-}
-
-r = requests.get(<span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>, params={
-
-}, headers = headers)
-
-<span class="hljs-keyword">print</span> r.json()
-
-</code></pre>
-<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/swimlanes/{swimlane}/cards"</span>);
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod(<span class="hljs-string">"GET"</span>);
-<span class="hljs-keyword">int</span> responseCode = con.getResponseCode();
-BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader(
- <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer();
-<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-</code></pre>
-<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main
-
-<span class="hljs-keyword">import</span> (
- <span class="hljs-string">"bytes"</span>
- <span class="hljs-string">"net/http"</span>
-)
-
-<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> {
-
- headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{
- <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>},
-
- }
-
- data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq})
- req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/swimlanes/{swimlane}/cards"</span>, data)
- req.Header = headers
-
- client := &amp;http.Client{}
- resp, err := client.Do(req)
- <span class="hljs-comment">// ...</span>
-}
-
-</code></pre>
-<p><code>GET /api/boards/{board}/swimlanes/{swimlane}/cards</code></p>
-<h3 id="get_board_swimlane_cards-parameters">Parameters</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>In</th>
-<th>Type</th>
-<th>Required</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>board</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the board value</td>
-</tr>
-<tr>
-<td>swimlane</td>
-<td>path</td>
-<td>string</td>
-<td>true</td>
-<td>the swimlane value</td>
-</tr>
-</tbody>
-</table>
-<h3 id="get_board_swimlane_cards-responses">Responses</h3>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Meaning</th>
-<th>Description</th>
-<th>Schema</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>200</td>
-<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td>
-<td>200 response</td>
-<td>None</td>
-</tr>
-</tbody>
-</table>
-<aside class="warning">
-To perform this operation, you must be authenticated by means of one of the following methods:
-UserSecurity
-</aside>
<h1 id="wekan-rest-api-users">Users</h1>
<h2 id="add_board_member">add_board_member</h2>
<p><a id="opIdadd_board_member"></a></p>
@@ -14342,457 +12898,6 @@ UserSecurity
</tr>
</tbody>
</table>
-<h2 id="tocscards">Cards</h2>
-<p><a id="schemacards"></a></p>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"archived"</span>: <span class="hljs-literal">true</span>,
- <span class="hljs-attr">"parentId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"listId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"swimlaneId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"coverId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>,
- <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"customFields"</span>: [
- {}
- ],
- <span class="hljs-attr">"dateLastActivity"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"requestedBy"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"assignedBy"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"labelIds"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"members"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"assignees"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"receivedAt"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"startAt"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"dueAt"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"endAt"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"spentTime"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"isOvertime"</span>: <span class="hljs-literal">true</span>,
- <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"subtaskSort"</span>: <span class="hljs-number">0</span>,
- <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"linkedId"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"vote"</span>: {
- <span class="hljs-attr">"question"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"positive"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"negative"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
- }
-}
-
-</code></pre>
-<h3 id="properties">Properties</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>Type</th>
-<th>Required</th>
-<th>Restrictions</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>title</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>the title of the card</td>
-</tr>
-<tr>
-<td>archived</td>
-<td>boolean</td>
-<td>true</td>
-<td>none</td>
-<td>is the card archived</td>
-</tr>
-<tr>
-<td>parentId</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>ID of the parent card</td>
-</tr>
-<tr>
-<td>listId</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>List ID where the card is</td>
-</tr>
-<tr>
-<td>swimlaneId</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>Swimlane ID where the card is</td>
-</tr>
-<tr>
-<td>boardId</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>Board ID of the card</td>
-</tr>
-<tr>
-<td>coverId</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>Cover ID of the card</td>
-</tr>
-<tr>
-<td>color</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>createdAt</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>creation date</td>
-</tr>
-<tr>
-<td>modifiedAt</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>customFields</td>
-<td>[<a href="#schemacardscustomfields">CardsCustomfields</a>]|null</td>
-<td>false</td>
-<td>none</td>
-<td>list of custom fields</td>
-</tr>
-<tr>
-<td>dateLastActivity</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>Date of last activity</td>
-</tr>
-<tr>
-<td>description</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>description of the card</td>
-</tr>
-<tr>
-<td>requestedBy</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>who requested the card (ID of the user)</td>
-</tr>
-<tr>
-<td>assignedBy</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>who assigned the card (ID of the user)</td>
-</tr>
-<tr>
-<td>labelIds</td>
-<td>[string]|null</td>
-<td>false</td>
-<td>none</td>
-<td>list of labels ID the card has</td>
-</tr>
-<tr>
-<td>members</td>
-<td>[string]|null</td>
-<td>false</td>
-<td>none</td>
-<td>list of members (user IDs)</td>
-</tr>
-<tr>
-<td>assignees</td>
-<td>[string]|null</td>
-<td>false</td>
-<td>none</td>
-<td>who is assignee of the card (user ID), maximum one ID of assignee in array.</td>
-</tr>
-<tr>
-<td>receivedAt</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>Date the card was received</td>
-</tr>
-<tr>
-<td>startAt</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>Date the card was started to be worked on</td>
-</tr>
-<tr>
-<td>dueAt</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>Date the card is due</td>
-</tr>
-<tr>
-<td>endAt</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>Date the card ended</td>
-</tr>
-<tr>
-<td>spentTime</td>
-<td>number|null</td>
-<td>false</td>
-<td>none</td>
-<td>How much time has been spent on this</td>
-</tr>
-<tr>
-<td>isOvertime</td>
-<td>boolean|null</td>
-<td>false</td>
-<td>none</td>
-<td>is the card over time?</td>
-</tr>
-<tr>
-<td>userId</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>user ID of the author of the card</td>
-</tr>
-<tr>
-<td>sort</td>
-<td>number</td>
-<td>true</td>
-<td>none</td>
-<td>Sort value</td>
-</tr>
-<tr>
-<td>subtaskSort</td>
-<td>number|null</td>
-<td>false</td>
-<td>none</td>
-<td>subtask sort value</td>
-</tr>
-<tr>
-<td>type</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>type of the card</td>
-</tr>
-<tr>
-<td>linkedId</td>
-<td>string|null</td>
-<td>false</td>
-<td>none</td>
-<td>ID of the linked card</td>
-</tr>
-<tr>
-<td>vote</td>
-<td><a href="#schemacardsvote">CardsVote</a></td>
-<td>false</td>
-<td>none</td>
-<td>vote object, see below</td>
-</tr>
-</tbody>
-</table>
-<h4 id="enumerated-values">Enumerated Values</h4>
-<table>
-<thead>
-<tr>
-<th>Property</th>
-<th>Value</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>color</td>
-<td>white</td>
-</tr>
-<tr>
-<td>color</td>
-<td>green</td>
-</tr>
-<tr>
-<td>color</td>
-<td>yellow</td>
-</tr>
-<tr>
-<td>color</td>
-<td>orange</td>
-</tr>
-<tr>
-<td>color</td>
-<td>red</td>
-</tr>
-<tr>
-<td>color</td>
-<td>purple</td>
-</tr>
-<tr>
-<td>color</td>
-<td>blue</td>
-</tr>
-<tr>
-<td>color</td>
-<td>sky</td>
-</tr>
-<tr>
-<td>color</td>
-<td>lime</td>
-</tr>
-<tr>
-<td>color</td>
-<td>pink</td>
-</tr>
-<tr>
-<td>color</td>
-<td>black</td>
-</tr>
-<tr>
-<td>color</td>
-<td>silver</td>
-</tr>
-<tr>
-<td>color</td>
-<td>peachpuff</td>
-</tr>
-<tr>
-<td>color</td>
-<td>crimson</td>
-</tr>
-<tr>
-<td>color</td>
-<td>plum</td>
-</tr>
-<tr>
-<td>color</td>
-<td>darkgreen</td>
-</tr>
-<tr>
-<td>color</td>
-<td>slateblue</td>
-</tr>
-<tr>
-<td>color</td>
-<td>magenta</td>
-</tr>
-<tr>
-<td>color</td>
-<td>gold</td>
-</tr>
-<tr>
-<td>color</td>
-<td>navy</td>
-</tr>
-<tr>
-<td>color</td>
-<td>gray</td>
-</tr>
-<tr>
-<td>color</td>
-<td>saddlebrown</td>
-</tr>
-<tr>
-<td>color</td>
-<td>paleturquoise</td>
-</tr>
-<tr>
-<td>color</td>
-<td>mistyrose</td>
-</tr>
-<tr>
-<td>color</td>
-<td>indigo</td>
-</tr>
-</tbody>
-</table>
-<h2 id="tocscardsvote">CardsVote</h2>
-<p><a id="schemacardsvote"></a></p>
-<pre class="highlight tab tab-json"><code>{
- <span class="hljs-attr">"question"</span>: <span class="hljs-string">"string"</span>,
- <span class="hljs-attr">"positive"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"negative"</span>: [
- <span class="hljs-string">"string"</span>
- ],
- <span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
-}
-
-</code></pre>
-<h3 id="properties">Properties</h3>
-<table>
-<thead>
-<tr>
-<th>Name</th>
-<th>Type</th>
-<th>Required</th>
-<th>Restrictions</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>question</td>
-<td>string</td>
-<td>true</td>
-<td>none</td>
-<td>none</td>
-</tr>
-<tr>
-<td>positive</td>
-<td>[string]</td>
-<td>false</td>
-<td>none</td>
-<td>list of members (user IDs)</td>
-</tr>
-<tr>
-<td>negative</td>
-<td>[string]</td>
-<td>false</td>
-<td>none</td>
-<td>list of members (user IDs)</td>
-</tr>
-<tr>
-<td>end</td>
-<td>string</td>
-<td>false</td>
-<td>none</td>
-<td>none</td>
-</tr>
-</tbody>
-</table>
-<h2 id="tocscardscustomfields">CardsCustomfields</h2>
-<p><a id="schemacardscustomfields"></a></p>
-<pre class="highlight tab tab-json"><code>{}
-
-</code></pre>
-<h3 id="properties">Properties</h3>
-<p><em>None</em></p>
<h2 id="tocschecklistitems">ChecklistItems</h2>
<p><a id="schemachecklistitems"></a></p>
<pre class="highlight tab tab-json"><code>{
diff --git a/public/api/wekan.yml b/public/api/wekan.yml
index 07461940..2b25fd97 100644
--- a/public/api/wekan.yml
+++ b/public/api/wekan.yml
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Wekan REST API
- version: v3.93
+ version: v3.94
description: |
The REST API allows you to control and extend Wekan with ease.
@@ -1221,296 +1221,6 @@ paths:
properties:
_id:
type: string
- /api/boards/{board}/lists/{list}/cards:
- get:
- operationId: get_all_cards
- summary: Get all Cards attached to a List
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: |
- the board ID
- type: string
- required: true
- - name: list
- in: path
- description: |
- the list ID
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- schema:
- type: array
- items:
- type: object
- properties:
- _id:
- type: string
- title:
- type: string
- description:
- type: string
- post:
- operationId: new_card
- summary: Create a new Card
- tags:
- - Cards
- consumes:
- - multipart/form-data
- - application/json
- parameters:
- - name: authorId
- in: formData
- description: the authorId value
- type: string
- required: true
- - name: members
- in: formData
- description: |
- the member IDs list of the new card
- type: string
- required: false
- - name: assignees
- in: formData
- description: |
- the array of maximum one ID of assignee of the new card
- type: string
- required: false
- - name: title
- in: formData
- description: |
- the title of the new card
- type: string
- required: true
- - name: description
- in: formData
- description: |
- the description of the new card
- type: string
- required: true
- - name: swimlaneId
- in: formData
- description: |
- the swimlane ID of the new card
- type: string
- required: true
- - name: board
- in: path
- description: |
- the board ID of the new card
- type: string
- required: true
- - name: list
- in: path
- description: |
- the list ID of the new card
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- schema:
- type: object
- properties:
- _id:
- type: string
- /api/boards/{board}/lists/{list}/cards/{card}:
- get:
- operationId: get_board_list_card
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: list
- in: path
- description: the list value
- type: string
- required: true
- - name: card
- in: path
- description: the card value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- put:
- operationId: put_board_list_card
- tags:
- - Cards
- consumes:
- - multipart/form-data
- - application/json
- parameters:
- - name: title
- in: formData
- description: the title value
- type: string
- required: true
- - name: listId
- in: formData
- description: the listId value
- type: string
- required: true
- - name: authorId
- in: formData
- description: the authorId value
- type: string
- required: true
- - name: parentId
- in: formData
- description: the parentId value
- type: string
- required: true
- - name: description
- in: formData
- description: the description value
- type: string
- required: true
- - name: color
- in: formData
- description: the color value
- type: string
- required: true
- - name: labelIds
- in: formData
- description: the labelIds value
- type: string
- required: true
- - name: requestedBy
- in: formData
- description: the requestedBy value
- type: string
- required: true
- - name: assignedBy
- in: formData
- description: the assignedBy value
- type: string
- required: true
- - name: receivedAt
- in: formData
- description: the receivedAt value
- type: string
- required: true
- - name: startAt
- in: formData
- description: the startAt value
- type: string
- required: true
- - name: dueAt
- in: formData
- description: the dueAt value
- type: string
- required: true
- - name: endAt
- in: formData
- description: the endAt value
- type: string
- required: true
- - name: spentTime
- in: formData
- description: the spentTime value
- type: string
- required: true
- - name: isOverTime
- in: formData
- description: the isOverTime value
- type: string
- required: true
- - name: customFields
- in: formData
- description: the customFields value
- type: string
- required: true
- - name: members
- in: formData
- description: the members value
- type: string
- required: true
- - name: assignees
- in: formData
- description: the assignees value
- type: string
- required: true
- - name: swimlaneId
- in: formData
- description: the swimlaneId value
- type: string
- required: true
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: list
- in: path
- description: the list value
- type: string
- required: true
- - name: card
- in: path
- description: the card value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- delete:
- operationId: delete_board_list_card
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: list
- in: path
- description: the list value
- type: string
- required: true
- - name: card
- in: path
- description: the card value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
/api/boards/{board}/members/{member}:
post:
operationId: set_board_member_permission
@@ -1780,30 +1490,6 @@ paths:
'200':
description: |-
200 response
- /api/boards/{board}/swimlanes/{swimlane}/cards:
- get:
- operationId: get_board_swimlane_cards
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: swimlane
- in: path
- description: the swimlane value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
/api/user:
get:
operationId: get_current_user
@@ -2349,219 +2035,6 @@ definitions:
- createdAt
- modifiedAt
- userId
- Cards:
- type: object
- properties:
- title:
- description: |
- the title of the card
- type: string
- x-nullable: true
- archived:
- description: |
- is the card archived
- type: boolean
- parentId:
- description: |
- ID of the parent card
- type: string
- x-nullable: true
- listId:
- description: |
- List ID where the card is
- type: string
- x-nullable: true
- swimlaneId:
- description: |
- Swimlane ID where the card is
- type: string
- boardId:
- description: |
- Board ID of the card
- type: string
- x-nullable: true
- coverId:
- description: |
- Cover ID of the card
- type: string
- x-nullable: true
- color:
- type: string
- enum:
- - white
- - green
- - yellow
- - orange
- - red
- - purple
- - blue
- - sky
- - lime
- - pink
- - black
- - silver
- - peachpuff
- - crimson
- - plum
- - darkgreen
- - slateblue
- - magenta
- - gold
- - navy
- - gray
- - saddlebrown
- - paleturquoise
- - mistyrose
- - indigo
- x-nullable: true
- createdAt:
- description: |
- creation date
- type: string
- modifiedAt:
- type: string
- customFields:
- description: |
- list of custom fields
- type: array
- items:
- $ref: "#/definitions/CardsCustomfields"
- x-nullable: true
- dateLastActivity:
- description: |
- Date of last activity
- type: string
- description:
- description: |
- description of the card
- type: string
- x-nullable: true
- requestedBy:
- description: |
- who requested the card (ID of the user)
- type: string
- x-nullable: true
- assignedBy:
- description: |
- who assigned the card (ID of the user)
- type: string
- x-nullable: true
- labelIds:
- description: |
- list of labels ID the card has
- type: array
- items:
- type: string
- x-nullable: true
- x-nullable: true
- members:
- description: |
- list of members (user IDs)
- type: array
- items:
- type: string
- x-nullable: true
- x-nullable: true
- assignees:
- description: |
- who is assignee of the card (user ID),
- maximum one ID of assignee in array.
- type: array
- items:
- type: string
- x-nullable: true
- x-nullable: true
- receivedAt:
- description: |
- Date the card was received
- type: string
- x-nullable: true
- startAt:
- description: |
- Date the card was started to be worked on
- type: string
- x-nullable: true
- dueAt:
- description: |
- Date the card is due
- type: string
- x-nullable: true
- endAt:
- description: |
- Date the card ended
- type: string
- x-nullable: true
- spentTime:
- description: |
- How much time has been spent on this
- type: number
- x-nullable: true
- isOvertime:
- description: |
- is the card over time?
- type: boolean
- x-nullable: true
- userId:
- description: |
- user ID of the author of the card
- type: string
- sort:
- description: |
- Sort value
- type: number
- subtaskSort:
- description: |
- subtask sort value
- type: number
- x-nullable: true
- type:
- description: |
- type of the card
- type: string
- linkedId:
- description: |
- ID of the linked card
- type: string
- x-nullable: true
- vote:
- description: |
- vote object, see below
- $ref: "#/definitions/CardsVote"
- x-nullable: true
- required:
- - archived
- - swimlaneId
- - createdAt
- - modifiedAt
- - dateLastActivity
- - userId
- - sort
- - type
- CardsVote:
- type: object
- properties:
- question:
- type: string
- positive:
- description: |
- list of members (user IDs)
- type: array
- items:
- type: string
- x-nullable: true
- negative:
- description: |
- list of members (user IDs)
- type: array
- items:
- type: string
- x-nullable: true
- end:
- type: string
- required:
- - question
- CardsCustomfields:
- type: object
ChecklistItems:
type: object
description: An item in a checklist