|
@@ -7,7 +7,7 @@
|
|
|
<meta charset="utf-8">
|
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
|
- <title>Wekan REST API v5.58</title>
|
|
|
+ <title>Wekan REST API v5.59</title>
|
|
|
|
|
|
<style>
|
|
|
</style>
|
|
@@ -1555,7 +1555,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 v5.58">Wekan REST API v5.58</a>
|
|
|
+ <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v5.59">Wekan REST API v5.59</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
@@ -2128,7 +2128,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 v5.58</h1>
|
|
|
+ <h1 id="wekan-rest-api">Wekan REST API v5.59</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>
|
|
@@ -3568,6 +3568,7 @@ System.out.println(response.toString());
|
|
|
<span class="hljs-attr">"allowsEndDate"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsDueDate"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"presentParentTask"</span>: <span class="hljs-string">"prefix-with-full-path"</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>,
|
|
@@ -10426,6 +10427,7 @@ Accept: application/json
|
|
|
"showOnCard": true,
|
|
|
"automaticallyOnCard": true,
|
|
|
"showLabelOnMiniCard": true,
|
|
|
+ "showSumAtTopOfList": true,
|
|
|
"authorId": "string"
|
|
|
}'</span>;
|
|
|
<span class="hljs-keyword">const</span> headers = {
|
|
@@ -10455,6 +10457,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields'</s
|
|
|
<span class="hljs-string">"showOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-string">"automaticallyOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-string">"showLabelOnMiniCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
+ <span class="hljs-string">"showSumAtTopOfList"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-string">"authorId"</span>: <span class="hljs-string">"string"</span>
|
|
|
};
|
|
|
<span class="hljs-keyword">const</span> headers = {
|
|
@@ -10581,6 +10584,7 @@ System.out.println(response.toString());
|
|
|
<span class="hljs-attr">showOnCard:</span> <span class="hljs-literal">true</span>
|
|
|
<span class="hljs-attr">automaticallyOnCard:</span> <span class="hljs-literal">true</span>
|
|
|
<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span>
|
|
|
+<span class="hljs-attr">showSumAtTopOfList:</span> <span class="hljs-literal">true</span>
|
|
|
<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span>
|
|
|
|
|
|
</code></pre>
|
|
@@ -10653,6 +10657,13 @@ System.out.println(response.toString());
|
|
|
<td>should the label of the custom field be shown on minicards?</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
+<td>» showSumAtTopOfList</td>
|
|
|
+<td>body</td>
|
|
|
+<td>boolean</td>
|
|
|
+<td>true</td>
|
|
|
+<td>should the sum of the custom fields be shown at top of list?</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
<td>» authorId</td>
|
|
|
<td>body</td>
|
|
|
<td>string</td>
|
|
@@ -10983,7 +10994,8 @@ Accept: application/json
|
|
|
"showOnCard": true,
|
|
|
"automaticallyOnCard": true,
|
|
|
"alwaysOnCard": "string",
|
|
|
- "showLabelOnMiniCard": true
|
|
|
+ "showLabelOnMiniCard": true,
|
|
|
+ "showSumAtTopOfList": true
|
|
|
}'</span>;
|
|
|
<span class="hljs-keyword">const</span> headers = {
|
|
|
<span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
|
|
@@ -11012,7 +11024,8 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customF
|
|
|
<span class="hljs-string">"showOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-string">"automaticallyOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-string">"alwaysOnCard"</span>: <span class="hljs-string">"string"</span>,
|
|
|
- <span class="hljs-string">"showLabelOnMiniCard"</span>: <span class="hljs-literal">true</span>
|
|
|
+ <span class="hljs-string">"showLabelOnMiniCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
+ <span class="hljs-string">"showSumAtTopOfList"</span>: <span class="hljs-literal">true</span>
|
|
|
};
|
|
|
<span class="hljs-keyword">const</span> headers = {
|
|
|
<span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
|
|
@@ -11139,6 +11152,7 @@ System.out.println(response.toString());
|
|
|
<span class="hljs-attr">automaticallyOnCard:</span> <span class="hljs-literal">true</span>
|
|
|
<span class="hljs-attr">alwaysOnCard:</span> <span class="hljs-string">string</span>
|
|
|
<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span>
|
|
|
+<span class="hljs-attr">showSumAtTopOfList:</span> <span class="hljs-literal">true</span>
|
|
|
|
|
|
</code></pre>
|
|
|
<h3 id="edit_custom_field-parameters">Parameters</h3>
|
|
@@ -11223,6 +11237,13 @@ System.out.println(response.toString());
|
|
|
<td>true</td>
|
|
|
<td>should the label of the custom field be shown on minicards</td>
|
|
|
</tr>
|
|
|
+<tr>
|
|
|
+<td>» showSumAtTopOfList</td>
|
|
|
+<td>body</td>
|
|
|
+<td>boolean</td>
|
|
|
+<td>true</td>
|
|
|
+<td>should the sum of the custom fields be shown at top of list</td>
|
|
|
+</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<blockquote>
|
|
@@ -18362,6 +18383,7 @@ UserSecurity
|
|
|
<span class="hljs-attr">"allowsEndDate"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsDueDate"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"presentParentTask"</span>: <span class="hljs-string">"prefix-with-full-path"</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>,
|
|
@@ -18652,6 +18674,13 @@ UserSecurity
|
|
|
<td>Controls how to present the parent task:<br /><br />- <code>prefix-with-full-path</code>: add a prefix with the full path<br />- <code>prefix-with-parent</code>: add a prefisx with the parent name<br />- <code>subtext-with-full-path</code>: add a subtext with the full path<br />- <code>subtext-with-parent</code>: add a subtext with the parent name<br />- <code>no-parent</code>: does not show the parent at all</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>
|
|
@@ -20109,6 +20138,7 @@ UserSecurity
|
|
|
<span class="hljs-attr">"automaticallyOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"alwaysOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"showLabelOnMiniCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
+ <span class="hljs-attr">"showSumAtTopOfList"</span>: <span class="hljs-literal">true</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>
|
|
|
}
|
|
@@ -20184,6 +20214,13 @@ UserSecurity
|
|
|
<td>should the label of the custom field be shown on minicards?</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
+<td>showSumAtTopOfList</td>
|
|
|
+<td>boolean</td>
|
|
|
+<td>true</td>
|
|
|
+<td>none</td>
|
|
|
+<td>should the sum of the custom fields be shown at top of list?</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
<td>createdAt</td>
|
|
|
<td>string¦null</td>
|
|
|
<td>false</td>
|