@ -1528,7 +1528,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.95" > Wekan REST API v4.95 < / a >
< a href = "#wekan-rest-api" class = "toc-h1 toc-link" data-title = "Wekan REST API v4.96" > Wekan REST API v4.96 < / a >
< / li >
@ -1571,11 +1571,6 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
< / li >
< li >
< a href = "#get_boards_count" class = "toc-h2 toc-link" data-title = "get_boards_count" > get_boards_count< / a >
< / li >
< li >
< a href = "#new_board" class = "toc-h2 toc-link" data-title = "" > new_board< / a >
@ -1611,6 +1606,11 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
< / li >
< li >
< a href = "#get_boards_count" class = "toc-h2 toc-link" data-title = "" > get_boards_count< / a >
< / li >
< li >
< a href = "#get_boards_from_user" class = "toc-h2 toc-link" data-title = "" > get_boards_from_user< / a >
@ -2051,7 +2051,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.95 < / h1 >
< h1 id = "wekan-rest-api" > Wekan REST API v4.96 < / 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 >
@ -4641,6 +4641,219 @@ 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_boards_count" > get_boards_count< / h2 >
< p > < a id = "opIdget_boards_count" > < / 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_count \
-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_count< / span > < span class = "hljs-meta" > HTTP/1.1< / span >
< span class = "ada" > < span class = "hljs-keyword" > Accept< / span > : application/json
< / 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_count' < / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > ' get' < / span > ,
< span class = "hljs-attr" > headers< / span > : headers,
< span class = "hljs-attr" > success< / span > : < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > data< / span > ) < / span > {
< span class = "hljs-built_in" > console< / span > .log(< span class = "hljs-built_in" > JSON< / span > .stringify(data));
}
})
< / code > < / pre >
< pre class = "highlight tab tab-javascript--nodejs" > < code > < span class = "hljs-keyword" > const< / span > fetch = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > ' node-fetch' < / span > );
< span class = "hljs-keyword" > const< / span > headers = {
< span class = "hljs-string" > ' Accept' < / span > :< span class = "hljs-string" > ' application/json' < / span > ,
< span class = "hljs-string" > ' Authorization' < / span > :< span class = "hljs-string" > ' API_KEY' < / span >
};
fetch(< span class = "hljs-string" > ' /api/boards_count' < / span > ,
{
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > ' GET' < / span > ,
< span class = "hljs-attr" > headers< / span > : headers
})
.then(< span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > res< / span > ) < / span > {
< span class = "hljs-keyword" > return< / span > res.json();
}).then(< span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > body< / span > ) < / span > {
< span class = "hljs-built_in" > console< / span > .log(body);
});
< / code > < / pre >
< pre class = "highlight tab tab-ruby" > < code > < span class = "hljs-keyword" > require< / span > < span class = "hljs-string" > ' rest-client' < / span >
< span class = "hljs-keyword" > require< / span > < span class = "hljs-string" > ' json' < / span >
headers = {
< span class = "hljs-string" > ' Accept' < / span > => < 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_count' < / span > ,
< span class = "hljs-symbol" > params:< / span > {
}, < span class = "hljs-symbol" > headers:< / span > headers
p JSON.parse(result)
< / code > < / pre >
< pre class = "highlight tab tab-python" > < code > < span class = "hljs-keyword" > import< / span > requests
headers = {
< span class = "hljs-string" > ' Accept' < / span > : < span class = "hljs-string" > ' application/json' < / span > ,
< span class = "hljs-string" > ' Authorization' < / span > : < span class = "hljs-string" > ' API_KEY' < / span >
}
r = requests.get(< span class = "hljs-string" > ' /api/boards_count' < / span > , params={
}, headers = headers)
< span class = "hljs-built_in" > 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_count" < / span > );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod(< span class = "hljs-string" > " GET" < / span > );
< span class = "hljs-keyword" > int< / span > responseCode = con.getResponseCode();
BufferedReader in = < span class = "hljs-keyword" > new< / span > BufferedReader(
< span class = "hljs-keyword" > new< / span > InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = < span class = "hljs-keyword" > new< / span > StringBuffer();
< span class = "hljs-keyword" > while< / span > ((inputLine = in.readLine()) != < span class = "hljs-keyword" > null< / span > ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
< / code > < / pre >
< pre class = "highlight tab tab-go" > < code > < span class = "hljs-keyword" > package< / span > main
< span class = "hljs-keyword" > import< / span > (
< span class = "hljs-string" > " bytes" < / span >
< span class = "hljs-string" > " net/http" < / span >
)
< span class = "hljs-function" > < span class = "hljs-keyword" > func< / span > < span class = "hljs-title" > main< / span > < span class = "hljs-params" > ()< / span > < / span > {
headers := < span class = "hljs-keyword" > map< / span > [< span class = "hljs-keyword" > string< / span > ][]< span class = "hljs-keyword" > string< / span > {
< span class = "hljs-string" > " Accept" < / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > " application/json" < / span > },
< span class = "hljs-string" > " Authorization" < / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > " API_KEY" < / span > },
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
req, err := http.NewRequest(< span class = "hljs-string" > " GET" < / span > , < span class = "hljs-string" > " /api/boards_count" < / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< pre class = "highlight tab tab-php" > < code > < span class = "hljs-string" > ' application/json' < / span > ,
< span class = "hljs-string" > ' Authorization' < / span > => < span class = "hljs-string" > ' API_KEY' < / span > ,
);
< span class = "hljs-variable" > $client< / span > = < span class = "hljs-keyword" > new< / span > \GuzzleHttp\Client();
< span class = "hljs-comment" > // Define array of request body.< / span >
< span class = "hljs-variable" > $request_body< / span > = < span class = "hljs-keyword" > array< / span > ();
< span class = "hljs-keyword" > try< / span > {
< span class = "hljs-variable" > $response< / span > = < span class = "hljs-variable" > $client< / span > -> request(< span class = "hljs-string" > ' GET' < / span > ,< span class = "hljs-string" > ' /api/boards_count' < / span > , < span class = "hljs-keyword" > array< / span > (
< span class = "hljs-string" > ' headers' < / span > => < span class = "hljs-variable" > $headers< / span > ,
< span class = "hljs-string" > ' json' < / span > => < span class = "hljs-variable" > $request_body< / span > ,
)
);
print_r(< span class = "hljs-variable" > $response< / span > -> getBody()-> getContents());
}
< span class = "hljs-keyword" > catch< / span > (\GuzzleHttp\< span class = "hljs-built_in" > Exception< / span > \BadResponseException < span class = "hljs-variable" > $e< / span > ) {
< span class = "hljs-comment" > // handle exception or api errors.< / span >
print_r(< span class = "hljs-variable" > $e< / span > -> getMessage());
}
< span class = "hljs-comment" > // ...< / span >
< / code > < / pre >
< p > < code > GET /api/boards_count< / code > < / p >
< p > < em > Get public and private boards count< / em > < / p >
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > " private" < / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > " public" < / span > : < span class = "hljs-number" > 0< / span >
}
< / code > < / pre >
< h3 id = "get_boards_count-responses" > Responses< / h3 >
< table >
< thead >
< tr >
< th > Status< / th >
< th > Meaning< / th >
< th > Description< / th >
< th > Schema< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > 200< / td >
< td > < a href = "https://tools.ietf.org/html/rfc7231#section-6.3.1" > OK< / a > < / td >
< td > 200 response< / td >
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "get_boards_count-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 > » private< / td >
< td > integer< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » public< / td >
< td > integer< / 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_boards_from_user" > get_boards_from_user< / h2 >
< p > < a id = "opIdget_boards_from_user" > < / a > < / p >
< blockquote >
Lauri Ojansivu
4 years ago