2019-07-17 17:06:25 +03:00
<!doctype html>
< html lang = "en" >
< head >
< 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< / title >
< style >
< / style >
< style media = "screen" > / * ! n o r m a l i z e . c s s v 3 . 0 . 2 | M I T L i c e n s e | g i t . i o / n o r m a l i z e * /
/**
* 1. Set default font family to sans-serif.
* 2. Prevent iOS text size adjust after orientation change, without disabling
* user zoom.
*/
html {
font-family: sans-serif;
/* 1 */
-ms-text-size-adjust: 100%;
/* 2 */
-webkit-text-size-adjust: 100%;
/* 2 */ }
/**
* Remove default margin.
*/
body {
margin: 0; }
/* HTML5 display definitions
========================================================================== */
/**
* Correct `block` display not defined for any HTML5 element in IE 8/9.
* Correct `block` display not defined for `details` or `summary` in IE 10/11
* and Firefox.
* Correct `block` display not defined for `main` in IE 11.
*/
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
menu,
nav,
section,
summary {
display: block; }
/**
* 1. Correct `inline-block` display not defined in IE 8/9.
* 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
*/
audio,
canvas,
progress,
video {
display: inline-block;
/* 1 */
vertical-align: baseline;
/* 2 */ }
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0; }
/**
* Address `[hidden]` styling not present in IE 8/9/10.
* Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
*/
[hidden],
template {
display: none; }
/* Links
========================================================================== */
/**
* Remove the gray background color from active links in IE 10.
*/
a {
background-color: transparent; }
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0; }
/* Text-level semantics
========================================================================== */
/**
* Address styling not present in IE 8/9/10/11, Safari, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted; }
/**
* Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
*/
b,
strong {
font-weight: bold; }
/**
* Address styling not present in Safari and Chrome.
*/
dfn {
font-style: italic; }
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari, and Chrome.
*/
h1 {
font-size: 2em;
margin: 0.67em 0; }
/**
* Address styling not present in IE 8/9.
*/
mark {
background: #ff0;
color: #000; }
/**
* Address inconsistent and variable font size in all browsers.
*/
small {
font-size: 80%; }
/**
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline; }
sup {
top: -0.5em; }
sub {
bottom: -0.25em; }
/* Embedded content
========================================================================== */
/**
* Remove border when inside `a` element in IE 8/9/10.
*/
img {
border: 0; }
/**
* Correct overflow not hidden in IE 9/10/11.
*/
svg:not(:root) {
overflow: hidden; }
/* Grouping content
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari.
*/
figure {
margin: 1em 40px; }
/**
* Address differences between Firefox and other browsers.
*/
hr {
-moz-box-sizing: content-box;
box-sizing: content-box;
height: 0; }
/**
* Contain overflow in all browsers.
*/
pre {
overflow: auto; }
/**
* Address odd `em`-unit font size rendering in all browsers.
*/
code,
kbd,
pre,
samp {
font-family: monospace, monospace;
font-size: 1em; }
/* Forms
========================================================================== */
/**
* Known limitation: by default, Chrome and Safari on OS X allow very limited
* styling of `select`, unless a `border` property is set.
*/
/**
* 1. Correct color not being inherited.
* Known issue: affects color of disabled elements.
* 2. Correct font properties not being inherited.
* 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
*/
button,
input,
optgroup,
select,
textarea {
color: inherit;
/* 1 */
font: inherit;
/* 2 */
margin: 0;
/* 3 */ }
/**
* Address `overflow` set to `hidden` in IE 8/9/10/11.
*/
button {
overflow: visible; }
/**
* Address inconsistent `text-transform` inheritance for `button` and `select`.
* All other form control elements do not inherit `text-transform` values.
* Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
* Correct `select` style inheritance in Firefox.
*/
button,
select {
text-transform: none; }
/**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/
button,
html input[type="button"],
input[type="reset"],
input[type="submit"] {
-webkit-appearance: button;
/* 2 */
cursor: pointer;
/* 3 */ }
/**
* Re-set default cursor for disabled elements.
*/
button[disabled],
html input[disabled] {
cursor: default; }
/**
* Remove inner padding and border in Firefox 4+.
*/
button::-moz-focus-inner,
input::-moz-focus-inner {
border: 0;
padding: 0; }
/**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
* the UA stylesheet.
*/
input {
line-height: normal; }
/**
* It's recommended that you don't attempt to style these elements.
* Firefox's implementation doesn't respect box-sizing, padding, or width.
*
* 1. Address box sizing set to `content-box` in IE 8/9/10.
* 2. Remove excess padding in IE 8/9/10.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box;
/* 1 */
padding: 0;
/* 2 */ }
/**
* Fix the cursor style for Chrome's increment/decrement buttons. For certain
* `font-size` values of the `input`, it causes the cursor style of the
* decrement button to change from `default` to `text`.
*/
input[type="number"]::-webkit-inner-spin-button,
input[type="number"]::-webkit-outer-spin-button {
height: auto; }
/**
* 1. Address `appearance` set to `searchfield` in Safari and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield;
/* 1 */
-moz-box-sizing: content-box;
-webkit-box-sizing: content-box;
/* 2 */
box-sizing: content-box; }
/**
* Remove inner padding and search cancel button in Safari and Chrome on OS X.
* Safari (but not Chrome) clips the cancel button when the search input has
* padding (and `textfield` appearance).
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none; }
/**
* Define consistent border, margin, and padding.
*/
fieldset {
border: 1px solid #c0c0c0;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em; }
/**
* 1. Correct `color` not being inherited in IE 8/9/10/11.
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
*/
legend {
border: 0;
/* 1 */
padding: 0;
/* 2 */ }
/**
* Remove default vertical scrollbar in IE 8/9/10/11.
*/
textarea {
overflow: auto; }
/**
* Don't inherit the `font-weight` (applied by a rule above).
* NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
*/
optgroup {
font-weight: bold; }
/* Tables
========================================================================== */
/**
* Remove most spacing between table cells.
*/
table {
border-collapse: collapse;
border-spacing: 0; }
td,
th {
padding: 0; }
/*
Copyright 2008-2013 Concur Technologies, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
*/
.content h1, .content h2, .content h3, .content h4, .content h5, .content h6, html, body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-size: 14px; }
.content h1, .content h2, .content h3, .content h4, .content h5, .content h6 {
font-weight: bold; }
.content code, .content pre {
font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif;
font-size: 12px;
line-height: 1.5; }
.content code {
word-break: break-all;
hyphens: auto; }
@font-face {
font-family: 'slate';
src: url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.eot?-syv14m');
src: url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.eot?#iefix-syv14m') format("embedded-opentype"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.woff2?-syv14m') format("woff2"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.woff?-syv14m') format("woff"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.ttf?-syv14m') format("truetype"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.svg?-syv14m#slate') format("svg");
font-weight: normal;
font-style: normal; }
.content aside.warning:before, .content aside.notice:before, .content aside.success:before, .toc-wrapper > .search:before {
font-family: 'slate';
speak: none;
font-style: normal;
font-weight: normal;
font-variant: normal;
text-transform: none;
line-height: 1; }
.content aside.warning:before {
content: "\e600"; }
.content aside.notice:before {
content: "\e602"; }
.content aside.success:before {
content: "\e606"; }
.toc-wrapper > .search:before {
content: "\e607"; }
/*
Copyright 2008-2013 Concur Technologies, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
*/
html, body {
color: #333;
padding: 0;
margin: 0;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
background-color: #F3F7F9;
height: 100%;
-webkit-text-size-adjust: none;
/* Never autoresize text */ }
#toc > ul > li > a > span {
float: right;
background-color: #2484FF;
border-radius: 40px;
width: 20px; }
.toc-wrapper {
transition: left 0.3s ease-in-out;
overflow-y: auto;
overflow-x: hidden;
position: fixed;
z-index: 30;
top: 0;
left: 0;
bottom: 0;
width: 230px;
background-color: #2E3336;
font-size: 13px;
font-weight: bold; }
.toc-wrapper .lang-selector {
display: none; }
.toc-wrapper .lang-selector a {
padding-top: 0.5em;
padding-bottom: 0.5em; }
.toc-wrapper .logo {
display: block;
max-width: 100%;
margin-bottom: 0px; }
.toc-wrapper > .search {
position: relative; }
.toc-wrapper > .search input {
background: #2E3336;
border-width: 0 0 1px 0;
border-color: #666;
padding: 6px 0 6px 20px;
box-sizing: border-box;
margin: 10px 15px;
width: 200px;
outline: none;
color: #fff;
border-radius: 0;
/* ios has a default border radius */ }
.toc-wrapper > .search:before {
position: absolute;
top: 17px;
left: 15px;
color: #fff; }
.toc-wrapper .search-results {
margin-top: 0;
box-sizing: border-box;
height: 0;
overflow-y: auto;
overflow-x: hidden;
transition-property: height, margin;
transition-duration: 180ms;
transition-timing-function: ease-in-out;
background: #1E2224; }
.toc-wrapper .search-results.visible {
height: 30%;
margin-bottom: 1em; }
.toc-wrapper .search-results li {
margin: 1em 15px;
line-height: 1; }
.toc-wrapper .search-results a {
color: #fff;
text-decoration: none; }
.toc-wrapper .search-results a:hover {
text-decoration: underline; }
.toc-wrapper ul, .toc-wrapper li {
list-style: none;
margin: 0;
padding: 0;
line-height: 28px; }
.toc-wrapper li {
color: #fff;
transition-property: background;
transition-timing-function: linear;
transition-duration: 200ms; }
.toc-wrapper .toc-link.active {
background-color: #0F75D4;
color: #fff; }
.toc-wrapper .toc-link.active-parent {
background-color: #1E2224;
color: #fff; }
.toc-wrapper .toc-list-h2 {
display: none;
background-color: #1E2224;
font-weight: 500; }
.toc-wrapper .toc-h2 {
padding-left: 25px;
font-size: 12px; }
.toc-wrapper .toc-footer {
padding: 1em 0;
margin-top: 1em;
border-top: 1px dashed #666; }
.toc-wrapper .toc-footer li, .toc-wrapper .toc-footer a {
color: #fff;
text-decoration: none; }
.toc-wrapper .toc-footer a:hover {
text-decoration: underline; }
.toc-wrapper .toc-footer li {
font-size: 0.8em;
line-height: 1.7;
text-decoration: none; }
.toc-link, .toc-footer li {
padding: 0 15px 0 15px;
display: block;
overflow-x: hidden;
white-space: nowrap;
text-overflow: ellipsis;
text-decoration: none;
color: #fff;
transition-property: background;
transition-timing-function: linear;
transition-duration: 130ms; }
#nav-button {
padding: 0 1.5em 5em 0;
display: none;
position: fixed;
top: 0;
left: 0;
z-index: 100;
color: #000;
text-decoration: none;
font-weight: bold;
opacity: 0.7;
line-height: 16px;
transition: left 0.3s ease-in-out; }
#nav-button span {
display: block;
padding: 6px 6px 6px;
background-color: rgba(243, 247, 249, 0.7);
transform-origin: 0 0;
transform: rotate(-90deg) translate(-100%, 0);
border-radius: 0 0 0 5px; }
#nav-button img {
height: 16px;
vertical-align: bottom; }
#nav-button:hover {
opacity: 1; }
#nav-button.open {
left: 230px; }
.page-wrapper {
margin-left: 230px;
position: relative;
z-index: 10;
background-color: #F3F7F9;
min-height: 100%;
padding-bottom: 1px; }
.page-wrapper .dark-box {
width: 50%;
background-color: #2E3336;
position: absolute;
right: 0;
top: 0;
bottom: 0; }
.page-wrapper .lang-selector {
position: fixed;
z-index: 50;
border-bottom: 5px solid #2E3336; }
.lang-selector {
background-color: #1E2224;
width: 100%;
font-weight: bold; }
.lang-selector a {
display: block;
float: left;
color: #fff;
text-decoration: none;
padding: 0 10px;
line-height: 30px;
outline: 0; }
.lang-selector a:active, .lang-selector a:focus {
background-color: #111;
color: #fff; }
.lang-selector a.active {
background-color: #2E3336;
color: #fff; }
.lang-selector:after {
content: '';
clear: both;
display: block; }
.content {
-webkit-transform: translateZ(0);
position: relative;
z-index: 30; }
.content:after {
content: '';
display: block;
clear: both; }
.content > h1, .content > h2, .content > h3, .content > h4, .content > h5, .content > h6, .content > p, .content > table, .content > ul, .content > ol, .content > aside, .content > dl {
margin-right: 50%;
padding: 0 28px;
box-sizing: border-box;
display: block; }
.content > ul, .content > ol {
padding-left: 43px; }
.content > h1, .content > h2, .content > div {
clear: both; }
.content h1 {
font-size: 25px;
padding-top: 0.5em;
padding-bottom: 0.5em;
margin-bottom: 21px;
margin-top: 2em;
border-top: 1px solid #ccc;
border-bottom: 1px solid #ccc;
background-color: #fdfdfd; }
.content h1:first-child, .content div:first-child + h1 {
border-top-width: 0;
margin-top: 0; }
.content h2 {
font-size: 19px;
margin-top: 4em;
margin-bottom: 0;
border-top: 1px solid #ccc;
padding-top: 1.2em;
padding-bottom: 1.2em;
background-image: linear-gradient(to bottom, rgba(255, 255, 255, 0.2), rgba(255, 255, 255, 0)); }
.content h1 + h2, .content h1 + div + h2 {
margin-top: -21px;
border-top: none; }
.content h3, .content h4, .content h5, .content h6 {
font-size: 15px;
margin-top: 2.5em;
margin-bottom: 0.8em; }
.content h4, .content h5, .content h6 {
font-size: 10px; }
.content hr {
margin: 2em 0;
border-top: 2px solid #2E3336;
border-bottom: 2px solid #F3F7F9; }
.content table {
margin-bottom: 1em;
overflow: auto; }
.content table th, .content table td {
text-align: left;
vertical-align: top;
line-height: 1.6; }
.content table th code, .content table td code {
white-space: nowrap; }
.content table th {
padding: 5px 10px;
border-bottom: 1px solid #ccc;
vertical-align: bottom; }
.content table td {
padding: 10px; }
.content table tr:last-child {
border-bottom: 1px solid #ccc; }
.content table tr:nth-child(odd) > td {
background-color: white; }
.content table tr:nth-child(even) > td {
background-color: #fbfcfd; }
.content dt {
font-weight: bold; }
.content dd {
margin-left: 15px; }
.content p, .content li, .content dt, .content dd {
line-height: 1.6;
margin-top: 0; }
.content img {
max-width: 100%; }
.content code {
background-color: rgba(0, 0, 0, 0.05);
padding: 3px;
border-radius: 3px; }
.content pre > code {
background-color: transparent;
padding: 0; }
.content aside {
padding-top: 1em;
padding-bottom: 1em;
margin-top: 1.5em;
margin-bottom: 1.5em;
background: #8fbcd4;
line-height: 1.6; }
.content aside.warning {
background-color: #c97a7e; }
.content aside.success {
background-color: #6ac174; }
.content aside:before {
vertical-align: middle;
padding-right: 0.5em;
font-size: 14px; }
.content .search-highlight {
padding: 2px;
margin: -3px;
border-radius: 4px;
border: 1px solid #F7E633;
background: linear-gradient(to top left, #F7E633 0%, #F1D32F 100%); }
.content pre, .content blockquote {
background-color: #1E2224;
color: #fff;
margin: 0;
width: 50%;
float: right;
clear: right;
box-sizing: border-box; }
.content pre > p, .content blockquote > p {
margin: 0; }
.content pre a, .content blockquote a {
color: #fff;
text-decoration: none;
border-bottom: dashed 1px #ccc; }
.content pre {
padding-top: 2em;
padding-bottom: 2em;
padding: 2em 28px; }
.content blockquote > p {
background-color: #191D1F;
padding: 13px 2em;
color: #eee; }
@media (max-width: 930px) {
.toc-wrapper {
left: -230px; }
.toc-wrapper.open {
left: 0; }
.page-wrapper {
margin-left: 0; }
#nav-button {
display: block; }
.toc-link {
padding-top: 0.3em;
padding-bottom: 0.3em; } }
@media (max-width: 700px) {
.dark-box {
display: none; }
.content > h1, .content > h2, .content > h3, .content > h4, .content > h5, .content > h6, .content > p, .content > table, .content > ul, .content > ol, .content > aside, .content > dl {
margin-right: 0; }
.toc-wrapper .lang-selector {
display: block; }
.page-wrapper .lang-selector {
display: none; }
.content pre, .content blockquote {
width: auto;
float: none; }
.content > pre + h1, .content > blockquote + h1, .content > pre + h2, .content > blockquote + h2, .content > pre + h3, .content > blockquote + h3, .content > pre + h4, .content > blockquote + h4, .content > pre + h5, .content > blockquote + h5, .content > pre + h6, .content > blockquote + h6, .content > pre + p, .content > blockquote + p, .content > pre + table, .content > blockquote + table, .content > pre + ul, .content > blockquote + ul, .content > pre + ol, .content > blockquote + ol, .content > pre + aside, .content > blockquote + aside, .content > pre + dl, .content > blockquote + dl {
margin-top: 28px; } }
.highlight .c, .highlight .cm, .highlight .c1, .highlight .cs {
color: #909090; }
.highlight, .highlight .w {
background-color: #1E2224; }
< / style >
< style media = "print" > / * ! n o r m a l i z e . c s s v 3 . 0 . 2 | M I T L i c e n s e | g i t . i o / n o r m a l i z e * /
/**
* 1. Set default font family to sans-serif.
* 2. Prevent iOS text size adjust after orientation change, without disabling
* user zoom.
*/
html {
font-family: sans-serif;
/* 1 */
-ms-text-size-adjust: 100%;
/* 2 */
-webkit-text-size-adjust: 100%;
/* 2 */ }
/**
* Remove default margin.
*/
body {
margin: 0; }
/* HTML5 display definitions
========================================================================== */
/**
* Correct `block` display not defined for any HTML5 element in IE 8/9.
* Correct `block` display not defined for `details` or `summary` in IE 10/11
* and Firefox.
* Correct `block` display not defined for `main` in IE 11.
*/
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
menu,
nav,
section,
summary {
display: block; }
/**
* 1. Correct `inline-block` display not defined in IE 8/9.
* 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
*/
audio,
canvas,
progress,
video {
display: inline-block;
/* 1 */
vertical-align: baseline;
/* 2 */ }
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0; }
/**
* Address `[hidden]` styling not present in IE 8/9/10.
* Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
*/
[hidden],
template {
display: none; }
/* Links
========================================================================== */
/**
* Remove the gray background color from active links in IE 10.
*/
a {
background-color: transparent; }
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0; }
/* Text-level semantics
========================================================================== */
/**
* Address styling not present in IE 8/9/10/11, Safari, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted; }
/**
* Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
*/
b,
strong {
font-weight: bold; }
/**
* Address styling not present in Safari and Chrome.
*/
dfn {
font-style: italic; }
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari, and Chrome.
*/
h1 {
font-size: 2em;
margin: 0.67em 0; }
/**
* Address styling not present in IE 8/9.
*/
mark {
background: #ff0;
color: #000; }
/**
* Address inconsistent and variable font size in all browsers.
*/
small {
font-size: 80%; }
/**
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline; }
sup {
top: -0.5em; }
sub {
bottom: -0.25em; }
/* Embedded content
========================================================================== */
/**
* Remove border when inside `a` element in IE 8/9/10.
*/
img {
border: 0; }
/**
* Correct overflow not hidden in IE 9/10/11.
*/
svg:not(:root) {
overflow: hidden; }
/* Grouping content
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari.
*/
figure {
margin: 1em 40px; }
/**
* Address differences between Firefox and other browsers.
*/
hr {
-moz-box-sizing: content-box;
box-sizing: content-box;
height: 0; }
/**
* Contain overflow in all browsers.
*/
pre {
overflow: auto; }
/**
* Address odd `em`-unit font size rendering in all browsers.
*/
code,
kbd,
pre,
samp {
font-family: monospace, monospace;
font-size: 1em; }
/* Forms
========================================================================== */
/**
* Known limitation: by default, Chrome and Safari on OS X allow very limited
* styling of `select`, unless a `border` property is set.
*/
/**
* 1. Correct color not being inherited.
* Known issue: affects color of disabled elements.
* 2. Correct font properties not being inherited.
* 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
*/
button,
input,
optgroup,
select,
textarea {
color: inherit;
/* 1 */
font: inherit;
/* 2 */
margin: 0;
/* 3 */ }
/**
* Address `overflow` set to `hidden` in IE 8/9/10/11.
*/
button {
overflow: visible; }
/**
* Address inconsistent `text-transform` inheritance for `button` and `select`.
* All other form control elements do not inherit `text-transform` values.
* Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
* Correct `select` style inheritance in Firefox.
*/
button,
select {
text-transform: none; }
/**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/
button,
html input[type="button"],
input[type="reset"],
input[type="submit"] {
-webkit-appearance: button;
/* 2 */
cursor: pointer;
/* 3 */ }
/**
* Re-set default cursor for disabled elements.
*/
button[disabled],
html input[disabled] {
cursor: default; }
/**
* Remove inner padding and border in Firefox 4+.
*/
button::-moz-focus-inner,
input::-moz-focus-inner {
border: 0;
padding: 0; }
/**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
* the UA stylesheet.
*/
input {
line-height: normal; }
/**
* It's recommended that you don't attempt to style these elements.
* Firefox's implementation doesn't respect box-sizing, padding, or width.
*
* 1. Address box sizing set to `content-box` in IE 8/9/10.
* 2. Remove excess padding in IE 8/9/10.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box;
/* 1 */
padding: 0;
/* 2 */ }
/**
* Fix the cursor style for Chrome's increment/decrement buttons. For certain
* `font-size` values of the `input`, it causes the cursor style of the
* decrement button to change from `default` to `text`.
*/
input[type="number"]::-webkit-inner-spin-button,
input[type="number"]::-webkit-outer-spin-button {
height: auto; }
/**
* 1. Address `appearance` set to `searchfield` in Safari and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield;
/* 1 */
-moz-box-sizing: content-box;
-webkit-box-sizing: content-box;
/* 2 */
box-sizing: content-box; }
/**
* Remove inner padding and search cancel button in Safari and Chrome on OS X.
* Safari (but not Chrome) clips the cancel button when the search input has
* padding (and `textfield` appearance).
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none; }
/**
* Define consistent border, margin, and padding.
*/
fieldset {
border: 1px solid #c0c0c0;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em; }
/**
* 1. Correct `color` not being inherited in IE 8/9/10/11.
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
*/
legend {
border: 0;
/* 1 */
padding: 0;
/* 2 */ }
/**
* Remove default vertical scrollbar in IE 8/9/10/11.
*/
textarea {
overflow: auto; }
/**
* Don't inherit the `font-weight` (applied by a rule above).
* NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
*/
optgroup {
font-weight: bold; }
/* Tables
========================================================================== */
/**
* Remove most spacing between table cells.
*/
table {
border-collapse: collapse;
border-spacing: 0; }
td,
th {
padding: 0; }
/*
Copyright 2008-2013 Concur Technologies, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
*/
.content h1, .content h2, .content h3, .content h4, body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-size: 14px; }
.content h1, .content h2, .content h3, .content h4 {
font-weight: bold; }
.content pre, .content code {
font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif;
font-size: 12px;
line-height: 1.5; }
.content pre, .content code {
word-break: break-all;
hyphens: auto; }
@font-face {
font-family: 'slate';
src: url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.eot?-syv14m');
src: url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.eot?#iefix-syv14m') format("embedded-opentype"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.woff2?-syv14m') format("woff2"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.woff?-syv14m') format("woff"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.ttf?-syv14m') format("truetype"), url('https://raw.githubusercontent.com/Mermade/shins/master/source/fonts/slate.svg?-syv14m#slate') format("svg");
font-weight: normal;
font-style: normal; }
.content aside.warning:before, .content aside.notice:before, .content aside.success:before {
font-family: 'slate';
speak: none;
font-style: normal;
font-weight: normal;
font-variant: normal;
text-transform: none;
line-height: 1; }
.content aside.warning:before {
content: "\e600"; }
.content aside.notice:before {
content: "\e602"; }
.content aside.success:before {
content: "\e606"; }
/*
Copyright 2008-2013 Concur Technologies, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
*/
.tocify, .toc-footer, .lang-selector, .search, #nav-button {
display: none; }
.tocify-wrapper > img {
margin: 0 auto;
display: block; }
.content {
font-size: 12px; }
.content pre, .content code {
border: 1px solid #999;
border-radius: 5px;
font-size: 0.8em; }
.content pre code {
border: 0; }
.content pre {
padding: 1.3em; }
.content code {
padding: 0.2em; }
.content table {
border: 1px solid #999; }
.content table tr {
border-bottom: 1px solid #999; }
.content table td, .content table th {
padding: 0.7em; }
.content p {
line-height: 1.5; }
.content a {
text-decoration: none;
color: #000; }
.content h1 {
font-size: 2.5em;
padding-top: 0.5em;
padding-bottom: 0.5em;
margin-top: 1em;
margin-bottom: 21px;
border: 2px solid #ccc;
border-width: 2px 0;
text-align: center; }
.content h2 {
font-size: 1.8em;
margin-top: 2em;
border-top: 2px solid #ccc;
padding-top: 0.8em; }
.content h1 + h2, .content h1 + div + h2 {
border-top: none;
padding-top: 0;
margin-top: 0; }
.content h3, .content h4 {
font-size: 0.8em;
margin-top: 1.5em;
margin-bottom: 0.8em;
text-transform: uppercase; }
.content h5, .content h6 {
text-transform: uppercase; }
.content aside {
padding: 1em;
border: 1px solid #ccc;
border-radius: 5px;
margin-top: 1.5em;
margin-bottom: 1.5em;
line-height: 1.6; }
.content aside:before {
vertical-align: middle;
padding-right: 0.5em;
font-size: 14px; }
< / style >
< style media = "screen" > / *
Darkula color scheme from the JetBrains family of IDEs
*/
.hljs {
display: block;
overflow-x: auto;
padding: 0.5em;
background: #2b2b2b;
-webkit-text-size-adjust: none;
}
.hljs,
.hljs-tag,
.hljs-title,
.css .hljs-rule,
.css .hljs-value,
.aspectj .hljs-function,
.css .hljs-function .hljs-preprocessor,
.hljs-pragma {
color: #bababa;
}
.hljs-strongemphasis,
.hljs-strong,
.hljs-emphasis {
color: #a8a8a2;
}
.hljs-bullet,
.hljs-blockquote,
.hljs-horizontal_rule,
.hljs-number,
.hljs-regexp,
.alias .hljs-keyword,
.hljs-literal,
.hljs-hexcolor {
color: #6896ba;
}
.hljs-tag .hljs-value,
.hljs-code,
.css .hljs-class,
.hljs-class .hljs-title:last-child {
color: #a6e22e;
}
.hljs-link_url {
font-size: 80%;
}
.hljs-emphasis,
.hljs-strongemphasis,
.hljs-class .hljs-title:last-child,
.hljs-typename {
font-style: italic;
}
.hljs-keyword,
.ruby .hljs-class .hljs-keyword:first-child,
.ruby .hljs-function .hljs-keyword,
.hljs-function,
.hljs-change,
.hljs-winutils,
.hljs-flow,
.nginx .hljs-title,
.tex .hljs-special,
.hljs-header,
.hljs-attribute,
.hljs-symbol,
.hljs-symbol .hljs-string,
.hljs-tag .hljs-title,
.hljs-value,
.alias .hljs-keyword:first-child,
.css .hljs-tag,
.css .unit,
.css .hljs-important {
color: #cb7832;
}
.hljs-function .hljs-keyword,
.hljs-class .hljs-keyword:first-child,
.hljs-aspect .hljs-keyword:first-child,
.hljs-constant,
.hljs-typename,
.css .hljs-attribute {
color: #cb7832;
}
.hljs-variable,
.hljs-params,
.hljs-class .hljs-title,
.hljs-aspect .hljs-title {
color: #b9b9b9;
}
.hljs-string,
.css .hljs-id,
.hljs-subst,
.hljs-type,
.ruby .hljs-class .hljs-parent,
.hljs-built_in,
.django .hljs-template_tag,
.django .hljs-variable,
.smalltalk .hljs-class,
.django .hljs-filter .hljs-argument,
.smalltalk .hljs-localvars,
.smalltalk .hljs-array,
.hljs-attr_selector,
.hljs-pseudo,
.hljs-addition,
.hljs-stream,
.hljs-envvar,
.apache .hljs-tag,
.apache .hljs-cbracket,
.tex .hljs-command,
.hljs-prompt,
.hljs-link_label,
.hljs-link_url,
.hljs-name {
color: #e0c46c;
}
.hljs-comment,
.hljs-annotation,
.hljs-pi,
.hljs-doctype,
.hljs-deletion,
.hljs-shebang,
.apache .hljs-sqbracket,
.tex .hljs-formula {
color: #7f7f7f;
}
.hljs-decorator {
color: #bab429;
}
.coffeescript .javascript,
.javascript .xml,
.tex .hljs-formula,
.xml .javascript,
.xml .vbscript,
.xml .css,
.xml .hljs-cdata,
.xml .php,
.php .xml {
opacity: 0.5;
}
< / style >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< script > ! f u n c t i o n ( e , t ) { " u s e s t r i c t " ; " o b j e c t " = = t y p e o f m o d u l e & & " o b j e c t " = = t y p e o f m o d u l e . e x p o r t s ? m o d u l e . e x p o r t s = e . d o c u m e n t ? t ( e , ! 0 ) : f u n c t i o n ( e ) { i f ( ! e . d o c u m e n t ) t h r o w n e w E r r o r ( " j Q u e r y r e q u i r e s a w i n d o w w i t h a d o c u m e n t " ) ; r e t u r n t ( e ) } : t ( e ) } ( " u n d e f i n e d " ! = t y p e o f w i n d o w ? w i n d o w : t h i s , f u n c t i o n ( e , t ) { " u s e s t r i c t " ; f u n c t i o n n ( e , t ) { t = t | | n e ; v a r n = t . c r e a t e E l e m e n t ( " s c r i p t " ) ; n . t e x t = e , t . h e a d . a p p e n d C h i l d ( n ) . p a r e n t N o d e . r e m o v e C h i l d ( n ) } f u n c t i o n r ( e ) { v a r t = ! ! e & & " l e n g t h " i n e & & e . l e n g t h , n = h e . t y p e ( e ) ; r e t u r n " f u n c t i o n " ! = = n & & ! h e . i s W i n d o w ( e ) & & ( " a r r a y " = = = n | | 0 = = = t | | " n u m b e r " = = t y p e o f t & & t > 0 & & t - 1 i n e ) } f u n c t i o n i ( e , t ) { r e t u r n e . n o d e N a m e & & e . n o d e N a m e . t o L o w e r C a s e ( ) = = = t . t o L o w e r C a s e ( ) } f u n c t i o n o ( e , t , n ) { r e t u r n h e . i s F u n c t i o n ( t ) ? h e . g r e p ( e , f u n c t i o n ( e , r ) { r e t u r n ! ! t . c a l l ( e , r , e ) ! = = n } ) : t . n o d e T y p e ? h e . g r e p ( e , f u n c t i o n ( e ) { r e t u r n e = = = t ! = = n } ) : " s t r i n g " ! = t y p e o f t ? h e . g r e p ( e , f u n c t i o n ( e ) { r e t u r n a e . c a l l ( t , e ) > - 1 ! = = n } ) : E e . t e s t ( t ) ? h e . f i l t e r ( t , e , n ) : ( t = h e . f i l t e r ( t , e ) , h e . g r e p ( e , f u n c t i o n ( e ) { r e t u r n a e . c a l l ( t , e ) > - 1 ! = = n & & 1 = = = e . n o d e T y p e } ) ) } f u n c t i o n s ( e , t ) { f o r ( ; ( e = e [ t ] ) & & 1 ! = = e . n o d e T y p e ; ) ; r e t u r n e } f u n c t i o n a ( e ) { v a r t = { } ; r e t u r n h e . e a c h ( e . m a t c h ( A e ) | | [ ] , f u n c t i o n ( e , n ) { t [ n ] = ! 0 } ) , t } f u n c t i o n u ( e ) { r e t u r n e } f u n c t i o n c ( e ) { t h r o w e } f u n c t i o n l ( e , t , n , r ) { v a r i ; t r y { e & & h e . i s F u n c t i o n ( i = e . p r o m i s e ) ? i . c a l l ( e ) . d o n e ( t ) . f a i l ( n ) : e & & h e . i s F u n c t i o n ( i = e . t h e n ) ? i . c a l l ( e , t , n ) : t . a p p l y ( v o i d 0 , [ e ] . s l i c e ( r ) ) } c a t c h ( e ) { n . a p p l y ( v o i d 0 , [ e ] ) } } f u n c t i o n f ( ) { n e . r e m o v e E v e n t L i s t e n e r ( " D O M C o n t e n t L o a d e d " , f ) , e . r e m o v e E v e n t L i s t e n e r ( " l o a d " , f ) , h e . r e a d y ( ) } f u n c t i o n d ( ) { t h i s . e x p a n d o = h e . e x p a n d o + d . u i d + + } f u n c t i o n p ( e ) { r e t u r n " t r u e " = = = e | | " f a l s e " ! = = e & & ( " n u l l " = = = e ? n u l l : e = = = + e + " " ? + e : P e . t e s t ( e ) ? J S O N . p a r s e ( e ) : e ) } f u n c t i o n h ( e , t , n ) { v a r r ; i f ( v o i d 0 = = = n & & 1 = = = e . n o d e T y p e ) i f ( r = " d a t a - " + t . r e p l a c e ( H e , " - $ & " ) . t o L o w e r C a s e ( ) , " s t r i n g " = = t y p e o f ( n = e . g e t A t t r i b u t e ( r ) ) ) { t r y { n = p ( n ) } c a t c h ( e ) { } $ e . s e t ( e , t , n ) } e l s e n = v o i d 0 ; r e t u r n n } f u n c t i o n g ( e , t , n , r ) { v a r i , o = 1 , s = 2 0 , a = r ? f u n c t i o n ( ) { r e t u r n r . c u r ( ) } : f u n c t i o n ( ) { r e t u r n h e . c s s ( e , t , " " ) } , u = a ( ) , c = n & & n [ 3 ] | | ( h e . c s s N u m b e r [ t ] ? " " : " p x " ) , l = ( h e . c s s N u m b e r [ t ] | | " p x " ! = = c & & + u ) & & R e . e x e c ( h e . c s s ( e , t ) ) ; i f ( l & & l [ 3 ] ! = = c ) { c = c | | l [ 3 ] , n = n | | [ ] , l = + u | | 1 ; d o { o = o | | " . 5 " , l / = o , h e . s t y l e ( e , t , l + c ) } w h i l e ( o ! = = ( o = a ( ) / u ) & & 1 ! = = o & & - - s ) } r e t u r n n & & ( l = + l | | + u | | 0 , i = n [ 1 ] ? l + ( n [ 1 ] + 1 ) * n [ 2 ] : + n [ 2 ] , r & & ( r . u n i t = c , r . s t a r t = l , r . e n d = i ) ) , i } f u n c t i o n v ( e ) { v a r t , n = e . o w n e r D o c u m e n t , r = e . n o d e N a m e , i = B e [ r ] ; r e t u r n i | | ( t = n . b o d y . a p p e n d C h i l d ( n . c r e a t e E l e m e n t ( r ) ) , i = h e . c s s ( t , " d i s p l a y " ) , t . p a r e n t N o d e . r e m o v e C h i l d ( t ) , " n o n e " = = = i & & ( i = " b l o c k " ) , B e [ r ] = i , i ) } f u n c t i o n m ( e , t ) { f o r ( v a r n , r , i = [ ] , o = 0 , s = e . l e n g t h ; o < s ; o + + ) r = e [ o ] , r . s t y l e & & ( n = r . s t y l e . d i s p l a y , t ? ( " n o n e " = = = n & & ( i [ o ] = F e . g e t ( r , " d i s p l a y " ) | | n u l l , i [ o ] | | ( r . s t y l e . d i s p l a y = " " ) ) , " " = = = r . s t y l e . d i s p l a y & & M e ( r ) & & ( i [ o ] = v ( r ) ) ) : " n o n e " ! = = n & & ( i [ o ] = " n o n e " , F e . s e t ( r , " d i s p l a y " , n ) ) ) ; f o r ( o = 0 ; o < s ; o + + ) n u l l ! = i [ o ] & & ( e [ o ] . s t y l e . d i s p l a y = i [ o ] ) ; r e t u r n e } f u n c t i o n y ( e , t ) { v a r n ; r e t u r n n = v o i d 0 ! = = e . g e t E l e m e n t s B y T a g N a m e ? e . g e t E l e m e n t s B y T a g N a m e ( t | | " * " ) : v o i d 0 ! = = e . q u e r y S e l e c t o r A l l ? e . q u e r y S e l e c t o r A l l ( t | | " * " ) : [ ] , v o i d 0 = = = t | | t & & i ( e , t ) ? h e . m e r g e ( [ e ] , n ) : n } f u n c t i o n x ( e , t ) { f o r ( v a r n = 0 , r = e . l e n g t h ; n < r ; n + + ) F e . s e t ( e [ n ] , " g l o b a l E v a l " , ! t | | F e . g e t ( t [ n ] , " g l o b a l E v a l " ) ) } f u n c t i o n b ( e , t , n , r , i ) { f o r ( v a r o , s , a , u , c , l , f = t . c r e a t e D o c u m e n t F r a g m e n t ( ) , d = [ ] , p = 0 , h = e . l e n g t h ; p < h ; p + + ) i f ( ( o = e [ p ] ) | | 0 = = = o ) i f ( " o b j e c t " = = = h e . t y p e ( o ) ) h e . m e r g e ( d , o . n o d e T y p e ? [ o ] : o ) ; e l s e i f ( Q e . t e s t ( o ) ) { f o r ( s = s | | f . a p p e n d C h i l d ( t . c r e a t e E l e m e n t ( " d i v " ) ) , a = ( V e . e x e c ( o ) | | [ " " , " " ] ) [ 1 ] . t o L o w e r C a s e ( ) , u = U e [ a ] | | U e . _ d e f a u l t , s . i n n e r H T M L = u [ 1 ] + h e . h t m l P r e f i l t e r ( o ) + u [ 2 ] , l = u [ 0 ] ; l - - ; ) s = s . l a s t C h i l d ; h e . m e r g e ( d , s . c h i l d N o d e s ) , s = f . f i r s t C h i l d , s . t e x t C o n t e n t = " " } e l s e d . p u s h ( t . c r e a t e T e x t N o d e ( o ) ) ; f o r ( f . t e x t C o n t e n t = " " , p = 0 ; o = d [ p + + ] ; ) i f ( r & & h e . i n A r r a y ( o , r ) > - 1 ) i & & i . p u s h ( o ) ; e l s e i f ( c = h e . c o n t a i n s ( o . o w n e r D o c u m e n t , o ) , s = y ( f . a p p e n d C h i l d ( o ) , " s c r i p t " ) , c & & x ( s ) , n ) f o r ( l = 0 ; o = s [ l + + ] ; ) X e . t e s t ( o . t y p e | | " " ) & & n . p u s h ( o ) ; r e t u r n f } f u n c t i o n w ( ) { r e t u r n ! 0 } f u n c t i o n T ( ) { r e t u r n ! 1 } f u n c t i o n S ( ) { t r y { r e t u r n n e . a c t i v e E l e m e n t } c a t c h ( e ) { } } f u n c t i o n E ( e , t , n , r , i , o ) { v a r s , a ; i f ( " o b j e c t " = = t y p e o f t ) { " s t r i n g " ! = t y p e o f n & & ( r = r | | n , n = v o i d 0 ) ; f o r ( a i n t ) E ( e , a , n , r , t [ a ] , o ) ; r e t u r n e } i f ( n u l l = = r & & n u l l = = i ? ( i = n , r = n = v o i d 0 ) : n u l l = = i & & ( " s t r i n g " = = t y p e o f n ? ( i = r , r = v o i d 0 ) : ( i = r , r = n , n = v o i d 0 ) ) , ! 1 = = = i ) i = T ; e l s e i f ( ! i ) r e t u r n e ; r e t u r n 1 = = = o & & ( s = i , i = f u n c t i o n ( e ) { r e t u r n h e ( ) . o f f ( e ) , s . a p p l y
;return"input"===t& & !!e.checked||"option"===t& & !!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild; e;e=e.nextSibling)if(e.nodeType< 6 ) return ! 1 ; return ! 0 } , parent:function ( e ) { return ! w . pseudos . empty ( e ) } , header:function ( e ) { return pe . test ( e . nodeName ) } , input:function ( e ) { return de . test ( e . nodeName ) } , button:function ( e ) { var t = e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t ; return " input " = = = e . nodeName . toLowerCase ( ) & & " text " = = = e . type & & ( null = =(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:u(function(){return[0]}),last:u(function(e,t){return[t-1]}),eq:u(function(e,t,n){return[n<0?n+t:n]}),even:u(function(e,t){for(var n = 0;n<t;n+=2)e.push(n);return e } ) , odd:u ( function ( e , t ) { for ( var n = 1;n<t;n+=2)e.push(n);return e } ) , lt:u ( function ( e , t , n ) { for ( var r = n<0?n+t:n;--r > =0;)e.push(r);return e}),gt:u(function(e,t,n){for(var r=n< 0 ? n + t:n ; + + r < t ; ) e . push ( r ) ; return e } ) } } , w . pseudos . nth = w.pseudos.eq;for(x in { radio: ! 0 , checkbox: ! 0 , file: ! 0 , password: ! 0 , image: ! 0 } ) w . pseudos [ x ] = function ( e ) { return function ( t ) { return " input " = = = t . nodeName . toLowerCase ( ) & & t . type = ==e}}(x);for(x in { submit: ! 0 , reset: ! 0 } ) w . pseudos [ x ] = function ( e ) { return function ( t ) { var n = t.nodeName.toLowerCase();return("input"===n||"button"===n)&&t.type===e}}(x);return l . prototype = w.filters=w.pseudos,w.setFilters=new l , E = t.tokenize=function(e,n){var r , i , o , s , a , u , c , l = B[e+" " ] ; if ( l ) return n ? 0:l . slice ( 0 ) ; for ( a = e,u=[],c=w.preFilter;a;){r&&!(i=se.exec(a))||(i&&(a=a.slice(i[0].length)||a),u.push(o=[])),r=!1,(i=ae.exec(a))&&(r=i.shift(),o.push({value:r,type:i[0].replace(oe," " ) } ) , a = a.slice(r.length));for(s in w . filter ) ! ( i = fe[s].exec(a))||c[s]&&!(i=c[s](i))||(r=i.shift(),o.push({value:r,type:s,matches:i}),a=a.slice(r.length));if(!r)break}return n ? a . length:a ? t . error ( e ) :B ( e , u ) . slice ( 0 ) } , C = t.compile=function(e,t){var n , r = [],i=[],o=z[e+" " ] ; if ( ! o ) { for ( t | | ( t = E(e)),n=t.length;n--;)o=m(t[n]),o[I]?r.push(o):i.push(o);o=z(e,y(i,r)),o.selector=e}return o } , k = t.select=function(e,t,n,r){var i , o , s , a , u , l = "function" = = typeof e & & e , d = !r&&E(e=l.selector||e);if(n=n||[],1===d.length){if(o=d[0]=d[0].slice(0),o.length > 2& & "ID"===(s=o[0]).type& & 9===t.nodeType& & q& & w.relative[o[1].type]){if(!(t=(w.find.ID(s.matches[0].replace(me,ye),t)||[])[0]))return n;l&&(t=t.parentNode),e=e.slice(o.shift().value.length)}for(i=fe.needsContext.test(e)?0:o.length; i--&&(s=o[i],!w.relative[a=s.type]); )if((u=w.find[a])& & (r=u(s.matches[0].replace(me,ye),ve.test(o[0].type)& & c(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length& & f(o)))return J.apply(n,r),n;break}}return(l||C(e,d))(r,t,!q,n,!t||ve.test(e)& & c(t.parentNode)||t),n},b.sortStable=I.split("").sort(V).join("")===I,b.detectDuplicates=!!A,L(),b.sortDetached=i(function(e){return 1& e.compareDocumentPosition(D.createElement("fieldset"))}),i(function(e){return e.innerHTML="< a href = '#' > < / a > ","#"===e.firstChild.getAttribute("href")})||o("type|href|height|width",function(e,t,n){if(!n)return e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),b.attributes& & i(function(e){return e.innerHTML="< input / > ",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||o("value",function(e,t,n){if(!n& & "input"===e.nodeName.toLowerCase())return e.defaultValue}),i(function(e){return null==e.getAttribute("disabled")})||o(Z,function(e,t,n){var r;if(!n)return!0===e[t]?t.toLowerCase():(r=e.getAttributeNode(t))&&r.specified?r.value:null}),t}(e); he.find=xe,he.expr=xe.selectors,he.expr[":"]=he.expr.pseudos,he.uniqueSort=he.unique=xe.uniqueSort,he.text=xe.getText,he.isXMLDoc=xe.isXML,he.contains=xe.contains,he.escapeSelector=xe.escape;var be=function(e,t,n){for(var r=[],i=void 0!==n;(e=e[t])&&9!==e.nodeType; )if(1===e.nodeType){if(i&&he(e).is(n))break; r.push(e)}return r},we=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e); return n},Te=he.expr.match.needsContext,Se=/^< ([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:< \/\1>|)$/i,Ee=/^.[^:#\[\.,]*$/;he.filter=function(e,t,n){var r=t[0];return n& & (e=":not("+e+")"),1===t.length& & 1===r.nodeType?he.find.matc
;for(i=o.length;i--;)o[i].elem!==this||null!=e&&o[i].queue!==e||(o[i].anim.stop(n),t=!1,o.splice(i,1)); !t& & n||he.dequeue(this,e)})},finish:function(e){return!1!==e& & (e=e||"fx"),this.each(function(){var t,n=Fe.get(this),r=n[e+"queue"],i=n[e+"queueHooks"],o=he.timers,s=r?r.length:0;for(n.finish=!0,he.queue(this,e,[]),i&&i.stop&&i.stop.call(this,!0),t=o.length; t--;)o[t].elem===this&&o[t].queue===e&&(o[t].anim.stop(!0),o.splice(t,1)); for(t=0;t< s ; t + + ) r [ t ] & & r [ t ] . finish & & r [ t ] . finish . call ( this ) ; delete n . finish } ) } } ) , he . each ( [ " toggle " , " show " , " hide " ] , function ( e , t ) { var n = he.fn[t];he.fn[t]=function(e,r,i){return null = =e||"boolean"==typeof e ? n . apply ( this , arguments ) :this . animate ( W ( t , ! 0 ) , e , r , i ) } } ) , he . each ( { slideDown:W ( " show " ) , slideUp:W ( " hide " ) , slideToggle:W ( " toggle " ) , fadeIn: { opacity: " show " } , fadeOut: { opacity: " hide " } , fadeToggle: { opacity: " toggle " } } , function ( e , t ) { he . fn [ e ] = function ( e , n , r ) { return this . animate ( t , e , n , r ) } } ) , he . timers = [],he.fx.tick=function(){var e , t = 0,n=he.timers;for(pt=he.now();t<n.length;t++)(e=n[t])()||n[t]!==e||n.splice(t--,1);n.length||he.fx.stop(),pt=void 0 } , he . fx . timer = function(e){he.timers.push(e),he.fx.start()},he.fx.interval=13,he.fx.start=function(){ht||(ht=!0,_())},he.fx.stop=function(){ht=null},he.fx.speeds={slow:600,fast:200,_default:400},he.fn.delay=function(t,n){return t = he.fx?he.fx.speeds[t]||t:t,n=n||"fx",this.queue(n,function(n,r){var i = e.setTimeout(n,t);r.stop=function(){e.clearTimeout(i)}})},function(){var e = ne.createElement("input"),t=ne.createElement("select"),n=t.appendChild(ne.createElement("option"));e.type="checkbox",pe.checkOn=""!==e.value,pe.optSelected=n.selected,e=ne.createElement("input"),e.value="t",e.type="radio",pe.radioValue="t"===e.value}();var mt , yt = he.expr.attrHandle;he.fn.extend({attr:function(e,t){return Oe ( this , he . attr , e , t , arguments . length > 1)},removeAttr:function(e){return this.each(function(){he.removeAttr(this,e)})}}),he.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o& & 8!==o& & 2!==o)return void 0===e.getAttribute?he.prop(e,t,n):(1===o& & he.isXMLDoc(e)||(i=he.attrHooks[t.toLowerCase()]||(he.expr.match.bool.test(t)?mt:void 0)),void 0!==n?null===n?void he.removeAttr(e,t):i& & "set"in i& & void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i& & "get"in i& & null!==(r=i.get(e,t))?r:(r=he.find.attr(e,t),null==r?void 0:r))},attrHooks:{type:{set:function(e,t){if(!pe.radioValue& & "radio"===t& & i(e,"input")){var n=e.value;return e.setAttribute("type",t),n& & (e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(Ae); if(i&&1===e.nodeType)for(; n=i[r++];)e.removeAttribute(n)}}),mt={set:function(e,t,n){return!1===t?he.removeAttr(e,n):e.setAttribute(n,n),n}},he.each(he.expr.match.bool.source.match(/\w+/g),function(e,t){var n=yt[t]||he.find.attr;yt[t]=function(e,t,r){var i,o,s=t.toLowerCase();return r||(o=yt[s],yt[s]=i,i=null!=n(e,t,r)?s:null,yt[s]=o),i}});var xt=/^(?:input|select|textarea|button)$/i,bt=/^(?:a|area)$/i;he.fn.extend({prop:function(e,t){return Oe(this,he.prop,e,t,arguments.length>1)},removeProp:function(e){return this.each(function(){delete this[he.propFix[e]||e]})}}),he.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o& & 8!==o& & 2!==o)return 1===o& & he.isXMLDoc(e)||(t=he.propFix[t]||t,i=he.propHooks[t]),void 0!==n?i& & "set"in i& & void 0!==(r=i.set(e,n,t))?r:e[t]=n:i& & "get"in i& & null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=he.find.attr(e,"tabindex");return t?parseInt(t,10):xt.test(e.nodeName)||bt.test(e.nodeName)& & e.href?0:-1}}},propFix:{for:"htmlFor",class:"className"}}),pe.optSelected||(he.propHooks.selected={get:function(e){var t=e.parentNode;return t& & t.parentNode& & t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t& & (t.selectedIndex,t.parentNode& & t.parentNode.selectedIndex)}}),he.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){he.propFix[this.toLowerCase()]=this}),he.fn.extend({addClass:function(e){var t,n,r,i,o,s,a,u=0;if(he.isFunction(e))return this.each(function(t){he(this).addClass(e.call(this,t,Q(this)))});if("string"==type
var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduce(function(e,t){return e+t.boost},0);return n.some(function(e){return this.tokenStore.has(e)},this)?(n.forEach(function(t,n,s){var a=1/s.length*this._fields.length*o,u=this,c=this.tokenStore.expand(t).reduce(function(n,i){var o=u.corpusTokens.indexOf(i),s=u.idf(i),c=1,l=new e.SortedSet;if(i!==t){var f=Math.max(3,i.length-t.length);c=1/Math.log(f)}return o>-1& & r.insert(o,a*s*c),Object.keys(u.tokenStore.get(i)).forEach(function(e){l.add(e)}),n.union(l)},new e.SortedSet);i.push(c)},this),i.reduce(function(e,t){return e.intersect(t)}).map(function(e){return{ref:e,score:r.similarity(this.documentVector(e))}},this).sort(function(e,t){return t.score-e.score})):[]},e.Index.prototype.documentVector=function(t){for(var n=this.documentStore.get(t),r=n.length,i=new e.Vector,o=0;o< r ; o + + ) { var s = n.elements[o],a=this.tokenStore.get(s)[t].tf,u=this.idf(s);i.insert(this.corpusTokens.indexOf(s),a*u)}return i } , e . Index . prototype . toJSON = function(){return{version:e.version,fields:this._fields,ref:this._ref,documentStore:this.documentStore.toJSON(),tokenStore:this.tokenStore.toJSON(),corpusTokens:this.corpusTokens.toJSON(),pipeline:this.pipeline.toJSON()}},e.Index.prototype.use=function(e){var t = Array.prototype.slice.call(arguments,1);t.unshift(this),e.apply(this,t)},e.Store=function(){this.store={},this.length=0},e.Store.load=function(t){var n = new this ; return n . length = t.length,n.store=Object.keys(t.store).reduce(function(n,r){return n [ r ] = e . SortedSet . load ( t . store [ r ] ) , n } , { } ) , n } , e . Store . prototype . set = function(e,t){this.has(e)||this.length++,this.store[e]=t},e.Store.prototype.get=function(e){return this . store [ e ] } , e . Store . prototype . has = function(e){return e in this . store } , e . Store . prototype . remove = function(e){this.has(e)&&(delete this . store [ e ] , this . length-- ) } , e . Store . prototype . toJSON = function(){return{store:this.store,length:this.length}},e.stemmer=function(){var e = {ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},t={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},n="[aeiouy]",r="[^aeiou][^aeiouy]*",i=new RegExp ( " ^ ( [ ^ aeiou ] [ ^ aeiouy ] * ) ? [ aeiouy ] [ aeiou ] * [ ^ aeiou ] [ ^ aeiouy ] * " ) , o = new RegExp ( " ^ ( [ ^ aeiou ] [ ^ aeiouy ] * ) ? [ aeiouy ] [ aeiou ] * [ ^ aeiou ] [ ^ aeiouy ] * [ aeiouy ] [ aeiou ] * [ ^ aeiou ] [ ^ aeiouy ] * " ) , s = new RegExp ( " ^ ( [ ^ aeiou ] [ ^ aeiouy ] * ) ? [ aeiouy ] [ aeiou ] * [ ^ aeiou ] [ ^ aeiouy ] * ( [ aeiouy ] [ aeiou ] * ) ? $ " ) , a = new RegExp ( " ^ ( [ ^ aeiou ] [ ^ aeiouy ] * ) ? [ aeiouy ] " ) , u = /^(.+?)(ss|i)es$/,c=/^(.+?)([^s])s$/,l=/^(.+?)eed$/,f=/^(.+?)(ed|ing)$/,d=/.$/,p=/(at|bl|iz)$/,h=new RegExp ( " ( [ ^ aeiouylsz ] ) \ \ 1 $ " ) , g = new RegExp ( " ^ " + r + n + " [ ^ aeiouwxy ] $ " ) , v = /^(.+?[^aeiou])y$/,m=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,y=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,x=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,b=/^(.+?)(s|t)(ion)$/,w=/^(.+?)e$/,T=/ll$/,S=new RegExp ( " ^ " + r + n + " [ ^ aeiouwxy ] $ " ) ; return function ( n ) { var r , E , C , k , N , j , A ; if ( n . length < 3 ) return n ; if ( C = n.substr(0,1),"y"==C&&(n=C.toUpperCase()+n.substr(1)),k=u,N=c,k.test(n)?n=n.replace(k,"$1$2"):N.test(n)&&(n=n.replace(N,"$1$2")),k=l,N=f,k.test(n)){var L = k.exec(n);k=i,k.test(L[1])&&(k=d,n=n.replace(k,""))}else if ( N . test ( n ) ) { var L = N.exec(n);r=L[1],N=a,N.test(r)&&(n=r,N=p,j=h,A=g,N.test(n)?n+="e":j.test(n)?(k=d,n=n.replace(k,"")):A.test(n)&&(n+="e"))}if(k=v,k.test(n)){var L = k.exec(n);r=L[1],n=r+"i"}if(k=m,k.test(n)){var L = k.exec(n);r=L[1],E=L[2],k=i,k.test(r)&&(n=r+e[E])}if(k=y,k.test(n)){var L = k.exec(n);r=L[1],E=L[2],k=i,k.test(r)&&(n=r+t[E])}if(k=x,N=b,k.test(n)){var L = k.exec(n);r=L[1],k=o,k.test(r)&&(n=r)}else if ( N . test ( n ) ) { var L = N.exec(n);r=L[1]+L[2],N=o,N.test(r)&&(n=r)}if(k=w,k.test(n)){var L = k.exec(n);r=L[1],k=o,N=s,j=S,(k.test(r)||N.test(r)&&!j.test(r))&&(n=r)}return k = T,N=o,k.test(n)&&N.test(n)&&(k=d,n=n.replace(k,"")),"y"==C&&(n=C
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< meta name = "theme-color" content = "#F3F7F9" / >
< / head >
< body data-languages = "["shell","http","javascript","javascript--nodejs","ruby","python","java","go"]" >
< a href = "#" id = "nav-button" >
< span >
NAV
< img src = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAAAAABWESUoAAAAAnRSTlMAAHaTzTgAAAAZSURBVHgBYxgswBIIsLFGrIJRBaMKBh4AAE3cQCEvEU3+AAAAAElFTkSuQmCC" class = "undefined" alt = "Navigation" >
< / span >
< / a >
< div class = "toc-wrapper" >
< img src = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGEAAAAcCAYAAABxutG8AAAG6klEQVR4Ad3aA4xkSxcA4LvefbZt27Zt27Zt27Zt27bttWe2R9+vTionlZs7760m/5eMutDVXV11T507RUeD7rgAL+AQzIlx/mYfp6OGs4oOAp3QEz3Er65FR4NO2EL0GhZtZ/t50IhWXFJ0EFgDd+LW9OUWHFd0RJgSr4lewGTVbZ2BFjRh16KDwHNKjEynE+MkfIz7MP0o3pJuEQ3FChXtxsdLgEYs+385CVgQ98rVcAy6jaIt6Vq5DSraLYM/AMMxbdFB4NmRmgRMhtXyjgxATXQ7xs37sA7WxQRFBXTDzXLrVLTbXTK0qNbxJwGTYVe8IPoFF2F3fC96BZPnffkG8AQ2ROeKre4JUV8sVd5GL1wn+an4BzAJFsE62Aa7YM1Ubgbsgz2xF3ajOsLBS397ErAj3kKrpBVnYf56nfXQKLqAOCgsjKGSRhyDTiXPPQs+Fb1F+faCKfCJ5NmindAT2+FuvIufMBBNgA8wSb3u/nIzFBVwIHrjN/wqfT2ZV2Z6vI5W0ZdYHF3Svu1EUSO2yvt0DlpEr5etBiyFmuiKihc5q+jqoh1wFP5ETbkfMG+9/pFys9XL5sI9eLH+9TKextToivHlX73SYOiMA+SacTe6xMGbCI+LvsHc+ZbmHbmLyVcCOmMv0WBsWPFmbik6qryuzlgLfbXP95irfBLMXi/bGTW5tYsqmAp3yfXD/iVtZkQ/0XN5PRtgmNxG5eFpNrmfVO27uEy0ZUm9qXGt9mlDA55XDzawG2oYjCFoxLRpC9cgt1bVBIyH5+V+oXwGsZqoBafFOnrgMrkRmKv8oJbZr6iAj0VL53XMibeU+wtP4WIcgm2xERaKF27rSdHemug0spNwhtwgLF/R7lxRA/EwhWnRW+49TF3S76Gi34t2kJsulpsDf8oNwaVYETNgYnQv/gHshMaq0DqDPnJbFBXwiah/EYSlO0h0c1lSDn9Vb1sR5ifKgw0DRV9h62IUwjrohza0og2wUFXDBtEtRQVMJHdffur1AT7EANGRJf1uIXqpaAfsIWpIZSbFx4A2fDSK3/wA3dAT3du9onCHaNLqNraV2yq/ZmjAtaJh2KSk3w8kfbEoZsKyWBiTlLS7RvRlusi7GjAYJ2CidqZmNsEGWBVz5uGwlbEptsYa+YfUWtgOUxVVMDsGp8FXw30yMVWBD/E6zhN9jwVKVsEIyXd4AZ9hdzyBT3EFxottvS96qv74+oBvqE7mYUu8gB9wDn5AX3yHK9ELe+Nb9MYwtOCG1Icd8C4Ghg9nFayEgXi3nfWHi96J5VYA7CgPN9/G+HnKwXOiNsB+GBf3AdrwNWnS0Si6Gl3wM77GHBWvZwI8ghGAlzAefhcthXvktq33c5g4luFhlVTBdNihup755I6JdTyF3zEhfhQ9nPdpczTKDUQnTIpXJc04OJ1xtIgOx8EYWrUCMCmelDThYEyL/qIV8KrcLFgdraIvMFcxqmFfuYVTueVQw26YXtSCU/JknVfk4HJ0wowYKmnD7mnVaRXtiYHYvzpl7lzRX5gSO6MxTo4Z8LXcePgKI0RPolcxquEuUT9MmNIBrsEf6IGlRSOwWezPIcrUUxXYVPSC+ovDrvkkeAYNVUEGFgYgJv5wu+g1dMcg0Yc4Fp/jCUkbLowXe4sVowI+Fj2iHvNjAdSwS/3v7UXDMU88QGlTpn4Bx2eSq0gRDh6Va0Ir7qX8JhMekNseU+FT0Tn1NjXRYxiK9fCBZBi2Kerw3ijZmjBdvsc7AV3RDVfgS/XTME4UDU596YJfAM1oEfXGdDgD8AmWi+OxNP5UDi4oi9flYDysj49QAwzBxhgPTaIG3IS50Srpk7Krlse7xaiAxfBnyZYxH9qwY6rvYtEP6UDjgTRYp+JL0a84AVeU5IHGxVVoUe3IkADMxpadL86uf/UDfIMZMBua5GbBRqKvY6BixWJUwLxxEgzFEuiG9/EEepbngbxVf/wqwGBshe54C/l2VAIn4hR8I6phqNyZmDzF8p6Suwzj437sjAGAF1Mor1n0Qb1sF9Gt6V9d3FiMSnhSMgjr4UH8iWnypJm/JL/gfkA/UsIPW8tdnz+/cXAXTsX0+EpuPfwp9yFewnOYBu+IDsY2uAiLYhBacVk6pGojT8FgddHR6IQrMEsxKmECfJRvHaYrqb8mBojexqwlCbBG0cWYFfPgZPyFrdMtTd/LzYAp8bzc1+kumanxnWQY3k6Bhh8BL+MUXCi3ULol6yvJK7g0vxk16s8L9+ModK6+aeQ03Ied0akiAXYMPsEwSR9cnJ+2HYs38DN6o2+MwGyHj9APt2GyfGU5Cg/gVHSNK9lX+BIroSt2xWW4C5divPiB8xUa8H3MAJf7Fykvx9WyNCXUAAAAAElFTkSuQmCC" class = "logo" alt = "Logo" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< div class = "lang-selector" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "shell" > Shell< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "http" > HTTP< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "javascript" > JavaScript< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "javascript--nodejs" > Node.js< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "ruby" > Ruby< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "python" > Python< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "java" > Java< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "go" > Go< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / div >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< div class = "search" >
< input type = "text" class = "search" id = "input-search" placeholder = "Search" >
< / div >
< ul class = "search-results" > < / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< div id = "toc" class = "toc-list-h1" >
< ul class = "toc-list-h1" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2021-01-29 15:16:35 +02:00
< a href = "#wekan-rest-api" class = "toc-h1 toc-link" data-title = "Wekan REST API v4.91" > Wekan REST API v4.91< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#production-security-concerns" class = "toc-h1 toc-link" data-title = "Production Security Concerns" > Production Security Concerns< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#authentication" class = "toc-h1 toc-link" data-title = "Authentication" > Authentication< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-login" class = "toc-h1 toc-link" data-title = "Login" > Login< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#login" class = "toc-h2 toc-link" data-title = "login" > login< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#register" class = "toc-h2 toc-link" data-title = "register" > register< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2021-01-28 19:24:10 +02:00
< li >
< a href = "#wekan-rest-api-boards" class = "toc-h1 toc-link" data-title = "Boards" > Boards< / a >
< ul class = "toc-list-h2" >
< li >
< a href = "#get_public_boards" class = "toc-h2 toc-link" data-title = "get_public_boards" > get_public_boards< / a >
< / li >
< li >
< a href = "#new_board" class = "toc-h2 toc-link" data-title = "new_board" > new_board< / a >
< / li >
< li >
< a href = "#get_board" class = "toc-h2 toc-link" data-title = "get_board" > get_board< / a >
< / li >
< li >
< a href = "#delete_board" class = "toc-h2 toc-link" data-title = "delete_board" > delete_board< / a >
< / li >
< li >
< a href = "#get_board_attachments" class = "toc-h2 toc-link" data-title = "get_board_attachments" > get_board_attachments< / a >
< / li >
< li >
< a href = "#exportjson" class = "toc-h2 toc-link" data-title = "exportJson" > exportJson< / a >
< / li >
< li >
< a href = "#add_board_label" class = "toc-h2 toc-link" data-title = "add_board_label" > add_board_label< / a >
< / li >
< li >
< a href = "#set_board_member_permission" class = "toc-h2 toc-link" data-title = "set_board_member_permission" > set_board_member_permission< / a >
< / li >
< li >
< a href = "#get_boards_from_user" class = "toc-h2 toc-link" data-title = "get_boards_from_user" > get_boards_from_user< / a >
< / li >
< / ul >
< / li >
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-checklists" class = "toc-h1 toc-link" data-title = "Checklists" > Checklists< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_all_checklists" class = "toc-h2 toc-link" data-title = "get_all_checklists" > get_all_checklists< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#new_checklist" class = "toc-h2 toc-link" data-title = "new_checklist" > new_checklist< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_checklist" class = "toc-h2 toc-link" data-title = "get_checklist" > get_checklist< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_checklist" class = "toc-h2 toc-link" data-title = "delete_checklist" > delete_checklist< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-checklistitems" class = "toc-h1 toc-link" data-title = "ChecklistItems" > ChecklistItems< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_checklist_item" class = "toc-h2 toc-link" data-title = "get_checklist_item" > get_checklist_item< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#edit_checklist_item" class = "toc-h2 toc-link" data-title = "edit_checklist_item" > edit_checklist_item< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_checklist_item" class = "toc-h2 toc-link" data-title = "delete_checklist_item" > delete_checklist_item< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-cardcomments" class = "toc-h1 toc-link" data-title = "CardComments" > CardComments< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_all_comments" class = "toc-h2 toc-link" data-title = "get_all_comments" > get_all_comments< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#new_comment" class = "toc-h2 toc-link" data-title = "new_comment" > new_comment< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_comment" class = "toc-h2 toc-link" data-title = "get_comment" > get_comment< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_comment" class = "toc-h2 toc-link" data-title = "delete_comment" > delete_comment< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-05-30 08:41:48 +03:00
< li >
< a href = "#wekan-rest-api-cards" class = "toc-h1 toc-link" data-title = "Cards" > Cards< / a >
< ul class = "toc-list-h2" >
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_cards_by_custom_field" class = "toc-h2 toc-link" data-title = "get_cards_by_custom_field" > get_cards_by_custom_field< / a >
2020-05-30 08:41:48 +03:00
< / 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 >
2020-06-17 21:59:54 +03:00
< a href = "#get_card" class = "toc-h2 toc-link" data-title = "get_card" > get_card< / a >
2020-05-30 08:41:48 +03:00
< / li >
< li >
2020-06-17 21:59:54 +03:00
< a href = "#edit_card" class = "toc-h2 toc-link" data-title = "edit_card" > edit_card< / a >
2020-05-30 08:41:48 +03:00
< / li >
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_card" class = "toc-h2 toc-link" data-title = "delete_card" > delete_card< / a >
2020-05-30 08:41:48 +03:00
< / li >
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_swimlane_cards" class = "toc-h2 toc-link" data-title = "get_swimlane_cards" > get_swimlane_cards< / a >
2020-05-30 08:41:48 +03:00
< / li >
< / ul >
< / li >
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-customfields" class = "toc-h1 toc-link" data-title = "CustomFields" > CustomFields< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_all_custom_fields" class = "toc-h2 toc-link" data-title = "get_all_custom_fields" > get_all_custom_fields< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#new_custom_field" class = "toc-h2 toc-link" data-title = "new_custom_field" > new_custom_field< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#get_custom_field" class = "toc-h2 toc-link" data-title = "get_custom_field" > get_custom_field< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_custom_field" class = "toc-h2 toc-link" data-title = "delete_custom_field" > delete_custom_field< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-integrations" class = "toc-h1 toc-link" data-title = "Integrations" > Integrations< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_all_integrations" class = "toc-h2 toc-link" data-title = "get_all_integrations" > get_all_integrations< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#new_integration" class = "toc-h2 toc-link" data-title = "new_integration" > new_integration< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_integration" class = "toc-h2 toc-link" data-title = "get_integration" > get_integration< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#edit_integration" class = "toc-h2 toc-link" data-title = "edit_integration" > edit_integration< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#delete_integration" class = "toc-h2 toc-link" data-title = "delete_integration" > delete_integration< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_integration_activities" class = "toc-h2 toc-link" data-title = "delete_integration_activities" > delete_integration_activities< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#new_integration_activities" class = "toc-h2 toc-link" data-title = "new_integration_activities" > new_integration_activities< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-lists" class = "toc-h1 toc-link" data-title = "Lists" > Lists< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_all_lists" class = "toc-h2 toc-link" data-title = "get_all_lists" > get_all_lists< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#new_list" class = "toc-h2 toc-link" data-title = "new_list" > new_list< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_list" class = "toc-h2 toc-link" data-title = "get_list" > get_list< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#delete_list" class = "toc-h2 toc-link" data-title = "delete_list" > delete_list< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#wekan-rest-api-users" class = "toc-h1 toc-link" data-title = "Users" > Users< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#add_board_member" class = "toc-h2 toc-link" data-title = "add_board_member" > add_board_member< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#remove_board_member" class = "toc-h2 toc-link" data-title = "remove_board_member" > remove_board_member< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#get_current_user" class = "toc-h2 toc-link" data-title = "get_current_user" > get_current_user< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#get_all_users" class = "toc-h2 toc-link" data-title = "get_all_users" > get_all_users< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#new_user" class = "toc-h2 toc-link" data-title = "new_user" > new_user< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#get_user" class = "toc-h2 toc-link" data-title = "get_user" > get_user< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#edit_user" class = "toc-h2 toc-link" data-title = "edit_user" > edit_user< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#delete_user" class = "toc-h2 toc-link" data-title = "delete_user" > delete_user< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#wekan-rest-api-swimlanes" class = "toc-h1 toc-link" data-title = "Swimlanes" > Swimlanes< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_all_swimlanes" class = "toc-h2 toc-link" data-title = "get_all_swimlanes" > get_all_swimlanes< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#new_swimlane" class = "toc-h2 toc-link" data-title = "new_swimlane" > new_swimlane< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#get_swimlane" class = "toc-h2 toc-link" data-title = "get_swimlane" > get_swimlane< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
2020-06-17 21:59:54 +03:00
< a href = "#delete_swimlane" class = "toc-h2 toc-link" data-title = "delete_swimlane" > delete_swimlane< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#schemas" class = "toc-h1 toc-link" data-title = "Schemas" > Schemas< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-list-h2" >
2020-05-25 21:46:08 +03:00
2021-01-28 19:24:10 +02:00
< li >
< a href = "#tocsboards" class = "toc-h2 toc-link" data-title = "Boards" > Boards< / a >
< / li >
< li >
< a href = "#tocsboardslabels" class = "toc-h2 toc-link" data-title = "BoardsLabels" > BoardsLabels< / a >
< / li >
< li >
< a href = "#tocsboardsmembers" class = "toc-h2 toc-link" data-title = "BoardsMembers" > BoardsMembers< / a >
< / li >
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocscardcomments" class = "toc-h2 toc-link" data-title = "CardComments" > CardComments< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#tocscards" class = "toc-h2 toc-link" data-title = "Cards" > Cards< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#tocscardsvote" class = "toc-h2 toc-link" data-title = "CardsVote" > CardsVote< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#tocscardscustomfields" class = "toc-h2 toc-link" data-title = "CardsCustomfields" > CardsCustomfields< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocschecklistitems" class = "toc-h2 toc-link" data-title = "ChecklistItems" > ChecklistItems< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocschecklists" class = "toc-h2 toc-link" data-title = "Checklists" > Checklists< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocscustomfields" class = "toc-h2 toc-link" data-title = "CustomFields" > CustomFields< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocscustomfieldssettings" class = "toc-h2 toc-link" data-title = "CustomFieldsSettings" > CustomFieldsSettings< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocscustomfieldssettingsdropdownitems" class = "toc-h2 toc-link" data-title = "CustomFieldsSettingsDropdownitems" > CustomFieldsSettingsDropdownitems< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocsintegrations" class = "toc-h2 toc-link" data-title = "Integrations" > Integrations< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocslists" class = "toc-h2 toc-link" data-title = "Lists" > Lists< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocslistswiplimit" class = "toc-h2 toc-link" data-title = "ListsWiplimit" > ListsWiplimit< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< li >
< a href = "#tocsswimlanes" class = "toc-h2 toc-link" data-title = "Swimlanes" > Swimlanes< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#tocsusers" class = "toc-h2 toc-link" data-title = "Users" > Users< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#tocsusersemails" class = "toc-h2 toc-link" data-title = "UsersEmails" > UsersEmails< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< li >
< a href = "#tocsusersprofile" class = "toc-h2 toc-link" data-title = "UsersProfile" > UsersProfile< / a >
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2021-01-16 05:08:10 +02:00
< li >
< a href = "#tocsuserssessiondata" class = "toc-h2 toc-link" data-title = "UsersSessiondata" > UsersSessiondata< / a >
< / li >
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / li >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
< / div >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< ul class = "toc-footer" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / ul >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / div >
< div class = "page-wrapper" >
< div class = "dark-box" > < / div >
< div class = "content" >
2021-01-29 15:16:35 +02:00
< h1 id = "wekan-rest-api" > Wekan REST API v4.91< / h1 >
2019-07-17 17:06:25 +03:00
< 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 >
< p > The REST API allows you to control and extend Wekan with ease.< / p >
< p > If you are an end-user and not a dev or a tester, < a href = "https://github.com/wekan/wekan/issues/new" > create an issue< / a > to request new APIs.< / p >
< blockquote >
< p > All API calls in the documentation are made using < code > curl< / code > . However, you are free to use Java / Python / PHP / Golang / Ruby / Swift / Objective-C / Rust / Scala / C# or any other programming languages.< / p >
< / blockquote >
< h1 id = "production-security-concerns" > Production Security Concerns< / h1 >
< p > When calling a production Wekan server, ensure it is running via HTTPS and has a valid SSL Certificate. The login method requires you to post your username and password in plaintext, which is why we highly suggest only calling the REST login api over HTTPS. Also, few things to note:< / p >
< ul >
< li > Only call via HTTPS< / li >
< li > Implement a timed authorization token expiration strategy< / li >
< li > Ensure the calling user only has permissions for what they are calling and no more< / li >
< / ul >
< h1 id = "authentication" > Authentication< / h1 >
< ul >
< li > API Key (UserSecurity)
< ul >
< li > Parameter Name: < strong > Authorization< / strong > , in: header.< / li >
< / ul >
< / li >
< / ul >
< h1 id = "wekan-rest-api-login" > Login< / h1 >
< h2 id = "login" > login< / h2 >
< p > < a id = "opIdlogin" > < / 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 /users/login \
-H < span class = "hljs-string" > 'Content-Type: application/x-www-form-urlencoded'< / span > \
-H < span class = "hljs-string" > 'Accept: */*'< / span >
< / code > < / pre >
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /users/login< / span > HTTP/1.1
< span class = "http" > < span class = "hljs-attribute" > Content-Type< / span > : application/x-www-form-urlencoded
< span class = "hljs-attribute" > Accept< / span > : */*
< 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" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > '*/*'< / span >
};
$.ajax({
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/users/login'< / 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 > {
< 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 > inputBody = < span class = "hljs-string" > '{
"username": "string",
"password": "pa$$word"
}'< / span > ;
< span class = "hljs-keyword" > const< / span > headers = {
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > '*/*'< / span >
};
fetch(< span class = "hljs-string" > '/users/login'< / 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 > {
< 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" > 'Content-Type'< / span > => < span class = "hljs-string" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > '*/*'< / span >
}
result = RestClient.post < span class = "hljs-string" > '/users/login'< / 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" > 'Content-Type'< / span > : < span class = "hljs-string" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > '*/*'< / span >
}
r = requests.post(< span class = "hljs-string" > '/users/login'< / 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" > "/users/login"< / span > );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/x-www-form-urlencoded"< / span > },
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "*/*"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/users/login"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > POST /users/login< / code > < / p >
< p > < em > Login with REST API< / em > < / p >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > username:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > password:< / span > < span class = "hljs-string" > pa$$word< / span >
< / code > < / pre >
< h3 id = "login-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » username< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > Your username< / td >
< / tr >
< tr >
< td > » password< / td >
< td > body< / td >
< td > string(password)< / td >
< td > true< / td >
< td > Your password< / td >
< / tr >
< / tbody >
< / table >
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< h3 id = "login-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 > Successful authentication< / td >
< td > Inline< / td >
< / tr >
< tr >
< td > 400< / td >
< td > < a href = "https://tools.ietf.org/html/rfc7231#section-6.5.1" > Bad Request< / a > < / td >
< td > Error in authentication< / td >
< td > Inline< / td >
< / tr >
< tr >
< td > default< / td >
< td > Default< / td >
< td > Error in authentication< / td >
< td > None< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "login-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 > » token< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » tokenExpires< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< / tbody >
< / table >
< p > Status Code < strong > 400< / 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 > » error< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » reason< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< / tbody >
< / table >
< aside class = "success" >
This operation does not require authentication
< / aside >
< h2 id = "register" > register< / h2 >
< p > < a id = "opIdregister" > < / 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 /users/register \
-H < span class = "hljs-string" > 'Content-Type: application/x-www-form-urlencoded'< / span > \
-H < span class = "hljs-string" > 'Accept: */*'< / span >
< / code > < / pre >
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /users/register< / span > HTTP/1.1
< span class = "http" > < span class = "hljs-attribute" > Content-Type< / span > : application/x-www-form-urlencoded
< span class = "hljs-attribute" > Accept< / span > : */*
< 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" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > '*/*'< / span >
};
$.ajax({
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/users/register'< / 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 > {
< 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 > inputBody = < span class = "hljs-string" > '{
"username": "string",
"password": "pa$$word",
"email": "string"
}'< / span > ;
< span class = "hljs-keyword" > const< / span > headers = {
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > '*/*'< / span >
};
fetch(< span class = "hljs-string" > '/users/register'< / 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 > {
< 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" > 'Content-Type'< / span > => < span class = "hljs-string" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > '*/*'< / span >
}
result = RestClient.post < span class = "hljs-string" > '/users/register'< / 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" > 'Content-Type'< / span > : < span class = "hljs-string" > 'application/x-www-form-urlencoded'< / span > ,
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > '*/*'< / span >
}
r = requests.post(< span class = "hljs-string" > '/users/register'< / 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" > "/users/register"< / span > );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/x-www-form-urlencoded"< / span > },
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "*/*"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/users/register"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > POST /users/register< / code > < / p >
< p > < em > Register with REST API< / em > < / p >
< p > Notes:< / p >
< ul >
< li > You will need to provide the token for any of the authenticated methods.< / li >
< / ul >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > username:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > password:< / span > < span class = "hljs-string" > pa$$word< / span >
< span class = "hljs-attr" > email:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "register-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » username< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > Your username< / td >
< / tr >
< tr >
< td > » password< / td >
< td > body< / td >
< td > string(password)< / td >
< td > true< / td >
< td > Your password< / td >
< / tr >
< tr >
< td > » email< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > Your email< / td >
< / tr >
< / tbody >
< / table >
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< h3 id = "register-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 > Successful registration< / td >
< td > Inline< / td >
< / tr >
< tr >
< td > 400< / td >
< td > < a href = "https://tools.ietf.org/html/rfc7231#section-6.5.1" > Bad Request< / a > < / td >
< td > Error in registration< / td >
< td > Inline< / td >
< / tr >
< tr >
< td > default< / td >
< td > Default< / td >
< td > Error in registration< / td >
< td > None< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "register-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 > » token< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » tokenExpires< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< / tbody >
< / table >
< p > Status Code < strong > 400< / 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 > » error< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » reason< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< / tbody >
< / table >
< aside class = "success" >
This operation does not require authentication
< / aside >
2021-01-28 19:24:10 +02:00
< h1 id = "wekan-rest-api-boards" > Boards< / h1 >
< h2 id = "get_public_boards" > get_public_boards< / h2 >
< p > < a id = "opIdget_public_boards" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards"< / span > );
2019-07-17 17:06:25 +03:00
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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards< / code > < / p >
< p > < em > Get all public boards< / em > < / p >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_public_boards-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_public_boards-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_board" > new_board< / h2 >
< p > < a id = "opIdnew_board" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards \
2019-07-17 17:06:25 +03:00
-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 >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /api/boards< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > {
< 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 > inputBody = < span class = "hljs-string" > '{
"title": "string",
2021-01-28 19:24:10 +02:00
"owner": "string",
"isAdmin": true,
"isActive": true,
"isNoComments": true,
"isCommentOnly": true,
"isWorker": true,
"permission": "string",
"color": "string"
2019-07-17 17:06:25 +03:00
}'< / 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 > {
< 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" > '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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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" > '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 >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards< / code > < / p >
< p > < em > Create a board< / em > < / p >
< p > This allows to create a board.< / p >
< p > The color has to be chosen between < code > belize< / code > , < code > nephritis< / code > , < code > pomegranate< / code > ,
< code > pumpkin< / code > , < code > wisteria< / code > , < code > moderatepink< / code > , < code > strongcyan< / code > ,
< code > limegreen< / code > , < code > midnight< / code > , < code > dark< / code > , < code > relax< / code > , < code > corteza< / code > :< / p >
< img src = "https://wekan.github.io/board-colors.png" alt = "Wekan logo" / >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > owner:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > isAdmin:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isActive:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isNoComments:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isCommentOnly:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isWorker:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > permission:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > color:< / span > < span class = "hljs-string" > string< / span >
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_board-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » title< / td >
< td > body< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the new title of the board< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » owner< / td >
< td > body< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > " ABCDE12345" < = User ID in Wekan.< / td >
< / tr >
< tr >
< td > » isAdmin< / td >
< td > body< / td >
< td > boolean< / td >
< td > false< / td >
< td > is the owner an admin of the board (default true)< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » isActive< / td >
2019-07-17 17:06:25 +03:00
< td > body< / td >
2021-01-28 19:24:10 +02:00
< td > boolean< / td >
< td > false< / td >
< td > is the board active (default true)< / td >
< / tr >
< tr >
< td > » isNoComments< / td >
2020-01-05 21:43:44 +02:00
< td > body< / td >
2021-01-28 19:24:10 +02:00
< td > boolean< / td >
2020-01-05 21:43:44 +02:00
< td > false< / td >
2021-01-28 19:24:10 +02:00
< td > disable comments (default false)< / td >
2020-01-05 21:43:44 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » isCommentOnly< / td >
< td > body< / td >
< td > boolean< / td >
< td > false< / td >
< td > only enable comments (default false)< / td >
< / tr >
< tr >
< td > » isWorker< / td >
< td > body< / td >
< td > boolean< / td >
< td > false< / td >
< td > only move cards, assign himself to card and comment (default false)< / td >
< / tr >
< tr >
< td > » permission< / td >
2019-07-17 17:06:25 +03:00
< td > body< / td >
< td > string< / td >
2021-01-28 19:24:10 +02:00
< td > false< / td >
< td > " private" board < == Set to " public" if you< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » color< / td >
2019-07-17 17:06:25 +03:00
< td > body< / td >
< td > string< / td >
< td > false< / td >
2021-01-28 19:24:10 +02:00
< td > the color of the board< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > » owner< / strong > : " ABCDE12345" < = User ID in Wekan.
(Not username or email)< / p >
< p > < strong > » permission< / strong > : " private" board < == Set to " public" if you
want public Wekan board< / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "defaultSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_board-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "new_board-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< tr >
< td > » defaultSwimlaneId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_board" > get_board< / h2 >
< p > < a id = "opIdget_board" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board} \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}"< / span > );
2019-07-17 17:06:25 +03:00
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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}< / code > < / p >
< p > < em > Get the board with that particular ID< / em > < / p >
< h3 id = "get_board-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the board to retrieve the data< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the ID of the board to retrieve the data< / p >
2019-07-17 17:06:25 +03:00
< 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 > ,
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "slug"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "archived"< / span > : < span class = "hljs-literal" > true< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "stars"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "labels"< / span > : [
2019-07-17 17:06:25 +03:00
{
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "name"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "green"< / span >
2019-07-17 17:06:25 +03:00
}
2021-01-28 19:24:10 +02:00
],
< span class = "hljs-attr" > "members"< / span > : [
{
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "isAdmin"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isActive"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isNoComments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isCommentOnly"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isWorker"< / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > "permission"< / span > : < span class = "hljs-string" > "public"< / 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 > ,
< span class = "hljs-attr" > "subtasksDefaultListId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "dateSettingsDefaultBoardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "dateSettingsDefaultListId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "allowsSubtasks"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsAttachments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsChecklists"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsComments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsDescriptionTitle"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsDescriptionText"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsActivities"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsLabels"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsAssignee"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsMembers"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsRequestedBy"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsAssignedBy"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsReceivedDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsStartDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsEndDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsDueDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "presentParentTask"< / span > : < span class = "hljs-string" > "prefix-with-full-path"< / span > ,
< span class = "hljs-attr" > "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-number" > 0< / span > ,
< span class = "hljs-attr" > "isOvertime"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "type"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_board-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemaboards" > Boards< / a > < / td >
2021-01-22 17:37:12 +02:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
2019-07-17 17:06:25 +03:00
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_board" > delete_board< / h2 >
< p > < a id = "opIddelete_board" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board} \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > DELETE< / span > < span class = "hljs-string" > /api/boards/{board}< / span > HTTP/1.1
2021-01-22 17:37:12 +02:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}"< / span > );
2019-07-17 17:06:25 +03:00
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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}< / code > < / p >
< p > < em > Delete a board< / em > < / p >
< h3 id = "delete_board-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the board< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the ID of the board< / p >
< h3 id = "delete_board-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > None< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_board_attachments" > get_board_attachments< / h2 >
< p > < a id = "opIdget_board_attachments" > < / a > < / p >
2020-12-08 21:49:56 +02:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/attachments \
2020-12-08 21:49:56 +02:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/attachments< / span > HTTP/1.1
2020-12-08 21:49:56 +02:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/attachments'< / span > ,
2020-12-08 21:49:56 +02:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/attachments'< / span > ,
2020-12-08 21:49:56 +02:00
{
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/attachments'< / span > ,
2020-12-08 21:49:56 +02:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/attachments'< / span > , params={
2020-12-08 21:49:56 +02:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/attachments"< / span > );
2020-12-08 21:49:56 +02:00
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})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/attachments"< / span > , data)
2020-12-08 21:49:56 +02:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/attachments< / code > < / p >
< p > < em > Get the list of attachments of a board< / em > < / p >
< h3 id = "get_board_attachments-parameters" > Parameters< / h3 >
2020-12-08 21:49:56 +02:00
< table >
< thead >
< tr >
< 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 > 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 >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > [
{
< span class = "hljs-attr" > "attachmentId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "attachmentName"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "attachmentType"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "swimlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
}
]
2020-12-08 21:49:56 +02:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_board_attachments-responses" > Responses< / h3 >
2020-12-08 21:49:56 +02:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > Inline< / td >
2020-12-08 21:49:56 +02:00
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "get_board_attachments-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 > » attachmentId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » attachmentName< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » attachmentType< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » cardId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » listId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » swimlaneId< / 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 = "exportjson" > exportJson< / h2 >
< p > < a id = "opIdexportJson" > < / 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}/< span class = "hljs-built_in" > export< / 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}/export< / span > HTTP/1.1
< span class = "undefined" > < / span > < / code > < / pre >
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
$.ajax({
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/export'< / 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" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
fetch(< span class = "hljs-string" > '/api/boards/{board}/export'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/export'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/export'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/export"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/export"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/export< / code > < / p >
< p > < em > This route is used to export the board to a json file format.< / em > < / p >
< p > If user is already logged-in, pass loginToken as param
" authToken" : '/api/boards/:boardId/export?authToken=:token'< / p >
< p > See < a href = "https://blog.kayla.com.au/server-side-route-authentication-in-meteor/" > https://blog.kayla.com.au/server-side-route-authentication-in-meteor/< / a >
for detailed explanations< / p >
< h3 id = "exportjson-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the board we are exporting< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the ID of the board we are exporting< / p >
< h3 id = "exportjson-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > None< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "add_board_label" > add_board_label< / h2 >
< p > < a id = "opIdadd_board_label" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X PUT /api/boards/{board}/labels \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > PUT< / span > < span class = "hljs-string" > /api/boards/{board}/labels< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/labels'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'put'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"label": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/labels'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'PUT'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.put < span class = "hljs-string" > '/api/boards/{board}/labels'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.put(< span class = "hljs-string" > '/api/boards/{board}/labels'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/labels"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "PUT"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "PUT"< / span > , < span class = "hljs-string" > "/api/boards/{board}/labels"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > PUT /api/boards/{board}/labels< / code > < / p >
< p > < em > Add a label to a board< / em > < / p >
< p > If the board doesn't have the name/color label, this function
adds the label to the board.< / p >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > label:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "add_board_label-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » label< / td >
< td > body< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the label value< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board< / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > < span class = "hljs-string" > "string"< / span >
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "add_board_label-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 > string< / 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 >
2021-01-28 19:24:10 +02:00
< h2 id = "set_board_member_permission" > set_board_member_permission< / h2 >
< p > < a id = "opIdset_board_member_permission" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/members/{member} \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /api/boards/{board}/members/{member}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "fortran" > Content-< span class = "hljs-keyword" > Type< / span > : multipart/< span class = "hljs-keyword" > form< / span > -< span class = "hljs-keyword" > data< / span >
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/members/{member}'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'post'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"isAdmin": true,
"isNoComments": true,
"isCommentOnly": true,
"isWorker": true
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/members/{member}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/members/{member}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/members/{member}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/members/{member}"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/members/{member}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards/{board}/members/{member}< / code > < / p >
< p > < em > Change the permission of a member of a board< / em > < / p >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > isAdmin:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isNoComments:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isCommentOnly:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isWorker:< / span > < span class = "hljs-literal" > true< / span >
< / code > < / pre >
< h3 id = "set_board_member_permission-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the board that we are changing< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > member< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the user to change permissions< / td >
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » isAdmin< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > admin capability< / td >
< / tr >
< tr >
< td > » isNoComments< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > NoComments capability< / td >
< / tr >
< tr >
< td > » isCommentOnly< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > CommentsOnly capability< / td >
< / tr >
< tr >
< td > » isWorker< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > Worker capability< / td >
2020-01-05 21:43:44 +02:00
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the ID of the board that we are changing< / p >
< p > < strong > member< / strong > : the ID of the user to change permissions< / p >
< h3 id = "set_board_member_permission-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > None< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_boards_from_user" > get_boards_from_user< / h2 >
< p > < a id = "opIdget_boards_from_user" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/users/{user}/boards \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/users/{user}/boards< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/users/{user}/boards'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'get'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/users/{user}/boards'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/users/{user}/boards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/users/{user}/boards'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/users/{user}/boards"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/users/{user}/boards"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/users/{user}/boards< / code > < / p >
< p > < em > Get all boards attached to a user< / em > < / p >
< h3 id = "get_boards_from_user-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< td > user< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the user to retrieve the data< / td >
2021-01-22 17:37:12 +02:00
< / tr >
2021-01-28 19:24:10 +02:00
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > user< / strong > : the ID of the user to retrieve the data< / 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_boards_from_user-responses" > Responses< / h3 >
< table >
< thead >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_boards_from_user-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< tr >
< td > » title< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h1 id = "wekan-rest-api-checklists" > Checklists< / h1 >
< h2 id = "get_all_checklists" > get_all_checklists< / h2 >
< p > < a id = "opIdget_all_checklists" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/cards/{card}/checklists \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists"< / span > );
2019-07-17 17:06:25 +03:00
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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/cards/{card}/checklists< / code > < / p >
< p > < em > Get the list of checklists attached to a card< / em > < / p >
< h3 id = "get_all_checklists-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > card< / strong > : the card ID< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 >
}
]
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_checklists-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "get_all_checklists-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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_checklist" > new_checklist< / h2 >
< p > < a id = "opIdnew_checklist" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/cards/{card}/checklists \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'post'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"title": "string",
"items": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards/{board}/cards/{card}/checklists< / code > < / p >
< p > < em > create a new checklist< / 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" > items:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "new_checklist-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » title< / td >
< td > body< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the title of the new checklist< / td >
< / tr >
< tr >
< td > » items< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the list of items on the new checklist< / td >
2019-10-07 00:39:52 +03:00
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > card< / strong > : the card ID< / p >
2020-06-17 21:59:54 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "new_checklist-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "new_checklist-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_checklist" > get_checklist< / h2 >
< p > < a id = "opIdget_checklist" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists/{checklist}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}"< / span > );
2019-07-17 17:06:25 +03:00
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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/cards/{card}/checklists/{checklist}< / code > < / p >
< p > < em > Get a checklist< / em > < / p >
< h3 id = "get_checklist-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2020-06-17 21:59:54 +03:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > checklist< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the checklist< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > card< / strong > : the card ID< / p >
< p > < strong > checklist< / strong > : the ID of the checklist< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "cardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "finishedAt"< / 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" > "items"< / span > : [
{
< 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" > "isFinished"< / span > : < span class = "hljs-literal" > true< / span >
}
]
}
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_checklist-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "get_checklist-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > » cardId< / td >
2020-06-17 21:59:54 +03:00
< 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 >
< tr >
2021-01-28 19:24:10 +02:00
< td > » finishedAt< / td >
2020-06-17 21:59:54 +03:00
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » createdAt< / td >
2020-06-17 21:59:54 +03:00
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » sort< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » items< / td >
< td > [object]< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > »» _id< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > »» title< / td >
2020-06-17 21:59:54 +03:00
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2021-01-28 19:24:10 +02:00
< tr >
< td > »» isFinished< / td >
< td > boolean< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_checklist" > delete_checklist< / h2 >
< p > < a id = "opIddelete_checklist" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > DELETE< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists/{checklist}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'delete'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}< / code > < / p >
< p > < em > Delete a checklist< / em > < / p >
< p > The checklist will be removed, not put in the recycle bin.< / p >
< h3 id = "delete_checklist-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2020-06-17 21:59:54 +03:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
< / tr >
< tr >
< td > checklist< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the checklist to remove< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > card< / strong > : the card ID< / p >
< p > < strong > checklist< / strong > : the ID of the checklist to remove< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
}
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_checklist-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_checklist-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h1 id = "wekan-rest-api-checklistitems" > ChecklistItems< / h1 >
< h2 id = "get_checklist_item" > get_checklist_item< / h2 >
< p > < a id = "opIdget_checklist_item" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-06-17 21:59:54 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'get'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}< / code > < / p >
< p > < em > Get a checklist item< / em > < / p >
< h3 id = "get_checklist_item-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > checklist< / td >
< td > path< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the checklist ID< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > item< / td >
< td > path< / td >
2021-01-22 17:37:12 +02:00
< td > string< / td >
2021-01-28 19:24:10 +02:00
< td > true< / td >
< td > the ID of the item< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > card< / strong > : the card ID< / p >
< p > < strong > checklist< / strong > : the checklist ID< / p >
< p > < strong > item< / strong > : the ID of the item< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "isFinished"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "checklistId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardId"< / 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 >
2020-06-17 21:59:54 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_checklist_item-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemachecklistitems" > ChecklistItems< / a > < / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "edit_checklist_item" > edit_checklist_item< / h2 >
< p > < a id = "opIdedit_checklist_item" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > PUT< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'put'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"isFinished": "string",
"title": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'PUT'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.put < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.put(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "PUT"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "PUT"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}< / code > < / p >
< p > < em > Edit a checklist item< / em > < / p >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > isFinished:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > title:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "edit_checklist_item-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2020-06-17 21:59:54 +03:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > checklist< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the checklist ID< / td >
< / tr >
< tr >
< td > item< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the item< / td >
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » isFinished< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > is the item checked?< / td >
< / tr >
< tr >
< td > » title< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new text of the item< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > card< / strong > : the card ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > checklist< / strong > : the checklist ID< / p >
< p > < strong > item< / strong > : the ID of the item< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2020-06-17 21:59:54 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "edit_checklist_item-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "edit_checklist_item-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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_checklist_item" > delete_checklist_item< / h2 >
< p > < a id = "opIddelete_checklist_item" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > DELETE< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-06-17 21:59:54 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'delete'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}< / code > < / p >
< p > < em > Delete a checklist item< / em > < / p >
< p > Note: this operation can't be reverted.< / p >
< h3 id = "delete_checklist_item-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the card ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > checklist< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the checklist ID< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > item< / td >
< td > path< / td >
2021-01-22 17:37:12 +02:00
< td > string< / td >
2021-01-28 19:24:10 +02:00
< td > true< / td >
< td > the ID of the item to be removed< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > card< / strong > : the card ID< / p >
< p > < strong > checklist< / strong > : the checklist ID< / p >
< p > < strong > item< / strong > : the ID of the item to be removed< / p >
2020-06-17 21:59:54 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_checklist_item-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_checklist_item-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h1 id = "wekan-rest-api-cardcomments" > CardComments< / h1 >
< h2 id = "get_all_comments" > get_all_comments< / h2 >
< p > < a id = "opIdget_all_comments" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/cards/{card}/comments \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/comments< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'get'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/cards/{card}/comments< / code > < / p >
< p > < em > Get all comments attached to a card< / em > < / p >
< h3 id = "get_all_comments-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the board ID of the card< / td >
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the card< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID of the card< / p >
< p > < strong > card< / strong > : the ID of the card< / p >
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > [
{
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "comment"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "authorId"< / span > : < span class = "hljs-string" > "string"< / span >
}
]
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_comments-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_comments-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< tr >
< td > » comment< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » authorId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_comment" > new_comment< / h2 >
< p > < a id = "opIdnew_comment" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/cards/{card}/comments \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/comments< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'post'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"authorId": "string",
"comment": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards/{board}/cards/{card}/comments< / code > < / p >
< p > < em > Add a comment on a 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" > comment:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "new_comment-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the 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 user who 'posted' the comment< / td >
< / tr >
< tr >
< td > » comment< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the comment value< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID of the card< / p >
< p > < strong > card< / strong > : the ID of the card< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
}
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_comment-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "new_comment-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_comment" > get_comment< / h2 >
< p > < a id = "opIdget_comment" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/cards/{card}/comments/{comment} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/comments/{comment}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments/{comment}"< / span > );
2019-07-17 17:06:25 +03:00
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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments/{comment}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/cards/{card}/comments/{comment}< / code > < / p >
< p > < em > Get a comment on a card< / em > < / p >
< h3 id = "get_comment-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID of the card< / td >
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the card< / td >
< / tr >
< tr >
< td > comment< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the comment to retrieve< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID of the card< / p >
< p > < strong > card< / strong > : the ID of the card< / p >
< p > < strong > comment< / strong > : the ID of the comment to retrieve< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "boardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "text"< / 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 >
}
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_comment-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemacardcomments" > CardComments< / a > < / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_comment" > delete_comment< / h2 >
< p > < a id = "opIddelete_comment" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/cards/{card}/comments/{comment} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > DELETE< / span > < span class = "hljs-string" > /api/boards/{board}/cards/{card}/comments/{comment}< / span > HTTP/1.1
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-06-17 21:59:54 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'delete'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/cards/{card}/comments/{comment}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments/{comment}"< / span > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cards/{card}/comments/{comment}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/cards/{card}/comments/{comment}< / code > < / p >
< p > < em > Delete a comment on a card< / em > < / p >
< h3 id = "delete_comment-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID of the card< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > card< / td >
< td > path< / td >
2021-01-22 17:37:12 +02:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the card< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > comment< / td >
< td > path< / td >
2021-01-22 17:37:12 +02:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the comment to delete< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID of the card< / p >
< p > < strong > card< / strong > : the ID of the card< / p >
< p > < strong > comment< / strong > : the ID of the comment to delete< / p >
2020-06-17 21:59:54 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_comment-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_comment-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h1 id = "wekan-rest-api-cards" > Cards< / h1 >
< h2 id = "get_cards_by_custom_field" > get_cards_by_custom_field< / h2 >
< p > < a id = "opIdget_cards_by_custom_field" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'< / span > ,
2019-07-17 17:06:25 +03:00
{
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}< / code > < / p >
< p > < em > Get all Cards that matchs a value of a specific custom field< / em > < / p >
< h3 id = "get_cards_by_custom_field-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< tr >
< td > customField< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the list ID< / td >
< / tr >
< tr >
< td > customFieldValue< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the value to look for< / td >
2020-05-30 08:41:48 +03:00
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > customField< / strong > : the list ID< / p >
< p > < strong > customFieldValue< / strong > : the value to look for< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 > ,
< span class = "hljs-attr" > "listId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "swinlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
}
]
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_cards_by_custom_field-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > Inline< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "get_cards_by_custom_field-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 >
< tr >
< td > » description< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » listId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » swinlaneId< / 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_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 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" > GET< / span > < span class = "hljs-string" > /api/boards/{board}/lists/{list}/cards< / span > HTTP/1.1
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}/cards"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > list< / td >
2020-05-30 08:41:48 +03:00
< td > path< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the list ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-05-30 08:41:48 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > list< / strong > : the list ID< / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 >
}
]
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_cards-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_cards-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_card" > new_card< / h2 >
< p > < a id = "opIdnew_card" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
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 > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2020-05-30 08:41:48 +03:00
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"authorId": "string",
"members": "string",
"assignees": "string",
"title": "string",
"description": "string",
"swimlaneId": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< 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 > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}/cards"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID of the new card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > list< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the list ID of the new card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2021-01-28 19:24:10 +02:00
< 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 >
< 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 >
< 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 = "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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "get_card" > get_card< / h2 >
< p > < a id = "opIdget_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}/lists/{list}/cards/{card} \
-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
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2020-05-30 08:41:48 +03:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'get'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2020-05-30 08:41:48 +03:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2020-05-30 08:41:48 +03:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}/cards/{card}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/lists/{list}/cards/{card}< / code > < / p >
< p > < em > Get a Card< / em > < / p >
< h3 id = "get_card-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2020-06-17 21:59:54 +03:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2021-01-28 19:24:10 +02:00
< tr >
< td > list< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the list ID of the card< / td >
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the card ID< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > list< / strong > : the list ID of the card< / p >
< p > < strong > card< / strong > : the card ID< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "archived"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "parentId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "swimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "coverId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "white"< / 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" > "customFields"< / span > : [
{}
],
< span class = "hljs-attr" > "dateLastActivity"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "description"< / 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" > "labelIds"< / 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" > "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-number" > 0< / span > ,
< span class = "hljs-attr" > "isOvertime"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "subtaskSort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "type"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "linkedId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "vote"< / span > : {
< span class = "hljs-attr" > "question"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "positive"< / span > : [
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "string"< / span >
],
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "negative"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "end"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "public"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowNonBoardMembers"< / span > : < span class = "hljs-literal" > true< / span >
2020-06-17 21:59:54 +03:00
}
2021-01-28 19:24:10 +02:00
}
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_card-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemacards" > Cards< / a > < / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "edit_card" > edit_card< / h2 >
< p > < a id = "opIdedit_card" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \
2020-05-30 08:41:48 +03:00
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2020-05-30 08:41:48 +03:00
< span class = "fortran" > Content-< span class = "hljs-keyword" > Type< / span > : multipart/< span class = "hljs-keyword" > form< / span > -< span class = "hljs-keyword" > data< / span >
2020-06-17 21:59:54 +03:00
Accept: application/json
2019-07-17 17:06:25 +03:00
2020-05-30 08:41:48 +03:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2020-05-30 08:41:48 +03:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
2021-01-28 19:24:10 +02:00
"title": "string",
"parentId": "string",
"description": "string",
"color": "string",
"vote": {},
"labelIds": "string",
"requestedBy": "string",
"assignedBy": "string",
"receivedAt": "string",
"startAt": "string",
"dueAt": "string",
"endAt": "string",
"spentTime": "string",
"isOverTime": true,
"customFields": "string",
"members": "string",
"assignees": "string",
"swimlaneId": "string",
"listId": "string",
"authorId": "string"
2020-05-30 08:41:48 +03:00
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'PUT'< / span > ,
2020-05-30 08:41:48 +03:00
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.put < span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.put(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "PUT"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "PUT"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}/cards/{card}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > PUT /api/boards/{board}/lists/{list}/cards/{card}< / code > < / p >
< p > < em > Edit Fields in a Card< / em > < / p >
< p > Edit a card< / p >
< p > The color has to be chosen between < code > white< / code > , < code > green< / code > , < code > yellow< / code > , < code > orange< / code > ,
< code > red< / code > , < code > purple< / code > , < code > blue< / code > , < code > sky< / code > , < code > lime< / code > , < code > pink< / code > , < code > black< / code > , < code > silver< / code > ,
< code > peachpuff< / code > , < code > crimson< / code > , < code > plum< / code > , < code > darkgreen< / code > , < code > slateblue< / code > , < code > magenta< / code > ,
< code > gold< / code > , < code > navy< / code > , < code > gray< / code > , < code > saddlebrown< / code > , < code > paleturquoise< / code > , < code > mistyrose< / code > ,
< code > indigo< / code > :< / p >
< img src = "/card-colors.png" alt = "Wekan card colors" / >
< p > Note: setting the color to white has the same effect than removing it.< / p >
2020-05-30 08:41:48 +03:00
< blockquote >
< p > Body parameter< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > title:< / 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" > vote:< / span > < span class = "hljs-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-literal" > true< / 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 >
< span class = "hljs-attr" > listId:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > authorId:< / span > < span class = "hljs-string" > string< / span >
2020-05-30 08:41:48 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "edit_card-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID of the card< / td >
< / tr >
< tr >
< td > list< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the list ID of the card< / td >
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-05-30 08:41:48 +03:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
2019-07-17 17:06:25 +03:00
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » title< / td >
2020-05-30 08:41:48 +03:00
< td > body< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
2021-01-28 19:24:10 +02:00
< td > false< / td >
< td > the new title of the card< / td >
2020-07-21 22:06:09 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< tr >
2021-01-28 19:24:10 +02:00
< td > » parentId< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > change the parent of the card< / td >
2020-05-30 08:41:48 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » description< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new description of the card< / td >
2020-06-17 21:59:54 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » color< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new color of the card< / td >
2020-06-17 21:59:54 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » vote< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > the vote object< / td >
< / tr >
< tr >
< td > » labelIds< / td >
< td > body< / td >
2020-06-17 21:59:54 +03:00
< td > string< / td >
< td > false< / td >
2021-01-28 19:24:10 +02:00
< td > the new list of label IDs attached to the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2021-01-28 19:24:10 +02:00
< tr >
< td > » requestedBy< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new requestedBy field of the card< / td >
< / tr >
< tr >
< td > » assignedBy< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new assignedBy field of the card< / td >
< / tr >
< tr >
< td > » receivedAt< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new receivedAt field of the card< / td >
< / tr >
< tr >
< td > » startAt< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new startAt field of the card< / td >
< / tr >
< tr >
< td > » dueAt< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new dueAt field of the card< / td >
< / tr >
< tr >
< td > » endAt< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new endAt field of the card< / td >
< / tr >
< tr >
< td > » spentTime< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new spentTime field of the card< / td >
< / tr >
< tr >
< td > » isOverTime< / td >
< td > body< / td >
< td > boolean< / td >
< td > false< / td >
< td > the new isOverTime field of the card< / td >
< / tr >
< tr >
< td > » customFields< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new customFields value of the card< / td >
< / tr >
< tr >
< td > » members< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new list of member IDs attached to the 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 attached to the card< / td >
< / tr >
< tr >
< td > » swimlaneId< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new swimlane ID of the card< / td >
< / tr >
< tr >
< td > » listId< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > the new list ID of the card (move operation)< / td >
< / tr >
< tr >
< td > » authorId< / td >
< td > body< / td >
< td > string< / td >
< td > false< / td >
< td > change the owner of the card< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID of the card< / p >
< p > < strong > list< / strong > : the list ID of the card< / p >
< p > < strong > card< / strong > : the ID of the 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 = "edit_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 > Inline< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "edit_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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "delete_card" > delete_card< / h2 >
< p > < a id = "opIddelete_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}/lists/{list}/cards/{card} \
-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
< 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" > 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));
2019-07-17 17:06:25 +03:00
}
})
< / 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 > );
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}/cards/{card}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}/cards/{card}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/lists/{list}/cards/{card}< / code > < / p >
< p > < em > Delete a card from a board< / em > < / p >
< p > This operation < strong > deletes< / strong > a card, and therefore the card
is not put in the recycle bin.< / p >
< h3 id = "delete_card-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > list< / td >
2020-05-30 08:41:48 +03:00
< td > path< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the list ID of the card< / td >
< / tr >
< tr >
< td > card< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID of the card< / p >
< p > < strong > list< / strong > : the list ID of the card< / p >
< p > < strong > card< / strong > : the ID of the card< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2020-06-17 21:59:54 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_card-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > Inline< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "get_swimlane_cards" > get_swimlane_cards< / h2 >
< p > < a id = "opIdget_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}/swimlanes/{swimlane}/cards \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-06-17 21:59:54 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/swimlanes/{swimlane}/cards'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/swimlanes/{swimlane}/cards'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/swimlanes/{swimlane}/cards'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/swimlanes/{swimlane}/cards"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/swimlanes/{swimlane}/cards< / code > < / p >
< p > < em > get all cards attached to a swimlane< / em > < / p >
< h3 id = "get_swimlane_cards-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2020-06-17 21:59:54 +03:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > swimlane< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the swimlane ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > swimlane< / strong > : the swimlane ID< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 > ,
< span class = "hljs-attr" > "listId"< / span > : < span class = "hljs-string" > "string"< / span >
}
]
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_swimlane_cards-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "get_swimlane_cards-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< 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 >
< tr >
< td > » listId< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/custom-fields \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2020-05-30 08:41:48 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2019-07-17 17:06:25 +03:00
2020-05-30 08:41:48 +03:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/custom-fields'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/custom-fields'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/custom-fields'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/custom-fields"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board value< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 >
}
]
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_custom_fields-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_custom_fields-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_custom_field" > new_custom_field< / h2 >
< p > < a id = "opIdnew_custom_field" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/custom-fields \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< 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 > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/custom-fields'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/custom-fields'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/custom-fields'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/custom-fields"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board value< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » name< / td >
< td > body< / td >
2020-05-30 08:41:48 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< 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 >
2020-05-30 08:41:48 +03:00
< / tr >
< / tbody >
< / table >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_custom_field-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "new_custom_field-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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_custom_field" > get_custom_field< / h2 >
< p > < a id = "opIdget_custom_field" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/custom-fields/{customField} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-06-17 21:59:54 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/custom-fields/{customField}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/custom-fields/{customField}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/custom-fields/{customField}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/custom-fields/{customField}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/boards/{board}/custom-fields/{customField}< / code > < / p >
< p > < em > Get a Custom Fields attached to a board< / em > < / p >
< h3 id = "get_custom_field-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board value< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > customField< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the ID of the custom field< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > customField< / strong > : the ID of the custom field< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "boardIds"< / span > : [
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "string"< / span >
],
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "name"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "type"< / span > : < span class = "hljs-string" > "text"< / span > ,
< span class = "hljs-attr" > "settings"< / span > : {
< span class = "hljs-attr" > "currencyCode"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "dropdownItems"< / 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" > "alwaysOnCard"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "showLabelOnMiniCard"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span >
2020-06-17 21:59:54 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_custom_field-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemacustomfields" > CustomFields< / a > < / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_custom_field" > delete_custom_field< / h2 >
< p > < a id = "opIddelete_custom_field" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/custom-fields/{customField} \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/custom-fields/{customField}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/custom-fields/{customField}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/custom-fields/{customField}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/custom-fields/{customField}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/custom-fields/{customField}< / code > < / p >
< p > < em > Delete a Custom Fields attached to a board< / em > < / p >
< p > The Custom Field can't be retrieved after this operation< / p >
< h3 id = "delete_custom_field-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board value< / td >
< / tr >
< tr >
< td > customField< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the custom field< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > customField< / strong > : the ID of the custom field< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
}
2020-06-17 21:59:54 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_custom_field-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_custom_field-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
2021-01-22 17:37:12 +02:00
< / tbody >
< / table >
2019-07-17 17:06:25 +03:00
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/integrations \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/integrations'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/integrations'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > 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 >
2021-01-28 19:24:10 +02:00
< 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 >
}
]
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_integrations-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_integrations-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< td > string< / td >
2021-01-28 19:24:10 +02:00
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > » token< / td >
< td > string|null< / td >
2019-07-17 17:06:25 +03:00
< td > false< / td >
< td > none< / td >
2021-01-28 19:24:10 +02:00
< 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 >
2020-05-30 08:41:48 +03:00
< td > none< / td >
2021-01-28 19:24:10 +02:00
< td > user ID who created the interation< / td >
2020-05-30 08:41:48 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
2019-07-17 17:06:25 +03:00
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_integration" > new_integration< / h2 >
< p > < a id = "opIdnew_integration" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/integrations \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"url": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/integrations'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/integrations'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the board ID< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » url< / td >
< td > body< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the URL of the integration< / td >
2019-07-17 17:06:25 +03:00
< / 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2021-01-22 17:37:12 +02:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_integration-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
2021-01-22 17:37:12 +02:00
< th > Status< / th >
< th > Meaning< / th >
2019-07-17 17:06:25 +03:00
< th > Description< / th >
2021-01-22 17:37:12 +02:00
< th > Schema< / th >
2019-07-17 17:06:25 +03:00
< / tr >
< / thead >
< tbody >
< tr >
2021-01-22 17:37:12 +02:00
< td > 200< / td >
< td > < a href = "https://tools.ietf.org/html/rfc7231#section-6.3.1" > OK< / a > < / td >
< td > 200 response< / td >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_integration" > get_integration< / h2 >
< p > < a id = "opIdget_integration" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/integrations/{int} \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations/{int}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the board ID< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > int< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the integration ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > int< / strong > : the integration ID< / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_integration-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemaintegrations" > Integrations< / a > < / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "edit_integration" > edit_integration< / h2 >
< p > < a id = "opIdedit_integration" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X PUT /api/boards/{board}/integrations/{int} \
2020-05-30 08:41:48 +03:00
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2020-05-30 08:41:48 +03:00
< 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
2019-07-17 17:06:25 +03:00
2020-05-30 08:41:48 +03:00
< / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2020-05-30 08:41:48 +03:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
2021-01-28 19:24:10 +02:00
"enabled": "string",
"title": "string",
"url": "string",
"token": "string",
"activities": "string"
2020-05-30 08:41:48 +03:00
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'PUT'< / span > ,
2020-05-30 08:41:48 +03:00
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.put < span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.put(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "PUT"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "PUT"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations/{int}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > PUT /api/boards/{board}/integrations/{int}< / code > < / p >
< p > < em > Edit integration data< / em > < / p >
2020-05-30 08:41:48 +03:00
< blockquote >
< p > Body parameter< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 >
2020-05-30 08:41:48 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "edit_integration-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the board ID< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > int< / td >
2019-07-17 17:06:25 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the integration ID< / td >
2020-05-30 08:41:48 +03:00
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » enabled< / td >
2020-05-30 08:41:48 +03:00
< td > body< / td >
< td > string< / td >
2021-01-28 19:24:10 +02:00
< td > false< / td >
< td > is the integration enabled?< / td >
2020-05-30 08:41:48 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » title< / td >
2020-05-30 08:41:48 +03:00
< td > body< / td >
2021-01-28 19:24:10 +02:00
< td > string< / td >
< td > false< / td >
< td > new name of the integration< / td >
2020-05-30 08:41:48 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » url< / td >
2020-05-30 08:41:48 +03:00
< td > body< / td >
2021-01-28 19:24:10 +02:00
< td > string< / td >
< td > false< / td >
< td > new URL of the integration< / td >
2020-05-30 08:41:48 +03:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » token< / td >
2020-05-30 08:41:48 +03:00
< td > body< / td >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > int< / strong > : the integration ID< / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "edit_integration-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "edit_integration-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_integration" > delete_integration< / h2 >
< p > < a id = "opIddelete_integration" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/integrations/{int} \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations/{int}"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/integrations/{int}< / code > < / p >
< p > < em > Delete integration< / em > < / p >
< h3 id = "delete_integration-parameters" > Parameters< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2020-04-28 03:24:18 +03:00
< td > the board ID< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > int< / td >
2020-04-28 03:24:18 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the integration ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2020-04-28 03:24:18 +03:00
< p > < strong > board< / strong > : the board ID< / p >
2021-01-28 19:24:10 +02:00
< p > < strong > int< / strong > : the integration ID< / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2020-05-30 08:41:48 +03:00
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2020-05-30 08:41:48 +03:00
}
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_integration-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_integration-responseschema" > Response Schema< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_integration_activities" > delete_integration_activities< / h2 >
< p > < a id = "opIddelete_integration_activities" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/integrations/{int}/activities \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2020-06-17 21:59:54 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}/activities'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2020-05-30 08:41:48 +03:00
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/integrations/{int}/activities'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}/activities'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations/{int}/activities"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > DELETE /api/boards/{board}/integrations/{int}/activities< / code > < / p >
< p > < em > Delete subscribed activities< / em > < / p >
< h3 id = "delete_integration_activities-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< 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 > 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 >
< / 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 >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< 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 >
2020-06-17 21:59:54 +03:00
],
2021-01-28 19:24:10 +02:00
< 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 > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span >
2020-06-17 21:59:54 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_integration_activities-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemaintegrations" > Integrations< / a > < / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_integration_activities" > new_integration_activities< / h2 >
< p > < a id = "opIdnew_integration_activities" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/integrations/{int}/activities \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2020-04-12 00:01:07 +03:00
2021-01-28 19:24:10 +02:00
< 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
2020-05-30 08:41:48 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2020-04-12 00:01:07 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-12 00:01:07 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
2019-07-17 17:06:25 +03:00
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"activities": "string"
}'< / span > ;
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}/activities'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/integrations/{int}/activities'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/integrations/{int}/activities'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/integrations/{int}/activities"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards/{board}/integrations/{int}/activities< / code > < / p >
< p > < em > Add subscribed activities< / em > < / p >
2021-01-22 17:37:12 +02:00
< blockquote >
2021-01-28 19:24:10 +02:00
< p > Body parameter< / p >
2021-01-22 17:37:12 +02:00
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > activities:< / span > < span class = "hljs-string" > string< / span >
2020-05-30 08:41:48 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_integration_activities-parameters" > Parameters< / h3 >
2020-04-25 16:44:45 +03:00
< table >
< thead >
< tr >
2021-01-28 19:24:10 +02:00
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
2020-04-25 16:44:45 +03:00
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< td > board< / td >
< 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 > » activities< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the activities value< / td >
2020-04-25 16:44:45 +03:00
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< 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 = "new_integration_activities-responses" > Responses< / h3 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
2021-01-28 19:24:10 +02:00
< th > Status< / th >
< th > Meaning< / th >
2019-07-17 17:06:25 +03:00
< th > Description< / th >
2021-01-28 19:24:10 +02:00
< th > Schema< / th >
2019-07-17 17:06:25 +03:00
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/lists \
2020-05-30 08:41:48 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2019-07-17 17:06:25 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2019-07-17 17:06:25 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-04-28 03:24:18 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2019-07-17 17:06:25 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists'< / span > ,
2019-07-17 17:06:25 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/lists'< / span > ,
2019-07-17 17:06:25 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/lists'< / span > , params={
2019-07-17 17:06:25 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2019-07-17 17:06:25 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2019-07-17 17:06:25 +03:00
< 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 > {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2019-07-17 17:06:25 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists"< / span > , data)
2019-07-17 17:06:25 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2019-07-17 17:06:25 +03:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< td > board< / td >
< td > path< / td >
2021-01-22 17:37:12 +02:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2020-04-28 03:24:18 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the board ID< / p >
2020-05-30 08:41:48 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 >
}
]
2020-05-30 08:41:48 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_lists-responses" > Responses< / h3 >
2020-05-30 08:41:48 +03:00
< table >
< thead >
2020-04-28 03:24:18 +03:00
< tr >
2020-05-30 08:41:48 +03:00
< th > Status< / th >
< th > Meaning< / th >
< th > Description< / th >
< th > Schema< / th >
2020-04-28 03:24:18 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< / thead >
< tbody >
2020-04-28 03:24:18 +03:00
< tr >
2020-05-30 08:41:48 +03:00
< 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 >
2020-04-28 03:24:18 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_lists-responseschema" > Response Schema< / h3 >
2020-05-30 08:41:48 +03:00
< p > Status Code < strong > 200< / strong > < / p >
< table >
< thead >
2020-04-28 03:24:18 +03:00
< tr >
2020-05-30 08:41:48 +03:00
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
2020-04-28 03:24:18 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< / thead >
< tbody >
2020-04-28 03:24:18 +03:00
< tr >
2020-05-30 08:41:48 +03:00
< td > » _id< / td >
2020-04-28 03:24:18 +03:00
< td > string< / td >
2020-05-30 08:41:48 +03:00
< td > false< / td >
< td > none< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< / tr >
2021-01-28 19:24:10 +02:00
< tr >
< td > » title< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2020-05-30 08:41:48 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_list" > new_list< / h2 >
< p > < a id = "opIdnew_list" > < / a > < / p >
2020-05-30 08:41:48 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/lists \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-05-30 08:41:48 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2020-05-30 08:41:48 +03:00
2021-01-28 19:24:10 +02:00
< 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
2020-05-30 08:41:48 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2020-05-30 08:41:48 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-05-30 08:41:48 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< 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 > ,
2020-05-30 08:41:48 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"title": "string"
}'< / span > ;
2020-05-30 08:41:48 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-05-30 08:41:48 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists'< / span > ,
2020-05-30 08:41:48 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2020-05-30 08:41:48 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-05-30 08:41:48 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/lists'< / span > ,
2020-05-30 08:41:48 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-05-30 08:41:48 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/lists'< / span > , params={
2020-05-30 08:41:48 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2020-05-30 08:41:48 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2020-05-30 08:41:48 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-05-30 08:41:48 +03:00
< 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})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists"< / span > , data)
2020-05-30 08:41:48 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
< / code > < / pre >
< h3 id = "new_list-parameters" > Parameters< / h3 >
2020-05-30 08:41:48 +03:00
< table >
< thead >
2020-04-28 03:24:18 +03:00
< tr >
2020-05-30 08:41:48 +03:00
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
2020-04-28 03:24:18 +03:00
< / tr >
2020-05-30 08:41:48 +03:00
< / thead >
< tbody >
2020-04-28 03:24:18 +03:00
< tr >
2021-01-28 19:24:10 +02:00
< td > board< / td >
2020-05-30 08:41:48 +03:00
< td > path< / td >
2020-04-28 03:24:18 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » title< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the title of the List< / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
2020-05-30 08:41:48 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
2020-05-30 08:41:48 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span >
2020-05-30 08:41:48 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "new_list-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< 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 >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_list" > get_list< / h2 >
< p > < a id = "opIdget_list" > < / a > < / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/boards/{board}/lists/{list} \
2020-05-30 08:41:48 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2020-04-28 03:24:18 +03:00
2021-01-28 19:24:10 +02:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
2020-05-30 08:41:48 +03:00
2021-01-28 19:24:10 +02:00
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2020-04-28 03:24:18 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< 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 > ,
2020-04-28 03:24:18 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
2020-04-28 03:24:18 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > ,
2020-04-28 03:24:18 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > , params={
2020-04-28 03:24:18 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2020-04-28 03:24:18 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2020-04-28 03:24:18 +03:00
< 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 > {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
}
2020-04-28 03:24:18 +03:00
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}"< / span > , data)
2020-04-28 03:24:18 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2020-04-28 03:24:18 +03:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< td > board< / td >
2020-04-28 03:24:18 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
2021-01-22 17:37:12 +02:00
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > list< / td >
< td > path< / td >
2020-04-28 03:24:18 +03:00
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the List ID< / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
2020-05-30 08:41:48 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > list< / strong > : the List ID< / p >
2020-05-30 08:41:48 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< 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 >
2020-05-30 08:41:48 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_list-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemalists" > Lists< / a > < / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "delete_list" > delete_list< / h2 >
< p > < a id = "opIddelete_list" > < / a > < / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X DELETE /api/boards/{board}/lists/{list} \
2020-05-30 08:41:48 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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
2020-04-28 03:24:18 +03:00
2020-05-30 08:41:48 +03:00
< span class = "http" > < span class = "hljs-attribute" > Accept< / span > : application/json
< span class = "undefined" > < / span > < / span > < / code > < / pre >
2020-04-28 03:24:18 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > ,
2020-05-30 08:41:48 +03:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'delete'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > ,
2020-04-28 03:24:18 +03:00
{
2020-05-30 08:41:48 +03:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'DELETE'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.delete < span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 = {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.delete(< span class = "hljs-string" > '/api/boards/{board}/lists/{list}'< / span > , params={
2020-04-28 03:24:18 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 > );
2020-04-28 03:24:18 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2020-05-30 08:41:48 +03:00
con.setRequestMethod(< span class = "hljs-string" > "DELETE"< / span > );
2020-04-28 03:24:18 +03:00
< 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 > {
2020-05-30 08:41:48 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "DELETE"< / span > , < span class = "hljs-string" > "/api/boards/{board}/lists/{list}"< / span > , data)
2020-04-28 03:24:18 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< 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 >
2020-04-28 03:24:18 +03:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-28 19:24:10 +02:00
< td > board< / td >
2020-04-28 03:24:18 +03:00
< td > path< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
< / tr >
< tr >
< td > list< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the list to remove< / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
2020-05-30 08:41:48 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > list< / strong > : the ID of the list to remove< / p >
2020-05-30 08:41:48 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_list-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2020-05-30 08:41:48 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "delete_list-responseschema" > Response Schema< / h3 >
2020-05-30 08:41:48 +03:00
< 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 >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h1 id = "wekan-rest-api-users" > Users< / h1 >
< h2 id = "add_board_member" > add_board_member< / h2 >
< p > < a id = "opIdadd_board_member" > < / a > < / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/members/{user}/add \
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /api/boards/{board}/members/{user}/add< / span > HTTP/1.1
2020-04-28 03:24:18 +03:00
2021-01-28 19:24:10 +02:00
< 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
2020-04-28 03:24:18 +03:00
2021-01-28 19:24:10 +02:00
< / span > < / code > < / pre >
2020-04-28 03:24:18 +03:00
< pre class = "highlight tab tab-javascript" > < code > < span class = "hljs-keyword" > var< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-04-28 03:24:18 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/members/{user}/add'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'post'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 > );
2021-01-28 19:24:10 +02:00
< span class = "hljs-keyword" > const< / span > inputBody = < span class = "hljs-string" > '{
"action": "string",
"isAdmin": true,
"isNoComments": true,
"isCommentOnly": true
}'< / span > ;
2020-04-28 03:24:18 +03:00
< span class = "hljs-keyword" > const< / span > headers = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/members/{user}/add'< / span > ,
2020-04-28 03:24:18 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'POST'< / span > ,
< span class = "hljs-attr" > body< / span > : inputBody,
2020-04-28 03:24:18 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/members/{user}/add'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 = {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/members/{user}/add'< / span > , params={
2020-04-28 03:24:18 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/members/{user}/add"< / span > );
2020-04-28 03:24:18 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "POST"< / span > );
2020-04-28 03:24:18 +03:00
< 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 > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-string" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-04-28 03:24:18 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/members/{user}/add"< / span > , data)
2020-04-28 03:24:18 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards/{board}/members/{user}/add< / code > < / p >
< p > < em > Add New Board Member with Role< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
< p > < strong > Note< / strong > : see < a href = "#set_board_member_permission" > Boards.set_board_member_permission< / a >
to later change the permissions.< / p >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > action:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > isAdmin:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isNoComments:< / span > < span class = "hljs-literal" > true< / span >
< span class = "hljs-attr" > isCommentOnly:< / span > < span class = "hljs-literal" > true< / span >
< / code > < / pre >
< h3 id = "add_board_member-parameters" > Parameters< / h3 >
2020-04-28 03:24:18 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
< / tr >
< tr >
< td > user< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the user ID< / td >
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » action< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the action value< / td >
< / tr >
< tr >
< td > » isAdmin< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > is the user an admin of the board< / td >
< / tr >
< tr >
< td > » isNoComments< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > disable comments< / td >
< / tr >
< tr >
< td > » isCommentOnly< / td >
< td > body< / td >
< td > boolean< / td >
< td > true< / td >
< td > only enable comments< / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > user< / strong > : the user ID< / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< 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 >
}
2020-04-28 03:24:18 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "add_board_member-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "add_board_member-responseschema" > Response Schema< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "remove_board_member" > remove_board_member< / h2 >
< p > < a id = "opIdremove_board_member" > < / a > < / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X POST /api/boards/{board}/members/{user}/remove \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Content-Type: multipart/form-data'< / span > \
2020-06-17 21:59:54 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > POST< / span > < span class = "hljs-string" > /api/boards/{board}/members/{user}/remove< / span > HTTP/1.1
2020-04-28 03:24:18 +03:00
< span class = "fortran" > Content-< span class = "hljs-keyword" > Type< / span > : multipart/< span class = "hljs-keyword" > form< / span > -< span class = "hljs-keyword" > data< / span >
2020-06-17 21:59:54 +03:00
Accept: application/json
2020-04-28 03:24:18 +03:00
< / 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 > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
$.ajax({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/boards/{board}/members/{user}/remove'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 > {
< 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 > inputBody = < span class = "hljs-string" > '{
2021-01-28 19:24:10 +02:00
"action": "string"
2020-04-28 03:24:18 +03:00
}'< / span > ;
< span class = "hljs-keyword" > const< / span > headers = {
< span class = "hljs-string" > 'Content-Type'< / span > :< span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > :< span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > :< span class = "hljs-string" > 'API_KEY'< / span >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/boards/{board}/members/{user}/remove'< / span > ,
2020-04-28 03:24:18 +03:00
{
< 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 > {
< 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" > 'Content-Type'< / span > => < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > => < span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > => < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
result = RestClient.post < span class = "hljs-string" > '/api/boards/{board}/members/{user}/remove'< / span > ,
2020-04-28 03:24:18 +03:00
< 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" > 'Content-Type'< / span > : < span class = "hljs-string" > 'multipart/form-data'< / span > ,
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > 'Accept'< / span > : < span class = "hljs-string" > 'application/json'< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > 'Authorization'< / span > : < span class = "hljs-string" > 'API_KEY'< / span >
}
2021-01-28 19:24:10 +02:00
r = requests.post(< span class = "hljs-string" > '/api/boards/{board}/members/{user}/remove'< / span > , params={
2020-04-28 03:24:18 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/boards/{board}/members/{user}/remove"< / span > );
2020-04-28 03:24:18 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "Content-Type"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "multipart/form-data"< / span > },
2020-06-17 21:59:54 +03:00
< span class = "hljs-string" > "Accept"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "application/json"< / span > },
2020-04-28 03:24:18 +03:00
< span class = "hljs-string" > "Authorization"< / span > : []< span class = "hljs-keyword" > string< / span > {< span class = "hljs-string" > "API_KEY"< / span > },
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "POST"< / span > , < span class = "hljs-string" > "/api/boards/{board}/members/{user}/remove"< / span > , data)
2020-04-28 03:24:18 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > POST /api/boards/{board}/members/{user}/remove< / code > < / p >
< p > < em > Remove Member from Board< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Body parameter< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > action:< / span > < span class = "hljs-string" > string< / span >
2020-04-28 03:24:18 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "remove_board_member-parameters" > Parameters< / h3 >
2020-04-28 03:24:18 +03:00
< table >
< thead >
< tr >
< 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 > true< / td >
2021-01-28 19:24:10 +02:00
< td > the board ID< / td >
< / tr >
< tr >
< td > user< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the user ID< / td >
2020-04-28 03:24:18 +03:00
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
2021-01-28 19:24:10 +02:00
< td > » action< / td >
2020-04-28 03:24:18 +03:00
< td > body< / td >
< td > string< / td >
< td > true< / td >
2021-01-28 19:24:10 +02:00
< td > the action (needs to be < code > remove< / code > )< / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
2020-06-17 21:59:54 +03:00
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
2021-01-28 19:24:10 +02:00
< p > < strong > board< / strong > : the board ID< / p >
< p > < strong > user< / strong > : the user ID< / p >
2020-06-17 21:59:54 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span >
2020-06-17 21:59:54 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "remove_board_member-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2020-06-17 21:59:54 +03:00
< td > Inline< / td >
< / tr >
< / tbody >
< / table >
2021-01-28 19:24:10 +02:00
< h3 id = "remove_board_member-responseschema" > Response Schema< / h3 >
2020-06-17 21:59:54 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< tr >
< td > » title< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2020-04-28 03:24:18 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_current_user" > get_current_user< / h2 >
< p > < a id = "opIdget_current_user" > < / a > < / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/user \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/user< / span > HTTP/1.1
2020-04-28 03:24:18 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/user'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/user'< / span > ,
2020-04-28 03:24:18 +03:00
{
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/user'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/user'< / span > , params={
2020-04-28 03:24:18 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/user"< / span > );
2020-04-28 03:24:18 +03:00
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 > },
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/user"< / span > , data)
2020-04-28 03:24:18 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/user< / code > < / p >
< p > < em > returns the current user< / em > < / p >
2021-01-22 17:37:12 +02:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
< pre class = "highlight tab tab-json" > < code > {
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "username"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emails"< / span > : [
{
< span class = "hljs-attr" > "address"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "verified"< / span > : < span class = "hljs-literal" > true< / span >
}
],
2021-01-22 17:37:12 +02:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > "profile"< / span > : {
< span class = "hljs-attr" > "avatarUrl"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emailBuffer"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "fullname"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showDesktopDragHandles"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hideCheckedItems"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hiddenSystemMessages"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hiddenMinicardLabelText"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "initials"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "invitedBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "language"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "notifications"< / span > : [],
< span class = "hljs-attr" > "activity"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "read"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showCardsCountAt"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "startDayOfWeek"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "starredBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "icode"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardView"< / span > : < span class = "hljs-string" > "board-view-swimlanes"< / span > ,
< span class = "hljs-attr" > "listSortBy"< / span > : < span class = "hljs-string" > "-modifiedat"< / span > ,
< span class = "hljs-attr" > "templatesBoardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
},
< span class = "hljs-attr" > "services"< / span > : {},
< span class = "hljs-attr" > "heartbeat"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "isAdmin"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "createdThroughApi"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "loginDisabled"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "authenticationMethod"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sessionData"< / span > : {
< span class = "hljs-attr" > "totalHits"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "lastHit"< / span > : < span class = "hljs-number" > 0< / span >
}
2020-04-28 03:24:18 +03:00
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_current_user-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< td > < a href = "#schemausers" > Users< / a > < / td >
2020-04-28 03:24:18 +03:00
< / tr >
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "get_all_users" > get_all_users< / h2 >
< p > < a id = "opIdget_all_users" > < / a > < / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Code samples< / p >
< / blockquote >
< pre class = "highlight tab tab-shell" > < code > < span class = "hljs-comment" > # You can also use wget< / span >
2021-01-28 19:24:10 +02:00
curl -X GET /api/users \
2020-04-28 03:24:18 +03:00
-H < span class = "hljs-string" > 'Accept: application/json'< / span > \
-H < span class = "hljs-string" > 'Authorization: API_KEY'< / span >
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-http" > < code > < span class = "hljs-keyword" > GET< / span > < span class = "hljs-string" > /api/users< / span > HTTP/1.1
2020-04-28 03:24:18 +03:00
< 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({
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > url< / span > : < span class = "hljs-string" > '/api/users'< / span > ,
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'get'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
};
2021-01-28 19:24:10 +02:00
fetch(< span class = "hljs-string" > '/api/users'< / span > ,
2020-04-28 03:24:18 +03:00
{
2021-01-28 19:24:10 +02:00
< span class = "hljs-attr" > method< / span > : < span class = "hljs-string" > 'GET'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
result = RestClient.get < span class = "hljs-string" > '/api/users'< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
}
2021-01-28 19:24:10 +02:00
r = requests.get(< span class = "hljs-string" > '/api/users'< / span > , params={
2020-04-28 03:24:18 +03:00
}, headers = headers)
< span class = "hljs-keyword" > print< / span > r.json()
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-java" > < code > URL obj = < span class = "hljs-keyword" > new< / span > URL(< span class = "hljs-string" > "/api/users"< / span > );
2020-04-28 03:24:18 +03:00
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
2021-01-28 19:24:10 +02:00
con.setRequestMethod(< span class = "hljs-string" > "GET"< / span > );
2020-04-28 03:24:18 +03:00
< 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 > },
2020-05-25 21:46:08 +03:00
2020-04-28 03:24:18 +03:00
}
data := bytes.NewBuffer([]< span class = "hljs-keyword" > byte< / span > {jsonReq})
2021-01-28 19:24:10 +02:00
req, err := http.NewRequest(< span class = "hljs-string" > "GET"< / span > , < span class = "hljs-string" > "/api/users"< / span > , data)
2020-04-28 03:24:18 +03:00
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< p > < code > GET /api/users< / code > < / p >
< p > < em > return all the users< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
2020-04-28 03:24:18 +03:00
< blockquote >
< p > Example responses< / p >
< / blockquote >
< blockquote >
< p > 200 Response< / p >
< / blockquote >
2021-01-28 19:24:10 +02:00
< pre class = "highlight tab tab-json" > < code > [
{
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "username"< / span > : < span class = "hljs-string" > "string"< / span >
}
]
2020-04-28 03:24:18 +03:00
< / code > < / pre >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_users-responses" > Responses< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< h3 id = "get_all_users-responseschema" > Response Schema< / h3 >
2020-04-28 03:24:18 +03:00
< 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 >
2021-01-28 19:24:10 +02:00
< tr >
< td > » username< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2020-04-28 03:24:18 +03:00
< / tbody >
< / table >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
2021-01-28 19:24:10 +02:00
< h2 id = "new_user" > new_user< / h2 >
< p > < a id = "opIdnew_user" > < / 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/users \
-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/users< / 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/users'< / 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 > {
< 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 > inputBody = < span class = "hljs-string" > '{
"username": "string",
"email": "string",
"password": "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/users'< / 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 > {
< 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" > '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/users'< / 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" > '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/users'< / 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/users"< / span > );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "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/users"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > POST /api/users< / code > < / p >
< p > < em > Create a new user< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > username:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > email:< / span > < span class = "hljs-string" > string< / span >
< span class = "hljs-attr" > password:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "new_user-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » username< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the new username< / td >
< / tr >
< tr >
< td > » email< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the email of the new user< / td >
< / tr >
< tr >
< td > » password< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the password of the new user< / 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 >
}
< / code > < / pre >
< h3 id = "new_user-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 = "new_user-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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "get_user" > get_user< / h2 >
< p > < a id = "opIdget_user" > < / 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/users/{user} \
-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/users/{user}< / span > HTTP/1.1
< 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/users/{user}'< / 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/users/{user}'< / 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/users/{user}'< / 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/users/{user}'< / 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/users/{user}"< / 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/users/{user}"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > GET /api/users/{user}< / code > < / p >
< p > < em > get a given user< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
< h3 id = "get_user-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > user< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the user ID< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > user< / strong > : the user 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" > "username"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emails"< / span > : [
{
< span class = "hljs-attr" > "address"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "verified"< / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "profile"< / span > : {
< span class = "hljs-attr" > "avatarUrl"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emailBuffer"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "fullname"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showDesktopDragHandles"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hideCheckedItems"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hiddenSystemMessages"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hiddenMinicardLabelText"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "initials"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "invitedBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "language"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "notifications"< / span > : [],
< span class = "hljs-attr" > "activity"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "read"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showCardsCountAt"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "startDayOfWeek"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "starredBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "icode"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardView"< / span > : < span class = "hljs-string" > "board-view-swimlanes"< / span > ,
< span class = "hljs-attr" > "listSortBy"< / span > : < span class = "hljs-string" > "-modifiedat"< / span > ,
< span class = "hljs-attr" > "templatesBoardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
},
< span class = "hljs-attr" > "services"< / span > : {},
< span class = "hljs-attr" > "heartbeat"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "isAdmin"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "createdThroughApi"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "loginDisabled"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "authenticationMethod"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sessionData"< / span > : {
< span class = "hljs-attr" > "totalHits"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "lastHit"< / span > : < span class = "hljs-number" > 0< / span >
}
}
< / code > < / pre >
< h3 id = "get_user-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 > < a href = "#schemausers" > Users< / a > < / 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 = "edit_user" > edit_user< / h2 >
< p > < a id = "opIdedit_user" > < / 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/users/{user} \
-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/users/{user}< / 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/users/{user}'< / 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 > {
< 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 > inputBody = < span class = "hljs-string" > '{
"action": "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/users/{user}'< / 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 > {
< 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" > '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/users/{user}'< / 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" > '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/users/{user}'< / 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/users/{user}"< / span > );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "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/users/{user}"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > PUT /api/users/{user}< / code > < / p >
< p > < em > edit a given user< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
< p > Possible values for < em > action< / em > :< / p >
< ul >
< li > < code > takeOwnership< / code > : The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on.< / li >
< li > < code > disableLogin< / code > : Disable a user (the user is not allowed to login and his login tokens are purged)< / li >
< li > < code > enableLogin< / code > : Enable a user< / li >
< / ul >
< blockquote >
< p > Body parameter< / p >
< / blockquote >
< pre class = "highlight tab tab-yaml" > < code > < span class = "hljs-attr" > action:< / span > < span class = "hljs-string" > string< / span >
< / code > < / pre >
< h3 id = "edit_user-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > user< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the user ID< / td >
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » action< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the action< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > user< / strong > : the user 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 = "edit_user-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 = "edit_user-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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "delete_user" > delete_user< / h2 >
< p > < a id = "opIddelete_user" > < / 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/users/{user} \
-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/users/{user}< / span > HTTP/1.1
< 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/users/{user}'< / 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" > '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/users/{user}'< / 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" > '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/users/{user}'< / 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.delete(< span class = "hljs-string" > '/api/users/{user}'< / 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/users/{user}"< / 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" > "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/users/{user}"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > DELETE /api/users/{user}< / code > < / p >
< p > < em > Delete a user< / em > < / p >
< p > Only the admin user (the first user) can call the REST API.< / p >
< h3 id = "delete_user-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > In< / th >
< th > Type< / th >
< th > Required< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > user< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the user to delete< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > user< / strong > : the ID of the user to delete< / 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_user-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 = "delete_user-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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h1 id = "wekan-rest-api-swimlanes" > Swimlanes< / h1 >
< h2 id = "get_all_swimlanes" > get_all_swimlanes< / h2 >
< p > < a id = "opIdget_all_swimlanes" > < / 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 \
-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< / span > HTTP/1.1
< 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'< / 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/{board}/swimlanes'< / 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/{board}/swimlanes'< / 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/{board}/swimlanes'< / 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"< / 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/{board}/swimlanes"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > GET /api/boards/{board}/swimlanes< / code > < / p >
< p > < em > Get the list of swimlanes attached to a board< / em > < / p >
< h3 id = "get_all_swimlanes-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the ID of the board< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the ID of the board< / 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_swimlanes-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_all_swimlanes-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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "new_swimlane" > new_swimlane< / h2 >
< p > < a id = "opIdnew_swimlane" > < / 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}/swimlanes \
-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}/swimlanes< / 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}/swimlanes'< / 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 > {
< 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 > inputBody = < span class = "hljs-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}/swimlanes'< / 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 > {
< 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" > '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}/swimlanes'< / 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" > '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}/swimlanes'< / 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"< / span > );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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()));
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" > "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}/swimlanes"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > POST /api/boards/{board}/swimlanes< / code > < / p >
< p > < em > Add a swimlane 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 >
< / code > < / pre >
< h3 id = "new_swimlane-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the ID of the board< / td >
< / tr >
< tr >
< td > body< / td >
< td > body< / td >
< td > object< / td >
< td > false< / td >
< td > none< / td >
< / tr >
< tr >
< td > » title< / td >
< td > body< / td >
< td > string< / td >
< td > true< / td >
< td > the new title of the swimlane< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the ID of the board< / 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_swimlane-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 = "new_swimlane-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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h2 id = "get_swimlane" > get_swimlane< / h2 >
< p > < a id = "opIdget_swimlane" > < / 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} \
-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}< / span > HTTP/1.1
< 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}'< / 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/{board}/swimlanes/{swimlane}'< / 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/{board}/swimlanes/{swimlane}'< / 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/{board}/swimlanes/{swimlane}'< / 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}"< / 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/{board}/swimlanes/{swimlane}"< / span > , data)
req.Header = headers
client := & http.Client{}
resp, err := client.Do(req)
< span class = "hljs-comment" > // ...< / span >
}
< / code > < / pre >
< p > < code > GET /api/boards/{board}/swimlanes/{swimlane}< / code > < / p >
< p > < em > Get a swimlane< / em > < / p >
< h3 id = "get_swimlane-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the ID of the board< / td >
< / tr >
< tr >
< td > swimlane< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the swimlane< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the ID of the board< / p >
< p > < strong > swimlane< / strong > : the ID of the swimlane< / 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" > "archived"< / span > : < span class = "hljs-literal" > true< / 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" > "sort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "white"< / 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" > "type"< / span > : < span class = "hljs-string" > "string"< / span >
}
< / code > < / pre >
< h3 id = "get_swimlane-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 > < a href = "#schemaswimlanes" > Swimlanes< / a > < / 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_swimlane" > delete_swimlane< / h2 >
< p > < a id = "opIddelete_swimlane" > < / 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}/swimlanes/{swimlane} \
-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}/swimlanes/{swimlane}< / span > HTTP/1.1
< 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}'< / 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" > '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}'< / 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" > '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}/swimlanes/{swimlane}'< / 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.delete(< span class = "hljs-string" > '/api/boards/{board}/swimlanes/{swimlane}'< / 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}"< / 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" > "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}/swimlanes/{swimlane}"< / 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}/swimlanes/{swimlane}< / code > < / p >
< p > < em > Delete a swimlane< / em > < / p >
< p > The swimlane will be deleted, not moved to the recycle bin< / p >
< h3 id = "delete_swimlane-parameters" > Parameters< / h3 >
< table >
< thead >
< tr >
< 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 > true< / td >
< td > the ID of the board< / td >
< / tr >
< tr >
< td > swimlane< / td >
< td > path< / td >
< td > string< / td >
< td > true< / td >
< td > the ID of the swimlane< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "detailed-descriptions" > Detailed descriptions< / h4 >
< p > < strong > board< / strong > : the ID of the board< / p >
< p > < strong > swimlane< / strong > : the ID of the swimlane< / 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_swimlane-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 = "delete_swimlane-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 >
< aside class = "warning" >
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
< / aside >
< h1 id = "schemas" > Schemas< / h1 >
< h2 id = "tocsboards" > Boards< / h2 >
< p > < a id = "schemaboards" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "slug"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "archived"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "stars"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "labels"< / span > : [
{
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "name"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "green"< / span >
}
],
< span class = "hljs-attr" > "members"< / span > : [
{
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "isAdmin"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isActive"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isNoComments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isCommentOnly"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isWorker"< / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > "permission"< / span > : < span class = "hljs-string" > "public"< / 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 > ,
< span class = "hljs-attr" > "subtasksDefaultListId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "dateSettingsDefaultBoardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "dateSettingsDefaultListId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "allowsSubtasks"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsAttachments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsChecklists"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsComments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsDescriptionTitle"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsDescriptionText"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsActivities"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsLabels"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsAssignee"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsMembers"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsRequestedBy"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsAssignedBy"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsReceivedDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsStartDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsEndDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowsDueDate"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "presentParentTask"< / span > : < span class = "hljs-string" > "prefix-with-full-path"< / span > ,
< span class = "hljs-attr" > "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-number" > 0< / span > ,
< span class = "hljs-attr" > "isOvertime"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "type"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span >
}
< / code > < / pre >
< p > < em > This is a Board.< / em > < / p >
< h3 id = "properties" > 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 > title< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The title of the board< / td >
< / tr >
< tr >
< td > slug< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The title slugified.< / td >
< / tr >
< tr >
< td > archived< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Is the board archived?< / td >
< / tr >
< tr >
< td > createdAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > Creation time of the board< / td >
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > Last modification time of the board< / td >
< / tr >
< tr >
< td > stars< / td >
< td > number< / td >
< td > true< / td >
< td > none< / td >
< td > How many stars the board has< / td >
< / tr >
< tr >
< td > labels< / td >
< td > [< a href = "#schemaboardslabels" > BoardsLabels< / a > ]< / td >
< td > true< / td >
< td > none< / td >
< td > List of labels attached to a board< / td >
< / tr >
< tr >
< td > members< / td >
< td > [< a href = "#schemaboardsmembers" > BoardsMembers< / a > ]< / td >
< td > true< / td >
< td > none< / td >
< td > List of members of a board< / td >
< / tr >
< tr >
< td > permission< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > visibility of the board< / td >
< / tr >
< tr >
< td > color< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The color of the board.< / td >
< / tr >
< tr >
< td > description< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > The description of the board< / td >
< / tr >
< tr >
< td > subtasksDefaultBoardId< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > The default board ID assigned to subtasks.< / td >
< / tr >
< tr >
< td > subtasksDefaultListId< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > The default List ID assigned to subtasks.< / td >
< / tr >
< tr >
< td > dateSettingsDefaultBoardId< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > dateSettingsDefaultListId< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > allowsSubtasks< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows subtasks?< / td >
< / tr >
< tr >
< td > allowsAttachments< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows attachments?< / td >
< / tr >
< tr >
< td > allowsChecklists< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows checklists?< / td >
< / tr >
< tr >
< td > allowsComments< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows comments?< / td >
< / tr >
< tr >
< td > allowsDescriptionTitle< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows description title?< / td >
< / tr >
< tr >
< td > allowsDescriptionText< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows description text?< / td >
< / tr >
< tr >
< td > allowsActivities< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows comments?< / td >
< / tr >
< tr >
< td > allowsLabels< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows labels?< / td >
< / tr >
< tr >
< td > allowsAssignee< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows assignee?< / td >
< / tr >
< tr >
< td > allowsMembers< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows members?< / td >
< / tr >
< tr >
< td > allowsRequestedBy< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows requested by?< / td >
< / tr >
< tr >
< td > allowsAssignedBy< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows requested by?< / td >
< / tr >
< tr >
< td > allowsReceivedDate< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows received date?< / td >
< / tr >
< tr >
< td > allowsStartDate< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows start date?< / td >
< / tr >
< tr >
< td > allowsEndDate< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows end date?< / td >
< / tr >
< tr >
< td > allowsDueDate< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Does the board allows due date?< / td >
< / tr >
< tr >
< td > presentParentTask< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > Controls how to present the parent task: - < code > prefix-with-full-path< / code > : add a prefix with the full path - < code > prefix-with-parent< / code > : add a prefisx with the parent name - < code > subtext-with-full-path< / code > : add a subtext with the full path - < code > subtext-with-parent< / code > : add a subtext with the parent name - < code > no-parent< / code > : does not show the parent at all< / td >
< / tr >
< tr >
< td > startAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > Starting date of the board.< / td >
< / tr >
< tr >
< td > dueAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > Due date of the board.< / td >
< / tr >
< tr >
< td > endAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > End date of the board.< / td >
< / tr >
< tr >
< td > spentTime< / td >
< td > number|null< / td >
< td > false< / td >
< td > none< / td >
< td > Time spent in the board.< / td >
< / tr >
< tr >
< td > isOvertime< / td >
< td > boolean|null< / td >
< td > false< / td >
< td > none< / td >
< td > Is the board overtimed?< / td >
< / tr >
< tr >
< td > type< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The type of board< / td >
< / tr >
< tr >
< td > sort< / td >
< td > number< / td >
< td > true< / td >
< td > none< / td >
< td > Sort value< / td >
< / tr >
< / tbody >
< / table >
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
< tr >
< th > Property< / th >
< th > Value< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > permission< / td >
< td > public< / td >
< / tr >
< tr >
< td > permission< / td >
< td > private< / td >
< / tr >
< tr >
< td > color< / td >
< td > belize< / td >
< / tr >
< tr >
< td > color< / td >
< td > nephritis< / td >
< / tr >
< tr >
< td > color< / td >
< td > pomegranate< / td >
< / tr >
< tr >
< td > color< / td >
< td > pumpkin< / td >
< / tr >
< tr >
< td > color< / td >
< td > wisteria< / td >
< / tr >
< tr >
< td > color< / td >
< td > moderatepink< / td >
< / tr >
< tr >
< td > color< / td >
< td > strongcyan< / td >
< / tr >
< tr >
< td > color< / td >
< td > limegreen< / td >
< / tr >
< tr >
< td > color< / td >
< td > midnight< / td >
< / tr >
< tr >
< td > color< / td >
< td > dark< / td >
< / tr >
< tr >
< td > color< / td >
< td > relax< / td >
< / tr >
< tr >
< td > color< / td >
< td > corteza< / td >
< / tr >
< tr >
< td > color< / td >
< td > clearblue< / td >
< / tr >
< tr >
< td > color< / td >
< td > natural< / td >
< / tr >
< tr >
< td > color< / td >
< td > modern< / td >
< / tr >
< tr >
< td > color< / td >
< td > moderndark< / td >
< / tr >
< tr >
< td > presentParentTask< / td >
< td > prefix-with-full-path< / td >
< / tr >
< tr >
< td > presentParentTask< / td >
< td > prefix-with-parent< / td >
< / tr >
< tr >
< td > presentParentTask< / td >
< td > subtext-with-full-path< / td >
< / tr >
< tr >
< td > presentParentTask< / td >
< td > subtext-with-parent< / td >
< / tr >
< tr >
< td > presentParentTask< / td >
< td > no-parent< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocsboardslabels" > BoardsLabels< / h2 >
< p > < a id = "schemaboardslabels" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "_id"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "name"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "green"< / span >
}
< / code > < / pre >
< h3 id = "properties" > 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 > _id< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > Unique id of a label< / td >
< / tr >
< tr >
< td > name< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > Name of a label< / td >
< / tr >
< tr >
< td > color< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > color of a label. Can be amongst < code > green< / code > , < code > yellow< / code > , < code > orange< / code > , < code > red< / code > , < code > purple< / code > , < code > blue< / code > , < code > sky< / code > , < code > lime< / code > , < code > pink< / code > , < code > black< / code > , < code > silver< / code > , < code > peachpuff< / code > , < code > crimson< / code > , < code > plum< / code > , < code > darkgreen< / code > , < code > slateblue< / code > , < code > magenta< / code > , < code > gold< / code > , < code > navy< / code > , < code > gray< / code > , < code > saddlebrown< / code > , < code > paleturquoise< / code > , < code > mistyrose< / code > , < code > indigo< / code > < / td >
< / tr >
< / tbody >
< / table >
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
< tr >
< th > Property< / th >
< th > Value< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > color< / td >
< td > green< / td >
< / tr >
< tr >
< td > color< / td >
< td > yellow< / td >
< / tr >
< tr >
< td > color< / td >
< td > orange< / td >
< / tr >
< tr >
< td > color< / td >
< td > red< / td >
< / tr >
< tr >
< td > color< / td >
< td > purple< / td >
< / tr >
< tr >
< td > color< / td >
< td > blue< / td >
< / tr >
< tr >
< td > color< / td >
< td > sky< / td >
< / tr >
< tr >
< td > color< / td >
< td > lime< / td >
< / tr >
< tr >
< td > color< / td >
< td > pink< / td >
< / tr >
< tr >
< td > color< / td >
< td > black< / td >
< / tr >
< tr >
< td > color< / td >
< td > silver< / td >
< / tr >
< tr >
< td > color< / td >
< td > peachpuff< / td >
< / tr >
< tr >
< td > color< / td >
< td > crimson< / td >
< / tr >
< tr >
< td > color< / td >
< td > plum< / td >
< / tr >
< tr >
< td > color< / td >
< td > darkgreen< / td >
< / tr >
< tr >
< td > color< / td >
< td > slateblue< / td >
< / tr >
< tr >
< td > color< / td >
< td > magenta< / td >
< / tr >
< tr >
< td > color< / td >
< td > gold< / td >
< / tr >
< tr >
< td > color< / td >
< td > navy< / td >
< / tr >
< tr >
< td > color< / td >
< td > gray< / td >
< / tr >
< tr >
< td > color< / td >
< td > saddlebrown< / td >
< / tr >
< tr >
< td > color< / td >
< td > paleturquoise< / td >
< / tr >
< tr >
< td > color< / td >
< td > mistyrose< / td >
< / tr >
< tr >
< td > color< / td >
< td > indigo< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocsboardsmembers" > BoardsMembers< / h2 >
< p > < a id = "schemaboardsmembers" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "isAdmin"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isActive"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isNoComments"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isCommentOnly"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "isWorker"< / span > : < span class = "hljs-literal" > true< / span >
}
< / code > < / pre >
< h3 id = "properties" > 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 > userId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The uniq ID of the member< / td >
< / tr >
< tr >
< td > isAdmin< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Is the member an admin of the board?< / td >
< / tr >
< tr >
< td > isActive< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > Is the member active?< / td >
< / tr >
< tr >
< td > isNoComments< / td >
< td > boolean< / td >
< td > false< / td >
< td > none< / td >
< td > Is the member not allowed to make comments< / td >
< / tr >
< tr >
< td > isCommentOnly< / td >
< td > boolean< / td >
< td > false< / td >
< td > none< / td >
< td > Is the member only allowed to comment on the board< / td >
< / tr >
< tr >
< td > isWorker< / td >
< td > boolean< / td >
< td > false< / td >
< td > none< / td >
< td > Is the member only allowed to move card, assign himself to card and comment< / td >
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocscardcomments" > CardComments< / h2 >
< p > < a id = "schemacardcomments" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "boardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "text"< / 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 >
< p > < em > A comment on a card< / em > < / p >
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-28 03:24:18 +03:00
< / thead >
< tbody >
2019-07-17 17:06:25 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< td > boardId< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the board ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > cardId< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the card ID< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > text< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the text of the comment< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > createdAt< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > when was the comment created< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > userId< / td >
< td > string< / td >
< td > true< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the author ID of the comment< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-28 03:24:18 +03:00
< / tbody >
< / table >
< h2 id = "tocscards" > Cards< / h2 >
< p > < a id = "schemacards" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "archived"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "parentId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "swimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "coverId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "white"< / 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" > "customFields"< / span > : [
{}
],
< span class = "hljs-attr" > "dateLastActivity"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "description"< / 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" > "labelIds"< / 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" > "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-number" > 0< / span > ,
< span class = "hljs-attr" > "isOvertime"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "subtaskSort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "type"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "linkedId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "vote"< / span > : {
< span class = "hljs-attr" > "question"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "positive"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "negative"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "end"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-05-15 20:20:29 +03:00
< span class = "hljs-attr" > "public"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowNonBoardMembers"< / span > : < span class = "hljs-literal" > true< / span >
2020-04-28 03:24:18 +03:00
}
}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
2019-07-17 17:06:25 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-28 03:24:18 +03:00
< / thead >
< tbody >
2019-07-17 17:06:25 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< td > title< / td >
2019-07-17 17:06:25 +03:00
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the title of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > archived< / td >
2020-04-12 00:01:07 +03:00
< td > boolean< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the card archived< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > parentId< / td >
< td > string|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > ID of the parent card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listId< / td >
< td > string|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > List ID where the card is< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > swimlaneId< / td >
< td > string< / td >
2020-04-12 00:01:07 +03:00
< td > true< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Swimlane ID where the card is< / td >
< / tr >
< tr >
< td > boardId< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > Board ID of the card< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > coverId< / td >
< td > string|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Cover ID of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > createdAt< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > creation date< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > modifiedAt< / td >
< td > string< / td >
2020-04-12 00:01:07 +03:00
< td > true< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > none< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > customFields< / td >
< td > [< a href = "#schemacardscustomfields" > CardsCustomfields< / a > ]|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > list of custom fields< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > dateLastActivity< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Date of last activity< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > description< / td >
< td > string|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > description of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > requestedBy< / td >
< td > string|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > who requested the card (ID of the user)< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > assignedBy< / td >
< td > string|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > who assigned the card (ID of the user)< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > labelIds< / td >
< td > [string]|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > list of labels ID the card has< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > members< / td >
< td > [string]|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > list of members (user IDs)< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > assignees< / td >
< td > [string]|null< / td >
< td > false< / td >
2019-11-05 22:10:01 +02:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > who is assignee of the card (user ID), maximum one ID of assignee in array.< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > receivedAt< / td >
2019-07-17 17:06:25 +03:00
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Date the card was received< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > startAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Date the card was started to be worked on< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > dueAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Date the card is due< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > endAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Date the card ended< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > spentTime< / td >
< td > number|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > How much time has been spent on this< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > isOvertime< / td >
< td > boolean|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the card over time?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > userId< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > user ID of the author of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-19 17:05:41 +03:00
< tr >
< td > sort< / td >
< td > number< / td >
< td > true< / td >
< td > none< / td >
< td > Sort value< / td >
< / tr >
2020-04-12 00:01:07 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< td > subtaskSort< / td >
< td > number|null< / td >
< td > false< / td >
< td > none< / td >
< td > subtask sort value< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > type< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > type of the card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > linkedId< / td >
< td > string|null< / td >
2019-07-17 17:06:25 +03:00
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > ID of the linked card< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-08 20:37:43 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< td > vote< / td >
< td > < a href = "#schemacardsvote" > CardsVote< / a > < / td >
< td > false< / td >
2020-04-08 20:37:43 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > vote object, see below< / td >
2020-04-08 20:37:43 +03:00
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
< tr >
< th > Property< / th >
< th > Value< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > color< / td >
2020-04-28 03:24:18 +03:00
< td > white< / td >
< / tr >
< tr >
< td > color< / td >
2019-07-17 17:06:25 +03:00
< td > green< / td >
< / tr >
< tr >
< td > color< / td >
< td > yellow< / td >
< / tr >
< tr >
< td > color< / td >
< td > orange< / td >
< / tr >
< tr >
< td > color< / td >
< td > red< / td >
< / tr >
< tr >
< td > color< / td >
< td > purple< / td >
< / tr >
< tr >
< td > color< / td >
< td > blue< / td >
< / tr >
< tr >
< td > color< / td >
< td > sky< / td >
< / tr >
< tr >
< td > color< / td >
< td > lime< / td >
< / tr >
< tr >
< td > color< / td >
< td > pink< / td >
< / tr >
< tr >
< td > color< / td >
< td > black< / td >
< / tr >
< tr >
< td > color< / td >
< td > silver< / td >
< / tr >
< tr >
< td > color< / td >
< td > peachpuff< / td >
< / tr >
< tr >
< td > color< / td >
< td > crimson< / td >
< / tr >
< tr >
< td > color< / td >
< td > plum< / td >
< / tr >
< tr >
< td > color< / td >
< td > darkgreen< / td >
< / tr >
< tr >
< td > color< / td >
< td > slateblue< / td >
< / tr >
< tr >
< td > color< / td >
< td > magenta< / td >
< / tr >
< tr >
< td > color< / td >
< td > gold< / td >
< / tr >
< tr >
< td > color< / td >
< td > navy< / td >
< / tr >
< tr >
< td > color< / td >
< td > gray< / td >
< / tr >
< tr >
< td > color< / td >
< td > saddlebrown< / td >
< / tr >
< tr >
< td > color< / td >
< td > paleturquoise< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > mistyrose< / td >
< / tr >
< tr >
< td > color< / td >
< td > indigo< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocscardsvote" > CardsVote< / h2 >
< p > < a id = "schemacardsvote" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "question"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "positive"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "negative"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "end"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-05-15 20:20:29 +03:00
< span class = "hljs-attr" > "public"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "allowNonBoardMembers"< / span > : < span class = "hljs-literal" > true< / span >
2020-04-28 03:24:18 +03:00
}
< / code > < / pre >
< h3 id = "properties" > 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 > question< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > positive< / td >
< td > [string]< / td >
< td > false< / td >
< td > none< / td >
< td > list of members (user IDs)< / td >
< / tr >
< tr >
< td > negative< / td >
< td > [string]< / td >
< td > false< / td >
< td > none< / td >
< td > list of members (user IDs)< / td >
< / tr >
< tr >
< td > end< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > public< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-05-15 20:20:29 +03:00
< tr >
< td > allowNonBoardMembers< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocscardscustomfields" > CardsCustomfields< / h2 >
< p > < a id = "schemacardscustomfields" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< p > < em > None< / em > < / p >
< h2 id = "tocschecklistitems" > ChecklistItems< / h2 >
< p > < a id = "schemachecklistitems" > < / a > < / p >
2020-04-08 20:37:43 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "isFinished"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "checklistId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardId"< / 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 >
2020-04-08 20:37:43 +03:00
}
< / code > < / pre >
2020-04-28 03:24:18 +03:00
< p > < em > An item in a checklist< / em > < / p >
2020-04-08 20:37:43 +03:00
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > title< / td >
2020-04-08 20:37:43 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the text of the item< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > sort< / td >
< td > number< / td >
2020-04-12 00:01:07 +03:00
< td > true< / td >
2020-04-08 20:37:43 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the sorting field of the item< / td >
2020-04-08 20:37:43 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > isFinished< / td >
2020-04-12 00:01:07 +03:00
< td > boolean< / td >
< td > true< / td >
2020-04-08 20:37:43 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Is the item checked?< / td >
2020-04-08 20:37:43 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > checklistId< / td >
< td > string< / td >
< td > true< / td >
2020-04-08 20:37:43 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the checklist ID the item is attached to< / td >
2020-04-08 20:37:43 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > cardId< / td >
< td > string< / td >
< td > true< / td >
2020-04-08 20:37:43 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the card ID the item is attached to< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > createdAt< / td >
< td > string|null< / td >
2020-04-12 00:01:07 +03:00
< td > false< / td >
2020-04-08 20:37:43 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > none< / td >
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
2020-04-08 20:37:43 +03:00
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocschecklists" > Checklists< / h2 >
< p > < a id = "schemachecklists" > < / a > < / p >
2020-04-12 00:01:07 +03:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "cardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "finishedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-12 00:01:07 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span >
2020-04-12 00:01:07 +03:00
}
2019-07-17 17:06:25 +03:00
< / code > < / pre >
2020-04-28 03:24:18 +03:00
< p > < em > A Checklist< / em > < / p >
2019-07-17 17:06:25 +03:00
< h3 id = "properties" > Properties< / h3 >
2020-04-12 00:01:07 +03:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > cardId< / td >
2020-04-12 00:01:07 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > The ID of the card the checklist is in< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > title< / td >
2020-04-12 00:01:07 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the title of the checklist< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > finishedAt< / td >
< td > string|null< / td >
< td > false< / td >
2020-04-12 00:01:07 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > When was the checklist finished< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
< td > createdAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Creation date of the checklist< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > sort< / td >
< td > number< / td >
2020-04-12 00:01:07 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > sorting value of the checklist< / td >
2020-04-12 00:01:07 +03:00
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocscustomfields" > CustomFields< / h2 >
< p > < a id = "schemacustomfields" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "boardIds"< / 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" > "text"< / span > ,
< span class = "hljs-attr" > "settings"< / span > : {
2020-05-26 17:12:29 +03:00
< span class = "hljs-attr" > "currencyCode"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "dropdownItems"< / 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 > ,
2021-01-23 21:14:06 +02:00
< span class = "hljs-attr" > "alwaysOnCard"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "showLabelOnMiniCard"< / span > : < span class = "hljs-literal" > true< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span >
}
< / code > < / pre >
2020-04-28 03:24:18 +03:00
< p > < em > A custom field on a card in the board< / em > < / p >
2019-07-17 17:06:25 +03:00
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > boardIds< / td >
< td > [string]< / td >
< td > true< / td >
< td > none< / td >
< td > the ID of the board< / td >
< / tr >
< tr >
< td > name< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > name of the custom field< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > type< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > type of the custom field< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > settings< / td >
< td > < a href = "#schemacustomfieldssettings" > CustomFieldsSettings< / a > < / td >
< td > true< / td >
< td > none< / td >
< td > settings of the custom field< / td >
< / tr >
< tr >
< td > showOnCard< / td >
2019-07-17 17:06:25 +03:00
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > should we show on the cards this custom field< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > automaticallyOnCard< / td >
< td > boolean< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > should the custom fields automatically be added on cards?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2021-01-23 21:14:06 +02:00
< td > alwaysOnCard< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
< td > should the custom field be automatically added to all cards?< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > showLabelOnMiniCard< / td >
< td > boolean< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > should the label of the custom field be shown on minicards?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > createdAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
< tr >
< th > Property< / th >
< th > Value< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > type< / td >
< td > text< / td >
< / tr >
< tr >
< td > type< / td >
< td > number< / td >
< / tr >
< tr >
< td > type< / td >
< td > date< / td >
< / tr >
< tr >
< td > type< / td >
< td > dropdown< / td >
< / tr >
2020-05-26 17:12:29 +03:00
< tr >
< td > type< / td >
2021-01-20 13:36:47 +02:00
< td > checkbox< / td >
< / tr >
< tr >
< td > type< / td >
2020-05-26 17:12:29 +03:00
< td > currency< / td >
< / tr >
2020-04-28 03:24:18 +03:00
< / tbody >
< / table >
< h2 id = "tocscustomfieldssettings" > CustomFieldsSettings< / h2 >
< p > < a id = "schemacustomfieldssettings" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-05-26 17:12:29 +03:00
< span class = "hljs-attr" > "currencyCode"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "dropdownItems"< / span > : [
{}
]
}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-05-26 17:12:29 +03:00
< td > currencyCode< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > dropdownItems< / td >
< td > [< a href = "#schemacustomfieldssettingsdropdownitems" > CustomFieldsSettingsDropdownitems< / a > ]< / td >
< td > false< / td >
< td > none< / td >
< td > list of drop down items objects< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocscustomfieldssettingsdropdownitems" > CustomFieldsSettingsDropdownitems< / h2 >
< p > < a id = "schemacustomfieldssettingsdropdownitems" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< p > < em > None< / em > < / p >
< h2 id = "tocsintegrations" > Integrations< / h2 >
< p > < a id = "schemaintegrations" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "enabled"< / span > : < span class = "hljs-literal" > true< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< 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 > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "userId"< / span > : < span class = "hljs-string" > "string"< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2020-04-28 03:24:18 +03:00
< p > < em > Integration with third-party applications< / em > < / p >
2019-07-17 17:06:25 +03:00
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > enabled< / td >
< td > boolean< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the integration enabled?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-25 16:44:45 +03:00
< td > title< / td >
2020-04-28 03:24:18 +03:00
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > name of the integration< / td >
< / tr >
< tr >
< td > type< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > type of the integratation (Default to 'outgoing-webhooks')< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > createdAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Creation date of the integration< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > userId< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > user ID who created the interation< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocslists" > Lists< / h2 >
< p > < a id = "schemalists" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-04-28 03:24:18 +03:00
< 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 > ,
2020-04-25 16:44:45 +03:00
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-04-28 03:24:18 +03:00
< 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 >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
2020-04-28 03:24:18 +03:00
< p > < em > A list (column) in the Wekan board.< / em > < / p >
2019-07-17 17:06:25 +03:00
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > title< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the title of the list< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > starred< / td >
< td > boolean|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > if a list is stared then we put it on the top< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > archived< / td >
< td > boolean< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the list archived< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > boardId< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the board associated to this list< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > swimlaneId< / td >
< td > string< / td >
2020-04-25 16:44:45 +03:00
< td > true< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the swimlane associated to this list. Used for templates< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > createdAt< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > creation date< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > sort< / td >
< td > number|null< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the list sorted< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > updatedAt< / td >
2019-07-17 17:06:25 +03:00
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > last update of the list< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-25 16:44:45 +03:00
< td > modifiedAt< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-25 16:44:45 +03:00
< td > none< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-28 03:24:18 +03:00
< tr >
< td > wipLimit< / td >
< td > < a href = "#schemalistswiplimit" > ListsWiplimit< / a > < / td >
< td > false< / td >
< td > none< / td >
< td > WIP object, see below< / td >
< / tr >
< tr >
< td > color< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > the color of the list< / td >
< / tr >
< tr >
< td > type< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The type of list< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
< tr >
< th > Property< / th >
< th > Value< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > white< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > green< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > yellow< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > orange< / td >
< / tr >
< tr >
< td > color< / td >
< td > red< / td >
< / tr >
< tr >
< td > color< / td >
< td > purple< / td >
< / tr >
< tr >
< td > color< / td >
< td > blue< / td >
< / tr >
< tr >
< td > color< / td >
< td > sky< / td >
< / tr >
< tr >
< td > color< / td >
< td > lime< / td >
< / tr >
< tr >
< td > color< / td >
< td > pink< / td >
< / tr >
< tr >
< td > color< / td >
< td > black< / td >
< / tr >
< tr >
< td > color< / td >
< td > peachpuff< / td >
< / tr >
< tr >
< td > color< / td >
< td > crimson< / td >
< / tr >
< tr >
< td > color< / td >
< td > plum< / td >
< / tr >
< tr >
< td > color< / td >
< td > darkgreen< / td >
< / tr >
< tr >
< td > color< / td >
< td > slateblue< / td >
< / tr >
< tr >
< td > color< / td >
< td > magenta< / td >
< / tr >
< tr >
< td > color< / td >
< td > gold< / td >
< / tr >
< tr >
< td > color< / td >
< td > navy< / td >
< / tr >
< tr >
< td > color< / td >
< td > gray< / td >
< / tr >
< tr >
< td > color< / td >
< td > saddlebrown< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > paleturquoise< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > mistyrose< / td >
< / tr >
< tr >
< td > color< / td >
< td > indigo< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocslistswiplimit" > ListsWiplimit< / h2 >
< p > < a id = "schemalistswiplimit" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "value"< / span > : < span class = "hljs-number" > 0< / span > ,
2019-07-17 17:06:25 +03:00
< span class = "hljs-attr" > "enabled"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "soft"< / span > : < span class = "hljs-literal" > true< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > value< / td >
< td > number< / td >
2020-04-25 16:44:45 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > value of the WIP< / td >
2020-04-25 16:44:45 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > enabled< / td >
< td > boolean< / td >
2020-04-25 16:44:45 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the WIP enabled< / td >
2020-04-25 16:44:45 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > soft< / td >
< td > boolean< / td >
2020-04-25 16:44:45 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the WIP a soft or hard requirement< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocsswimlanes" > Swimlanes< / h2 >
< p > < a id = "schemaswimlanes" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "title"< / span > : < span class = "hljs-string" > "string"< / 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" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sort"< / span > : < span class = "hljs-number" > 0< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "color"< / span > : < span class = "hljs-string" > "white"< / span > ,
2019-07-17 17:06:25 +03:00
< 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" > "type"< / span > : < span class = "hljs-string" > "string"< / span >
}
< / code > < / pre >
2020-04-28 03:24:18 +03:00
< p > < em > A swimlane is an line in the kaban board.< / em > < / p >
2019-07-17 17:06:25 +03:00
< h3 id = "properties" > 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 > title< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the title of the swimlane< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > archived< / td >
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > is the swimlane archived?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > boardId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the ID of the board the swimlane is attached to< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-25 16:44:45 +03:00
< td > createdAt< / td >
< td > string< / td >
< td > true< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > creation date of the swimlane< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-25 16:44:45 +03:00
< td > sort< / td >
< td > number|null< / td >
2019-07-17 17:06:25 +03:00
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > the sort value of the swimlane< / td >
< / tr >
< tr >
< td > color< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > the color of the swimlane< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > updatedAt< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > when was the swimlane last edited< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
< / tr >
< tr >
< td > type< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > The type of swimlane< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
< tr >
< th > Property< / th >
< th > Value< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > color< / td >
< td > white< / td >
< / tr >
< tr >
< td > color< / td >
< td > green< / td >
< / tr >
< tr >
< td > color< / td >
< td > yellow< / td >
< / tr >
< tr >
< td > color< / td >
< td > orange< / td >
< / tr >
< tr >
< td > color< / td >
< td > red< / td >
< / tr >
< tr >
< td > color< / td >
< td > purple< / td >
< / tr >
< tr >
< td > color< / td >
< td > blue< / td >
< / tr >
< tr >
< td > color< / td >
< td > sky< / td >
< / tr >
< tr >
< td > color< / td >
< td > lime< / td >
< / tr >
< tr >
< td > color< / td >
< td > pink< / td >
< / tr >
< tr >
< td > color< / td >
< td > black< / td >
< / tr >
< tr >
< td > color< / td >
< td > peachpuff< / td >
< / tr >
< tr >
< td > color< / td >
< td > crimson< / td >
< / tr >
< tr >
< td > color< / td >
< td > plum< / td >
< / tr >
< tr >
< td > color< / td >
< td > darkgreen< / td >
< / tr >
< tr >
< td > color< / td >
2020-04-25 16:44:45 +03:00
< td > slateblue< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > color< / td >
< td > magenta< / td >
< / tr >
< tr >
< td > color< / td >
< td > gold< / td >
< / tr >
< tr >
< td > color< / td >
< td > navy< / td >
< / tr >
< tr >
< td > color< / td >
< td > gray< / td >
< / tr >
< tr >
< td > color< / td >
< td > saddlebrown< / td >
< / tr >
< tr >
< td > color< / td >
< td > paleturquoise< / td >
< / tr >
< tr >
< td > color< / td >
< td > mistyrose< / td >
< / tr >
< tr >
< td > color< / td >
< td > indigo< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "tocsusers" > Users< / h2 >
< p > < a id = "schemausers" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "username"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emails"< / span > : [
{
< span class = "hljs-attr" > "address"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "verified"< / span > : < span class = "hljs-literal" > true< / span >
}
],
< span class = "hljs-attr" > "createdAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "modifiedAt"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "profile"< / span > : {
< span class = "hljs-attr" > "avatarUrl"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emailBuffer"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "fullname"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showDesktopDragHandles"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-06-16 20:08:20 +03:00
< span class = "hljs-attr" > "hideCheckedItems"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "hiddenSystemMessages"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hiddenMinicardLabelText"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "initials"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "invitedBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "language"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "notifications"< / span > : [],
< span class = "hljs-attr" > "activity"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "read"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showCardsCountAt"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "startDayOfWeek"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "starredBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "icode"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-06-08 20:29:55 +03:00
< span class = "hljs-attr" > "boardView"< / span > : < span class = "hljs-string" > "board-view-swimlanes"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "listSortBy"< / span > : < span class = "hljs-string" > "-modifiedat"< / span > ,
< span class = "hljs-attr" > "templatesBoardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
},
< span class = "hljs-attr" > "services"< / span > : {},
< span class = "hljs-attr" > "heartbeat"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "isAdmin"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "createdThroughApi"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "loginDisabled"< / span > : < span class = "hljs-literal" > true< / span > ,
2021-01-16 05:08:10 +02:00
< span class = "hljs-attr" > "authenticationMethod"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "sessionData"< / span > : {
< span class = "hljs-attr" > "totalHits"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "lastHit"< / span > : < span class = "hljs-number" > 0< / span >
}
2020-04-28 03:24:18 +03:00
}
< / code > < / pre >
< p > < em > A User in wekan< / em > < / p >
< h3 id = "properties" > 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 > username< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > the username of the user< / td >
< / tr >
< tr >
< td > emails< / td >
< td > [< a href = "#schemausersemails" > UsersEmails< / a > ]|null< / td >
< td > false< / td >
< td > none< / td >
< td > the list of emails attached to a user< / td >
< / tr >
< tr >
< td > createdAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > creation date of the user< / td >
< / tr >
< tr >
< td > modifiedAt< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > none< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > profile< / td >
< td > < a href = "#schemausersprofile" > UsersProfile< / a > < / td >
< td > false< / td >
< td > none< / td >
< td > profile settings< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > services< / td >
< td > object|null< / td >
< td > false< / td >
< td > none< / td >
< td > services field of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > heartbeat< / td >
< td > string|null< / td >
< td > false< / td >
< td > none< / td >
< td > last time the user has been seen< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > isAdmin< / td >
< td > boolean|null< / td >
< td > false< / td >
< td > none< / td >
< td > is the user an admin of the board?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > createdThroughApi< / td >
< td > boolean|null< / td >
< td > false< / td >
< td > none< / td >
< td > was the user created through the API?< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > loginDisabled< / td >
< td > boolean|null< / td >
< td > false< / td >
< td > none< / td >
< td > loginDisabled field of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > authenticationMethod< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > authentication method of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2021-01-16 05:08:10 +02:00
< tr >
< td > sessionData< / td >
< td > < a href = "#schemauserssessiondata" > UsersSessiondata< / a > < / td >
< td > false< / td >
< td > none< / td >
< td > profile settings< / td >
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocsusersemails" > UsersEmails< / h2 >
< p > < a id = "schemausersemails" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "address"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "verified"< / span > : < span class = "hljs-literal" > true< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > address< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > The email address< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > verified< / td >
2019-07-17 17:06:25 +03:00
< td > boolean< / td >
< td > true< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > Has the email been verified< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< / tbody >
< / table >
2020-04-28 03:24:18 +03:00
< h2 id = "tocsusersprofile" > UsersProfile< / h2 >
< p > < a id = "schemausersprofile" > < / a > < / p >
2019-07-17 17:06:25 +03:00
< pre class = "highlight tab tab-json" > < code > {
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "avatarUrl"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "emailBuffer"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "fullname"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showDesktopDragHandles"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-06-16 20:08:20 +03:00
< span class = "hljs-attr" > "hideCheckedItems"< / span > : < span class = "hljs-literal" > true< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "hiddenSystemMessages"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "hiddenMinicardLabelText"< / span > : < span class = "hljs-literal" > true< / span > ,
< span class = "hljs-attr" > "initials"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "invitedBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "language"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "notifications"< / span > : [],
< span class = "hljs-attr" > "activity"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "read"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "showCardsCountAt"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "startDayOfWeek"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "starredBoards"< / span > : [
< span class = "hljs-string" > "string"< / span >
],
< span class = "hljs-attr" > "icode"< / span > : < span class = "hljs-string" > "string"< / span > ,
2020-06-08 20:29:55 +03:00
< span class = "hljs-attr" > "boardView"< / span > : < span class = "hljs-string" > "board-view-swimlanes"< / span > ,
2020-04-28 03:24:18 +03:00
< span class = "hljs-attr" > "listSortBy"< / span > : < span class = "hljs-string" > "-modifiedat"< / span > ,
< span class = "hljs-attr" > "templatesBoardId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "cardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "listTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span > ,
< span class = "hljs-attr" > "boardTemplatesSwimlaneId"< / span > : < span class = "hljs-string" > "string"< / span >
2019-07-17 17:06:25 +03:00
}
< / code > < / pre >
< h3 id = "properties" > Properties< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Required< / th >
< th > Restrictions< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-04-28 03:24:18 +03:00
< td > avatarUrl< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
2020-04-28 03:24:18 +03:00
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > URL of the avatar of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > emailBuffer< / td >
< td > [string]< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > list of email buffers of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > fullname< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
2020-04-28 03:24:18 +03:00
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > full name of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > showDesktopDragHandles< / td >
< td > boolean< / td >
< td > false< / td >
2019-11-19 21:59:09 +02:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > does the user want to hide system messages?< / td >
2019-11-19 21:59:09 +02:00
< / tr >
< tr >
2020-06-16 20:08:20 +03:00
< td > hideCheckedItems< / td >
< td > boolean< / td >
< td > false< / td >
< td > none< / td >
< td > does the user want to hide checked checklist items?< / td >
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > hiddenSystemMessages< / td >
< td > boolean< / td >
2019-07-17 17:06:25 +03:00
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > does the user want to hide system messages?< / td >
2019-08-13 01:23:30 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > hiddenMinicardLabelText< / td >
< td > boolean< / td >
2019-11-19 21:59:09 +02:00
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > does the user want to hide minicard label texts?< / td >
2019-11-19 21:59:09 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > initials< / td >
< td > string< / td >
2019-07-17 17:06:25 +03:00
< td > false< / td >
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > initials of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > invitedBoards< / td >
< td > [string]< / td >
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > board IDs the user has been invited to< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > language< / td >
2019-07-17 17:06:25 +03:00
< td > string< / td >
2020-04-28 03:24:18 +03:00
< td > false< / td >
2019-07-17 17:06:25 +03:00
< td > none< / td >
2020-04-28 03:24:18 +03:00
< td > language of the user< / td >
2020-04-02 02:34:02 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > notifications< / td >
< td > [< a href = "#schemausersprofilenotifications" > UsersProfileNotifications< / a > ]< / td >
< td > false< / td >
< td > none< / td >
< td > enabled notifications for the user< / td >
2020-04-02 02:34:02 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > activity< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > The id of the activity this notification references< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > read< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > the date on which this notification was read< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > showCardsCountAt< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > showCardCountAt field of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > startDayOfWeek< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > startDayOfWeek field of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > starredBoards< / td >
< td > [string]< / td >
< td > false< / td >
< td > none< / td >
< td > list of starred board IDs< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > icode< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > icode< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > boardView< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > boardView field of the user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > string< / td >
< td > false< / td >
< td > none< / td >
< td > default sort list for user< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > templatesBoardId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > Reference to the templates board< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > cardTemplatesSwimlaneId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > Reference to the card templates swimlane Id< / td >
2020-04-25 16:44:45 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listTemplatesSwimlaneId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > Reference to the list templates swimlane Id< / td >
2020-04-25 16:44:45 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > boardTemplatesSwimlaneId< / td >
< td > string< / td >
< td > true< / td >
< td > none< / td >
< td > Reference to the board templates swimlane Id< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-28 03:24:18 +03:00
< / tbody >
< / table >
< h4 id = "enumerated-values" > Enumerated Values< / h4 >
< table >
< thead >
2019-07-17 17:06:25 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< th > Property< / th >
< th > Value< / th >
2019-07-17 17:06:25 +03:00
< / tr >
2020-04-28 03:24:18 +03:00
< / thead >
< tbody >
2019-07-17 17:06:25 +03:00
< tr >
2020-04-28 03:24:18 +03:00
< td > boardView< / td >
2020-06-08 20:29:55 +03:00
< td > board-view-swimlanes< / td >
2019-07-17 17:06:25 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > boardView< / td >
2020-06-08 20:29:55 +03:00
< td > board-view-lists< / td >
2019-07-17 17:06:25 +03:00
< / tr >
2019-11-05 22:10:01 +02:00
< tr >
2020-04-28 03:24:18 +03:00
< td > boardView< / td >
< td > board-view-cal< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > -modifiedat< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > modifiedat< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > -title< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > title< / td >
2019-11-05 22:10:01 +02:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > -sort< / td >
2020-04-25 16:44:45 +03:00
< / tr >
< tr >
2020-04-28 03:24:18 +03:00
< td > listSortBy< / td >
< td > sort< / td >
2019-11-05 22:10:01 +02:00
< / tr >
2019-07-17 17:06:25 +03:00
< / tbody >
2021-01-16 05:08:10 +02:00
< / table >
< h2 id = "tocsuserssessiondata" > UsersSessiondata< / h2 >
< p > < a id = "schemauserssessiondata" > < / a > < / p >
< pre class = "highlight tab tab-json" > < code > {
< span class = "hljs-attr" > "totalHits"< / span > : < span class = "hljs-number" > 0< / span > ,
< span class = "hljs-attr" > "lastHit"< / span > : < span class = "hljs-number" > 0< / span >
}
< / code > < / pre >
< h3 id = "properties" > 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 > totalHits< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > Total hits from last search< / td >
< / tr >
< tr >
< td > lastHit< / td >
< td > number< / td >
< td > false< / td >
< td > none< / td >
< td > last hit that was returned< / td >
< / tr >
< / tbody >
2019-07-17 17:06:25 +03:00
< / table >
< / div >
< div class = "dark-box" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< div class = "lang-selector" >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "shell" > Shell< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "http" > HTTP< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "javascript" > JavaScript< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "javascript--nodejs" > Node.js< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "ruby" > Ruby< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "python" > Python< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "java" > Java< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< a href = "#" data-language-name = "go" > Go< / a >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / div >
2020-05-25 21:46:08 +03:00
2019-07-17 17:06:25 +03:00
< / div >
< / div >
< / body >
< / html >
