@ -7,7 +7,7 @@
< meta charset = "utf-8" >
< meta content = "IE=edge,chrome=1" http-equiv = "X-UA-Compatible" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, maximum-scale=1" >
< title > Wekan REST API v5.37 < / title >
< title > Wekan REST API v5.38 < / title >
< style >
< / style >
@ -1490,6 +1490,8 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
< / head >
@ -1553,7 +1555,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
< ul class = "toc-list-h1" >
< li >
< a href = "#wekan-rest-api" class = "toc-h1 toc-link" data-title = "Wekan REST API v5.37" > Wekan REST API v5.37 < / a >
< a href = "#wekan-rest-api" class = "toc-h1 toc-link" data-title = "Wekan REST API v5.38" > Wekan REST API v5.38 < / a >
< / li >
@ -1996,6 +1998,16 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
< / li >
< li >
< a href = "#tocs_boardsorgs" class = "toc-h2 toc-link" data-title = "" > BoardsOrgs< / a >
< / li >
< li >
< a href = "#tocs_boardsteams" class = "toc-h2 toc-link" data-title = "" > BoardsTeams< / a >
< / li >
< li >
< a href = "#tocs_cardcomments" class = "toc-h2 toc-link" data-title = "" > CardComments< / a >
@ -2116,7 +2128,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
< div class = "page-wrapper" >
< div class = "dark-box" > < / div >
< div class = "content" >
< h1 id = "wekan-rest-api" > Wekan REST API v5.37 < / h1 >
< h1 id = "wekan-rest-api" > Wekan REST API v5.38 < / 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 >
@ -3516,6 +3528,20 @@ System.out.println(response.toString());
}
],
< span class = "hljs-attr" > " permission" < / span > : < span class = "hljs-string" > " public" < / span > ,
< span class = "hljs-attr" > " orgs" < / span > : [
{
< span class = "hljs-attr" > " orgId" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " orgDisplayName" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " isActive" < / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > " teams" < / span > : [
{
< span class = "hljs-attr" > " teamId" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " teamDisplayName" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " isActive" < / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > " color" < / span > : < span class = "hljs-string" > " belize" < / span > ,
< span class = "hljs-attr" > " description" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " subtasksDefaultBoardId" < / span > : < span class = "hljs-string" > " string" < / span > ,
@ -18294,6 +18320,20 @@ UserSecurity
}
],
< span class = "hljs-attr" > " permission" < / span > : < span class = "hljs-string" > " public" < / span > ,
< span class = "hljs-attr" > " orgs" < / span > : [
{
< span class = "hljs-attr" > " orgId" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " orgDisplayName" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " isActive" < / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > " teams" < / span > : [
{
< span class = "hljs-attr" > " teamId" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " teamDisplayName" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " isActive" < / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > " color" < / span > : < span class = "hljs-string" > " belize" < / span > ,
< span class = "hljs-attr" > " description" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " subtasksDefaultBoardId" < / span > : < span class = "hljs-string" > " string" < / span > ,
@ -18413,6 +18453,20 @@ UserSecurity
< td > visibility of the board< / td >
< / tr >
< tr >
< td > orgs< / td >
< td > [< a href = "#schemaboardsorgs" > BoardsOrgs< / a > ]¦null< / td >
< td > false< / td >
< td > none< / td >
< td > the list of organizations that a board belongs to< / td >
< / tr >
< tr >
< td > teams< / td >
< td > [< a href = "#schemaboardsteams" > BoardsTeams< / a > ]¦null< / td >
< td > false< / td >
< td > none< / td >
< td > the list of teams that a board belongs to< / td >
< / tr >
< tr >
< td > color< / td >
< td > string< / td >
< td > true< / td >
@ -18982,6 +19036,100 @@ UserSecurity
< / tr >
< / tbody >
< / table >
< h2 id = "tocs_boardsorgs" > BoardsOrgs< / h2 >
< p > < a id = "schemaboardsorgs" > < / a >
< a id = "schema_BoardsOrgs" > < / a >
< a id = "tocSboardsorgs" > < / a >
< a id = "tocsboardsorgs" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > " orgId" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " orgDisplayName" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " isActive" < / span > : < span class = "hljs-literal" > true< / span >
}
< / code > < / pre >
< h3 id = "properties-4" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > orgId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The uniq ID of the organization< / td >
< / tr >
< tr >
< td > orgDisplayName< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The display name of the organization< / td >
< / tr >
< tr >
< td > isActive< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Is the organization active?< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocs_boardsteams" > BoardsTeams< / h2 >
< p > < a id = "schemaboardsteams" > < / a >
< a id = "schema_BoardsTeams" > < / a >
< a id = "tocSboardsteams" > < / a >
< a id = "tocsboardsteams" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > " teamId" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " teamDisplayName" < / span > : < span class = "hljs-string" > " string" < / span > ,
< span class = "hljs-attr" > " isActive" < / span > : < span class = "hljs-literal" > true< / span >
}
< / code > < / pre >
< h3 id = "properties-5" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > teamId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The uniq ID of the team< / td >
< / tr >
< tr >
< td > teamDisplayName< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The display name of the team< / td >
< / tr >
< tr >
< td > isActive< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Is the team active?< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocs_cardcomments" > CardComments< / h2 >
< p > < a id = "schemacardcomments" > < / a >
< a id = "schema_CardComments" > < / a >
@ -18998,7 +19146,7 @@ UserSecurity
< / code > < / pre >
< p > A comment on a card< / p >
< h3 id = "properties-4 " > Properties< / h3 >
< h3 id = "properties-6 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -19158,7 +19306,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-5 " > Properties< / h3 >
< h3 id = "properties-7 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -19547,7 +19695,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-6 " > Properties< / h3 >
< h3 id = "properties-8 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -19646,7 +19794,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-7 " > Properties< / h3 >
< h3 id = "properties-9 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -19766,7 +19914,7 @@ UserSecurity
< pre class = "highlight tab tab-json" > < code > {}
< / code > < / pre >
< h3 id = "properties-8 " > Properties< / h3 >
< h3 id = "properties-10 " > Properties< / h3 >
< p > < em > None< / em > < / p >
< h2 id = "tocs_checklistitems" > ChecklistItems< / h2 >
< p > < a id = "schemachecklistitems" > < / a >
@ -19785,7 +19933,7 @@ UserSecurity
< / code > < / pre >
< p > An item in a checklist< / p >
< h3 id = "properties-9 " > Properties< / h3 >
< h3 id = "properties-11 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -19864,7 +20012,7 @@ UserSecurity
< / code > < / pre >
< p > A Checklist< / p >
< h3 id = "properties-10 " > Properties< / h3 >
< h3 id = "properties-12 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -19949,7 +20097,7 @@ UserSecurity
< / code > < / pre >
< p > A custom field on a card in the board< / p >
< h3 id = "properties-11 " > Properties< / h3 >
< h3 id = "properties-13 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20087,7 +20235,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-12 " > Properties< / h3 >
< h3 id = "properties-14 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20137,7 +20285,7 @@ UserSecurity
< pre class = "highlight tab tab-json" > < code > {}
< / code > < / pre >
< h3 id = "properties-13 " > Properties< / h3 >
< h3 id = "properties-15 " > Properties< / h3 >
< p > < em > None< / em > < / p >
< h2 id = "tocs_integrations" > Integrations< / h2 >
< p > < a id = "schemaintegrations" > < / a >
@ -20161,7 +20309,7 @@ UserSecurity
< / code > < / pre >
< p > Integration with third-party applications< / p >
< h3 id = "properties-14 " > Properties< / h3 >
< h3 id = "properties-16 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20272,7 +20420,7 @@ UserSecurity
< / code > < / pre >
< p > A list (column) in the Wekan board.< / p >
< h3 id = "properties-15 " > Properties< / h3 >
< h3 id = "properties-17 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20500,7 +20648,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-16 " > Properties< / h3 >
< h3 id = "properties-18 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20555,7 +20703,7 @@ UserSecurity
< / code > < / pre >
< p > A swimlane is an line in the kaban board.< / p >
< h3 id = "properties-17 " > Properties< / h3 >
< h3 id = "properties-19 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20828,7 +20976,7 @@ UserSecurity
< / code > < / pre >
< p > A User in wekan< / p >
< h3 id = "properties-18 " > Properties< / h3 >
< h3 id = "properties-20 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -20989,7 +21137,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-19 " > Properties< / h3 >
< h3 id = "properties-2 1" > Properties< / h3 >
< table >
< thead >
< tr >
@ -21214,7 +21362,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-20 " > Properties< / h3 >
< h3 id = "properties-22 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -21246,7 +21394,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-21 " > Properties< / h3 >
< h3 id = "properties-23 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -21285,7 +21433,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-22 " > Properties< / h3 >
< h3 id = "properties-24 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -21324,7 +21472,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-23 " > Properties< / h3 >
< h3 id = "properties-25 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -21363,7 +21511,7 @@ UserSecurity
}
< / code > < / pre >
< h3 id = "properties-24 " > Properties< / h3 >
< h3 id = "properties-26 " > Properties< / h3 >
< table >
< thead >
< tr >
@ -21416,6 +21564,8 @@ UserSecurity
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
< / div >
< div class = "dark-box" >
Lauri Ojansivu
4 years ago