diff options
author | Lauri Ojansivu <x@xet7.org> | 2020-05-30 08:41:48 +0300 |
---|---|---|
committer | Lauri Ojansivu <x@xet7.org> | 2020-05-30 08:41:48 +0300 |
commit | 6ac3249272bcfe1aa98edbde5a5a0cd13d58a547 (patch) | |
tree | 472e7893bf4024e3bf04d3f5511eb11240ca3543 | |
parent | 784f960e8fac53c87d1c92b9f22c0f134c77d5f8 (diff) | |
download | wekan-6ac3249272bcfe1aa98edbde5a5a0cd13d58a547.tar.gz wekan-6ac3249272bcfe1aa98edbde5a5a0cd13d58a547.tar.bz2 wekan-6ac3249272bcfe1aa98edbde5a5a0cd13d58a547.zip |
v4.10v4.10
-rw-r--r-- | CHANGELOG.md | 2 | ||||
-rw-r--r-- | Stackerfile.yml | 2 | ||||
-rw-r--r-- | package-lock.json | 2 | ||||
-rw-r--r-- | package.json | 2 | ||||
-rw-r--r-- | public/api/wekan.html | 2652 | ||||
-rw-r--r-- | public/api/wekan.yml | 31 | ||||
-rw-r--r-- | sandstorm-pkgdef.capnp | 4 |
7 files changed, 1451 insertions, 1244 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 417ff959..de548351 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Upcoming Wekan release +# v4.10 2020-05-30 Wekan release This release adds the following new features: diff --git a/Stackerfile.yml b/Stackerfile.yml index 804ec536..59f26cb8 100644 --- a/Stackerfile.yml +++ b/Stackerfile.yml @@ -1,5 +1,5 @@ appId: wekan-public/apps/77b94f60-dec9-0136-304e-16ff53095928 -appVersion: "v4.09.0" +appVersion: "v4.10.0" files: userUploads: - README.md diff --git a/package-lock.json b/package-lock.json index 7efc5c9f..50387df6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "wekan", - "version": "v4.09.0", + "version": "v4.10.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index d44c51a3..175eef48 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wekan", - "version": "v4.09.0", + "version": "v4.10.0", "description": "Open-Source kanban", "private": true, "scripts": { diff --git a/public/api/wekan.html b/public/api/wekan.html index 7996c744..7d441b01 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 v4.09">Wekan REST API v4.09</a> + <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v4.10">Wekan REST API v4.10</a> </li> @@ -1689,6 +1689,50 @@ 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_board_customfieldvalue" class="toc-h2 toc-link" data-title="get_board_customFieldValue">get_board_customFieldValue</a> + + </li> + + <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-customfields" class="toc-h1 toc-link" data-title="CustomFields">CustomFields</a> <ul class="toc-list-h2"> @@ -1791,45 +1835,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"> @@ -2022,7 +2027,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 v4.09</h1> + <h1 id="wekan-rest-api">Wekan REST API v4.10</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> @@ -6397,31 +6402,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h1 id="wekan-rest-api-customfields">CustomFields</h1> -<h2 id="get_all_custom_fields">get_all_custom_fields</h2> -<p><a id="opIdget_all_custom_fields"></a></p> +<h1 id="wekan-rest-api-cards">Cards</h1> +<h2 id="get_board_customfieldvalue">get_board_customFieldValue</h2> +<p><a id="opIdget_board_customFieldValue"></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}/custom-fields \ - -H <span class="hljs-string">'Accept: application/json'</span> \ +curl -X GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} \ -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}/custom-fields</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}</span> HTTP/1.1 -<span class="http"><span class="hljs-attribute">Accept</span>: application/json - -<span class="undefined"></span></span></code></pre> +<span class="undefined"></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}/custom-fields'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, <span class="hljs-attr">headers</span>: headers, @@ -6434,12 +6435,11 @@ $.ajax({ <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}/custom-fields'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'</span>, { <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, @@ -6456,11 +6456,10 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -6469,18 +6468,17 @@ 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}/custom-fields'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'</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}/custom-fields"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod(<span class="hljs-string">"GET"</span>); <span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); @@ -6505,13 +6503,12 @@ System.out.println(response.toString()); <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}/custom-fields"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}"</span>, data) req.Header = headers client := &http.Client{} @@ -6520,9 +6517,8 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/custom-fields</code></p> -<p><em>Get the list of Custom Fields attached to a board</em></p> -<h3 id="get_all_custom_fields-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}</code></p> +<h3 id="get_board_customfieldvalue-parameters">Parameters</h3> <table> <thead> <tr> @@ -6541,23 +6537,23 @@ System.out.println(response.toString()); <td>true</td> <td>the board value</td> </tr> +<tr> +<td>customField</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the customField value</td> +</tr> +<tr> +<td>customFieldValue</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the customFieldValue value</td> +</tr> </tbody> </table> -<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">"name"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span> - } -] -</code></pre> -<h3 id="get_all_custom_fields-responses">Responses</h3> +<h3 id="get_board_customfieldvalue-responses">Responses</h3> <table> <thead> <tr> @@ -6572,43 +6568,7 @@ System.out.println(response.toString()); <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_custom_fields-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>» name</td> -<td>string</td> -<td>false</td> -<td>none</td> -<td>none</td> -</tr> -<tr> -<td>» type</td> -<td>string</td> -<td>false</td> -<td>none</td> -<td>none</td> +<td>None</td> </tr> </tbody> </table> @@ -6616,34 +6576,31 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="new_custom_field">new_custom_field</h2> -<p><a id="opIdnew_custom_field"></a></p> +<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 POST /api/boards/{board}/custom-fields \ - -H <span class="hljs-string">'Content-Type: multipart/form-data'</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">POST</span> <span class="hljs-string">/api/boards/{board}/custom-fields</span> HTTP/1.1 +<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="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 class="http"><span class="hljs-attribute">Accept</span>: application/json -</span></code></pre> +<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">'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}/custom-fields'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, + <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>{ @@ -6653,26 +6610,17 @@ $.ajax({ </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">'{ - "name": "string", - "type": "string", - "settings": "string", - "showOnCard": true, - "automaticallyOnCard": true, - "showLabelOnMiniCard": true, - "authorId": "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}/custom-fields'</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">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>{ @@ -6686,12 +6634,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.post <span class="hljs-string">'/api/boards/{board}/custom-fields'</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 @@ -6700,21 +6647,20 @@ 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}/custom-fields'</span>, params={ +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}/custom-fields"</span>); +<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>); +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())); @@ -6737,14 +6683,13 @@ System.out.println(response.toString()); <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}/custom-fields"</span>, data) + 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 := &http.Client{} @@ -6753,21 +6698,9 @@ System.out.println(response.toString()); } </code></pre> -<p><code>POST /api/boards/{board}/custom-fields</code></p> -<p><em>Create a Custom Field</em></p> -<blockquote> -<p>Body parameter</p> -</blockquote> -<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">name:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">type:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">settings:</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> -<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span> -<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span> - -</code></pre> -<h3 id="new_custom_field-parameters">Parameters</h3> +<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> @@ -6784,77 +6717,35 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> -</tr> -<tr> -<td>body</td> -<td>body</td> -<td>object</td> -<td>false</td> -<td>none</td> -</tr> -<tr> -<td>» name</td> -<td>body</td> -<td>string</td> -<td>true</td> -<td>the name of the custom field</td> -</tr> -<tr> -<td>» type</td> -<td>body</td> -<td>string</td> -<td>true</td> -<td>the type of the custom field</td> -</tr> -<tr> -<td>» settings</td> -<td>body</td> -<td>string</td> -<td>true</td> -<td>the settings object of the custom field</td> -</tr> -<tr> -<td>» showOnCard</td> -<td>body</td> -<td>boolean</td> -<td>true</td> -<td>should we show the custom field on cards?</td> -</tr> -<tr> -<td>» automaticallyOnCard</td> -<td>body</td> -<td>boolean</td> -<td>true</td> -<td>should the custom fields automatically be added on cards?</td> -</tr> -<tr> -<td>» showLabelOnMiniCard</td> -<td>body</td> -<td>boolean</td> -<td>true</td> -<td>should the label of the custom field be shown on minicards?</td> +<td>the board ID</td> </tr> <tr> -<td>» authorId</td> -<td>body</td> +<td>list</td> +<td>path</td> <td>string</td> <td>true</td> -<td>the authorId value</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> -} +<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="new_custom_field-responses">Responses</h3> +<h3 id="get_all_cards-responses">Responses</h3> <table> <thead> <tr> @@ -6873,7 +6764,7 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="new_custom_field-responseschema">Response Schema</h3> +<h3 id="get_all_cards-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -6893,33 +6784,54 @@ System.out.println(response.toString()); <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="get_board_customfield">get_board_customField</h2> -<p><a id="opIdget_board_customField"></a></p> +<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 GET /api/boards/{board}/custom-fields/{customField} \ +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">GET</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 +<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="undefined"></span></code></pre> +<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}/custom-fields/{customField}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, + <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>{ @@ -6929,16 +6841,25 @@ $.ajax({ </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}/custom-fields/{customField}'</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">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>{ @@ -6952,10 +6873,12 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField} <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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 @@ -6964,19 +6887,21 @@ 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.get(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, params={ +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}/custom-fields/{customField}"</span>); +<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>); +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())); @@ -6999,12 +6924,14 @@ System.out.println(response.toString()); <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">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>, data) + 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 := &http.Client{} @@ -7013,8 +6940,20 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/custom-fields/{customField}</code></p> -<h3 id="get_board_customfield-parameters">Parameters</h3> +<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> @@ -7031,18 +6970,80 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID of the new card</td> </tr> <tr> -<td>customField</td> +<td>list</td> <td>path</td> <td>string</td> <td>true</td> -<td>the customField value</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> -<h3 id="get_board_customfield-responses">Responses</h3> +<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> @@ -7057,7 +7058,29 @@ System.out.println(response.toString()); <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> +<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> @@ -7065,17 +7088,17 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_customfield">delete_board_customField</h2> -<p><a id="opIddelete_board_customField"></a></p> +<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 DELETE /api/boards/{board}/custom-fields/{customField} \ +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">DELETE</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 +<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 = { @@ -7084,8 +7107,8 @@ curl -X DELETE /api/boards/{board}/custom-fields/{customField} \ }; $.ajax({ - <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + <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>{ @@ -7101,9 +7124,9 @@ $.ajax({ }; -fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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">method</span>: <span class="hljs-string">'GET'</span>, <span class="hljs-attr">headers</span>: headers }) @@ -7121,7 +7144,7 @@ headers = { <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } -result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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 @@ -7133,16 +7156,16 @@ headers = { <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } -r = requests.delete(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, params={ +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}/custom-fields/{customField}"</span>); +<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>); +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())); @@ -7170,7 +7193,7 @@ System.out.println(response.toString()); } 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}/custom-fields/{customField}"</span>, data) + 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 := &http.Client{} @@ -7179,8 +7202,8 @@ System.out.println(response.toString()); } </code></pre> -<p><code>DELETE /api/boards/{board}/custom-fields/{customField}</code></p> -<h3 id="delete_board_customfield-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/lists/{list}/cards/{card}</code></p> +<h3 id="get_board_list_card-parameters">Parameters</h3> <table> <thead> <tr> @@ -7200,15 +7223,22 @@ System.out.println(response.toString()); <td>the board value</td> </tr> <tr> -<td>customField</td> +<td>list</td> <td>path</td> <td>string</td> <td>true</td> -<td>the customField value</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_customfield-responses">Responses</h3> +<h3 id="get_board_list_card-responses">Responses</h3> <table> <thead> <tr> @@ -7231,32 +7261,31 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h1 id="wekan-rest-api-integrations">Integrations</h1> -<h2 id="get_all_integrations">get_all_integrations</h2> -<p><a id="opIdget_all_integrations"></a></p> +<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 GET /api/boards/{board}/integrations \ - -H <span class="hljs-string">'Accept: application/json'</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">GET</span> <span class="hljs-string">/api/boards/{board}/integrations</span> HTTP/1.1 +<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="http"><span class="hljs-attribute">Accept</span>: application/json +<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> -<span class="undefined"></span></span></code></pre> +</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">'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}/integrations'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, + <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>{ @@ -7266,17 +7295,37 @@ $.ajax({ </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">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <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}/integrations'</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">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>{ @@ -7290,11 +7339,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { - <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, + <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> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/integrations'</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 @@ -7303,20 +7352,20 @@ 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">'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.get(<span class="hljs-string">'/api/boards/{board}/integrations'</span>, params={ +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}/integrations"</span>); +<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>); +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())); @@ -7339,13 +7388,13 @@ System.out.println(response.toString()); <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">"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">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/integrations"</span>, data) + 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 := &http.Client{} @@ -7354,9 +7403,32 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/integrations</code></p> -<p><em>Get all integrations in board</em></p> -<h3 id="get_all_integrations-parameters">Parameters</h3> +<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> @@ -7373,143 +7445,180 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board ID</td> -</tr> -</tbody> -</table> -<h4 id="detailed-descriptions">Detailed descriptions</h4> -<p><strong>board</strong>: the board 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">"enabled"</span>: <span class="hljs-literal">true</span>, - <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"activities"</span>: [ - <span class="hljs-string">"string"</span> - ], - <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</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">"userId"</span>: <span class="hljs-string">"string"</span> - } -] -</code></pre> -<h3 id="get_all_integrations-responses">Responses</h3> -<table> -<thead> -<tr> -<th>Status</th> -<th>Meaning</th> -<th>Description</th> -<th>Schema</th> +<td>the board value</td> </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> +<td>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list value</td> </tr> -</tbody> -</table> -<h3 id="get_all_integrations-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> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> </tr> -</thead> -<tbody> <tr> -<td><em>anonymous</em></td> -<td>[<a href="#schemaintegrations">Integrations</a>]</td> +<td>body</td> +<td>body</td> +<td>object</td> <td>false</td> <td>none</td> -<td>[Integration with third-party applications]</td> </tr> <tr> -<td>» enabled</td> -<td>boolean</td> +<td>» title</td> +<td>body</td> +<td>string</td> <td>true</td> -<td>none</td> -<td>is the integration enabled?</td> +<td>the title value</td> </tr> <tr> -<td>» title</td> -<td>string|null</td> -<td>false</td> -<td>none</td> -<td>name of the integration</td> +<td>» listId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the listId value</td> </tr> <tr> -<td>» type</td> +<td>» authorId</td> +<td>body</td> <td>string</td> <td>true</td> -<td>none</td> -<td>type of the integratation (Default to 'outgoing-webhooks')</td> +<td>the authorId value</td> </tr> <tr> -<td>» activities</td> -<td>[string]</td> +<td>» parentId</td> +<td>body</td> +<td>string</td> <td>true</td> -<td>none</td> -<td>activities the integration gets triggered (list)</td> +<td>the parentId value</td> </tr> <tr> -<td>» url</td> +<td>» description</td> +<td>body</td> <td>string</td> <td>true</td> -<td>none</td> -<td>none</td> +<td>the description value</td> </tr> <tr> -<td>» token</td> -<td>string|null</td> -<td>false</td> -<td>none</td> -<td>token of the integration</td> +<td>» color</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the color value</td> </tr> <tr> -<td>» boardId</td> +<td>» labelIds</td> +<td>body</td> <td>string</td> <td>true</td> -<td>none</td> -<td>Board ID of the integration</td> +<td>the labelIds value</td> </tr> <tr> -<td>» createdAt</td> +<td>» requestedBy</td> +<td>body</td> <td>string</td> <td>true</td> -<td>none</td> -<td>Creation date of the integration</td> +<td>the requestedBy value</td> </tr> <tr> -<td>» modifiedAt</td> +<td>» assignedBy</td> +<td>body</td> <td>string</td> <td>true</td> -<td>none</td> -<td>none</td> +<td>the assignedBy value</td> </tr> <tr> -<td>» userId</td> +<td>» receivedAt</td> +<td>body</td> <td>string</td> <td>true</td> -<td>none</td> -<td>user ID who created the interation</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> @@ -7517,34 +7626,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="new_integration">new_integration</h2> -<p><a id="opIdnew_integration"></a></p> +<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 POST /api/boards/{board}/integrations \ - -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ - -H <span class="hljs-string">'Accept: application/json'</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">POST</span> <span class="hljs-string">/api/boards/{board}/integrations</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 +<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></code></pre> +<span class="undefined"></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}/integrations'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, + <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>{ @@ -7554,20 +7656,16 @@ $.ajax({ </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">'{ - "url": "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}/integrations'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>, - <span class="hljs-attr">body</span>: inputBody, + <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>{ @@ -7581,12 +7679,10 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.post <span class="hljs-string">'/api/boards/{board}/integrations'</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 @@ -7595,21 +7691,19 @@ 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}/integrations'</span>, params={ +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}/integrations"</span>); +<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">"POST"</span>); +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())); @@ -7632,14 +7726,12 @@ System.out.println(response.toString()); <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}/integrations"</span>, data) + 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 := &http.Client{} @@ -7648,15 +7740,8 @@ System.out.println(response.toString()); } </code></pre> -<p><code>POST /api/boards/{board}/integrations</code></p> -<p><em>Create a new integration</em></p> -<blockquote> -<p>Body parameter</p> -</blockquote> -<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">url:</span> <span class="hljs-string">string</span> - -</code></pre> -<h3 id="new_integration-parameters">Parameters</h3> +<p><code>DELETE /api/boards/{board}/lists/{list}/cards/{card}</code></p> +<h3 id="delete_board_list_card-parameters">Parameters</h3> <table> <thead> <tr> @@ -7673,37 +7758,25 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board ID</td> +<td>the board value</td> </tr> <tr> -<td>body</td> -<td>body</td> -<td>object</td> -<td>false</td> -<td>none</td> +<td>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list value</td> </tr> <tr> -<td>» url</td> -<td>body</td> +<td>card</td> +<td>path</td> <td>string</td> <td>true</td> -<td>the URL of the integration</td> +<td>the card value</td> </tr> </tbody> </table> -<h4 id="detailed-descriptions">Detailed descriptions</h4> -<p><strong>board</strong>: the board 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> -} -</code></pre> -<h3 id="new_integration-responses">Responses</h3> +<h3 id="delete_board_list_card-responses">Responses</h3> <table> <thead> <tr> @@ -7718,29 +7791,7 @@ System.out.println(response.toString()); <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_integration-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> +<td>None</td> </tr> </tbody> </table> @@ -7748,30 +7799,26 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_integration">get_integration</h2> -<p><a id="opIdget_integration"></a></p> +<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}/integrations/{int} \ - -H <span class="hljs-string">'Accept: application/json'</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}/integrations/{int}</span> HTTP/1.1 - -<span class="http"><span class="hljs-attribute">Accept</span>: application/json +<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></span></code></pre> +<span class="undefined"></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}/integrations/{int}'</span>, + <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, @@ -7784,12 +7831,11 @@ $.ajax({ <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}/integrations/{int}'</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>, @@ -7806,11 +7852,10 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</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 @@ -7819,18 +7864,17 @@ 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}/integrations/{int}'</span>, params={ +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}/integrations/{int}"</span>); +<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(); @@ -7855,13 +7899,12 @@ System.out.println(response.toString()); <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}/integrations/{int}"</span>, data) + 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 := &http.Client{} @@ -7870,9 +7913,8 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/integrations/{int}</code></p> -<p><em>Get a single integration in board</em></p> -<h3 id="get_integration-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/swimlanes/{swimlane}/cards</code></p> +<h3 id="get_board_swimlane_cards-parameters">Parameters</h3> <table> <thead> <tr> @@ -7889,42 +7931,18 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board ID</td> +<td>the board value</td> </tr> <tr> -<td>int</td> +<td>swimlane</td> <td>path</td> <td>string</td> <td>true</td> -<td>the integration ID</td> +<td>the swimlane value</td> </tr> </tbody> </table> -<h4 id="detailed-descriptions">Detailed descriptions</h4> -<p><strong>board</strong>: the board ID</p> -<p><strong>int</strong>: the integration 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">"enabled"</span>: <span class="hljs-literal">true</span>, - <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"activities"</span>: [ - <span class="hljs-string">"string"</span> - ], - <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</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">"userId"</span>: <span class="hljs-string">"string"</span> -} -</code></pre> -<h3 id="get_integration-responses">Responses</h3> +<h3 id="get_board_swimlane_cards-responses">Responses</h3> <table> <thead> <tr> @@ -7939,7 +7957,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td><a href="#schemaintegrations">Integrations</a></td> +<td>None</td> </tr> </tbody> </table> @@ -7947,34 +7965,32 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="edit_integration">edit_integration</h2> -<p><a id="opIdedit_integration"></a></p> +<h1 id="wekan-rest-api-customfields">CustomFields</h1> +<h2 id="get_all_custom_fields">get_all_custom_fields</h2> +<p><a id="opIdget_all_custom_fields"></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}/integrations/{int} \ - -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ +curl -X GET /api/boards/{board}/custom-fields \ -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">PUT</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/custom-fields</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 class="http"><span class="hljs-attribute">Accept</span>: application/json -</span></code></pre> +<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">'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}/integrations/{int}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'put'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields'</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>{ @@ -7984,24 +8000,17 @@ $.ajax({ </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">'{ - "enabled": "string", - "title": "string", - "url": "string", - "token": "string", - "activities": "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}/integrations/{int}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'PUT'</span>, - <span class="hljs-attr">body</span>: inputBody, + <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>{ @@ -8015,12 +8024,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.put <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -8029,21 +8037,20 @@ 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.put(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/custom-fields'</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}/integrations/{int}"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"PUT"</span>); +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())); @@ -8066,14 +8073,13 @@ System.out.println(response.toString()); <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">"PUT"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields"</span>, data) req.Header = headers client := &http.Client{} @@ -8082,19 +8088,9 @@ System.out.println(response.toString()); } </code></pre> -<p><code>PUT /api/boards/{board}/integrations/{int}</code></p> -<p><em>Edit integration data</em></p> -<blockquote> -<p>Body parameter</p> -</blockquote> -<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">enabled:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">title:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">url:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">token:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> - -</code></pre> -<h3 id="edit_integration-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/custom-fields</code></p> +<p><em>Get the list of Custom Fields attached to a board</em></p> +<h3 id="get_all_custom_fields-parameters">Parameters</h3> <table> <thead> <tr> @@ -8111,73 +8107,25 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board ID</td> -</tr> -<tr> -<td>int</td> -<td>path</td> -<td>string</td> -<td>true</td> -<td>the integration ID</td> -</tr> -<tr> -<td>body</td> -<td>body</td> -<td>object</td> -<td>false</td> -<td>none</td> -</tr> -<tr> -<td>» enabled</td> -<td>body</td> -<td>string</td> -<td>false</td> -<td>is the integration enabled?</td> -</tr> -<tr> -<td>» title</td> -<td>body</td> -<td>string</td> -<td>false</td> -<td>new name of the integration</td> -</tr> -<tr> -<td>» url</td> -<td>body</td> -<td>string</td> -<td>false</td> -<td>new URL of the integration</td> -</tr> -<tr> -<td>» token</td> -<td>body</td> -<td>string</td> -<td>false</td> -<td>new token of the integration</td> -</tr> -<tr> -<td>» activities</td> -<td>body</td> -<td>string</td> -<td>false</td> -<td>new list of activities of the integration</td> +<td>the board value</td> </tr> </tbody> </table> -<h4 id="detailed-descriptions">Detailed descriptions</h4> -<p><strong>board</strong>: the board ID</p> -<p><strong>int</strong>: the integration 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> -} +<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">"type"</span>: <span class="hljs-string">"string"</span> + } +] </code></pre> -<h3 id="edit_integration-responses">Responses</h3> +<h3 id="get_all_custom_fields-responses">Responses</h3> <table> <thead> <tr> @@ -8196,7 +8144,7 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="edit_integration-responseschema">Response Schema</h3> +<h3 id="get_all_custom_fields-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -8216,37 +8164,54 @@ System.out.println(response.toString()); <td>none</td> <td>none</td> </tr> +<tr> +<td>» name</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» type</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="delete_integration">delete_integration</h2> -<p><a id="opIddelete_integration"></a></p> +<h2 id="new_custom_field">new_custom_field</h2> +<p><a id="opIdnew_custom_field"></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}/integrations/{int} \ +curl -X POST /api/boards/{board}/custom-fields \ + -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">DELETE</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/custom-fields</span> HTTP/1.1 -<span class="http"><span class="hljs-attribute">Accept</span>: application/json +<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 class="undefined"></span></span></code></pre> +</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}/integrations/{int}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields'</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>{ @@ -8256,17 +8221,26 @@ $.ajax({ </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">'{ + "name": "string", + "type": "string", + "settings": "string", + "showOnCard": true, + "automaticallyOnCard": true, + "showLabelOnMiniCard": true, + "authorId": "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}/integrations/{int}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</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>{ @@ -8280,11 +8254,12 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -8293,20 +8268,21 @@ 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.delete(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, params={ +r = requests.post(<span class="hljs-string">'/api/boards/{board}/custom-fields'</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}/integrations/{int}"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +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())); @@ -8329,13 +8305,14 @@ System.out.println(response.toString()); <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">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields"</span>, data) req.Header = headers client := &http.Client{} @@ -8344,9 +8321,21 @@ System.out.println(response.toString()); } </code></pre> -<p><code>DELETE /api/boards/{board}/integrations/{int}</code></p> -<p><em>Delete integration</em></p> -<h3 id="delete_integration-parameters">Parameters</h3> +<p><code>POST /api/boards/{board}/custom-fields</code></p> +<p><em>Create a Custom Field</em></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">name:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">type:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">settings:</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> +<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span> +<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="new_custom_field-parameters">Parameters</h3> <table> <thead> <tr> @@ -8363,20 +8352,66 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board ID</td> +<td>the board value</td> </tr> <tr> -<td>int</td> -<td>path</td> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» name</td> +<td>body</td> <td>string</td> <td>true</td> -<td>the integration ID</td> +<td>the name of the custom field</td> +</tr> +<tr> +<td>» type</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the type of the custom field</td> +</tr> +<tr> +<td>» settings</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the settings object of the custom field</td> +</tr> +<tr> +<td>» showOnCard</td> +<td>body</td> +<td>boolean</td> +<td>true</td> +<td>should we show the custom field on cards?</td> +</tr> +<tr> +<td>» automaticallyOnCard</td> +<td>body</td> +<td>boolean</td> +<td>true</td> +<td>should the custom fields automatically be added on cards?</td> +</tr> +<tr> +<td>» showLabelOnMiniCard</td> +<td>body</td> +<td>boolean</td> +<td>true</td> +<td>should the label of the custom field be shown on minicards?</td> +</tr> +<tr> +<td>» authorId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the authorId value</td> </tr> </tbody> </table> -<h4 id="detailed-descriptions">Detailed descriptions</h4> -<p><strong>board</strong>: the board ID</p> -<p><strong>int</strong>: the integration ID</p> <blockquote> <p>Example responses</p> </blockquote> @@ -8387,7 +8422,7 @@ System.out.println(response.toString()); <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> } </code></pre> -<h3 id="delete_integration-responses">Responses</h3> +<h3 id="new_custom_field-responses">Responses</h3> <table> <thead> <tr> @@ -8406,7 +8441,7 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="delete_integration-responseschema">Response Schema</h3> +<h3 id="new_custom_field-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -8432,17 +8467,17 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_int_activities">delete_board_int_activities</h2> -<p><a id="opIddelete_board_int_activities"></a></p> +<h2 id="get_board_customfield">get_board_customField</h2> +<p><a id="opIdget_board_customField"></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}/integrations/{int}/activities \ +curl -X GET /api/boards/{board}/custom-fields/{customField} \ -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}/integrations/{int}/activities</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 <span class="undefined"></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { @@ -8451,8 +8486,8 @@ curl -X DELETE /api/boards/{board}/integrations/{int}/activities \ }; $.ajax({ - <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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>{ @@ -8468,9 +8503,9 @@ $.ajax({ }; -fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, <span class="hljs-attr">headers</span>: headers }) @@ -8488,7 +8523,7 @@ headers = { <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } -result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -8500,16 +8535,16 @@ headers = { <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } -r = requests.delete(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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}/integrations/{int}/activities"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +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())); @@ -8537,7 +8572,7 @@ System.out.println(response.toString()); } 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}/integrations/{int}/activities"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>, data) req.Header = headers client := &http.Client{} @@ -8546,8 +8581,8 @@ System.out.println(response.toString()); } </code></pre> -<p><code>DELETE /api/boards/{board}/integrations/{int}/activities</code></p> -<h3 id="delete_board_int_activities-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/custom-fields/{customField}</code></p> +<h3 id="get_board_customfield-parameters">Parameters</h3> <table> <thead> <tr> @@ -8567,15 +8602,15 @@ System.out.println(response.toString()); <td>the board value</td> </tr> <tr> -<td>int</td> +<td>customField</td> <td>path</td> <td>string</td> <td>true</td> -<td>the int value</td> +<td>the customField value</td> </tr> </tbody> </table> -<h3 id="delete_board_int_activities-responses">Responses</h3> +<h3 id="get_board_customfield-responses">Responses</h3> <table> <thead> <tr> @@ -8598,31 +8633,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="post_board_int_activities">post_board_int_activities</h2> -<p><a id="opIdpost_board_int_activities"></a></p> +<h2 id="delete_board_customfield">delete_board_customField</h2> +<p><a id="opIddelete_board_customField"></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}/integrations/{int}/activities \ - -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ +curl -X DELETE /api/boards/{board}/custom-fields/{customField} \ -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}/integrations/{int}/activities</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> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 -</span></code></pre> +<span class="undefined"></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}/integrations/{int}/activities'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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>{ @@ -8632,19 +8663,16 @@ $.ajax({ </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">'{ - "activities": "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}/integrations/{int}/activities'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>, - <span class="hljs-attr">body</span>: inputBody, + <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>{ @@ -8658,11 +8686,10 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activiti <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.post <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -8671,20 +8698,19 @@ 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.post(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, params={ +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</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}/integrations/{int}/activities"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"POST"</span>); +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())); @@ -8707,13 +8733,12 @@ System.out.println(response.toString()); <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">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>, data) req.Header = headers client := &http.Client{} @@ -8722,14 +8747,8 @@ System.out.println(response.toString()); } </code></pre> -<p><code>POST /api/boards/{board}/integrations/{int}/activities</code></p> -<blockquote> -<p>Body parameter</p> -</blockquote> -<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> - -</code></pre> -<h3 id="post_board_int_activities-parameters">Parameters</h3> +<p><code>DELETE /api/boards/{board}/custom-fields/{customField}</code></p> +<h3 id="delete_board_customfield-parameters">Parameters</h3> <table> <thead> <tr> @@ -8749,29 +8768,15 @@ System.out.println(response.toString()); <td>the board value</td> </tr> <tr> -<td>int</td> +<td>customField</td> <td>path</td> <td>string</td> <td>true</td> -<td>the int value</td> -</tr> -<tr> -<td>body</td> -<td>body</td> -<td>object</td> -<td>false</td> -<td>none</td> -</tr> -<tr> -<td>» activities</td> -<td>body</td> -<td>string</td> -<td>true</td> -<td>the activities value</td> +<td>the customField value</td> </tr> </tbody> </table> -<h3 id="post_board_int_activities-responses">Responses</h3> +<h3 id="delete_board_customfield-responses">Responses</h3> <table> <thead> <tr> @@ -8794,19 +8799,19 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h1 id="wekan-rest-api-lists">Lists</h1> -<h2 id="get_all_lists">get_all_lists</h2> -<p><a id="opIdget_all_lists"></a></p> +<h1 id="wekan-rest-api-integrations">Integrations</h1> +<h2 id="get_all_integrations">get_all_integrations</h2> +<p><a id="opIdget_all_integrations"></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 \ +curl -X GET /api/boards/{board}/integrations \ -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</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/integrations</span> HTTP/1.1 <span class="http"><span class="hljs-attribute">Accept</span>: application/json @@ -8818,7 +8823,7 @@ curl -X GET /api/boards/{board}/lists \ }; $.ajax({ - <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations'</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, <span class="hljs-attr">headers</span>: headers, @@ -8836,7 +8841,7 @@ $.ajax({ }; -fetch(<span class="hljs-string">'/api/boards/{board}/lists'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/integrations'</span>, { <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, @@ -8857,7 +8862,7 @@ headers = { <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/integrations'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -8870,14 +8875,14 @@ 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'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/integrations'</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"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod(<span class="hljs-string">"GET"</span>); <span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); @@ -8908,7 +8913,7 @@ System.out.println(response.toString()); } 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"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/integrations"</span>, data) req.Header = headers client := &http.Client{} @@ -8917,9 +8922,9 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/lists</code></p> -<p><em>Get the list of Lists attached to a board</em></p> -<h3 id="get_all_lists-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/integrations</code></p> +<p><em>Get all integrations in board</em></p> +<h3 id="get_all_integrations-parameters">Parameters</h3> <table> <thead> <tr> @@ -8950,12 +8955,22 @@ System.out.println(response.toString()); </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">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"activities"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</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">"userId"</span>: <span class="hljs-string">"string"</span> } ] </code></pre> -<h3 id="get_all_lists-responses">Responses</h3> +<h3 id="get_all_integrations-responses">Responses</h3> <table> <thead> <tr> @@ -8974,7 +8989,7 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="get_all_lists-responseschema">Response Schema</h3> +<h3 id="get_all_integrations-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -8988,38 +9003,101 @@ System.out.println(response.toString()); </thead> <tbody> <tr> -<td>» _id</td> -<td>string</td> +<td><em>anonymous</em></td> +<td>[<a href="#schemaintegrations">Integrations</a>]</td> <td>false</td> <td>none</td> +<td>[Integration with third-party applications]</td> +</tr> +<tr> +<td>» enabled</td> +<td>boolean</td> +<td>true</td> <td>none</td> +<td>is the integration enabled?</td> </tr> <tr> <td>» title</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>name of the integration</td> +</tr> +<tr> +<td>» type</td> <td>string</td> +<td>true</td> +<td>none</td> +<td>type of the integratation (Default to 'outgoing-webhooks')</td> +</tr> +<tr> +<td>» activities</td> +<td>[string]</td> +<td>true</td> +<td>none</td> +<td>activities the integration gets triggered (list)</td> +</tr> +<tr> +<td>» url</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» token</td> +<td>string|null</td> <td>false</td> <td>none</td> +<td>token of the integration</td> +</tr> +<tr> +<td>» boardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Board ID of the integration</td> +</tr> +<tr> +<td>» createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Creation date of the integration</td> +</tr> +<tr> +<td>» modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> <td>none</td> </tr> +<tr> +<td>» userId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>user ID who created the interation</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_list">new_list</h2> -<p><a id="opIdnew_list"></a></p> +<h2 id="new_integration">new_integration</h2> +<p><a id="opIdnew_integration"></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 \ +curl -X POST /api/boards/{board}/integrations \ -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</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/integrations</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 @@ -9033,7 +9111,7 @@ Accept: application/json }; $.ajax({ - <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations'</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, <span class="hljs-attr">headers</span>: headers, @@ -9045,7 +9123,7 @@ $.ajax({ </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" + "url": "string" }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, @@ -9054,7 +9132,7 @@ $.ajax({ }; -fetch(<span class="hljs-string">'/api/boards/{board}/lists'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/integrations'</span>, { <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>, <span class="hljs-attr">body</span>: inputBody, @@ -9076,7 +9154,7 @@ headers = { <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } -result = RestClient.post <span class="hljs-string">'/api/boards/{board}/lists'</span>, +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/integrations'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -9090,14 +9168,14 @@ headers = { <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } -r = requests.post(<span class="hljs-string">'/api/boards/{board}/lists'</span>, params={ +r = requests.post(<span class="hljs-string">'/api/boards/{board}/integrations'</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"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod(<span class="hljs-string">"POST"</span>); <span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); @@ -9129,7 +9207,7 @@ System.out.println(response.toString()); } 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"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/integrations"</span>, data) req.Header = headers client := &http.Client{} @@ -9138,15 +9216,15 @@ System.out.println(response.toString()); } </code></pre> -<p><code>POST /api/boards/{board}/lists</code></p> -<p><em>Add a List to a board</em></p> +<p><code>POST /api/boards/{board}/integrations</code></p> +<p><em>Create a new integration</em></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> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">url:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="new_list-parameters">Parameters</h3> +<h3 id="new_integration-parameters">Parameters</h3> <table> <thead> <tr> @@ -9173,11 +9251,11 @@ System.out.println(response.toString()); <td>none</td> </tr> <tr> -<td>» title</td> +<td>» url</td> <td>body</td> <td>string</td> <td>true</td> -<td>the title of the List</td> +<td>the URL of the integration</td> </tr> </tbody> </table> @@ -9193,7 +9271,7 @@ System.out.println(response.toString()); <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> } </code></pre> -<h3 id="new_list-responses">Responses</h3> +<h3 id="new_integration-responses">Responses</h3> <table> <thead> <tr> @@ -9212,7 +9290,7 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="new_list-responseschema">Response Schema</h3> +<h3 id="new_integration-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -9238,18 +9316,18 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_list">get_list</h2> -<p><a id="opIdget_list"></a></p> +<h2 id="get_integration">get_integration</h2> +<p><a id="opIdget_integration"></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} \ +curl -X GET /api/boards/{board}/integrations/{int} \ -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}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</span> HTTP/1.1 <span class="http"><span class="hljs-attribute">Accept</span>: application/json @@ -9261,7 +9339,7 @@ curl -X GET /api/boards/{board}/lists/{list} \ }; $.ajax({ - <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, <span class="hljs-attr">headers</span>: headers, @@ -9279,7 +9357,7 @@ $.ajax({ }; -fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, { <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, @@ -9300,7 +9378,7 @@ headers = { <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -9313,14 +9391,14 @@ 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}'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</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}"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod(<span class="hljs-string">"GET"</span>); <span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); @@ -9351,7 +9429,7 @@ System.out.println(response.toString()); } 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}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>, data) req.Header = headers client := &http.Client{} @@ -9360,9 +9438,9 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/lists/{list}</code></p> -<p><em>Get a List attached to a board</em></p> -<h3 id="get_list-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/integrations/{int}</code></p> +<p><em>Get a single integration in board</em></p> +<h3 id="get_integration-parameters">Parameters</h3> <table> <thead> <tr> @@ -9382,17 +9460,17 @@ System.out.println(response.toString()); <td>the board ID</td> </tr> <tr> -<td>list</td> +<td>int</td> <td>path</td> <td>string</td> <td>true</td> -<td>the List ID</td> +<td>the integration 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> +<p><strong>int</strong>: the integration ID</p> <blockquote> <p>Example responses</p> </blockquote> @@ -9400,25 +9478,21 @@ System.out.println(response.toString()); <p>200 Response</p> </blockquote> <pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"starred"</span>: <span class="hljs-literal">true</span>, - <span class="hljs-attr">"archived"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"activities"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"swimlaneId"</span>: <span class="hljs-string">"string"</span>, <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, - <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"wipLimit"</span>: { - <span class="hljs-attr">"value"</span>: <span class="hljs-number">0</span>, - <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, - <span class="hljs-attr">"soft"</span>: <span class="hljs-literal">true</span> - }, - <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>, - <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span> + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span> } </code></pre> -<h3 id="get_list-responses">Responses</h3> +<h3 id="get_integration-responses">Responses</h3> <table> <thead> <tr> @@ -9433,7 +9507,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td><a href="#schemalists">Lists</a></td> +<td><a href="#schemaintegrations">Integrations</a></td> </tr> </tbody> </table> @@ -9441,31 +9515,34 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_list">delete_list</h2> -<p><a id="opIddelete_list"></a></p> +<h2 id="edit_integration">edit_integration</h2> +<p><a id="opIdedit_integration"></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} \ +curl -X PUT /api/boards/{board}/integrations/{int} \ + -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">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</span> HTTP/1.1 -<span class="http"><span class="hljs-attribute">Accept</span>: application/json +<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 class="undefined"></span></span></code></pre> +</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}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</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>{ @@ -9475,17 +9552,24 @@ $.ajax({ </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">'{ + "enabled": "string", + "title": "string", + "url": "string", + "token": "string", + "activities": "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}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</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>{ @@ -9499,11 +9583,12 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, +result = RestClient.put <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -9512,20 +9597,21 @@ 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.delete(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, params={ +r = requests.put(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</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}"</span>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +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())); @@ -9548,13 +9634,14 @@ System.out.println(response.toString()); <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">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"PUT"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>, data) req.Header = headers client := &http.Client{} @@ -9563,11 +9650,19 @@ System.out.println(response.toString()); } </code></pre> -<p><code>DELETE /api/boards/{board}/lists/{list}</code></p> -<p><em>Delete a List</em></p> -<p>This <strong>deletes</strong> a list from a board. -The list is not put in the recycle bin.</p> -<h3 id="delete_list-parameters">Parameters</h3> +<p><code>PUT /api/boards/{board}/integrations/{int}</code></p> +<p><em>Edit integration data</em></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">enabled:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">title:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">url:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">token:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="edit_integration-parameters">Parameters</h3> <table> <thead> <tr> @@ -9587,17 +9682,59 @@ The list is not put in the recycle bin.</p> <td>the board ID</td> </tr> <tr> -<td>list</td> +<td>int</td> <td>path</td> <td>string</td> <td>true</td> -<td>the ID of the list to remove</td> +<td>the integration ID</td> +</tr> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» enabled</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>is the integration enabled?</td> +</tr> +<tr> +<td>» title</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new name of the integration</td> +</tr> +<tr> +<td>» url</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new URL of the integration</td> +</tr> +<tr> +<td>» token</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new token of the integration</td> +</tr> +<tr> +<td>» activities</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new list of activities of the integration</td> </tr> </tbody> </table> <h4 id="detailed-descriptions">Detailed descriptions</h4> <p><strong>board</strong>: the board ID</p> -<p><strong>list</strong>: the ID of the list to remove</p> +<p><strong>int</strong>: the integration ID</p> <blockquote> <p>Example responses</p> </blockquote> @@ -9608,7 +9745,7 @@ The list is not put in the recycle bin.</p> <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> } </code></pre> -<h3 id="delete_list-responses">Responses</h3> +<h3 id="edit_integration-responses">Responses</h3> <table> <thead> <tr> @@ -9627,7 +9764,7 @@ The list is not put in the recycle bin.</p> </tr> </tbody> </table> -<h3 id="delete_list-responseschema">Response Schema</h3> +<h3 id="edit_integration-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -9653,19 +9790,18 @@ 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> +<h2 id="delete_integration">delete_integration</h2> +<p><a id="opIddelete_integration"></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 \ +curl -X DELETE /api/boards/{board}/integrations/{int} \ -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 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</span> HTTP/1.1 <span class="http"><span class="hljs-attribute">Accept</span>: application/json @@ -9677,8 +9813,8 @@ curl -X GET /api/boards/{board}/lists/{list}/cards \ }; $.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">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</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>{ @@ -9695,9 +9831,9 @@ $.ajax({ }; -fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, <span class="hljs-attr">headers</span>: headers }) @@ -9716,7 +9852,7 @@ headers = { <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -9729,16 +9865,16 @@ 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'</span>, params={ +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</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>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"GET"</span>); +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())); @@ -9767,7 +9903,7 @@ System.out.println(response.toString()); } 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, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>, data) req.Header = headers client := &http.Client{} @@ -9776,9 +9912,9 @@ System.out.println(response.toString()); } </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> +<p><code>DELETE /api/boards/{board}/integrations/{int}</code></p> +<p><em>Delete integration</em></p> +<h3 id="delete_integration-parameters">Parameters</h3> <table> <thead> <tr> @@ -9798,32 +9934,28 @@ System.out.println(response.toString()); <td>the board ID</td> </tr> <tr> -<td>list</td> +<td>int</td> <td>path</td> <td>string</td> <td>true</td> -<td>the list ID</td> +<td>the integration 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> +<p><strong>int</strong>: the integration 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> - } -] +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} </code></pre> -<h3 id="get_all_cards-responses">Responses</h3> +<h3 id="delete_integration-responses">Responses</h3> <table> <thead> <tr> @@ -9842,7 +9974,7 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="get_all_cards-responseschema">Response Schema</h3> +<h3 id="delete_integration-responseschema">Response Schema</h3> <p>Status Code <strong>200</strong></p> <table> <thead> @@ -9862,19 +9994,171 @@ System.out.println(response.toString()); <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="delete_board_int_activities">delete_board_int_activities</h2> +<p><a id="opIddelete_board_int_activities"></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}/integrations/{int}/activities \ + -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}/integrations/{int}/activities</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}/integrations/{int}/activities'</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}/integrations/{int}/activities'</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> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</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}/integrations/{int}/activities'</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}/integrations/{int}/activities"</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}/integrations/{int}/activities"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>DELETE /api/boards/{board}/integrations/{int}/activities</code></p> +<h3 id="delete_board_int_activities-parameters">Parameters</h3> +<table> +<thead> <tr> -<td>» title</td> +<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>false</td> -<td>none</td> -<td>none</td> +<td>true</td> +<td>the board value</td> </tr> <tr> -<td>» description</td> +<td>int</td> +<td>path</td> <td>string</td> -<td>false</td> -<td>none</td> -<td>none</td> +<td>true</td> +<td>the int value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_int_activities-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> @@ -9882,33 +10166,30 @@ System.out.println(response.toString()); 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> +<h2 id="post_board_int_activities">post_board_int_activities</h2> +<p><a id="opIdpost_board_int_activities"></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 \ +curl -X POST /api/boards/{board}/integrations/{int}/activities \ -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 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}/activities</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">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, <span class="hljs-attr">headers</span>: headers, @@ -9920,21 +10201,15 @@ $.ajax({ </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" + "activities": "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>, +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, { <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>, <span class="hljs-attr">body</span>: inputBody, @@ -9952,11 +10227,10 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</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> } -result = RestClient.post <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -9966,18 +10240,17 @@ p JSON.parse(result) <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={ +r = requests.post(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</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>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod(<span class="hljs-string">"POST"</span>); <span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); @@ -10003,13 +10276,12 @@ System.out.println(response.toString()); 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, err := http.NewRequest(<span class="hljs-string">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>, data) req.Header = headers client := &http.Client{} @@ -10018,20 +10290,14 @@ System.out.println(response.toString()); } </code></pre> -<p><code>POST /api/boards/{board}/lists/{list}/cards</code></p> -<p><em>Create a new Card</em></p> +<p><code>POST /api/boards/{board}/integrations/{int}/activities</code></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> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="new_card-parameters">Parameters</h3> +<h3 id="post_board_int_activities-parameters">Parameters</h3> <table> <thead> <tr> @@ -10048,14 +10314,14 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board ID of the new card</td> +<td>the board value</td> </tr> <tr> -<td>list</td> +<td>int</td> <td>path</td> <td>string</td> <td>true</td> -<td>the list ID of the new card</td> +<td>the int value</td> </tr> <tr> <td>body</td> @@ -10065,63 +10331,15 @@ System.out.println(response.toString()); <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>» activities</td> <td>body</td> <td>string</td> <td>true</td> -<td>the swimlane ID of the new card</td> +<td>the activities value</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> +<h3 id="post_board_int_activities-responses">Responses</h3> <table> <thead> <tr> @@ -10136,29 +10354,7 @@ System.out.println(response.toString()); <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> +<td>None</td> </tr> </tbody> </table> @@ -10166,26 +10362,31 @@ System.out.println(response.toString()); 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> +<h1 id="wekan-rest-api-lists">Lists</h1> +<h2 id="get_all_lists">get_all_lists</h2> +<p><a id="opIdget_all_lists"></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} \ +curl -X GET /api/boards/{board}/lists \ + -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/{card}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<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/{card}'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists'</span>, <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, <span class="hljs-attr">headers</span>: headers, @@ -10198,11 +10399,12 @@ $.ajax({ <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/{card}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/lists'</span>, { <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, @@ -10219,10 +10421,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'< <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -10231,17 +10434,18 @@ 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/{card}'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/lists'</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>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); con.setRequestMethod(<span class="hljs-string">"GET"</span>); <span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); @@ -10266,12 +10470,13 @@ System.out.println(response.toString()); <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/{card}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/lists"</span>, data) req.Header = headers client := &http.Client{} @@ -10280,8 +10485,9 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/lists/{list}/cards/{card}</code></p> -<h3 id="get_board_list_card-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/lists</code></p> +<p><em>Get the list of Lists attached to a board</em></p> +<h3 id="get_all_lists-parameters">Parameters</h3> <table> <thead> <tr> @@ -10298,25 +10504,26 @@ System.out.println(response.toString()); <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> +<td>the board ID</td> </tr> </tbody> </table> -<h3 id="get_board_list_card-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board 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> + } +] +</code></pre> +<h3 id="get_all_lists-responses">Responses</h3> <table> <thead> <tr> @@ -10331,7 +10538,36 @@ System.out.println(response.toString()); <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> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="get_all_lists-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> </tbody> </table> @@ -10339,31 +10575,34 @@ System.out.println(response.toString()); 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> +<h2 id="new_list">new_list</h2> +<p><a id="opIdnew_list"></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} \ +curl -X POST /api/boards/{board}/lists \ -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">PUT</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/lists</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/{card}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'put'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists'</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>{ @@ -10374,35 +10613,18 @@ $.ajax({ </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" + "title": "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/{card}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/lists'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'PUT'</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 }) @@ -10418,10 +10640,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'< 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> } -result = RestClient.put <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/lists'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -10431,19 +10654,20 @@ p JSON.parse(result) <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.put(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={ +r = requests.post(<span class="hljs-string">'/api/boards/{board}/lists'</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>); +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"PUT"</span>); +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())); @@ -10467,12 +10691,13 @@ System.out.println(response.toString()); 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">"PUT"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/lists"</span>, data) req.Header = headers client := &http.Client{} @@ -10481,32 +10706,15 @@ System.out.println(response.toString()); } </code></pre> -<p><code>PUT /api/boards/{board}/lists/{list}/cards/{card}</code></p> +<p><code>POST /api/boards/{board}/lists</code></p> +<p><em>Add a List to a board</em></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> +<h3 id="new_list-parameters">Parameters</h3> <table> <thead> <tr> @@ -10523,21 +10731,7 @@ System.out.println(response.toString()); <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> +<td>the board ID</td> </tr> <tr> <td>body</td> @@ -10551,137 +10745,23 @@ System.out.println(response.toString()); <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> +<td>the title of the List</td> </tr> </tbody> </table> -<h3 id="put_board_list_card-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board 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> +} +</code></pre> +<h3 id="new_list-responses">Responses</h3> <table> <thead> <tr> @@ -10696,7 +10776,29 @@ System.out.println(response.toString()); <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> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="new_list-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> @@ -10704,27 +10806,31 @@ System.out.println(response.toString()); 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> +<h2 id="get_list">get_list</h2> +<p><a id="opIdget_list"></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} \ +curl -X GET /api/boards/{board}/lists/{list} \ + -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">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists/{list}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<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/{card}'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}'</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>{ @@ -10736,13 +10842,14 @@ $.ajax({ <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/{card}'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, <span class="hljs-attr">headers</span>: headers }) @@ -10757,10 +10864,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'< <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -10769,19 +10877,20 @@ 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.delete(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={ +r = requests.get(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</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>); +<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}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +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())); @@ -10804,12 +10913,13 @@ System.out.println(response.toString()); <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">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}"</span>, data) req.Header = headers client := &http.Client{} @@ -10818,8 +10928,9 @@ System.out.println(response.toString()); } </code></pre> -<p><code>DELETE /api/boards/{board}/lists/{list}/cards/{card}</code></p> -<h3 id="delete_board_list_card-parameters">Parameters</h3> +<p><code>GET /api/boards/{board}/lists/{list}</code></p> +<p><em>Get a List attached to a board</em></p> +<h3 id="get_list-parameters">Parameters</h3> <table> <thead> <tr> @@ -10836,25 +10947,46 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</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> +<td>the List ID</td> </tr> </tbody> </table> -<h3 id="delete_board_list_card-responses">Responses</h3> +<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">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"starred"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"archived"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"swimlaneId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"wipLimit"</span>: { + <span class="hljs-attr">"value"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"soft"</span>: <span class="hljs-literal">true</span> + }, + <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="get_list-responses">Responses</h3> <table> <thead> <tr> @@ -10869,7 +11001,7 @@ System.out.println(response.toString()); <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> +<td><a href="#schemalists">Lists</a></td> </tr> </tbody> </table> @@ -10877,27 +11009,31 @@ System.out.println(response.toString()); 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> +<h2 id="delete_list">delete_list</h2> +<p><a id="opIddelete_list"></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 \ +curl -X DELETE /api/boards/{board}/lists/{list} \ + -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}/swimlanes/{swimlane}/cards</span> HTTP/1.1 +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<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}/swimlanes/{swimlane}/cards'</span>, - <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}'</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>{ @@ -10909,13 +11045,14 @@ $.ajax({ <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}/swimlanes/{swimlane}/cards'</span>, +fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, { - <span class="hljs-attr">method</span>: <span class="hljs-string">'GET'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, <span class="hljs-attr">headers</span>: headers }) @@ -10930,10 +11067,11 @@ fetch(<span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards' <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</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> } -result = RestClient.get <span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>, +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/lists/{list}'</span>, <span class="hljs-symbol">params:</span> { }, <span class="hljs-symbol">headers:</span> headers @@ -10942,19 +11080,20 @@ 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}/swimlanes/{swimlane}/cards'</span>, params={ +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/lists/{list}'</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>); +<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}"</span>); HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod(<span class="hljs-string">"GET"</span>); +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())); @@ -10977,12 +11116,13 @@ System.out.println(response.toString()); <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}/swimlanes/{swimlane}/cards"</span>, data) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}"</span>, data) req.Header = headers client := &http.Client{} @@ -10991,8 +11131,11 @@ System.out.println(response.toString()); } </code></pre> -<p><code>GET /api/boards/{board}/swimlanes/{swimlane}/cards</code></p> -<h3 id="get_board_swimlane_cards-parameters">Parameters</h3> +<p><code>DELETE /api/boards/{board}/lists/{list}</code></p> +<p><em>Delete a List</em></p> +<p>This <strong>deletes</strong> a list from a board. +The list is not put in the recycle bin.</p> +<h3 id="delete_list-parameters">Parameters</h3> <table> <thead> <tr> @@ -11009,18 +11152,31 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> -<td>swimlane</td> +<td>list</td> <td>path</td> <td>string</td> <td>true</td> -<td>the swimlane value</td> +<td>the ID of the list to remove</td> </tr> </tbody> </table> -<h3 id="get_board_swimlane_cards-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>list</strong>: the ID of the list to remove</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="delete_list-responses">Responses</h3> <table> <thead> <tr> @@ -11035,7 +11191,29 @@ System.out.println(response.toString()); <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> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_list-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> diff --git a/public/api/wekan.yml b/public/api/wekan.yml index 252ffb18..b7f37205 100644 --- a/public/api/wekan.yml +++ b/public/api/wekan.yml @@ -1,7 +1,7 @@ swagger: '2.0' info: title: Wekan REST API - version: v4.09 + version: v4.10 description: | The REST API allows you to control and extend Wekan with ease. @@ -649,6 +649,35 @@ paths: '200': description: |- 200 response + /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}: + get: + operationId: get_board_customFieldValue + tags: + - Cards + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: customField + in: path + description: the customField value + type: string + required: true + - name: customFieldValue + in: path + description: the customFieldValue value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response /api/boards/{board}/custom-fields: get: operationId: get_all_custom_fields diff --git a/sandstorm-pkgdef.capnp b/sandstorm-pkgdef.capnp index 2e196a22..c31c3e4f 100644 --- a/sandstorm-pkgdef.capnp +++ b/sandstorm-pkgdef.capnp @@ -22,10 +22,10 @@ const pkgdef :Spk.PackageDefinition = ( appTitle = (defaultText = "Wekan"), # The name of the app as it is displayed to the user. - appVersion = 409, + appVersion = 410, # Increment this for every release. - appMarketingVersion = (defaultText = "4.09.0~2020-05-27"), + appMarketingVersion = (defaultText = "4.10.0~2020-05-30"), # Human-readable presentation of the app version. minUpgradableAppVersion = 0, |