|
@@ -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.17</title>
|
|
|
+ <title>Wekan REST API v5.20</title>
|
|
|
|
|
|
<style>
|
|
|
</style>
|
|
@@ -1549,7 +1549,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.17">Wekan REST API v5.17</a>
|
|
|
+ <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v5.20">Wekan REST API v5.20</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
@@ -2092,7 +2092,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.17</h1>
|
|
|
+ <h1 id="wekan-rest-api">Wekan REST API v5.20</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>
|
|
@@ -3478,7 +3478,7 @@ System.out.println(response.toString());
|
|
|
{
|
|
|
<span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>,
|
|
|
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
|
|
- <span class="hljs-attr">"color"</span>: <span class="hljs-string">"green"</span>
|
|
|
+ <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>
|
|
|
}
|
|
|
],
|
|
|
<span class="hljs-attr">"members"</span>: [
|
|
@@ -3506,6 +3506,7 @@ System.out.println(response.toString());
|
|
|
<span class="hljs-attr">"allowsDescriptionText"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsActivities"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsLabels"</span>: <span class="hljs-literal">true</span>,
|
|
|
+ <span class="hljs-attr">"allowsCreator"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsAssignee"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsMembers"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsRequestedBy"</span>: <span class="hljs-literal">true</span>,
|
|
@@ -3520,7 +3521,7 @@ System.out.println(response.toString());
|
|
|
<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">"type"</span>: <span class="hljs-string">"string"</span>,
|
|
|
+ <span class="hljs-attr">"type"</span>: <span class="hljs-string">"board"</span>,
|
|
|
<span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>
|
|
|
}
|
|
|
</code></pre>
|
|
@@ -9028,7 +9029,7 @@ System.out.println(response.toString());
|
|
|
<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">"type"</span>: <span class="hljs-string">"cardtype-card"</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>,
|
|
@@ -18169,7 +18170,7 @@ UserSecurity
|
|
|
{
|
|
|
<span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>,
|
|
|
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
|
|
- <span class="hljs-attr">"color"</span>: <span class="hljs-string">"green"</span>
|
|
|
+ <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>
|
|
|
}
|
|
|
],
|
|
|
<span class="hljs-attr">"members"</span>: [
|
|
@@ -18197,6 +18198,7 @@ UserSecurity
|
|
|
<span class="hljs-attr">"allowsDescriptionText"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsActivities"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsLabels"</span>: <span class="hljs-literal">true</span>,
|
|
|
+ <span class="hljs-attr">"allowsCreator"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsAssignee"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsMembers"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"allowsRequestedBy"</span>: <span class="hljs-literal">true</span>,
|
|
@@ -18211,7 +18213,7 @@ UserSecurity
|
|
|
<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">"type"</span>: <span class="hljs-string">"string"</span>,
|
|
|
+ <span class="hljs-attr">"type"</span>: <span class="hljs-string">"board"</span>,
|
|
|
<span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>
|
|
|
}
|
|
|
|
|
@@ -18398,6 +18400,13 @@ UserSecurity
|
|
|
<td>Does the board allows labels?</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
+<td>allowsCreator</td>
|
|
|
+<td>boolean</td>
|
|
|
+<td>true</td>
|
|
|
+<td>none</td>
|
|
|
+<td>Does the board allow creator?</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
<td>allowsAssignee</td>
|
|
|
<td>boolean</td>
|
|
|
<td>true</td>
|
|
@@ -18500,7 +18509,7 @@ UserSecurity
|
|
|
<td>string</td>
|
|
|
<td>true</td>
|
|
|
<td>none</td>
|
|
|
-<td>The type of board</td>
|
|
|
+<td>The type of board<br />possible values: board, template-board, template-container</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>sort</td>
|
|
@@ -18612,6 +18621,18 @@ UserSecurity
|
|
|
<td>presentParentTask</td>
|
|
|
<td>no-parent</td>
|
|
|
</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>board</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>template-board</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>template-container</td>
|
|
|
+</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="tocs_boardslabels">BoardsLabels</h2>
|
|
@@ -18622,7 +18643,7 @@ UserSecurity
|
|
|
<pre class="highlight tab tab-json"><code>{
|
|
|
<span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>,
|
|
|
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
|
|
- <span class="hljs-attr">"color"</span>: <span class="hljs-string">"green"</span>
|
|
|
+ <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>
|
|
|
}
|
|
|
|
|
|
</code></pre>
|
|
@@ -18672,6 +18693,10 @@ UserSecurity
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>color</td>
|
|
|
+<td>white</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>color</td>
|
|
|
<td>green</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
@@ -18953,7 +18978,7 @@ UserSecurity
|
|
|
<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">"type"</span>: <span class="hljs-string">"cardtype-card"</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>,
|
|
@@ -19310,6 +19335,18 @@ UserSecurity
|
|
|
<td>color</td>
|
|
|
<td>indigo</td>
|
|
|
</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>cardtype-card</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>cardtype-linkedcard</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>cardtype-linkedboard</td>
|
|
|
+</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="tocs_cardsvote">CardsVote</h2>
|
|
@@ -19564,7 +19601,9 @@ UserSecurity
|
|
|
<span class="hljs-attr">"currencyCode"</span>: <span class="hljs-string">"string"</span>,
|
|
|
<span class="hljs-attr">"dropdownItems"</span>: [
|
|
|
{}
|
|
|
- ]
|
|
|
+ ],
|
|
|
+ <span class="hljs-attr">"stringtemplateFormat"</span>: <span class="hljs-string">"string"</span>,
|
|
|
+ <span class="hljs-attr">"stringtemplateSeparator"</span>: <span class="hljs-string">"string"</span>
|
|
|
},
|
|
|
<span class="hljs-attr">"showOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
|
<span class="hljs-attr">"automaticallyOnCard"</span>: <span class="hljs-literal">true</span>,
|
|
@@ -19693,6 +19732,10 @@ UserSecurity
|
|
|
<td>type</td>
|
|
|
<td>currency</td>
|
|
|
</tr>
|
|
|
+<tr>
|
|
|
+<td>type</td>
|
|
|
+<td>stringtemplate</td>
|
|
|
+</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="tocs_customfieldssettings">CustomFieldsSettings</h2>
|
|
@@ -19704,7 +19747,9 @@ UserSecurity
|
|
|
<span class="hljs-attr">"currencyCode"</span>: <span class="hljs-string">"string"</span>,
|
|
|
<span class="hljs-attr">"dropdownItems"</span>: [
|
|
|
{}
|
|
|
- ]
|
|
|
+ ],
|
|
|
+ <span class="hljs-attr">"stringtemplateFormat"</span>: <span class="hljs-string">"string"</span>,
|
|
|
+ <span class="hljs-attr">"stringtemplateSeparator"</span>: <span class="hljs-string">"string"</span>
|
|
|
}
|
|
|
|
|
|
</code></pre>
|
|
@@ -19734,6 +19779,20 @@ UserSecurity
|
|
|
<td>none</td>
|
|
|
<td>list of drop down items objects</td>
|
|
|
</tr>
|
|
|
+<tr>
|
|
|
+<td>stringtemplateFormat</td>
|
|
|
+<td>string</td>
|
|
|
+<td>false</td>
|
|
|
+<td>none</td>
|
|
|
+<td>none</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>stringtemplateSeparator</td>
|
|
|
+<td>string</td>
|
|
|
+<td>false</td>
|
|
|
+<td>none</td>
|
|
|
+<td>none</td>
|
|
|
+</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="tocs_customfieldssettingsdropdownitems">CustomFieldsSettingsDropdownitems</h2>
|
|
@@ -20039,6 +20098,10 @@ UserSecurity
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>color</td>
|
|
|
+<td>silver</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>color</td>
|
|
|
<td>peachpuff</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
@@ -20297,6 +20360,10 @@ UserSecurity
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>color</td>
|
|
|
+<td>silver</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>color</td>
|
|
|
<td>peachpuff</td>
|
|
|
</tr>
|
|
|
<tr>
|