diff options
Diffstat (limited to 'public')
| -rw-r--r-- | public/api/wekan.html | 15766 | ||||
| -rw-r--r-- | public/api/wekan.yml | 2937 |
2 files changed, 18703 insertions, 0 deletions
diff --git a/public/api/wekan.html b/public/api/wekan.html new file mode 100644 index 00000000..c437c049 --- /dev/null +++ b/public/api/wekan.html @@ -0,0 +1,15766 @@ + + + +<!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">/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ +/** + * 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">/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ +/** + * 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> + + <script>!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(e,t){"use strict";function n(e,t){t=t||ne;var n=t.createElement("script");n.text=e,t.head.appendChild(n).parentNode.removeChild(n)}function r(e){var t=!!e&&"length"in e&&e.length,n=he.type(e);return"function"!==n&&!he.isWindow(e)&&("array"===n||0===t||"number"==typeof t&&t>0&&t-1 in e)}function i(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}function o(e,t,n){return he.isFunction(t)?he.grep(e,function(e,r){return!!t.call(e,r,e)!==n}):t.nodeType?he.grep(e,function(e){return e===t!==n}):"string"!=typeof t?he.grep(e,function(e){return ae.call(t,e)>-1!==n}):Ee.test(t)?he.filter(t,e,n):(t=he.filter(t,e),he.grep(e,function(e){return ae.call(t,e)>-1!==n&&1===e.nodeType}))}function s(e,t){for(;(e=e[t])&&1!==e.nodeType;);return e}function a(e){var t={};return he.each(e.match(Ae)||[],function(e,n){t[n]=!0}),t}function u(e){return e}function c(e){throw e}function l(e,t,n,r){var i;try{e&&he.isFunction(i=e.promise)?i.call(e).done(t).fail(n):e&&he.isFunction(i=e.then)?i.call(e,t,n):t.apply(void 0,[e].slice(r))}catch(e){n.apply(void 0,[e])}}function f(){ne.removeEventListener("DOMContentLoaded",f),e.removeEventListener("load",f),he.ready()}function d(){this.expando=he.expando+d.uid++}function p(e){return"true"===e||"false"!==e&&("null"===e?null:e===+e+""?+e:Pe.test(e)?JSON.parse(e):e)}function h(e,t,n){var r;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(He,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n=p(n)}catch(e){}$e.set(e,t,n)}else n=void 0;return n}function g(e,t,n,r){var i,o=1,s=20,a=r?function(){return r.cur()}:function(){return he.css(e,t,"")},u=a(),c=n&&n[3]||(he.cssNumber[t]?"":"px"),l=(he.cssNumber[t]||"px"!==c&&+u)&&Re.exec(he.css(e,t));if(l&&l[3]!==c){c=c||l[3],n=n||[],l=+u||1;do{o=o||".5",l/=o,he.style(e,t,l+c)}while(o!==(o=a()/u)&&1!==o&&--s)}return n&&(l=+l||+u||0,i=n[1]?l+(n[1]+1)*n[2]:+n[2],r&&(r.unit=c,r.start=l,r.end=i)),i}function v(e){var t,n=e.ownerDocument,r=e.nodeName,i=Be[r];return i||(t=n.body.appendChild(n.createElement(r)),i=he.css(t,"display"),t.parentNode.removeChild(t),"none"===i&&(i="block"),Be[r]=i,i)}function m(e,t){for(var n,r,i=[],o=0,s=e.length;o<s;o++)r=e[o],r.style&&(n=r.style.display,t?("none"===n&&(i[o]=Fe.get(r,"display")||null,i[o]||(r.style.display="")),""===r.style.display&&Me(r)&&(i[o]=v(r))):"none"!==n&&(i[o]="none",Fe.set(r,"display",n)));for(o=0;o<s;o++)null!=i[o]&&(e[o].style.display=i[o]);return e}function y(e,t){var n;return n=void 0!==e.getElementsByTagName?e.getElementsByTagName(t||"*"):void 0!==e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&i(e,t)?he.merge([e],n):n}function x(e,t){for(var n=0,r=e.length;n<r;n++)Fe.set(e[n],"globalEval",!t||Fe.get(t[n],"globalEval"))}function b(e,t,n,r,i){for(var o,s,a,u,c,l,f=t.createDocumentFragment(),d=[],p=0,h=e.length;p<h;p++)if((o=e[p])||0===o)if("object"===he.type(o))he.merge(d,o.nodeType?[o]:o);else if(Qe.test(o)){for(s=s||f.appendChild(t.createElement("div")),a=(Ve.exec(o)||["",""])[1].toLowerCase(),u=Ue[a]||Ue._default,s.innerHTML=u[1]+he.htmlPrefilter(o)+u[2],l=u[0];l--;)s=s.lastChild;he.merge(d,s.childNodes),s=f.firstChild,s.textContent=""}else d.push(t.createTextNode(o));for(f.textContent="",p=0;o=d[p++];)if(r&&he.inArray(o,r)>-1)i&&i.push(o);else if(c=he.contains(o.ownerDocument,o),s=y(f.appendChild(o),"script"),c&&x(s),n)for(l=0;o=s[l++];)Xe.test(o.type||"")&&n.push(o);return f}function w(){return!0}function T(){return!1}function S(){try{return ne.activeElement}catch(e){}}function E(e,t,n,r,i,o){var s,a;if("object"==typeof t){"string"!=typeof n&&(r=r||n,n=void 0);for(a in t)E(e,a,n,r,t[a],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=T;else if(!i)return e;return 1===o&&(s=i,i=function(e){return he().off(e),s.apply(this,arguments)},i.guid=s.guid||(s.guid=he.guid++)),e.each(function(){he.event.add(this,t,i,r,n)})}function C(e,t){return i(e,"table")&&i(11!==t.nodeType?t:t.firstChild,"tr")?he(">tbody",e)[0]||e:e}function k(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function N(e){var t=nt.exec(e.type);return t?e.type=t[1]:e.removeAttribute("type"),e}function j(e,t){var n,r,i,o,s,a,u,c;if(1===t.nodeType){if(Fe.hasData(e)&&(o=Fe.access(e),s=Fe.set(t,o),c=o.events)){delete s.handle,s.events={};for(i in c)for(n=0,r=c[i].length;n<r;n++)he.event.add(t,i,c[i][n])}$e.hasData(e)&&(a=$e.access(e),u=he.extend({},a),$e.set(t,u))}}function A(e,t){var n=t.nodeName.toLowerCase();"input"===n&&ze.test(e.type)?t.checked=e.checked:"input"!==n&&"textarea"!==n||(t.defaultValue=e.defaultValue)}function L(e,t,r,i){t=oe.apply([],t);var o,s,a,u,c,l,f=0,d=e.length,p=d-1,h=t[0],g=he.isFunction(h);if(g||d>1&&"string"==typeof h&&!pe.checkClone&&tt.test(h))return e.each(function(n){var o=e.eq(n);g&&(t[0]=h.call(this,n,o.html())),L(o,t,r,i)});if(d&&(o=b(t,e[0].ownerDocument,!1,e,i),s=o.firstChild,1===o.childNodes.length&&(o=s),s||i)){for(a=he.map(y(o,"script"),k),u=a.length;f<d;f++)c=o,f!==p&&(c=he.clone(c,!0,!0),u&&he.merge(a,y(c,"script"))),r.call(e[f],c,f);if(u)for(l=a[a.length-1].ownerDocument,he.map(a,N),f=0;f<u;f++)c=a[f],Xe.test(c.type||"")&&!Fe.access(c,"globalEval")&&he.contains(l,c)&&(c.src?he._evalUrl&&he._evalUrl(c.src):n(c.textContent.replace(rt,""),l))}return e}function D(e,t,n){for(var r,i=t?he.filter(t,e):e,o=0;null!=(r=i[o]);o++)n||1!==r.nodeType||he.cleanData(y(r)),r.parentNode&&(n&&he.contains(r.ownerDocument,r)&&x(y(r,"script")),r.parentNode.removeChild(r));return e}function O(e,t,n){var r,i,o,s,a=e.style;return n=n||st(e),n&&(s=n.getPropertyValue(t)||n[t],""!==s||he.contains(e.ownerDocument,e)||(s=he.style(e,t)),!pe.pixelMarginRight()&&ot.test(s)&&it.test(t)&&(r=a.width,i=a.minWidth,o=a.maxWidth,a.minWidth=a.maxWidth=a.width=s,s=n.width,a.width=r,a.minWidth=i,a.maxWidth=o)),void 0!==s?s+"":s}function q(e,t){return{get:function(){return e()?void delete this.get:(this.get=t).apply(this,arguments)}}}function F(e){if(e in dt)return e;for(var t=e[0].toUpperCase()+e.slice(1),n=ft.length;n--;)if((e=ft[n]+t)in dt)return e}function $(e){var t=he.cssProps[e];return t||(t=he.cssProps[e]=F(e)||e),t}function P(e,t,n){var r=Re.exec(t);return r?Math.max(0,r[2]-(n||0))+(r[3]||"px"):t}function H(e,t,n,r,i){var o,s=0;for(o=n===(r?"border":"content")?4:"width"===t?1:0;o<4;o+=2)"margin"===n&&(s+=he.css(e,n+_e[o],!0,i)),r?("content"===n&&(s-=he.css(e,"padding"+_e[o],!0,i)),"margin"!==n&&(s-=he.css(e,"border"+_e[o]+"Width",!0,i))):(s+=he.css(e,"padding"+_e[o],!0,i),"padding"!==n&&(s+=he.css(e,"border"+_e[o]+"Width",!0,i)));return s}function I(e,t,n){var r,i=st(e),o=O(e,t,i),s="border-box"===he.css(e,"boxSizing",!1,i);return ot.test(o)?o:(r=s&&(pe.boxSizingReliable()||o===e.style[t]),"auto"===o&&(o=e["offset"+t[0].toUpperCase()+t.slice(1)]),(o=parseFloat(o)||0)+H(e,t,n||(s?"border":"content"),r,i)+"px")}function R(e,t,n,r,i){return new R.prototype.init(e,t,n,r,i)}function _(){ht&&(!1===ne.hidden&&e.requestAnimationFrame?e.requestAnimationFrame(_):e.setTimeout(_,he.fx.interval),he.fx.tick())}function M(){return e.setTimeout(function(){pt=void 0}),pt=he.now()}function W(e,t){var n,r=0,i={height:e};for(t=t?1:0;r<4;r+=2-t)n=_e[r],i["margin"+n]=i["padding"+n]=e;return t&&(i.opacity=i.width=e),i}function B(e,t,n){for(var r,i=(X.tweeners[t]||[]).concat(X.tweeners["*"]),o=0,s=i.length;o<s;o++)if(r=i[o].call(n,t,e))return r}function z(e,t,n){var r,i,o,s,a,u,c,l,f="width"in t||"height"in t,d=this,p={},h=e.style,g=e.nodeType&&Me(e),v=Fe.get(e,"fxshow");n.queue||(s=he._queueHooks(e,"fx"),null==s.unqueued&&(s.unqueued=0,a=s.empty.fire,s.empty.fire=function(){s.unqueued||a()}),s.unqueued++,d.always(function(){d.always(function(){s.unqueued--,he.queue(e,"fx").length||s.empty.fire()})}));for(r in t)if(i=t[r],gt.test(i)){if(delete t[r],o=o||"toggle"===i,i===(g?"hide":"show")){if("show"!==i||!v||void 0===v[r])continue;g=!0}p[r]=v&&v[r]||he.style(e,r)}if((u=!he.isEmptyObject(t))||!he.isEmptyObject(p)){f&&1===e.nodeType&&(n.overflow=[h.overflow,h.overflowX,h.overflowY],c=v&&v.display,null==c&&(c=Fe.get(e,"display")),l=he.css(e,"display"),"none"===l&&(c?l=c:(m([e],!0),c=e.style.display||c,l=he.css(e,"display"),m([e]))),("inline"===l||"inline-block"===l&&null!=c)&&"none"===he.css(e,"float")&&(u||(d.done(function(){h.display=c}),null==c&&(l=h.display,c="none"===l?"":l)),h.display="inline-block")),n.overflow&&(h.overflow="hidden",d.always(function(){h.overflow=n.overflow[0],h.overflowX=n.overflow[1],h.overflowY=n.overflow[2]})),u=!1;for(r in p)u||(v?"hidden"in v&&(g=v.hidden):v=Fe.access(e,"fxshow",{display:c}),o&&(v.hidden=!g),g&&m([e],!0),d.done(function(){g||m([e]),Fe.remove(e,"fxshow");for(r in p)he.style(e,r,p[r])})),u=B(g?v[r]:0,r,d),r in v||(v[r]=u.start,g&&(u.end=u.start,u.start=0))}}function V(e,t){var n,r,i,o,s;for(n in e)if(r=he.camelCase(n),i=t[r],o=e[n],Array.isArray(o)&&(i=o[1],o=e[n]=o[0]),n!==r&&(e[r]=o,delete e[n]),(s=he.cssHooks[r])&&"expand"in s){o=s.expand(o),delete e[r];for(n in o)n in e||(e[n]=o[n],t[n]=i)}else t[r]=i}function X(e,t,n){var r,i,o=0,s=X.prefilters.length,a=he.Deferred().always(function(){delete u.elem}),u=function(){if(i)return!1;for(var t=pt||M(),n=Math.max(0,c.startTime+c.duration-t),r=n/c.duration||0,o=1-r,s=0,u=c.tweens.length;s<u;s++)c.tweens[s].run(o);return a.notifyWith(e,[c,o,n]),o<1&&u?n:(u||a.notifyWith(e,[c,1,0]),a.resolveWith(e,[c]),!1)},c=a.promise({elem:e,props:he.extend({},t),opts:he.extend(!0,{specialEasing:{},easing:he.easing._default},n),originalProperties:t,originalOptions:n,startTime:pt||M(),duration:n.duration,tweens:[],createTween:function(t,n){var r=he.Tween(e,c.opts,t,n,c.opts.specialEasing[t]||c.opts.easing);return c.tweens.push(r),r},stop:function(t){var n=0,r=t?c.tweens.length:0;if(i)return this;for(i=!0;n<r;n++)c.tweens[n].run(1);return t?(a.notifyWith(e,[c,1,0]),a.resolveWith(e,[c,t])):a.rejectWith(e,[c,t]),this}}),l=c.props;for(V(l,c.opts.specialEasing);o<s;o++)if(r=X.prefilters[o].call(c,e,l,c.opts))return he.isFunction(r.stop)&&(he._queueHooks(c.elem,c.opts.queue).stop=he.proxy(r.stop,r)),r;return he.map(l,B,c),he.isFunction(c.opts.start)&&c.opts.start.call(e,c),c.progress(c.opts.progress).done(c.opts.done,c.opts.complete).fail(c.opts.fail).always(c.opts.always),he.fx.timer(he.extend(u,{elem:e,anim:c,queue:c.opts.queue})),c}function U(e){return(e.match(Ae)||[]).join(" ")}function Q(e){return e.getAttribute&&e.getAttribute("class")||""}function Y(e,t,n,r){var i;if(Array.isArray(t))he.each(t,function(t,i){n||kt.test(e)?r(e,i):Y(e+"["+("object"==typeof i&&null!=i?t:"")+"]",i,n,r)});else if(n||"object"!==he.type(t))r(e,t);else for(i in t)Y(e+"["+i+"]",t[i],n,r)}function J(e){return function(t,n){"string"!=typeof t&&(n=t,t="*");var r,i=0,o=t.toLowerCase().match(Ae)||[];if(he.isFunction(n))for(;r=o[i++];)"+"===r[0]?(r=r.slice(1)||"*",(e[r]=e[r]||[]).unshift(n)):(e[r]=e[r]||[]).push(n)}}function G(e,t,n,r){function i(a){var u;return o[a]=!0,he.each(e[a]||[],function(e,a){var c=a(t,n,r);return"string"!=typeof c||s||o[c]?s?!(u=c):void 0:(t.dataTypes.unshift(c),i(c),!1)}),u}var o={},s=e===It;return i(t.dataTypes[0])||!o["*"]&&i("*")}function K(e,t){var n,r,i=he.ajaxSettings.flatOptions||{};for(n in t)void 0!==t[n]&&((i[n]?e:r||(r={}))[n]=t[n]);return r&&he.extend(!0,e,r),e}function Z(e,t,n){for(var r,i,o,s,a=e.contents,u=e.dataTypes;"*"===u[0];)u.shift(),void 0===r&&(r=e.mimeType||t.getResponseHeader("Content-Type"));if(r)for(i in a)if(a[i]&&a[i].test(r)){u.unshift(i);break}if(u[0]in n)o=u[0];else{for(i in n){if(!u[0]||e.converters[i+" "+u[0]]){o=i;break}s||(s=i)}o=o||s}if(o)return o!==u[0]&&u.unshift(o),n[o]}function ee(e,t,n,r){var i,o,s,a,u,c={},l=e.dataTypes.slice();if(l[1])for(s in e.converters)c[s.toLowerCase()]=e.converters[s];for(o=l.shift();o;)if(e.responseFields[o]&&(n[e.responseFields[o]]=t),!u&&r&&e.dataFilter&&(t=e.dataFilter(t,e.dataType)),u=o,o=l.shift())if("*"===o)o=u;else if("*"!==u&&u!==o){if(!(s=c[u+" "+o]||c["* "+o]))for(i in c)if(a=i.split(" "),a[1]===o&&(s=c[u+" "+a[0]]||c["* "+a[0]])){!0===s?s=c[i]:!0!==c[i]&&(o=a[0],l.unshift(a[1]));break}if(!0!==s)if(s&&e.throws)t=s(t);else try{t=s(t)}catch(e){return{state:"parsererror",error:s?e:"No conversion from "+u+" to "+o}}}return{state:"success",data:t}}var te=[],ne=e.document,re=Object.getPrototypeOf,ie=te.slice,oe=te.concat,se=te.push,ae=te.indexOf,ue={},ce=ue.toString,le=ue.hasOwnProperty,fe=le.toString,de=fe.call(Object),pe={},he=function(e,t){return new he.fn.init(e,t)},ge=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,ve=/^-ms-/,me=/-([a-z])/g,ye=function(e,t){return t.toUpperCase()};he.fn=he.prototype={jquery:"3.2.1",constructor:he,length:0,toArray:function(){return ie.call(this)},get:function(e){return null==e?ie.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=he.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return he.each(this,e)},map:function(e){return this.pushStack(he.map(this,function(t,n){return e.call(t,n,t)}))},slice:function(){return this.pushStack(ie.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(n>=0&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:se,sort:te.sort,splice:te.splice},he.extend=he.fn.extend=function(){var e,t,n,r,i,o,s=arguments[0]||{},a=1,u=arguments.length,c=!1;for("boolean"==typeof s&&(c=s,s=arguments[a]||{},a++),"object"==typeof s||he.isFunction(s)||(s={}),a===u&&(s=this,a--);a<u;a++)if(null!=(e=arguments[a]))for(t in e)n=s[t],r=e[t],s!==r&&(c&&r&&(he.isPlainObject(r)||(i=Array.isArray(r)))?(i?(i=!1,o=n&&Array.isArray(n)?n:[]):o=n&&he.isPlainObject(n)?n:{},s[t]=he.extend(c,o,r)):void 0!==r&&(s[t]=r));return s},he.extend({expando:"jQuery"+("3.2.1"+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isFunction:function(e){return"function"===he.type(e)},isWindow:function(e){return null!=e&&e===e.window},isNumeric:function(e){var t=he.type(e);return("number"===t||"string"===t)&&!isNaN(e-parseFloat(e))},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==ce.call(e))&&(!(t=re(e))||"function"==typeof(n=le.call(t,"constructor")&&t.constructor)&&fe.call(n)===de)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},type:function(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?ue[ce.call(e)]||"object":typeof e},globalEval:function(e){n(e)},camelCase:function(e){return e.replace(ve,"ms-").replace(me,ye)},each:function(e,t){var n,i=0;if(r(e))for(n=e.length;i<n&&!1!==t.call(e[i],i,e[i]);i++);else for(i in e)if(!1===t.call(e[i],i,e[i]))break;return e},trim:function(e){return null==e?"":(e+"").replace(ge,"")},makeArray:function(e,t){var n=t||[];return null!=e&&(r(Object(e))?he.merge(n,"string"==typeof e?[e]:e):se.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:ae.call(t,e,n)},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,s=!n;i<o;i++)!t(e[i],i)!==s&&r.push(e[i]);return r},map:function(e,t,n){var i,o,s=0,a=[];if(r(e))for(i=e.length;s<i;s++)null!=(o=t(e[s],s,n))&&a.push(o);else for(s in e)null!=(o=t(e[s],s,n))&&a.push(o);return oe.apply([],a)},guid:1,proxy:function(e,t){var n,r,i;if("string"==typeof t&&(n=e[t],t=e,e=n),he.isFunction(e))return r=ie.call(arguments,2),i=function(){return e.apply(t||this,r.concat(ie.call(arguments)))},i.guid=e.guid=e.guid||he.guid++,i},now:Date.now,support:pe}),"function"==typeof Symbol&&(he.fn[Symbol.iterator]=te[Symbol.iterator]),he.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(e,t){ue["[object "+t+"]"]=t.toLowerCase()});var xe=function(e){function t(e,t,n,r){var i,o,s,a,u,l,d,p=t&&t.ownerDocument,h=t?t.nodeType:9;if(n=n||[],"string"!=typeof e||!e||1!==h&&9!==h&&11!==h)return n;if(!r&&((t?t.ownerDocument||t:R)!==D&&L(t),t=t||D,q)){if(11!==h&&(u=ge.exec(e)))if(i=u[1]){if(9===h){if(!(s=t.getElementById(i)))return n;if(s.id===i)return n.push(s),n}else if(p&&(s=p.getElementById(i))&&H(t,s)&&s.id===i)return n.push(s),n}else{if(u[2])return J.apply(n,t.getElementsByTagName(e)),n;if((i=u[3])&&b.getElementsByClassName&&t.getElementsByClassName)return J.apply(n,t.getElementsByClassName(i)),n}if(b.qsa&&!z[e+" "]&&(!F||!F.test(e))){if(1!==h)p=t,d=e;else if("object"!==t.nodeName.toLowerCase()){for((a=t.getAttribute("id"))?a=a.replace(xe,be):t.setAttribute("id",a=I),l=E(e),o=l.length;o--;)l[o]="#"+a+" "+f(l[o]);d=l.join(","),p=ve.test(e)&&c(t.parentNode)||t}if(d)try{return J.apply(n,p.querySelectorAll(d)),n}catch(e){}finally{a===I&&t.removeAttribute("id")}}}return k(e.replace(oe,"$1"),t,n,r)}function n(){function e(n,r){return t.push(n+" ")>w.cacheLength&&delete e[t.shift()],e[n+" "]=r}var t=[];return e}function r(e){return e[I]=!0,e}function i(e){var t=D.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function o(e,t){for(var n=e.split("|"),r=n.length;r--;)w.attrHandle[n[r]]=t}function s(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)for(;n=n.nextSibling;)if(n===t)return-1;return e?1:-1}function a(e){return function(t){return"form"in t?t.parentNode&&!1===t.disabled?"label"in t?"label"in t.parentNode?t.parentNode.disabled===e:t.disabled===e:t.isDisabled===e||t.isDisabled!==!e&&Te(t)===e:t.disabled===e:"label"in t&&t.disabled===e}}function u(e){return r(function(t){return t=+t,r(function(n,r){for(var i,o=e([],n.length,t),s=o.length;s--;)n[i=o[s]]&&(n[i]=!(r[i]=n[i]))})})}function c(e){return e&&void 0!==e.getElementsByTagName&&e}function l(){}function f(e){for(var t=0,n=e.length,r="";t<n;t++)r+=e[t].value;return r}function d(e,t,n){var r=t.dir,i=t.next,o=i||r,s=n&&"parentNode"===o,a=M++;return t.first?function(t,n,i){for(;t=t[r];)if(1===t.nodeType||s)return e(t,n,i);return!1}:function(t,n,u){var c,l,f,d=[_,a];if(u){for(;t=t[r];)if((1===t.nodeType||s)&&e(t,n,u))return!0}else for(;t=t[r];)if(1===t.nodeType||s)if(f=t[I]||(t[I]={}),l=f[t.uniqueID]||(f[t.uniqueID]={}),i&&i===t.nodeName.toLowerCase())t=t[r]||t;else{if((c=l[o])&&c[0]===_&&c[1]===a)return d[2]=c[2];if(l[o]=d,d[2]=e(t,n,u))return!0}return!1}}function p(e){return e.length>1?function(t,n,r){for(var i=e.length;i--;)if(!e[i](t,n,r))return!1;return!0}:e[0]}function h(e,n,r){for(var i=0,o=n.length;i<o;i++)t(e,n[i],r);return r}function g(e,t,n,r,i){for(var o,s=[],a=0,u=e.length,c=null!=t;a<u;a++)(o=e[a])&&(n&&!n(o,r,i)||(s.push(o),c&&t.push(a)));return s}function v(e,t,n,i,o,s){return i&&!i[I]&&(i=v(i)),o&&!o[I]&&(o=v(o,s)),r(function(r,s,a,u){var c,l,f,d=[],p=[],v=s.length,m=r||h(t||"*",a.nodeType?[a]:a,[]),y=!e||!r&&t?m:g(m,d,e,a,u),x=n?o||(r?e:v||i)?[]:s:y;if(n&&n(y,x,a,u),i)for(c=g(x,p),i(c,[],a,u),l=c.length;l--;)(f=c[l])&&(x[p[l]]=!(y[p[l]]=f));if(r){if(o||e){if(o){for(c=[],l=x.length;l--;)(f=x[l])&&c.push(y[l]=f);o(null,x=[],c,u)}for(l=x.length;l--;)(f=x[l])&&(c=o?K(r,f):d[l])>-1&&(r[c]=!(s[c]=f))}}else x=g(x===s?x.splice(v,x.length):x),o?o(null,s,x,u):J.apply(s,x)})}function m(e){for(var t,n,r,i=e.length,o=w.relative[e[0].type],s=o||w.relative[" "],a=o?1:0,u=d(function(e){return e===t},s,!0),c=d(function(e){return K(t,e)>-1},s,!0),l=[function(e,n,r){var i=!o&&(r||n!==N)||((t=n).nodeType?u(e,n,r):c(e,n,r));return t=null,i}];a<i;a++)if(n=w.relative[e[a].type])l=[d(p(l),n)];else{if(n=w.filter[e[a].type].apply(null,e[a].matches),n[I]){for(r=++a;r<i&&!w.relative[e[r].type];r++);return v(a>1&&p(l),a>1&&f(e.slice(0,a-1).concat({value:" "===e[a-2].type?"*":""})).replace(oe,"$1"),n,a<r&&m(e.slice(a,r)),r<i&&m(e=e.slice(r)),r<i&&f(e))}l.push(n)}return p(l)}function y(e,n){var i=n.length>0,o=e.length>0,s=function(r,s,a,u,c){var l,f,d,p=0,h="0",v=r&&[],m=[],y=N,x=r||o&&w.find.TAG("*",c),b=_+=null==y?1:Math.random()||.1,T=x.length;for(c&&(N=s===D||s||c);h!==T&&null!=(l=x[h]);h++){if(o&&l){for(f=0,s||l.ownerDocument===D||(L(l),a=!q);d=e[f++];)if(d(l,s||D,a)){u.push(l);break}c&&(_=b)}i&&((l=!d&&l)&&p--,r&&v.push(l))}if(p+=h,i&&h!==p){for(f=0;d=n[f++];)d(v,m,s,a);if(r){if(p>0)for(;h--;)v[h]||m[h]||(m[h]=Q.call(u));m=g(m)}J.apply(u,m),c&&!r&&m.length>0&&p+n.length>1&&t.uniqueSort(u)}return c&&(_=b,N=y),v};return i?r(s):s}var x,b,w,T,S,E,C,k,N,j,A,L,D,O,q,F,$,P,H,I="sizzle"+1*new Date,R=e.document,_=0,M=0,W=n(),B=n(),z=n(),V=function(e,t){return e===t&&(A=!0),0},X={}.hasOwnProperty,U=[],Q=U.pop,Y=U.push,J=U.push,G=U.slice,K=function(e,t){for(var n=0,r=e.length;n<r;n++)if(e[n]===t)return n;return-1},Z="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",ee="[\\x20\\t\\r\\n\\f]",te="(?:\\\\.|[\\w-]|[^\0-\\xa0])+",ne="\\["+ee+"*("+te+")(?:"+ee+"*([*^$|!~]?=)"+ee+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+te+"))|)"+ee+"*\\]",re=":("+te+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+ne+")*)|.*)\\)|)",ie=new RegExp(ee+"+","g"),oe=new RegExp("^"+ee+"+|((?:^|[^\\\\])(?:\\\\.)*)"+ee+"+$","g"),se=new RegExp("^"+ee+"*,"+ee+"*"),ae=new RegExp("^"+ee+"*([>+~]|"+ee+")"+ee+"*"),ue=new RegExp("="+ee+"*([^\\]'\"]*?)"+ee+"*\\]","g"),ce=new RegExp(re),le=new RegExp("^"+te+"$"),fe={ID:new RegExp("^#("+te+")"),CLASS:new RegExp("^\\.("+te+")"),TAG:new RegExp("^("+te+"|[*])"),ATTR:new RegExp("^"+ne),PSEUDO:new RegExp("^"+re),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ee+"*(even|odd|(([+-]|)(\\d*)n|)"+ee+"*(?:([+-]|)"+ee+"*(\\d+)|))"+ee+"*\\)|)","i"),bool:new RegExp("^(?:"+Z+")$","i"),needsContext:new RegExp("^"+ee+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ee+"*((?:-\\d)?\\d*)"+ee+"*\\)|)(?=[^-]|$)","i")},de=/^(?:input|select|textarea|button)$/i,pe=/^h\d$/i,he=/^[^{]+\{\s*\[native \w/,ge=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ve=/[+~]/,me=new RegExp("\\\\([\\da-f]{1,6}"+ee+"?|("+ee+")|.)","ig"),ye=function(e,t,n){var r="0x"+t-65536;return r!==r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},xe=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,be=function(e,t){return t?"\0"===e?"�":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},we=function(){L()},Te=d(function(e){return!0===e.disabled&&("form"in e||"label"in e)},{dir:"parentNode",next:"legend"});try{J.apply(U=G.call(R.childNodes),R.childNodes),U[R.childNodes.length].nodeType}catch(e){J={apply:U.length?function(e,t){Y.apply(e,G.call(t))}:function(e,t){for(var n=e.length,r=0;e[n++]=t[r++];);e.length=n-1}}}b=t.support={},S=t.isXML=function(e){var t=e&&(e.ownerDocument||e).documentElement;return!!t&&"HTML"!==t.nodeName},L=t.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:R;return r!==D&&9===r.nodeType&&r.documentElement?(D=r,O=D.documentElement,q=!S(D),R!==D&&(n=D.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",we,!1):n.attachEvent&&n.attachEvent("onunload",we)),b.attributes=i(function(e){return e.className="i",!e.getAttribute("className")}),b.getElementsByTagName=i(function(e){return e.appendChild(D.createComment("")),!e.getElementsByTagName("*").length}),b.getElementsByClassName=he.test(D.getElementsByClassName),b.getById=i(function(e){return O.appendChild(e).id=I,!D.getElementsByName||!D.getElementsByName(I).length}),b.getById?(w.filter.ID=function(e){var t=e.replace(me,ye);return function(e){return e.getAttribute("id")===t}},w.find.ID=function(e,t){if(void 0!==t.getElementById&&q){var n=t.getElementById(e);return n?[n]:[]}}):(w.filter.ID=function(e){var t=e.replace(me,ye);return function(e){var n=void 0!==e.getAttributeNode&&e.getAttributeNode("id");return n&&n.value===t}},w.find.ID=function(e,t){if(void 0!==t.getElementById&&q){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];for(i=t.getElementsByName(e),r=0;o=i[r++];)if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),w.find.TAG=b.getElementsByTagName?function(e,t){return void 0!==t.getElementsByTagName?t.getElementsByTagName(e):b.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){for(;n=o[i++];)1===n.nodeType&&r.push(n);return r}return o},w.find.CLASS=b.getElementsByClassName&&function(e,t){if(void 0!==t.getElementsByClassName&&q)return t.getElementsByClassName(e)},$=[],F=[],(b.qsa=he.test(D.querySelectorAll))&&(i(function(e){O.appendChild(e).innerHTML="<a id='"+I+"'></a><select id='"+I+"-\r\\' msallowcapture=''><option selected=''></option></select>",e.querySelectorAll("[msallowcapture^='']").length&&F.push("[*^$]="+ee+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||F.push("\\["+ee+"*(?:value|"+Z+")"),e.querySelectorAll("[id~="+I+"-]").length||F.push("~="),e.querySelectorAll(":checked").length||F.push(":checked"),e.querySelectorAll("a#"+I+"+*").length||F.push(".#.+[+~]")}),i(function(e){e.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var t=D.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&F.push("name"+ee+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&F.push(":enabled",":disabled"),O.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&F.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),F.push(",.*:")})),(b.matchesSelector=he.test(P=O.matches||O.webkitMatchesSelector||O.mozMatchesSelector||O.oMatchesSelector||O.msMatchesSelector))&&i(function(e){b.disconnectedMatch=P.call(e,"*"),P.call(e,"[s!='']:x"),$.push("!=",re)}),F=F.length&&new RegExp(F.join("|")),$=$.length&&new RegExp($.join("|")),t=he.test(O.compareDocumentPosition),H=t||he.test(O.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)for(;t=t.parentNode;)if(t===e)return!0;return!1},V=t?function(e,t){if(e===t)return A=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1,1&n||!b.sortDetached&&t.compareDocumentPosition(e)===n?e===D||e.ownerDocument===R&&H(R,e)?-1:t===D||t.ownerDocument===R&&H(R,t)?1:j?K(j,e)-K(j,t):0:4&n?-1:1)}:function(e,t){if(e===t)return A=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],u=[t];if(!i||!o)return e===D?-1:t===D?1:i?-1:o?1:j?K(j,e)-K(j,t):0;if(i===o)return s(e,t);for(n=e;n=n.parentNode;)a.unshift(n);for(n=t;n=n.parentNode;)u.unshift(n);for(;a[r]===u[r];)r++;return r?s(a[r],u[r]):a[r]===R?-1:u[r]===R?1:0},D):D},t.matches=function(e,n){return t(e,null,null,n)},t.matchesSelector=function(e,n){if((e.ownerDocument||e)!==D&&L(e),n=n.replace(ue,"='$1']"),b.matchesSelector&&q&&!z[n+" "]&&(!$||!$.test(n))&&(!F||!F.test(n)))try{var r=P.call(e,n);if(r||b.disconnectedMatch||e.document&&11!==e.document.nodeType)return r}catch(e){}return t(n,D,null,[e]).length>0},t.contains=function(e,t){return(e.ownerDocument||e)!==D&&L(e),H(e,t)},t.attr=function(e,t){(e.ownerDocument||e)!==D&&L(e);var n=w.attrHandle[t.toLowerCase()],r=n&&X.call(w.attrHandle,t.toLowerCase())?n(e,t,!q):void 0;return void 0!==r?r:b.attributes||!q?e.getAttribute(t):(r=e.getAttributeNode(t))&&r.specified?r.value:null},t.escape=function(e){return(e+"").replace(xe,be)},t.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},t.uniqueSort=function(e){var t,n=[],r=0,i=0;if(A=!b.detectDuplicates,j=!b.sortStable&&e.slice(0),e.sort(V),A){for(;t=e[i++];)t===e[i]&&(r=n.push(i));for(;r--;)e.splice(n[r],1)}return j=null,e},T=t.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=T(e)}else if(3===i||4===i)return e.nodeValue}else for(;t=e[r++];)n+=T(t);return n},w=t.selectors={cacheLength:50,createPseudo:r,match:fe,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(me,ye),e[3]=(e[3]||e[4]||e[5]||"").replace(me,ye),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||t.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&t.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return fe.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&ce.test(n)&&(t=E(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(me,ye).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=W[e+" "];return t||(t=new RegExp("(^|"+ee+")"+e+"("+ee+"|$)"))&&W(e,function(e){return t.test("string"==typeof e.className&&e.className||void 0!==e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(e,n,r){return function(i){var o=t.attr(i,e);return null==o?"!="===n:!n||(o+="","="===n?o===r:"!="===n?o!==r:"^="===n?r&&0===o.indexOf(r):"*="===n?r&&o.indexOf(r)>-1:"$="===n?r&&o.slice(-r.length)===r:"~="===n?(" "+o.replace(ie," ")+" ").indexOf(r)>-1:"|="===n&&(o===r||o.slice(0,r.length+1)===r+"-"))}},CHILD:function(e,t,n,r,i){var o="nth"!==e.slice(0,3),s="last"!==e.slice(-4),a="of-type"===t;return 1===r&&0===i?function(e){return!!e.parentNode}:function(t,n,u){var c,l,f,d,p,h,g=o!==s?"nextSibling":"previousSibling",v=t.parentNode,m=a&&t.nodeName.toLowerCase(),y=!u&&!a,x=!1;if(v){if(o){for(;g;){for(d=t;d=d[g];)if(a?d.nodeName.toLowerCase()===m:1===d.nodeType)return!1;h=g="only"===e&&!h&&"nextSibling"}return!0}if(h=[s?v.firstChild:v.lastChild],s&&y){for(d=v,f=d[I]||(d[I]={}),l=f[d.uniqueID]||(f[d.uniqueID]={}),c=l[e]||[],p=c[0]===_&&c[1],x=p&&c[2],d=p&&v.childNodes[p];d=++p&&d&&d[g]||(x=p=0)||h.pop();)if(1===d.nodeType&&++x&&d===t){l[e]=[_,p,x];break}}else if(y&&(d=t,f=d[I]||(d[I]={}),l=f[d.uniqueID]||(f[d.uniqueID]={}),c=l[e]||[],p=c[0]===_&&c[1],x=p),!1===x)for(;(d=++p&&d&&d[g]||(x=p=0)||h.pop())&&((a?d.nodeName.toLowerCase()!==m:1!==d.nodeType)||!++x||(y&&(f=d[I]||(d[I]={}),l=f[d.uniqueID]||(f[d.uniqueID]={}),l[e]=[_,x]),d!==t)););return(x-=i)===r||x%r==0&&x/r>=0}}},PSEUDO:function(e,n){var i,o=w.pseudos[e]||w.setFilters[e.toLowerCase()]||t.error("unsupported pseudo: "+e);return o[I]?o(n):o.length>1?(i=[e,e,"",n],w.setFilters.hasOwnProperty(e.toLowerCase())?r(function(e,t){for(var r,i=o(e,n),s=i.length;s--;)r=K(e,i[s]),e[r]=!(t[r]=i[s])}):function(e){return o(e,0,i)}):o}},pseudos:{not:r(function(e){var t=[],n=[],i=C(e.replace(oe,"$1"));return i[I]?r(function(e,t,n,r){for(var o,s=i(e,null,r,[]),a=e.length;a--;)(o=s[a])&&(e[a]=!(t[a]=o))}):function(e,r,o){return t[0]=e,i(t,null,o,n),t[0]=null,!n.pop()}}),has:r(function(e){return function(n){return t(e,n).length>0}}),contains:r(function(e){return e=e.replace(me,ye),function(t){return(t.textContent||t.innerText||T(t)).indexOf(e)>-1}}),lang:r(function(e){return le.test(e||"")||t.error("unsupported lang: "+e),e=e.replace(me,ye).toLowerCase(),function(t){var n;do{if(n=q?t.lang:t.getAttribute("xml:lang")||t.getAttribute("lang"))return(n=n.toLowerCase())===e||0===n.indexOf(e+"-")}while((t=t.parentNode)&&1===t.nodeType);return!1}}),target:function(t){var n=e.location&&e.location.hash;return n&&n.slice(1)===t.id},root:function(e){return e===O},focus:function(e){return e===D.activeElement&&(!D.hasFocus||D.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:a(!1),disabled:a(!0),checked:function(e){var t=e.nodeName.toLowerCase() +;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.matchesSelector(r,e)?[r]:[]:he.find.matches(e,he.grep(t,function(e){return 1===e.nodeType}))},he.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(he(e).filter(function(){for(t=0;t<r;t++)if(he.contains(i[t],this))return!0}));for(n=this.pushStack([]),t=0;t<r;t++)he.find(e,i[t],n);return r>1?he.uniqueSort(n):n},filter:function(e){return this.pushStack(o(this,e||[],!1))},not:function(e){return this.pushStack(o(this,e||[],!0))},is:function(e){return!!o(this,"string"==typeof e&&Te.test(e)?he(e):e||[],!1).length}});var Ce,ke=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(he.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||Ce,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&e.length>=3?[null,e,null]:ke.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof he?t[0]:t,he.merge(this,he.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:ne,!0)),Se.test(r[1])&&he.isPlainObject(t))for(r in t)he.isFunction(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return i=ne.getElementById(r[2]),i&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):he.isFunction(e)?void 0!==n.ready?n.ready(e):e(he):he.makeArray(e,this)}).prototype=he.fn,Ce=he(ne);var Ne=/^(?:parents|prev(?:Until|All))/,je={children:!0,contents:!0,next:!0,prev:!0};he.fn.extend({has:function(e){var t=he(e,this),n=t.length;return this.filter(function(){for(var e=0;e<n;e++)if(he.contains(this,t[e]))return!0})},closest:function(e,t){var n,r=0,i=this.length,o=[],s="string"!=typeof e&&he(e);if(!Te.test(e))for(;r<i;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(n.nodeType<11&&(s?s.index(n)>-1:1===n.nodeType&&he.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(o.length>1?he.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?ae.call(he(e),this[0]):ae.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(he.uniqueSort(he.merge(this.get(),he(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),he.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return be(e,"parentNode")},parentsUntil:function(e,t,n){return be(e,"parentNode",n)},next:function(e){return s(e,"nextSibling")},prev:function(e){return s(e,"previousSibling")},nextAll:function(e){return be(e,"nextSibling")},prevAll:function(e){return be(e,"previousSibling")},nextUntil:function(e,t,n){return be(e,"nextSibling",n)},prevUntil:function(e,t,n){return be(e,"previousSibling",n)},siblings:function(e){return we((e.parentNode||{}).firstChild,e)},children:function(e){return we(e.firstChild)},contents:function(e){return i(e,"iframe")?e.contentDocument:(i(e,"template")&&(e=e.content||e),he.merge([],e.childNodes))}},function(e,t){he.fn[e]=function(n,r){var i=he.map(this,t,n);return"Until"!==e.slice(-5)&&(r=n),r&&"string"==typeof r&&(i=he.filter(r,i)),this.length>1&&(je[e]||he.uniqueSort(i),Ne.test(e)&&i.reverse()),this.pushStack(i)}});var Ae=/[^\x20\t\r\n\f]+/g;he.Callbacks=function(e){e="string"==typeof e?a(e):he.extend({},e);var t,n,r,i,o=[],s=[],u=-1,c=function(){for(i=i||e.once,r=t=!0;s.length;u=-1)for(n=s.shift();++u<o.length;)!1===o[u].apply(n[0],n[1])&&e.stopOnFalse&&(u=o.length,n=!1);e.memory||(n=!1),t=!1,i&&(o=n?[]:"")},l={add:function(){return o&&(n&&!t&&(u=o.length-1,s.push(n)),function t(n){he.each(n,function(n,r){he.isFunction(r)?e.unique&&l.has(r)||o.push(r):r&&r.length&&"string"!==he.type(r)&&t(r)})}(arguments),n&&!t&&c()),this},remove:function(){return he.each(arguments,function(e,t){for(var n;(n=he.inArray(t,o,n))>-1;)o.splice(n,1),n<=u&&u--}),this},has:function(e){return e?he.inArray(e,o)>-1:o.length>0},empty:function(){return o&&(o=[]),this},disable:function(){return i=s=[],o=n="",this},disabled:function(){return!o},lock:function(){return i=s=[],n||t||(o=n=""),this},locked:function(){return!!i},fireWith:function(e,n){return i||(n=n||[],n=[e,n.slice?n.slice():n],s.push(n),t||c()),this},fire:function(){return l.fireWith(this,arguments),this},fired:function(){return!!r}};return l},he.extend({Deferred:function(t){var n=[["notify","progress",he.Callbacks("memory"),he.Callbacks("memory"),2],["resolve","done",he.Callbacks("once memory"),he.Callbacks("once memory"),0,"resolved"],["reject","fail",he.Callbacks("once memory"),he.Callbacks("once memory"),1,"rejected"]],r="pending",i={state:function(){return r},always:function(){return o.done(arguments).fail(arguments),this},catch:function(e){return i.then(null,e)},pipe:function(){var e=arguments;return he.Deferred(function(t){he.each(n,function(n,r){var i=he.isFunction(e[r[4]])&&e[r[4]];o[r[1]](function(){var e=i&&i.apply(this,arguments);e&&he.isFunction(e.promise)?e.promise().progress(t.notify).done(t.resolve).fail(t.reject):t[r[0]+"With"](this,i?[e]:arguments)})}),e=null}).promise()},then:function(t,r,i){function o(t,n,r,i){return function(){var a=this,l=arguments,f=function(){var e,f;if(!(t<s)){if((e=r.apply(a,l))===n.promise())throw new TypeError("Thenable self-resolution");f=e&&("object"==typeof e||"function"==typeof e)&&e.then,he.isFunction(f)?i?f.call(e,o(s,n,u,i),o(s,n,c,i)):(s++,f.call(e,o(s,n,u,i),o(s,n,c,i),o(s,n,u,n.notifyWith))):(r!==u&&(a=void 0,l=[e]),(i||n.resolveWith)(a,l))}},d=i?f:function(){try{f()}catch(e){he.Deferred.exceptionHook&&he.Deferred.exceptionHook(e,d.stackTrace),t+1>=s&&(r!==c&&(a=void 0,l=[e]),n.rejectWith(a,l))}};t?d():(he.Deferred.getStackHook&&(d.stackTrace=he.Deferred.getStackHook()),e.setTimeout(d))}}var s=0;return he.Deferred(function(e){n[0][3].add(o(0,e,he.isFunction(i)?i:u,e.notifyWith)),n[1][3].add(o(0,e,he.isFunction(t)?t:u)),n[2][3].add(o(0,e,he.isFunction(r)?r:c))}).promise()},promise:function(e){return null!=e?he.extend(e,i):i}},o={};return he.each(n,function(e,t){var s=t[2],a=t[5];i[t[1]]=s.add,a&&s.add(function(){r=a},n[3-e][2].disable,n[0][2].lock),s.add(t[3].fire),o[t[0]]=function(){return o[t[0]+"With"](this===o?void 0:this,arguments),this},o[t[0]+"With"]=s.fireWith}),i.promise(o),t&&t.call(o,o),o},when:function(e){var t=arguments.length,n=t,r=Array(n),i=ie.call(arguments),o=he.Deferred(),s=function(e){return function(n){r[e]=this,i[e]=arguments.length>1?ie.call(arguments):n,--t||o.resolveWith(r,i)}};if(t<=1&&(l(e,o.done(s(n)).resolve,o.reject,!t),"pending"===o.state()||he.isFunction(i[n]&&i[n].then)))return o.then();for(;n--;)l(i[n],s(n),o.reject);return o.promise()}});var Le=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;he.Deferred.exceptionHook=function(t,n){e.console&&e.console.warn&&t&&Le.test(t.name)&&e.console.warn("jQuery.Deferred exception: "+t.message,t.stack,n)},he.readyException=function(t){e.setTimeout(function(){throw t})};var De=he.Deferred();he.fn.ready=function(e){return De.then(e).catch(function(e){he.readyException(e)}),this},he.extend({isReady:!1,readyWait:1,ready:function(e){(!0===e?--he.readyWait:he.isReady)||(he.isReady=!0,!0!==e&&--he.readyWait>0||De.resolveWith(ne,[he]))}}),he.ready.then=De.then,"complete"===ne.readyState||"loading"!==ne.readyState&&!ne.documentElement.doScroll?e.setTimeout(he.ready):(ne.addEventListener("DOMContentLoaded",f),e.addEventListener("load",f));var Oe=function(e,t,n,r,i,o,s){var a=0,u=e.length,c=null==n;if("object"===he.type(n)){i=!0;for(a in n)Oe(e,t,a,n[a],!0,o,s)}else if(void 0!==r&&(i=!0,he.isFunction(r)||(s=!0),c&&(s?(t.call(e,r),t=null):(c=t,t=function(e,t,n){return c.call(he(e),n)})),t))for(;a<u;a++)t(e[a],n,s?r:r.call(e[a],a,t(e[a],n)));return i?e:c?t.call(e):u?t(e[0],n):o},qe=function(e){return 1===e.nodeType||9===e.nodeType||!+e.nodeType};d.uid=1,d.prototype={cache:function(e){var t=e[this.expando];return t||(t={},qe(e)&&(e.nodeType?e[this.expando]=t:Object.defineProperty(e,this.expando,{value:t,configurable:!0}))),t},set:function(e,t,n){var r,i=this.cache(e);if("string"==typeof t)i[he.camelCase(t)]=n;else for(r in t)i[he.camelCase(r)]=t[r];return i},get:function(e,t){return void 0===t?this.cache(e):e[this.expando]&&e[this.expando][he.camelCase(t)]},access:function(e,t,n){return void 0===t||t&&"string"==typeof t&&void 0===n?this.get(e,t):(this.set(e,t,n),void 0!==n?n:t)},remove:function(e,t){var n,r=e[this.expando];if(void 0!==r){if(void 0!==t){Array.isArray(t)?t=t.map(he.camelCase):(t=he.camelCase(t),t=t in r?[t]:t.match(Ae)||[]),n=t.length;for(;n--;)delete r[t[n]]}(void 0===t||he.isEmptyObject(r))&&(e.nodeType?e[this.expando]=void 0:delete e[this.expando])}},hasData:function(e){var t=e[this.expando];return void 0!==t&&!he.isEmptyObject(t)}};var Fe=new d,$e=new d,Pe=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,He=/[A-Z]/g;he.extend({hasData:function(e){return $e.hasData(e)||Fe.hasData(e)},data:function(e,t,n){return $e.access(e,t,n)},removeData:function(e,t){$e.remove(e,t)},_data:function(e,t,n){return Fe.access(e,t,n)},_removeData:function(e,t){Fe.remove(e,t)}}),he.fn.extend({data:function(e,t){var n,r,i,o=this[0],s=o&&o.attributes;if(void 0===e){if(this.length&&(i=$e.get(o),1===o.nodeType&&!Fe.get(o,"hasDataAttrs"))){for(n=s.length;n--;)s[n]&&(r=s[n].name,0===r.indexOf("data-")&&(r=he.camelCase(r.slice(5)),h(o,r,i[r])));Fe.set(o,"hasDataAttrs",!0)}return i}return"object"==typeof e?this.each(function(){$e.set(this,e)}):Oe(this,function(t){var n;if(o&&void 0===t){if(void 0!==(n=$e.get(o,e)))return n;if(void 0!==(n=h(o,e)))return n}else this.each(function(){$e.set(this,e,t)})},null,t,arguments.length>1,null,!0)},removeData:function(e){return this.each(function(){$e.remove(this,e)})}}),he.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=Fe.get(e,t),n&&(!r||Array.isArray(n)?r=Fe.access(e,t,he.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=he.queue(e,t),r=n.length,i=n.shift(),o=he._queueHooks(e,t),s=function(){he.dequeue(e,t)};"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,s,o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return Fe.get(e,n)||Fe.access(e,n,{empty:he.Callbacks("once memory").add(function(){Fe.remove(e,[t+"queue",n])})})}}),he.fn.extend({queue:function(e,t){var n=2;return"string"!=typeof e&&(t=e,e="fx",n--),arguments.length<n?he.queue(this[0],e):void 0===t?this:this.each(function(){var n=he.queue(this,e,t);he._queueHooks(this,e),"fx"===e&&"inprogress"!==n[0]&&he.dequeue(this,e)})},dequeue:function(e){return this.each(function(){he.dequeue(this,e)})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=he.Deferred(),o=this,s=this.length,a=function(){--r||i.resolveWith(o,[o])};for("string"!=typeof e&&(t=e,e=void 0),e=e||"fx";s--;)(n=Fe.get(o[s],e+"queueHooks"))&&n.empty&&(r++,n.empty.add(a));return a(),i.promise(t)}});var Ie=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,Re=new RegExp("^(?:([+-])=|)("+Ie+")([a-z%]*)$","i"),_e=["Top","Right","Bottom","Left"],Me=function(e,t){return e=t||e,"none"===e.style.display||""===e.style.display&&he.contains(e.ownerDocument,e)&&"none"===he.css(e,"display")},We=function(e,t,n,r){var i,o,s={};for(o in t)s[o]=e.style[o],e.style[o]=t[o];i=n.apply(e,r||[]);for(o in t)e.style[o]=s[o];return i},Be={};he.fn.extend({show:function(){return m(this,!0)},hide:function(){return m(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){Me(this)?he(this).show():he(this).hide()})}});var ze=/^(?:checkbox|radio)$/i,Ve=/<([a-z][^\/\0>\x20\t\r\n\f]+)/i,Xe=/^$|\/(?:java|ecma)script/i,Ue={option:[1,"<select multiple='multiple'>","</select>"],thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};Ue.optgroup=Ue.option,Ue.tbody=Ue.tfoot=Ue.colgroup=Ue.caption=Ue.thead,Ue.th=Ue.td;var Qe=/<|&#?\w+;/;!function(){var e=ne.createDocumentFragment(),t=e.appendChild(ne.createElement("div")),n=ne.createElement("input");n.setAttribute("type","radio"),n.setAttribute("checked","checked"),n.setAttribute("name","t"),t.appendChild(n),pe.checkClone=t.cloneNode(!0).cloneNode(!0).lastChild.checked,t.innerHTML="<textarea>x</textarea>",pe.noCloneChecked=!!t.cloneNode(!0).lastChild.defaultValue}();var Ye=ne.documentElement,Je=/^key/,Ge=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ke=/^([^.]*)(?:\.(.+)|)/;he.event={global:{},add:function(e,t,n,r,i){var o,s,a,u,c,l,f,d,p,h,g,v=Fe.get(e);if(v)for(n.handler&&(o=n,n=o.handler,i=o.selector),i&&he.find.matchesSelector(Ye,i),n.guid||(n.guid=he.guid++),(u=v.events)||(u=v.events={}),(s=v.handle)||(s=v.handle=function(t){return void 0!==he&&he.event.triggered!==t.type?he.event.dispatch.apply(e,arguments):void 0}),t=(t||"").match(Ae)||[""],c=t.length;c--;)a=Ke.exec(t[c])||[],p=g=a[1],h=(a[2]||"").split(".").sort(),p&&(f=he.event.special[p]||{},p=(i?f.delegateType:f.bindType)||p,f=he.event.special[p]||{},l=he.extend({type:p,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&he.expr.match.needsContext.test(i),namespace:h.join(".")},o),(d=u[p])||(d=u[p]=[],d.delegateCount=0,f.setup&&!1!==f.setup.call(e,r,h,s)||e.addEventListener&&e.addEventListener(p,s)),f.add&&(f.add.call(e,l),l.handler.guid||(l.handler.guid=n.guid)),i?d.splice(d.delegateCount++,0,l):d.push(l),he.event.global[p]=!0)},remove:function(e,t,n,r,i){var o,s,a,u,c,l,f,d,p,h,g,v=Fe.hasData(e)&&Fe.get(e);if(v&&(u=v.events)){for(t=(t||"").match(Ae)||[""],c=t.length;c--;)if(a=Ke.exec(t[c])||[],p=g=a[1],h=(a[2]||"").split(".").sort(),p){for(f=he.event.special[p]||{},p=(r?f.delegateType:f.bindType)||p,d=u[p]||[],a=a[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),s=o=d.length;o--;)l=d[o],!i&&g!==l.origType||n&&n.guid!==l.guid||a&&!a.test(l.namespace)||r&&r!==l.selector&&("**"!==r||!l.selector)||(d.splice(o,1),l.selector&&d.delegateCount--,f.remove&&f.remove.call(e,l));s&&!d.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||he.removeEvent(e,p,v.handle),delete u[p])}else for(p in u)he.event.remove(e,p+t[c],n,r,!0);he.isEmptyObject(u)&&Fe.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,s,a=he.event.fix(e),u=new Array(arguments.length),c=(Fe.get(this,"events")||{})[a.type]||[],l=he.event.special[a.type]||{};for(u[0]=a,t=1;t<arguments.length;t++)u[t]=arguments[t];if(a.delegateTarget=this,!l.preDispatch||!1!==l.preDispatch.call(this,a)){for(s=he.event.handlers.call(this,a,c),t=0;(i=s[t++])&&!a.isPropagationStopped();)for(a.currentTarget=i.elem,n=0;(o=i.handlers[n++])&&!a.isImmediatePropagationStopped();)a.rnamespace&&!a.rnamespace.test(o.namespace)||(a.handleObj=o,a.data=o.data,void 0!==(r=((he.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,u))&&!1===(a.result=r)&&(a.preventDefault(),a.stopPropagation()));return l.postDispatch&&l.postDispatch.call(this,a),a.result}},handlers:function(e,t){var n,r,i,o,s,a=[],u=t.delegateCount,c=e.target;if(u&&c.nodeType&&!("click"===e.type&&e.button>=1))for(;c!==this;c=c.parentNode||this)if(1===c.nodeType&&("click"!==e.type||!0!==c.disabled)){for(o=[],s={},n=0;n<u;n++)r=t[n],i=r.selector+" ",void 0===s[i]&&(s[i]=r.needsContext?he(i,this).index(c)>-1:he.find(i,this,null,[c]).length),s[i]&&o.push(r);o.length&&a.push({elem:c,handlers:o})}return c=this,u<t.length&&a.push({elem:c,handlers:t.slice(u)}),a},addProp:function(e,t){Object.defineProperty(he.Event.prototype,e,{enumerable:!0,configurable:!0,get:he.isFunction(t)?function(){if(this.originalEvent)return t(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[e]},set:function(t){Object.defineProperty(this,e,{enumerable:!0,configurable:!0,writable:!0,value:t})}})},fix:function(e){return e[he.expando]?e:new he.Event(e)},special:{load:{noBubble:!0},focus:{trigger:function(){if(this!==S()&&this.focus)return this.focus(),!1},delegateType:"focusin"},blur:{trigger:function(){if(this===S()&&this.blur)return this.blur(),!1},delegateType:"focusout"},click:{trigger:function(){if("checkbox"===this.type&&this.click&&i(this,"input"))return this.click(),!1},_default:function(e){return i(e.target,"a")}},beforeunload:{postDispatch:function(e){void 0!==e.result&&e.originalEvent&&(e.originalEvent.returnValue=e.result)}}}},he.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n)},he.Event=function(e,t){if(!(this instanceof he.Event))return new he.Event(e,t);e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||void 0===e.defaultPrevented&&!1===e.returnValue?w:T,this.target=e.target&&3===e.target.nodeType?e.target.parentNode:e.target,this.currentTarget=e.currentTarget,this.relatedTarget=e.relatedTarget):this.type=e,t&&he.extend(this,t),this.timeStamp=e&&e.timeStamp||he.now(),this[he.expando]=!0},he.Event.prototype={constructor:he.Event,isDefaultPrevented:T,isPropagationStopped:T,isImmediatePropagationStopped:T,isSimulated:!1,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=w,e&&!this.isSimulated&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=w,e&&!this.isSimulated&&e.stopPropagation()},stopImmediatePropagation:function(){var e=this.originalEvent;this.isImmediatePropagationStopped=w,e&&!this.isSimulated&&e.stopImmediatePropagation(),this.stopPropagation()}},he.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,char:!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(e){var t=e.button;return null==e.which&&Je.test(e.type)?null!=e.charCode?e.charCode:e.keyCode:!e.which&&void 0!==t&&Ge.test(e.type)?1&t?1:2&t?3:4&t?2:0:e.which}},he.event.addProp),he.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(e,t){he.event.special[e]={delegateType:t,bindType:t,handle:function(e){var n,r=this,i=e.relatedTarget,o=e.handleObj;return i&&(i===r||he.contains(r,i))||(e.type=o.origType,n=o.handler.apply(this,arguments),e.type=t),n}}}),he.fn.extend({on:function(e,t,n,r){return E(this,e,t,n,r)},one:function(e,t,n,r){return E(this,e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,he(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return!1!==t&&"function"!=typeof t||(n=t,t=void 0),!1===n&&(n=T),this.each(function(){he.event.remove(this,e,n,t)})}});var Ze=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,et=/<script|<style|<link/i,tt=/checked\s*(?:[^=]|=\s*.checked.)/i,nt=/^true\/(.*)/,rt=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;he.extend({htmlPrefilter:function(e){return e.replace(Ze,"<$1></$2>")},clone:function(e,t,n){var r,i,o,s,a=e.cloneNode(!0),u=he.contains(e.ownerDocument,e);if(!(pe.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||he.isXMLDoc(e)))for(s=y(a),o=y(e),r=0,i=o.length;r<i;r++)A(o[r],s[r]);if(t)if(n)for(o=o||y(e),s=s||y(a),r=0,i=o.length;r<i;r++)j(o[r],s[r]);else j(e,a);return s=y(a,"script"),s.length>0&&x(s,!u&&y(e,"script")),a},cleanData:function(e){for(var t,n,r,i=he.event.special,o=0;void 0!==(n=e[o]);o++)if(qe(n)){if(t=n[Fe.expando]){if(t.events)for(r in t.events)i[r]?he.event.remove(n,r):he.removeEvent(n,r,t.handle);n[Fe.expando]=void 0}n[$e.expando]&&(n[$e.expando]=void 0)}}}),he.fn.extend({detach:function(e){return D(this,e,!0)},remove:function(e){return D(this,e)},text:function(e){return Oe(this,function(e){return void 0===e?he.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return L(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){C(this,e).appendChild(e)}})},prepend:function(){return L(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=C(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return L(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return L(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(he.cleanData(y(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return he.clone(this,e,t)})},html:function(e){return Oe(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!et.test(e)&&!Ue[(Ve.exec(e)||["",""])[1].toLowerCase()]){e=he.htmlPrefilter(e);try{for(;n<r;n++)t=this[n]||{},1===t.nodeType&&(he.cleanData(y(t,!1)),t.innerHTML=e);t=0}catch(e){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var e=[];return L(this,arguments,function(t){var n=this.parentNode;he.inArray(this,e)<0&&(he.cleanData(y(this)),n&&n.replaceChild(t,this))},e)}}),he.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,t){he.fn[e]=function(e){for(var n,r=[],i=he(e),o=i.length-1,s=0;s<=o;s++)n=s===o?this:this.clone(!0),he(i[s])[t](n),se.apply(r,n.get());return this.pushStack(r)}});var it=/^margin/,ot=new RegExp("^("+Ie+")(?!px)[a-z%]+$","i"),st=function(t){var n=t.ownerDocument.defaultView;return n&&n.opener||(n=e),n.getComputedStyle(t)};!function(){function t(){if(a){a.style.cssText="box-sizing:border-box;position:relative;display:block;margin:auto;border:1px;padding:1px;top:1%;width:50%",a.innerHTML="",Ye.appendChild(s);var t=e.getComputedStyle(a);n="1%"!==t.top,o="2px"===t.marginLeft,r="4px"===t.width,a.style.marginRight="50%",i="4px"===t.marginRight,Ye.removeChild(s),a=null}}var n,r,i,o,s=ne.createElement("div"),a=ne.createElement("div");a.style&&(a.style.backgroundClip="content-box",a.cloneNode(!0).style.backgroundClip="",pe.clearCloneStyle="content-box"===a.style.backgroundClip,s.style.cssText="border:0;width:8px;height:0;top:0;left:-9999px;padding:0;margin-top:1px;position:absolute",s.appendChild(a),he.extend(pe,{pixelPosition:function(){return t(),n},boxSizingReliable:function(){return t(),r},pixelMarginRight:function(){return t(),i},reliableMarginLeft:function(){return t(),o}}))}();var at=/^(none|table(?!-c[ea]).+)/,ut=/^--/,ct={position:"absolute",visibility:"hidden",display:"block"},lt={letterSpacing:"0",fontWeight:"400"},ft=["Webkit","Moz","ms"],dt=ne.createElement("div").style;he.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=O(e,"opacity");return""===n?"1":n}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{float:"cssFloat"},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,s,a=he.camelCase(t),u=ut.test(t),c=e.style;if(u||(t=$(a)),s=he.cssHooks[t]||he.cssHooks[a],void 0===n)return s&&"get"in s&&void 0!==(i=s.get(e,!1,r))?i:c[t];o=typeof n,"string"===o&&(i=Re.exec(n))&&i[1]&&(n=g(e,t,i),o="number"),null!=n&&n===n&&("number"===o&&(n+=i&&i[3]||(he.cssNumber[a]?"":"px")),pe.clearCloneStyle||""!==n||0!==t.indexOf("background")||(c[t]="inherit"),s&&"set"in s&&void 0===(n=s.set(e,n,r))||(u?c.setProperty(t,n):c[t]=n))}},css:function(e,t,n,r){var i,o,s,a=he.camelCase(t);return ut.test(t)||(t=$(a)),s=he.cssHooks[t]||he.cssHooks[a],s&&"get"in s&&(i=s.get(e,!0,n)),void 0===i&&(i=O(e,t,r)),"normal"===i&&t in lt&&(i=lt[t]),""===n||n?(o=parseFloat(i),!0===n||isFinite(o)?o||0:i):i}}),he.each(["height","width"],function(e,t){he.cssHooks[t]={get:function(e,n,r){if(n)return!at.test(he.css(e,"display"))||e.getClientRects().length&&e.getBoundingClientRect().width?I(e,t,r):We(e,ct,function(){return I(e,t,r)})},set:function(e,n,r){var i,o=r&&st(e),s=r&&H(e,t,r,"border-box"===he.css(e,"boxSizing",!1,o),o);return s&&(i=Re.exec(n))&&"px"!==(i[3]||"px")&&(e.style[t]=n,n=he.css(e,t)),P(e,n,s)}}}),he.cssHooks.marginLeft=q(pe.reliableMarginLeft,function(e,t){if(t)return(parseFloat(O(e,"marginLeft"))||e.getBoundingClientRect().left-We(e,{marginLeft:0},function(){return e.getBoundingClientRect().left}))+"px"}),he.each({margin:"",padding:"",border:"Width"},function(e,t){he.cssHooks[e+t]={expand:function(n){for(var r=0,i={},o="string"==typeof n?n.split(" "):[n];r<4;r++)i[e+_e[r]+t]=o[r]||o[r-2]||o[0];return i}},it.test(e)||(he.cssHooks[e+t].set=P)}),he.fn.extend({css:function(e,t){return Oe(this,function(e,t,n){var r,i,o={},s=0;if(Array.isArray(t)){for(r=st(e),i=t.length;s<i;s++)o[t[s]]=he.css(e,t[s],!1,r);return o}return void 0!==n?he.style(e,t,n):he.css(e,t)},e,t,arguments.length>1)}}),he.Tween=R,R.prototype={constructor:R,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||he.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(he.cssNumber[n]?"":"px")},cur:function(){var e=R.propHooks[this.prop];return e&&e.get?e.get(this):R.propHooks._default.get(this)},run:function(e){var t,n=R.propHooks[this.prop];return this.options.duration?this.pos=t=he.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):R.propHooks._default.set(this),this}},R.prototype.init.prototype=R.prototype,R.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=he.css(e.elem,e.prop,""),t&&"auto"!==t?t:0)},set:function(e){he.fx.step[e.prop]?he.fx.step[e.prop](e):1!==e.elem.nodeType||null==e.elem.style[he.cssProps[e.prop]]&&!he.cssHooks[e.prop]?e.elem[e.prop]=e.now:he.style(e.elem,e.prop,e.now+e.unit)}}},R.propHooks.scrollTop=R.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},he.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},he.fx=R.prototype.init,he.fx.step={};var pt,ht,gt=/^(?:toggle|show|hide)$/,vt=/queueHooks$/;he.Animation=he.extend(X,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return g(n.elem,e,Re.exec(t),n),n}]},tweener:function(e,t){he.isFunction(e)?(t=e,e=["*"]):e=e.match(Ae);for(var n,r=0,i=e.length;r<i;r++)n=e[r],X.tweeners[n]=X.tweeners[n]||[],X.tweeners[n].unshift(t)},prefilters:[z],prefilter:function(e,t){t?X.prefilters.unshift(e):X.prefilters.push(e)}}),he.speed=function(e,t,n){var r=e&&"object"==typeof e?he.extend({},e):{complete:n||!n&&t||he.isFunction(e)&&e,duration:e,easing:n&&t||t&&!he.isFunction(t)&&t};return he.fx.off?r.duration=0:"number"!=typeof r.duration&&(r.duration in he.fx.speeds?r.duration=he.fx.speeds[r.duration]:r.duration=he.fx.speeds._default),null!=r.queue&&!0!==r.queue||(r.queue="fx"),r.old=r.complete,r.complete=function(){he.isFunction(r.old)&&r.old.call(this),r.queue&&he.dequeue(this,r.queue)},r},he.fn.extend({fadeTo:function(e,t,n,r){return this.filter(Me).css("opacity",0).show().end().animate({opacity:t},e,n,r)},animate:function(e,t,n,r){var i=he.isEmptyObject(e),o=he.speed(t,n,r),s=function(){var t=X(this,he.extend({},e),o);(i||Fe.get(this,"finish"))&&t.stop(!0)};return s.finish=s,i||!1===o.queue?this.each(s):this.queue(o.queue,s)},stop:function(e,t,n){var r=function(e){var t=e.stop;delete e.stop,t(n)};return"string"!=typeof e&&(n=t,t=e,e=void 0),t&&!1!==e&&this.queue(e||"fx",[]),this.each(function(){var t=!0,i=null!=e&&e+"queueHooks",o=he.timers,s=Fe.get(this);if(i)s[i]&&s[i].stop&&r(s[i]);else for(i in s)s[i]&&s[i].stop&&vt.test(i)&&r(s[i]) +;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"==typeof e&&e)for(t=e.match(Ae)||[];n=this[u++];)if(i=Q(n),r=1===n.nodeType&&" "+U(i)+" "){for(s=0;o=t[s++];)r.indexOf(" "+o+" ")<0&&(r+=o+" ");a=U(r),i!==a&&n.setAttribute("class",a)}return this},removeClass:function(e){var t,n,r,i,o,s,a,u=0;if(he.isFunction(e))return this.each(function(t){he(this).removeClass(e.call(this,t,Q(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof e&&e)for(t=e.match(Ae)||[];n=this[u++];)if(i=Q(n),r=1===n.nodeType&&" "+U(i)+" "){for(s=0;o=t[s++];)for(;r.indexOf(" "+o+" ")>-1;)r=r.replace(" "+o+" "," ");a=U(r),i!==a&&n.setAttribute("class",a)}return this},toggleClass:function(e,t){var n=typeof e;return"boolean"==typeof t&&"string"===n?t?this.addClass(e):this.removeClass(e):he.isFunction(e)?this.each(function(n){he(this).toggleClass(e.call(this,n,Q(this),t),t)}):this.each(function(){var t,r,i,o;if("string"===n)for(r=0,i=he(this),o=e.match(Ae)||[];t=o[r++];)i.hasClass(t)?i.removeClass(t):i.addClass(t);else void 0!==e&&"boolean"!==n||(t=Q(this),t&&Fe.set(this,"__className__",t),this.setAttribute&&this.setAttribute("class",t||!1===e?"":Fe.get(this,"__className__")||""))})},hasClass:function(e){var t,n,r=0;for(t=" "+e+" ";n=this[r++];)if(1===n.nodeType&&(" "+U(Q(n))+" ").indexOf(t)>-1)return!0;return!1}});var wt=/\r/g;he.fn.extend({val:function(e){var t,n,r,i=this[0];{if(arguments.length)return r=he.isFunction(e),this.each(function(n){var i;1===this.nodeType&&(i=r?e.call(this,n,he(this).val()):e,null==i?i="":"number"==typeof i?i+="":Array.isArray(i)&&(i=he.map(i,function(e){return null==e?"":e+""})),(t=he.valHooks[this.type]||he.valHooks[this.nodeName.toLowerCase()])&&"set"in t&&void 0!==t.set(this,i,"value")||(this.value=i))});if(i)return(t=he.valHooks[i.type]||he.valHooks[i.nodeName.toLowerCase()])&&"get"in t&&void 0!==(n=t.get(i,"value"))?n:(n=i.value,"string"==typeof n?n.replace(wt,""):null==n?"":n)}}}),he.extend({valHooks:{option:{get:function(e){var t=he.find.attr(e,"value");return null!=t?t:U(he.text(e))}},select:{get:function(e){var t,n,r,o=e.options,s=e.selectedIndex,a="select-one"===e.type,u=a?null:[],c=a?s+1:o.length;for(r=s<0?c:a?s:0;r<c;r++)if(n=o[r],(n.selected||r===s)&&!n.disabled&&(!n.parentNode.disabled||!i(n.parentNode,"optgroup"))){if(t=he(n).val(),a)return t;u.push(t)}return u},set:function(e,t){for(var n,r,i=e.options,o=he.makeArray(t),s=i.length;s--;)r=i[s],(r.selected=he.inArray(he.valHooks.option.get(r),o)>-1)&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),he.each(["radio","checkbox"],function(){he.valHooks[this]={set:function(e,t){if(Array.isArray(t))return e.checked=he.inArray(he(e).val(),t)>-1}},pe.checkOn||(he.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})});var Tt=/^(?:focusinfocus|focusoutblur)$/;he.extend(he.event,{trigger:function(t,n,r,i){var o,s,a,u,c,l,f,d=[r||ne],p=le.call(t,"type")?t.type:t,h=le.call(t,"namespace")?t.namespace.split("."):[];if(s=a=r=r||ne,3!==r.nodeType&&8!==r.nodeType&&!Tt.test(p+he.event.triggered)&&(p.indexOf(".")>-1&&(h=p.split("."),p=h.shift(),h.sort()),c=p.indexOf(":")<0&&"on"+p,t=t[he.expando]?t:new he.Event(p,"object"==typeof t&&t),t.isTrigger=i?2:3,t.namespace=h.join("."),t.rnamespace=t.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,t.result=void 0,t.target||(t.target=r),n=null==n?[t]:he.makeArray(n,[t]),f=he.event.special[p]||{},i||!f.trigger||!1!==f.trigger.apply(r,n))){if(!i&&!f.noBubble&&!he.isWindow(r)){for(u=f.delegateType||p,Tt.test(u+p)||(s=s.parentNode);s;s=s.parentNode)d.push(s),a=s;a===(r.ownerDocument||ne)&&d.push(a.defaultView||a.parentWindow||e)}for(o=0;(s=d[o++])&&!t.isPropagationStopped();)t.type=o>1?u:f.bindType||p,l=(Fe.get(s,"events")||{})[t.type]&&Fe.get(s,"handle"),l&&l.apply(s,n),(l=c&&s[c])&&l.apply&&qe(s)&&(t.result=l.apply(s,n),!1===t.result&&t.preventDefault());return t.type=p,i||t.isDefaultPrevented()||f._default&&!1!==f._default.apply(d.pop(),n)||!qe(r)||c&&he.isFunction(r[p])&&!he.isWindow(r)&&(a=r[c],a&&(r[c]=null),he.event.triggered=p,r[p](),he.event.triggered=void 0,a&&(r[c]=a)),t.result}},simulate:function(e,t,n){var r=he.extend(new he.Event,n,{type:e,isSimulated:!0});he.event.trigger(r,null,t)}}),he.fn.extend({trigger:function(e,t){return this.each(function(){he.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return he.event.trigger(e,t,n,!0)}}),he.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,t){he.fn[t]=function(e,n){return arguments.length>0?this.on(t,null,e,n):this.trigger(t)}}),he.fn.extend({hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),pe.focusin="onfocusin"in e,pe.focusin||he.each({focus:"focusin",blur:"focusout"},function(e,t){var n=function(e){he.event.simulate(t,e.target,he.event.fix(e))};he.event.special[t]={setup:function(){var r=this.ownerDocument||this,i=Fe.access(r,t);i||r.addEventListener(e,n,!0),Fe.access(r,t,(i||0)+1)},teardown:function(){var r=this.ownerDocument||this,i=Fe.access(r,t)-1;i?Fe.access(r,t,i):(r.removeEventListener(e,n,!0),Fe.remove(r,t))}}});var St=e.location,Et=he.now(),Ct=/\?/;he.parseXML=function(t){var n;if(!t||"string"!=typeof t)return null;try{n=(new e.DOMParser).parseFromString(t,"text/xml")}catch(e){n=void 0}return n&&!n.getElementsByTagName("parsererror").length||he.error("Invalid XML: "+t),n};var kt=/\[\]$/,Nt=/\r?\n/g,jt=/^(?:submit|button|image|reset|file)$/i,At=/^(?:input|select|textarea|keygen)/i;he.param=function(e,t){var n,r=[],i=function(e,t){var n=he.isFunction(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(Array.isArray(e)||e.jquery&&!he.isPlainObject(e))he.each(e,function(){i(this.name,this.value)});else for(n in e)Y(n,e[n],t,i);return r.join("&")},he.fn.extend({serialize:function(){return he.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=he.prop(this,"elements");return e?he.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!he(this).is(":disabled")&&At.test(this.nodeName)&&!jt.test(e)&&(this.checked||!ze.test(e))}).map(function(e,t){var n=he(this).val();return null==n?null:Array.isArray(n)?he.map(n,function(e){return{name:t.name,value:e.replace(Nt,"\r\n")}}):{name:t.name,value:n.replace(Nt,"\r\n")}}).get()}});var Lt=/%20/g,Dt=/#.*$/,Ot=/([?&])_=[^&]*/,qt=/^(.*?):[ \t]*([^\r\n]*)$/gm,Ft=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,$t=/^(?:GET|HEAD)$/,Pt=/^\/\//,Ht={},It={},Rt="*/".concat("*"),_t=ne.createElement("a");_t.href=St.href,he.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:St.href,type:"GET",isLocal:Ft.test(St.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Rt,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":he.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?K(K(e,he.ajaxSettings),t):K(he.ajaxSettings,e)},ajaxPrefilter:J(Ht),ajaxTransport:J(It),ajax:function(t,n){function r(t,n,r,a){var c,d,p,b,w,T=n;l||(l=!0,u&&e.clearTimeout(u),i=void 0,s=a||"",S.readyState=t>0?4:0,c=t>=200&&t<300||304===t,r&&(b=Z(h,S,r)),b=ee(h,b,S,c),c?(h.ifModified&&(w=S.getResponseHeader("Last-Modified"),w&&(he.lastModified[o]=w),(w=S.getResponseHeader("etag"))&&(he.etag[o]=w)),204===t||"HEAD"===h.type?T="nocontent":304===t?T="notmodified":(T=b.state,d=b.data,p=b.error,c=!p)):(p=T,!t&&T||(T="error",t<0&&(t=0))),S.status=t,S.statusText=(n||T)+"",c?m.resolveWith(g,[d,T,S]):m.rejectWith(g,[S,T,p]),S.statusCode(x),x=void 0,f&&v.trigger(c?"ajaxSuccess":"ajaxError",[S,h,c?d:p]),y.fireWith(g,[S,T]),f&&(v.trigger("ajaxComplete",[S,h]),--he.active||he.event.trigger("ajaxStop")))}"object"==typeof t&&(n=t,t=void 0),n=n||{};var i,o,s,a,u,c,l,f,d,p,h=he.ajaxSetup({},n),g=h.context||h,v=h.context&&(g.nodeType||g.jquery)?he(g):he.event,m=he.Deferred(),y=he.Callbacks("once memory"),x=h.statusCode||{},b={},w={},T="canceled",S={readyState:0,getResponseHeader:function(e){var t;if(l){if(!a)for(a={};t=qt.exec(s);)a[t[1].toLowerCase()]=t[2];t=a[e.toLowerCase()]}return null==t?null:t},getAllResponseHeaders:function(){return l?s:null},setRequestHeader:function(e,t){return null==l&&(e=w[e.toLowerCase()]=w[e.toLowerCase()]||e,b[e]=t),this},overrideMimeType:function(e){return null==l&&(h.mimeType=e),this},statusCode:function(e){var t;if(e)if(l)S.always(e[S.status]);else for(t in e)x[t]=[x[t],e[t]];return this},abort:function(e){var t=e||T;return i&&i.abort(t),r(0,t),this}};if(m.promise(S),h.url=((t||h.url||St.href)+"").replace(Pt,St.protocol+"//"),h.type=n.method||n.type||h.method||h.type,h.dataTypes=(h.dataType||"*").toLowerCase().match(Ae)||[""],null==h.crossDomain){c=ne.createElement("a");try{c.href=h.url,c.href=c.href,h.crossDomain=_t.protocol+"//"+_t.host!=c.protocol+"//"+c.host}catch(e){h.crossDomain=!0}}if(h.data&&h.processData&&"string"!=typeof h.data&&(h.data=he.param(h.data,h.traditional)),G(Ht,h,n,S),l)return S;f=he.event&&h.global,f&&0==he.active++&&he.event.trigger("ajaxStart"),h.type=h.type.toUpperCase(),h.hasContent=!$t.test(h.type),o=h.url.replace(Dt,""),h.hasContent?h.data&&h.processData&&0===(h.contentType||"").indexOf("application/x-www-form-urlencoded")&&(h.data=h.data.replace(Lt,"+")):(p=h.url.slice(o.length),h.data&&(o+=(Ct.test(o)?"&":"?")+h.data,delete h.data),!1===h.cache&&(o=o.replace(Ot,"$1"),p=(Ct.test(o)?"&":"?")+"_="+Et+++p),h.url=o+p),h.ifModified&&(he.lastModified[o]&&S.setRequestHeader("If-Modified-Since",he.lastModified[o]),he.etag[o]&&S.setRequestHeader("If-None-Match",he.etag[o])),(h.data&&h.hasContent&&!1!==h.contentType||n.contentType)&&S.setRequestHeader("Content-Type",h.contentType),S.setRequestHeader("Accept",h.dataTypes[0]&&h.accepts[h.dataTypes[0]]?h.accepts[h.dataTypes[0]]+("*"!==h.dataTypes[0]?", "+Rt+"; q=0.01":""):h.accepts["*"]);for(d in h.headers)S.setRequestHeader(d,h.headers[d]);if(h.beforeSend&&(!1===h.beforeSend.call(g,S,h)||l))return S.abort();if(T="abort",y.add(h.complete),S.done(h.success),S.fail(h.error),i=G(It,h,n,S)){if(S.readyState=1,f&&v.trigger("ajaxSend",[S,h]),l)return S;h.async&&h.timeout>0&&(u=e.setTimeout(function(){S.abort("timeout")},h.timeout));try{l=!1,i.send(b,r)}catch(e){if(l)throw e;r(-1,e)}}else r(-1,"No Transport");return S},getJSON:function(e,t,n){return he.get(e,t,n,"json")},getScript:function(e,t){return he.get(e,void 0,t,"script")}}),he.each(["get","post"],function(e,t){he[t]=function(e,n,r,i){return he.isFunction(n)&&(i=i||r,r=n,n=void 0),he.ajax(he.extend({url:e,type:t,dataType:i,data:n,success:r},he.isPlainObject(e)&&e))}}),he._evalUrl=function(e){return he.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,throws:!0})},he.fn.extend({wrapAll:function(e){var t;return this[0]&&(he.isFunction(e)&&(e=e.call(this[0])),t=he(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){for(var e=this;e.firstElementChild;)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(e){return he.isFunction(e)?this.each(function(t){he(this).wrapInner(e.call(this,t))}):this.each(function(){var t=he(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=he.isFunction(e);return this.each(function(n){he(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(e){return this.parent(e).not("body").each(function(){he(this).replaceWith(this.childNodes)}),this}}),he.expr.pseudos.hidden=function(e){return!he.expr.pseudos.visible(e)},he.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},he.ajaxSettings.xhr=function(){try{return new e.XMLHttpRequest}catch(e){}};var Mt={0:200,1223:204},Wt=he.ajaxSettings.xhr();pe.cors=!!Wt&&"withCredentials"in Wt,pe.ajax=Wt=!!Wt,he.ajaxTransport(function(t){var n,r;if(pe.cors||Wt&&!t.crossDomain)return{send:function(i,o){var s,a=t.xhr();if(a.open(t.type,t.url,t.async,t.username,t.password),t.xhrFields)for(s in t.xhrFields)a[s]=t.xhrFields[s];t.mimeType&&a.overrideMimeType&&a.overrideMimeType(t.mimeType),t.crossDomain||i["X-Requested-With"]||(i["X-Requested-With"]="XMLHttpRequest");for(s in i)a.setRequestHeader(s,i[s]);n=function(e){return function(){n&&(n=r=a.onload=a.onerror=a.onabort=a.onreadystatechange=null,"abort"===e?a.abort():"error"===e?"number"!=typeof a.status?o(0,"error"):o(a.status,a.statusText):o(Mt[a.status]||a.status,a.statusText,"text"!==(a.responseType||"text")||"string"!=typeof a.responseText?{binary:a.response}:{text:a.responseText},a.getAllResponseHeaders()))}},a.onload=n(),r=a.onerror=n("error"),void 0!==a.onabort?a.onabort=r:a.onreadystatechange=function(){4===a.readyState&&e.setTimeout(function(){n&&r()})},n=n("abort");try{a.send(t.hasContent&&t.data||null)}catch(e){if(n)throw e}},abort:function(){n&&n()}}}),he.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),he.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return he.globalEval(e),e}}}),he.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),he.ajaxTransport("script",function(e){if(e.crossDomain){var t,n;return{send:function(r,i){t=he("<script>").prop({charset:e.scriptCharset,src:e.url}).on("load error",n=function(e){t.remove(),n=null,e&&i("error"===e.type?404:200,e.type)}),ne.head.appendChild(t[0])},abort:function(){n&&n()}}}});var Bt=[],zt=/(=)\?(?=&|$)|\?\?/;he.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Bt.pop()||he.expando+"_"+Et++;return this[e]=!0,e}}),he.ajaxPrefilter("json jsonp",function(t,n,r){var i,o,s,a=!1!==t.jsonp&&(zt.test(t.url)?"url":"string"==typeof t.data&&0===(t.contentType||"").indexOf("application/x-www-form-urlencoded")&&zt.test(t.data)&&"data");if(a||"jsonp"===t.dataTypes[0])return i=t.jsonpCallback=he.isFunction(t.jsonpCallback)?t.jsonpCallback():t.jsonpCallback,a?t[a]=t[a].replace(zt,"$1"+i):!1!==t.jsonp&&(t.url+=(Ct.test(t.url)?"&":"?")+t.jsonp+"="+i),t.converters["script json"]=function(){return s||he.error(i+" was not called"),s[0]},t.dataTypes[0]="json",o=e[i],e[i]=function(){s=arguments},r.always(function(){void 0===o?he(e).removeProp(i):e[i]=o,t[i]&&(t.jsonpCallback=n.jsonpCallback,Bt.push(i)),s&&he.isFunction(o)&&o(s[0]),s=o=void 0}),"script"}),pe.createHTMLDocument=function(){var e=ne.implementation.createHTMLDocument("").body;return e.innerHTML="<form></form><form></form>",2===e.childNodes.length}(),he.parseHTML=function(e,t,n){if("string"!=typeof e)return[];"boolean"==typeof t&&(n=t,t=!1);var r,i,o;return t||(pe.createHTMLDocument?(t=ne.implementation.createHTMLDocument(""),r=t.createElement("base"),r.href=ne.location.href,t.head.appendChild(r)):t=ne),i=Se.exec(e),o=!n&&[],i?[t.createElement(i[1])]:(i=b([e],t,o),o&&o.length&&he(o).remove(),he.merge([],i.childNodes))},he.fn.load=function(e,t,n){var r,i,o,s=this,a=e.indexOf(" ");return a>-1&&(r=U(e.slice(a)),e=e.slice(0,a)),he.isFunction(t)?(n=t,t=void 0):t&&"object"==typeof t&&(i="POST"),s.length>0&&he.ajax({url:e,type:i||"GET",dataType:"html",data:t}).done(function(e){o=arguments,s.html(r?he("<div>").append(he.parseHTML(e)).find(r):e)}).always(n&&function(e,t){s.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},he.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){he.fn[t]=function(e){return this.on(t,e)}}),he.expr.pseudos.animated=function(e){return he.grep(he.timers,function(t){return e===t.elem}).length},he.offset={setOffset:function(e,t,n){var r,i,o,s,a,u,c,l=he.css(e,"position"),f=he(e),d={};"static"===l&&(e.style.position="relative"),a=f.offset(),o=he.css(e,"top"),u=he.css(e,"left"),c=("absolute"===l||"fixed"===l)&&(o+u).indexOf("auto")>-1,c?(r=f.position(),s=r.top,i=r.left):(s=parseFloat(o)||0,i=parseFloat(u)||0),he.isFunction(t)&&(t=t.call(e,n,he.extend({},a))),null!=t.top&&(d.top=t.top-a.top+s),null!=t.left&&(d.left=t.left-a.left+i),"using"in t?t.using.call(e,d):f.css(d)}},he.fn.extend({offset:function(e){if(arguments.length)return void 0===e?this:this.each(function(t){he.offset.setOffset(this,e,t)});var t,n,r,i,o=this[0];if(o)return o.getClientRects().length?(r=o.getBoundingClientRect(),t=o.ownerDocument,n=t.documentElement,i=t.defaultView,{top:r.top+i.pageYOffset-n.clientTop,left:r.left+i.pageXOffset-n.clientLeft}):{top:0,left:0}},position:function(){if(this[0]){var e,t,n=this[0],r={top:0,left:0};return"fixed"===he.css(n,"position")?t=n.getBoundingClientRect():(e=this.offsetParent(),t=this.offset(),i(e[0],"html")||(r=e.offset()),r={top:r.top+he.css(e[0],"borderTopWidth",!0),left:r.left+he.css(e[0],"borderLeftWidth",!0)}),{top:t.top-r.top-he.css(n,"marginTop",!0),left:t.left-r.left-he.css(n,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){for(var e=this.offsetParent;e&&"static"===he.css(e,"position");)e=e.offsetParent;return e||Ye})}}),he.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(e,t){var n="pageYOffset"===t;he.fn[e]=function(r){return Oe(this,function(e,r,i){var o;if(he.isWindow(e)?o=e:9===e.nodeType&&(o=e.defaultView),void 0===i)return o?o[t]:e[r];o?o.scrollTo(n?o.pageXOffset:i,n?i:o.pageYOffset):e[r]=i},e,r,arguments.length)}}),he.each(["top","left"],function(e,t){he.cssHooks[t]=q(pe.pixelPosition,function(e,n){if(n)return n=O(e,t),ot.test(n)?he(e).position()[t]+"px":n})}),he.each({Height:"height",Width:"width"},function(e,t){he.each({padding:"inner"+e,content:t,"":"outer"+e},function(n,r){he.fn[r]=function(i,o){var s=arguments.length&&(n||"boolean"!=typeof i),a=n||(!0===i||!0===o?"margin":"border");return Oe(this,function(t,n,i){var o;return he.isWindow(t)?0===r.indexOf("outer")?t["inner"+e]:t.document.documentElement["client"+e]:9===t.nodeType?(o=t.documentElement,Math.max(t.body["scroll"+e],o["scroll"+e],t.body["offset"+e],o["offset"+e],o["client"+e])):void 0===i?he.css(t,n,a):he.style(t,n,i,a)},t,s?i:void 0,s)}})}),he.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)}}),he.holdReady=function(e){e?he.readyWait++:he.ready(!0)},he.isArray=Array.isArray,he.parseJSON=JSON.parse,he.nodeName=i,"function"==typeof define&&define.amd&&define("jquery",[],function(){return he});var Vt=e.jQuery,Xt=e.$;return he.noConflict=function(t){return e.$===he&&(e.$=Xt),t&&e.jQuery===he&&(e.jQuery=Vt),he},t||(e.jQuery=e.$=he),he}),jQuery.extend({highlight:function(e,t,n,r){if(3===e.nodeType){var i=e.data.match(t);if(i){var o=document.createElement(n||"span");o.className=r||"highlight";var s=e.splitText(i.index);s.splitText(i[0].length);var a=s.cloneNode(!0);return o.appendChild(a),s.parentNode.replaceChild(o,s),1}}else if(1===e.nodeType&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&(e.tagName!==n.toUpperCase()||e.className!==r))for(var u=0;u<e.childNodes.length;u++)u+=jQuery.highlight(e.childNodes[u],t,n,r);return 0}}),jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};return jQuery.extend(t,e),this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this),e.normalize()}).end()},jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:!1,wordsOnly:!1};if(jQuery.extend(n,t),e.constructor===String&&(e=[e]),e=jQuery.grep(e,function(e,t){return""!=e}),e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")}),0==e.length)return this;var r=n.caseSensitive?"":"i",i="("+e.join("|")+")";n.wordsOnly&&(i="\\b"+i+"\\b");var o=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,o,n.element,n.className)})},function(){var e=function(t){var n=new e.Index;return n.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),t&&t.call(n,n),n};e.version="0.5.7",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.EventEmitter=function(){this.events={}},e.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},e.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);this.events[e].splice(n,1),this.events[e].length||delete this.events[e]}},e.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)})}},e.EventEmitter.prototype.hasHandler=function(e){return e in this.events},e.tokenizer=function(e){if(!arguments.length||null==e||void 0==e)return[];if(Array.isArray(e))return e.map(function(e){return e.toLowerCase()});for(var t=e.toString().replace(/^\s+/,""),n=t.length-1;n>=0;n--)if(/\S/.test(t.charAt(n))){t=t.substring(0,n+1);break}return t.split(/(?:\s+|\-)/).filter(function(e){return!!e}).map(function(e){return e.toLowerCase()})},e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions={},e.Pipeline.registerFunction=function(t,n){n in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+n),t.label=n,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){t.label&&t.label in this.registeredFunctions||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var n=new e.Pipeline;return t.forEach(function(t){var r=e.Pipeline.registeredFunctions[t];if(!r)throw new Error("Cannot load un-registered function: "+t);n.add(r)}),n},e.Pipeline.prototype.add=function(){Array.prototype.slice.call(arguments).forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,n){e.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(t)+1;this._stack.splice(r,0,n)},e.Pipeline.prototype.before=function(t,n){e.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(t);this._stack.splice(r,0,n)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,r=this._stack.length,i=0;i<n;i++){for(var o=e[i],s=0;s<r&&void 0!==(o=this._stack[s](o,i,e));s++);void 0!==o&&t.push(o)}return t},e.Pipeline.prototype.reset=function(){this._stack=[]},e.Pipeline.prototype.toJSON=function(){return this._stack.map(function(t){return e.Pipeline.warnIfFunctionNotRegistered(t),t.label})},e.Vector=function(){this._magnitude=null,this.list=void 0,this.length=0},e.Vector.Node=function(e,t,n){this.idx=e,this.val=t,this.next=n},e.Vector.prototype.insert=function(t,n){var r=this.list;if(!r)return this.list=new e.Vector.Node(t,n,r),this.length++;for(var i=r,o=r.next;void 0!=o;){if(t<o.idx)return i.next=new e.Vector.Node(t,n,o),this.length++;i=o,o=o.next}return i.next=new e.Vector.Node(t,n,o),this.length++},e.Vector.prototype.magnitude=function(){if(this._magniture)return this._magnitude;for(var e,t=this.list,n=0;t;)e=t.val,n+=e*e,t=t.next;return this._magnitude=Math.sqrt(n)},e.Vector.prototype.dot=function(e){for(var t=this.list,n=e.list,r=0;t&&n;)t.idx<n.idx?t=t.next:t.idx>n.idx?n=n.next:(r+=t.val*n.val,t=t.next,n=n.next);return r},e.Vector.prototype.similarity=function(e){return this.dot(e)/(this.magnitude()*e.magnitude())},e.SortedSet=function(){this.length=0,this.elements=[]},e.SortedSet.load=function(e){var t=new this;return t.elements=e,t.length=e.length,t},e.SortedSet.prototype.add=function(){Array.prototype.slice.call(arguments).forEach(function(e){~this.indexOf(e)||this.elements.splice(this.locationFor(e),0,e)},this),this.length=this.elements.length},e.SortedSet.prototype.toArray=function(){return this.elements.slice()},e.SortedSet.prototype.map=function(e,t){return this.elements.map(e,t)},e.SortedSet.prototype.forEach=function(e,t){return this.elements.forEach(e,t)},e.SortedSet.prototype.indexOf=function(e,t,n){var t=t||0,n=n||this.elements.length,r=n-t,i=t+Math.floor(r/2),o=this.elements[i];return r<=1?o===e?i:-1:o<e?this.indexOf(e,i,n):o>e?this.indexOf(e,t,i):o===e?i:void 0},e.SortedSet.prototype.locationFor=function(e,t,n){var t=t||0,n=n||this.elements.length,r=n-t,i=t+Math.floor(r/2),o=this.elements[i];if(r<=1){if(o>e)return i;if(o<e)return i+1}return o<e?this.locationFor(e,i,n):o>e?this.locationFor(e,t,i):void 0},e.SortedSet.prototype.intersect=function(t){for(var n=new e.SortedSet,r=0,i=0,o=this.length,s=t.length,a=this.elements,u=t.elements;;){if(r>o-1||i>s-1)break;a[r]!==u[i]?a[r]<u[i]?r++:a[r]>u[i]&&i++:(n.add(a[r]),r++,i++)}return n},e.SortedSet.prototype.clone=function(){var t=new e.SortedSet;return t.elements=this.toArray(),t.length=t.elements.length,t},e.SortedSet.prototype.union=function(e){var t,n,r;return this.length>=e.length?(t=this,n=e):(t=e,n=this),r=t.clone(),r.add.apply(r,n.toArray()),r},e.SortedSet.prototype.toJSON=function(){return this.toArray()},e.Index=function(){this._fields=[],this._ref="id",this.pipeline=new e.Pipeline,this.documentStore=new e.Store,this.tokenStore=new e.TokenStore,this.corpusTokens=new e.SortedSet,this.eventEmitter=new e.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},e.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},e.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},e.Index.load=function(t){t.version!==e.version&&e.utils.warn("version mismatch: current "+e.version+" importing "+t.version);var n=new this;return n._fields=t.fields,n._ref=t.ref,n.documentStore=e.Store.load(t.documentStore),n.tokenStore=e.TokenStore.load(t.tokenStore),n.corpusTokens=e.SortedSet.load(t.corpusTokens),n.pipeline=e.Pipeline.load(t.pipeline),n},e.Index.prototype.field=function(e,t){var t=t||{},n={name:e,boost:t.boost||1};return this._fields.push(n),this},e.Index.prototype.ref=function(e){return this._ref=e,this},e.Index.prototype.add=function(t,n){var r={},i=new e.SortedSet,o=t[this._ref],n=void 0===n||n;this._fields.forEach(function(n){var o=this.pipeline.run(e.tokenizer(t[n.name]));r[n.name]=o,e.SortedSet.prototype.add.apply(i,o)},this),this.documentStore.set(o,i),e.SortedSet.prototype.add.apply(this.corpusTokens,i.toArray());for(var s=0;s<i.length;s++){var a=i.elements[s],u=this._fields.reduce(function(e,t){var n=r[t.name].length;return n?e+r[t.name].filter(function(e){return e===a}).length/n*t.boost:e},0);this.tokenStore.add(a,{ref:o,tf:u})}n&&this.eventEmitter.emit("add",t,this)},e.Index.prototype.remove=function(e,t){var n=e[this._ref],t=void 0===t||t;if(this.documentStore.has(n)){var r=this.documentStore.get(n);this.documentStore.remove(n),r.forEach(function(e){this.tokenStore.remove(e,n)},this),t&&this.eventEmitter.emit("remove",e,this)}},e.Index.prototype.update=function(e,t){var t=void 0===t||t;this.remove(e,!1),this.add(e,!1),t&&this.eventEmitter.emit("update",e,this)},e.Index.prototype.idf=function(e){var t="@"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,t))return this._idfCache[t];var n=this.tokenStore.count(e),r=1;return n>0&&(r=1+Math.log(this.tokenStore.length/n)),this._idfCache[t]=r},e.Index.prototype.search=function(t){ +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.toLowerCase()+n.substr(1)),n}}(),e.Pipeline.registerFunction(e.stemmer,"stemmer"),e.stopWordFilter=function(t){if(-1===e.stopWordFilter.stopWords.indexOf(t))return t},e.stopWordFilter.stopWords=new e.SortedSet,e.stopWordFilter.stopWords.length=119,e.stopWordFilter.stopWords.elements=["","a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"],e.Pipeline.registerFunction(e.stopWordFilter,"stopWordFilter"),e.trimmer=function(e){return e.replace(/^\W+/,"").replace(/\W+$/,"")},e.Pipeline.registerFunction(e.trimmer,"trimmer"),e.TokenStore=function(){this.root={docs:{}},this.length=0},e.TokenStore.load=function(e){var t=new this;return t.root=e.root,t.length=e.length,t},e.TokenStore.prototype.add=function(e,t,n){var n=n||this.root,r=e[0],i=e.slice(1);return r in n||(n[r]={docs:{}}),0===i.length?(n[r].docs[t.ref]=t,void(this.length+=1)):this.add(i,t,n[r])},e.TokenStore.prototype.has=function(e){if(!e)return!1;for(var t=this.root,n=0;n<e.length;n++){if(!t[e[n]])return!1;t=t[e[n]]}return!0},e.TokenStore.prototype.getNode=function(e){if(!e)return{};for(var t=this.root,n=0;n<e.length;n++){if(!t[e[n]])return{};t=t[e[n]]}return t},e.TokenStore.prototype.get=function(e,t){return this.getNode(e,t).docs||{}},e.TokenStore.prototype.count=function(e,t){return Object.keys(this.get(e,t)).length},e.TokenStore.prototype.remove=function(e,t){if(e){for(var n=this.root,r=0;r<e.length;r++){if(!(e[r]in n))return;n=n[e[r]]}delete n.docs[t]}},e.TokenStore.prototype.expand=function(e,t){var n=this.getNode(e),r=n.docs||{},t=t||[];return Object.keys(r).length&&t.push(e),Object.keys(n).forEach(function(n){"docs"!==n&&t.concat(this.expand(e+n,t))},this),t},e.TokenStore.prototype.toJSON=function(){return{root:this.root,length:this.length}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(),function(){function e(){}function t(e,t){for(var n=e.length;n--;)if(e[n].listener===t)return n;return-1}function n(e){return function(){return this[e].apply(this,arguments)}}var r=e.prototype,i=this,o=i.EventEmitter;r.getListeners=function(e){var t,n,r=this._getEvents();if("object"==typeof e){t={};for(n in r)r.hasOwnProperty(n)&&e.test(n)&&(t[n]=r[n])}else t=r[e]||(r[e]=[]);return t},r.flattenListeners=function(e){var t,n=[];for(t=0;e.length>t;t+=1)n.push(e[t].listener);return n},r.getListenersAsObject=function(e){var t,n=this.getListeners(e);return n instanceof Array&&(t={},t[e]=n),t||n},r.addListener=function(e,n){var r,i=this.getListenersAsObject(e),o="object"==typeof n;for(r in i)i.hasOwnProperty(r)&&-1===t(i[r],n)&&i[r].push(o?n:{listener:n,once:!1});return this},r.on=n("addListener"),r.addOnceListener=function(e,t){return this.addListener(e,{listener:t,once:!0})},r.once=n("addOnceListener"),r.defineEvent=function(e){return this.getListeners(e),this},r.defineEvents=function(e){for(var t=0;e.length>t;t+=1)this.defineEvent(e[t]);return this},r.removeListener=function(e,n){var r,i,o=this.getListenersAsObject(e);for(i in o)o.hasOwnProperty(i)&&-1!==(r=t(o[i],n))&&o[i].splice(r,1);return this},r.off=n("removeListener"),r.addListeners=function(e,t){return this.manipulateListeners(!1,e,t)},r.removeListeners=function(e,t){return this.manipulateListeners(!0,e,t)},r.manipulateListeners=function(e,t,n){var r,i,o=e?this.removeListener:this.addListener,s=e?this.removeListeners:this.addListeners;if("object"!=typeof t||t instanceof RegExp)for(r=n.length;r--;)o.call(this,t,n[r]);else for(r in t)t.hasOwnProperty(r)&&(i=t[r])&&("function"==typeof i?o.call(this,r,i):s.call(this,r,i));return this},r.removeEvent=function(e){var t,n=typeof e,r=this._getEvents();if("string"===n)delete r[e];else if("object"===n)for(t in r)r.hasOwnProperty(t)&&e.test(t)&&delete r[t];else delete this._events;return this},r.removeAllListeners=n("removeEvent"),r.emitEvent=function(e,t){var n,r,i,o=this.getListenersAsObject(e);for(i in o)if(o.hasOwnProperty(i))for(r=o[i].length;r--;)n=o[i][r],!0===n.once&&this.removeListener(e,n.listener),n.listener.apply(this,t||[])===this._getOnceReturnValue()&&this.removeListener(e,n.listener);return this},r.trigger=n("emitEvent"),r.emit=function(e){var t=Array.prototype.slice.call(arguments,1);return this.emitEvent(e,t)},r.setOnceReturnValue=function(e){return this._onceReturnValue=e,this},r._getOnceReturnValue=function(){return!this.hasOwnProperty("_onceReturnValue")||this._onceReturnValue},r._getEvents=function(){return this._events||(this._events={})},e.noConflict=function(){return i.EventEmitter=o,e},"function"==typeof define&&define.amd?define("eventEmitter/EventEmitter",[],function(){return e}):"object"==typeof module&&module.exports?module.exports=e:this.EventEmitter=e}.call(this),function(e){function t(t){var n=e.event;return n.target=n.target||n.srcElement||t,n}var n=document.documentElement,r=function(){};n.addEventListener?r=function(e,t,n){e.addEventListener(t,n,!1)}:n.attachEvent&&(r=function(e,n,r){e[n+r]=r.handleEvent?function(){var n=t(e);r.handleEvent.call(r,n)}:function(){var n=t(e);r.call(e,n)},e.attachEvent("on"+n,e[n+r])});var i=function(){};n.removeEventListener?i=function(e,t,n){e.removeEventListener(t,n,!1)}:n.detachEvent&&(i=function(e,t,n){e.detachEvent("on"+t,e[t+n]);try{delete e[t+n]}catch(r){e[t+n]=void 0}});var o={bind:r,unbind:i};"function"==typeof define&&define.amd?define("eventie/eventie",o):e.eventie=o}(this),function(e,t){"function"==typeof define&&define.amd?define(["eventEmitter/EventEmitter","eventie/eventie"],function(n,r){return t(e,n,r)}):"object"==typeof exports?module.exports=t(e,require("wolfy87-eventemitter"),require("eventie")):e.imagesLoaded=t(e,e.EventEmitter,e.eventie)}(window,function(e,t,n){function r(e,t){for(var n in t)e[n]=t[n];return e}function i(e){return"[object Array]"===d.call(e)}function o(e){var t=[];if(i(e))t=e;else if("number"==typeof e.length)for(var n=0,r=e.length;r>n;n++)t.push(e[n]);else t.push(e);return t}function s(e,t,n){if(!(this instanceof s))return new s(e,t);"string"==typeof e&&(e=document.querySelectorAll(e)),this.elements=o(e),this.options=r({},this.options),"function"==typeof t?n=t:r(this.options,t),n&&this.on("always",n),this.getImages(),c&&(this.jqDeferred=new c.Deferred);var i=this;setTimeout(function(){i.check()})}function a(e){this.img=e}function u(e){this.src=e,p[e]=this}var c=e.jQuery,l=e.console,f=void 0!==l,d=Object.prototype.toString;s.prototype=new t,s.prototype.options={},s.prototype.getImages=function(){this.images=[];for(var e=0,t=this.elements.length;t>e;e++){var n=this.elements[e];"IMG"===n.nodeName&&this.addImage(n);var r=n.nodeType;if(r&&(1===r||9===r||11===r))for(var i=n.querySelectorAll("img"),o=0,s=i.length;s>o;o++){var a=i[o];this.addImage(a)}}},s.prototype.addImage=function(e){var t=new a(e);this.images.push(t)},s.prototype.check=function(){function e(e,i){return t.options.debug&&f&&l.log("confirm",e,i),t.progress(e),n++,n===r&&t.complete(),!0}var t=this,n=0,r=this.images.length;if(this.hasAnyBroken=!1,!r)return void this.complete();for(var i=0;r>i;i++){var o=this.images[i];o.on("confirm",e),o.check()}},s.prototype.progress=function(e){this.hasAnyBroken=this.hasAnyBroken||!e.isLoaded;var t=this;setTimeout(function(){t.emit("progress",t,e),t.jqDeferred&&t.jqDeferred.notify&&t.jqDeferred.notify(t,e)})},s.prototype.complete=function(){var e=this.hasAnyBroken?"fail":"done";this.isComplete=!0;var t=this;setTimeout(function(){if(t.emit(e,t),t.emit("always",t),t.jqDeferred){var n=t.hasAnyBroken?"reject":"resolve";t.jqDeferred[n](t)}})},c&&(c.fn.imagesLoaded=function(e,t){return new s(this,e,t).jqDeferred.promise(c(this))}),a.prototype=new t,a.prototype.check=function(){var e=p[this.img.src]||new u(this.img.src);if(e.isConfirmed)return void this.confirm(e.isLoaded,"cached was confirmed");if(this.img.complete&&void 0!==this.img.naturalWidth)return void this.confirm(0!==this.img.naturalWidth,"naturalWidth");var t=this;e.on("confirm",function(e,n){return t.confirm(e.isLoaded,n),!0}),e.check()},a.prototype.confirm=function(e,t){this.isLoaded=e,this.emit("confirm",this,t)};var p={};return u.prototype=new t,u.prototype.check=function(){if(!this.isChecked){var e=new Image;n.bind(e,"load",this),n.bind(e,"error",this),e.src=this.src,this.isChecked=!0}},u.prototype.handleEvent=function(e){var t="on"+e.type;this[t]&&this[t](e)},u.prototype.onload=function(e){this.confirm(!0,"onload"),this.unbindProxyEvents(e)},u.prototype.onerror=function(e){this.confirm(!1,"onerror"),this.unbindProxyEvents(e)},u.prototype.confirm=function(e,t){this.isConfirmed=!0,this.isLoaded=e,this.emit("confirm",this,t)},u.prototype.unbindProxyEvents=function(e){n.unbind(e.target,"load",this),n.unbind(e.target,"error",this)},s}),function(){if("ontouchstart"in window){var e,t,n,r,i,o,s={};e=function(e,t){return Math.abs(e[0]-t[0])>5||Math.abs(e[1]-t[1])>5},t=function(e){this.startXY=[e.touches[0].clientX,e.touches[0].clientY],this.threshold=!1},n=function(t){if(this.threshold)return!1;this.threshold=e(this.startXY,[t.touches[0].clientX,t.touches[0].clientY])},r=function(t){if(!this.threshold&&!e(this.startXY,[t.changedTouches[0].clientX,t.changedTouches[0].clientY])){var n=t.changedTouches[0],r=document.createEvent("MouseEvents");r.initMouseEvent("click",!0,!0,window,0,n.screenX,n.screenY,n.clientX,n.clientY,!1,!1,!1,!1,0,null),r.simulated=!0,t.target.dispatchEvent(r)}},i=function(e){var t=Date.now(),n=t-s.time,r=e.clientX,i=e.clientY,a=[Math.abs(s.x-r),Math.abs(s.y-i)],u=o(e.target,"A")||e.target,c=u.nodeName,l="A"===c,f=window.navigator.standalone&&l&&e.target.getAttribute("href");if(s.time=t,s.x=r,s.y=i,(!e.simulated&&(n<500||n<1500&&a[0]<50&&a[1]<50)||f)&&(e.preventDefault(),e.stopPropagation(),!f))return!1;f&&(window.location=u.getAttribute("href")),u&&u.classList&&(u.classList.add("energize-focus"),window.setTimeout(function(){u.classList.remove("energize-focus")},150))},o=function(e,t){for(var n=e;n!==document.body;){if(!n||n.nodeName===t)return n;n=n.parentNode}return null},document.addEventListener("touchstart",t,!1),document.addEventListener("touchmove",n,!1),document.addEventListener("touchend",r,!1),document.addEventListener("click",i,!0)}}(),function(){"use strict";function e(e){if(e&&""!==e){$(".lang-selector a").removeClass("active"),$(".lang-selector a[data-language-name='"+e+"']").addClass("active");for(var t=0;t<a.length;t++)$(".highlight.tab-"+a[t]).hide(),$(".lang-specific."+a[t]).hide();$(".highlight.tab-"+e).show(),$(".lang-specific."+e).show(),window.recacheHeights(),$(window.location.hash).get(0)&&$(window.location.hash).get(0).scrollIntoView(!0)}}function t(e){return"string"!=typeof e?{}:(e=e.trim().replace(/^(\?|#|&)/,""),e?e.split("&").reduce(function(e,t){var n=t.replace(/\+/g," ").split("="),r=n[0],i=n[1];return r=decodeURIComponent(r),i=void 0===i?null:decodeURIComponent(i),e.hasOwnProperty(r)?Array.isArray(e[r])?e[r].push(i):e[r]=[e[r],i]:e[r]=i,e},{}):{})}function n(e){return e?Object.keys(e).sort().map(function(t){var n=e[t];return Array.isArray(n)?n.sort().map(function(e){return encodeURIComponent(t)+"="+encodeURIComponent(e)}).join("&"):encodeURIComponent(t)+"="+encodeURIComponent(n)}).join("&"):""}function r(){if(location.search.length>=1){var e=t(location.search).language;if(e)return e;if(-1!=jQuery.inArray(location.search.substr(1),a))return location.search.substr(1)}return!1}function i(e){var r=t(location.search);return r.language?(r.language=e,n(r)):e}function o(e){if(history){var t=window.location.hash;t&&(t=t.replace(/^#+/,"")),history.pushState({},"","?"+i(e)+"#"+t),localStorage.setItem("language",e)}}function s(t){var n=localStorage.getItem("language");a=t;var i=r();i?(e(i),localStorage.setItem("language",i)):e(null!==n&&-1!=jQuery.inArray(n,a)?n:a[0])}var a=[];window.setupLanguages=s,window.activateLanguage=e,window.getLanguageFromQueryString=r,$(function(){$(".lang-selector a").on("click",function(){var t=$(this).data("language-name");return o(t),e(t),!1})})}(),function(){"use strict";function e(){$("h1, h2").each(function(){var e=$(this),t=e.nextUntil("h1, h2");f.add({id:e.prop("id"),title:e.text(),body:t.text()})}),t()}function t(){f.tokenStore.length>5e3&&(c=300)}function n(){s=$(".content"),a=$(".search-results"),$("#input-search").on("keyup",function(e){!function(){return function(e,t){clearTimeout(l),l=setTimeout(e,t)}}()(function(){r(e)},c)})}function r(e){var t=$("#input-search")[0];if(o(),a.addClass("visible"),27===e.keyCode&&(t.value=""),t.value){var n=f.search(t.value).filter(function(e){return e.score>1e-4});n.length?(a.empty(),$.each(n,function(e,t){var n=document.getElementById(t.ref);a.append("<li><a href='#"+t.ref+"'>"+$(n).text()+"</a></li>")}),i.call(t)):(a.html("<li></li>"),$(".search-results li").text('No Results Found for "'+t.value+'"'))}else o(),a.removeClass("visible")}function i(){this.value&&s.highlight(this.value,u)}function o(){s.unhighlight(u)}var s,a,u={element:"span",className:"search-highlight"},c=0,l=0,f=new lunr.Index;f.ref("id"),f.field("title",{boost:10}),f.field("body"),f.pipeline.add(lunr.trimmer,lunr.stopWordFilter),$(e),$(n)}(),function(){"use strict";function e(e,i,o,s){var a={},u=0,c=0,l=document.title,f=function(){a={},u=$(document).height(),c=$(window).height(),e.find(i).each(function(){var e=$(this).attr("href");"#"===e[0]&&(a[e]=$(e).offset().top)})},d=function(){var n=$(document).scrollTop()+s;n+c>=u&&(n=u+1e3);var r=null;for(var f in a)(a[f]<n&&a[f]>a[r]||null===r)&&(r=f);n!=s||t||(r=window.location.hash,t=!0);var d=e.find("[href='"+r+"']").first();if(!d.hasClass("active")){e.find(".active").removeClass("active"),e.find(".active-parent").removeClass("active-parent"),d.addClass("active"),d.parents(o).addClass("active").siblings(i).addClass("active-parent"),d.siblings(o).addClass("active"),e.find(o).filter(":not(.active)").slideUp(150),e.find(o).filter(".active").slideDown(150),window.history.replaceState&&window.history.replaceState(null,"",r);var p=d.data("title");void 0!==p&&p.length>0?document.title=p+" – "+l:document.title=l}};!function(){f(),d(),$("#nav-button").click(function(){return $(".toc-wrapper").toggleClass("open"),$("#nav-button").toggleClass("open"),!1}),$(".page-wrapper").click(r),$(".toc-link").click(r),e.find(i).click(function(){setTimeout(function(){d()},0)}),$(window).scroll(n(d,200)),$(window).resize(n(f,200))}(),window.recacheHeights=f,window.refreshToc=d}var t=!1,n=function(e,t){var n=!1;return function(){!1===n&&(setTimeout(function(){e(),n=!1},t),n=!0)}},r=function(){$(".toc-wrapper").removeClass("open"),$("#nav-button").removeClass("open")};window.loadToc=e}(),$(function(){loadToc($("#toc"),".toc-link",".toc-list-h2, .toc-list-h3, .toc-list-h4, .toc-list-h5, .toc-list-h6",10),setupLanguages($("body").data("languages")),$(".content").imagesLoaded(function(){window.recacheHeights(),window.refreshToc()})}),window.onpopstate=function(){activateLanguage(getLanguageFromQueryString())};</script> + + <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"> + + <div class="lang-selector"> + + + <a href="#" data-language-name="shell">Shell</a> + + + + <a href="#" data-language-name="http">HTTP</a> + + + + <a href="#" data-language-name="javascript">JavaScript</a> + + + + <a href="#" data-language-name="javascript--nodejs">Node.js</a> + + + + <a href="#" data-language-name="ruby">Ruby</a> + + + + <a href="#" data-language-name="python">Python</a> + + + + <a href="#" data-language-name="java">Java</a> + + + + <a href="#" data-language-name="go">Go</a> + + + </div> + + + <div class="search"> + <input type="text" class="search" id="input-search" placeholder="Search"> + </div> + <ul class="search-results"></ul> + + <div id="toc" class="toc-list-h1"> + <ul class="toc-list-h1"> + + <li> + <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v2.99">Wekan REST API v2.99</a> + + </li> + + <li> + <a href="#production-security-concerns" class="toc-h1 toc-link" data-title="Production Security Concerns">Production Security Concerns</a> + + </li> + + <li> + <a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a> + + </li> + + <li> + <a href="#wekan-rest-api-login" class="toc-h1 toc-link" data-title="Login">Login</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#login" class="toc-h2 toc-link" data-title="login">login</a> + + </li> + + <li> + <a href="#register" class="toc-h2 toc-link" data-title="register">register</a> + + </li> + + </ul> + + </li> + + <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="#export" class="toc-h2 toc-link" data-title="export">export</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> + + <li> + <a href="#wekan-rest-api-checklists" class="toc-h1 toc-link" data-title="Checklists">Checklists</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_board_card_checklists" class="toc-h2 toc-link" data-title="get_board_card_checklists">get_board_card_checklists</a> + + </li> + + <li> + <a href="#post_board_card_checklists" class="toc-h2 toc-link" data-title="post_board_card_checklists">post_board_card_checklists</a> + + </li> + + <li> + <a href="#get_board_card_checklist" class="toc-h2 toc-link" data-title="get_board_card_checklist">get_board_card_checklist</a> + + </li> + + <li> + <a href="#delete_board_card_checklist" class="toc-h2 toc-link" data-title="delete_board_card_checklist">delete_board_card_checklist</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-checklistitems" class="toc-h1 toc-link" data-title="ChecklistItems">ChecklistItems</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_board_card_checklist_item" class="toc-h2 toc-link" data-title="get_board_card_checklist_item">get_board_card_checklist_item</a> + + </li> + + <li> + <a href="#put_board_card_checklist_item" class="toc-h2 toc-link" data-title="put_board_card_checklist_item">put_board_card_checklist_item</a> + + </li> + + <li> + <a href="#delete_board_card_checklist_item" class="toc-h2 toc-link" data-title="delete_board_card_checklist_item">delete_board_card_checklist_item</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-cardcomments" class="toc-h1 toc-link" data-title="CardComments">CardComments</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_all_comments" class="toc-h2 toc-link" data-title="get_all_comments">get_all_comments</a> + + </li> + + <li> + <a href="#post_board_card_comments" class="toc-h2 toc-link" data-title="post_board_card_comments">post_board_card_comments</a> + + </li> + + <li> + <a href="#get_board_card_comment" class="toc-h2 toc-link" data-title="get_board_card_comment">get_board_card_comment</a> + + </li> + + <li> + <a href="#delete_board_card_comment" class="toc-h2 toc-link" data-title="delete_board_card_comment">delete_board_card_comment</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-customfields" class="toc-h1 toc-link" data-title="CustomFields">CustomFields</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_all_custom_fields" class="toc-h2 toc-link" data-title="get_all_custom_fields">get_all_custom_fields</a> + + </li> + + <li> + <a href="#new_custom_field" class="toc-h2 toc-link" data-title="new_custom_field">new_custom_field</a> + + </li> + + <li> + <a href="#get_board_customfield" class="toc-h2 toc-link" data-title="get_board_customField">get_board_customField</a> + + </li> + + <li> + <a href="#delete_board_customfield" class="toc-h2 toc-link" data-title="delete_board_customField">delete_board_customField</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-integrations" class="toc-h1 toc-link" data-title="Integrations">Integrations</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_all_integrations" class="toc-h2 toc-link" data-title="get_all_integrations">get_all_integrations</a> + + </li> + + <li> + <a href="#new_integration" class="toc-h2 toc-link" data-title="new_integration">new_integration</a> + + </li> + + <li> + <a href="#get_integration" class="toc-h2 toc-link" data-title="get_integration">get_integration</a> + + </li> + + <li> + <a href="#edit_integration" class="toc-h2 toc-link" data-title="edit_integration">edit_integration</a> + + </li> + + <li> + <a href="#delete_integration" class="toc-h2 toc-link" data-title="delete_integration">delete_integration</a> + + </li> + + <li> + <a href="#delete_board_int_activities" class="toc-h2 toc-link" data-title="delete_board_int_activities">delete_board_int_activities</a> + + </li> + + <li> + <a href="#post_board_int_activities" class="toc-h2 toc-link" data-title="post_board_int_activities">post_board_int_activities</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-lists" class="toc-h1 toc-link" data-title="Lists">Lists</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_all_lists" class="toc-h2 toc-link" data-title="get_all_lists">get_all_lists</a> + + </li> + + <li> + <a href="#new_list" class="toc-h2 toc-link" data-title="new_list">new_list</a> + + </li> + + <li> + <a href="#get_list" class="toc-h2 toc-link" data-title="get_list">get_list</a> + + </li> + + <li> + <a href="#delete_list" class="toc-h2 toc-link" data-title="delete_list">delete_list</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-cards" class="toc-h1 toc-link" data-title="Cards">Cards</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_all_cards" class="toc-h2 toc-link" data-title="get_all_cards">get_all_cards</a> + + </li> + + <li> + <a href="#new_card" class="toc-h2 toc-link" data-title="new_card">new_card</a> + + </li> + + <li> + <a href="#get_board_list_card" class="toc-h2 toc-link" data-title="get_board_list_card">get_board_list_card</a> + + </li> + + <li> + <a href="#put_board_list_card" class="toc-h2 toc-link" data-title="put_board_list_card">put_board_list_card</a> + + </li> + + <li> + <a href="#delete_board_list_card" class="toc-h2 toc-link" data-title="delete_board_list_card">delete_board_list_card</a> + + </li> + + <li> + <a href="#get_board_swimlane_cards" class="toc-h2 toc-link" data-title="get_board_swimlane_cards">get_board_swimlane_cards</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-users" class="toc-h1 toc-link" data-title="Users">Users</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#add_board_member" class="toc-h2 toc-link" data-title="add_board_member">add_board_member</a> + + </li> + + <li> + <a href="#post_board_user_remove" class="toc-h2 toc-link" data-title="post_board_user_remove">post_board_user_remove</a> + + </li> + + <li> + <a href="#get_current_user" class="toc-h2 toc-link" data-title="get_current_user">get_current_user</a> + + </li> + + <li> + <a href="#get_all_users" class="toc-h2 toc-link" data-title="get_all_users">get_all_users</a> + + </li> + + <li> + <a href="#new_user" class="toc-h2 toc-link" data-title="new_user">new_user</a> + + </li> + + <li> + <a href="#get_user" class="toc-h2 toc-link" data-title="get_user">get_user</a> + + </li> + + <li> + <a href="#edit_user" class="toc-h2 toc-link" data-title="edit_user">edit_user</a> + + </li> + + <li> + <a href="#delete_user" class="toc-h2 toc-link" data-title="delete_user">delete_user</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#wekan-rest-api-swimlanes" class="toc-h1 toc-link" data-title="Swimlanes">Swimlanes</a> + + <ul class="toc-list-h2"> + + <li> + <a href="#get_all_swimlanes" class="toc-h2 toc-link" data-title="get_all_swimlanes">get_all_swimlanes</a> + + </li> + + <li> + <a href="#new_swimlane" class="toc-h2 toc-link" data-title="new_swimlane">new_swimlane</a> + + </li> + + <li> + <a href="#get_swimlane" class="toc-h2 toc-link" data-title="get_swimlane">get_swimlane</a> + + </li> + + <li> + <a href="#delete_board_swimlane" class="toc-h2 toc-link" data-title="delete_board_swimlane">delete_board_swimlane</a> + + </li> + + </ul> + + </li> + + <li> + <a href="#schemas" class="toc-h1 toc-link" data-title="Schemas">Schemas</a> + + <ul class="toc-list-h2"> + + <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> + + <li> + <a href="#tocscardcomments" class="toc-h2 toc-link" data-title="CardComments">CardComments</a> + + </li> + + <li> + <a href="#tocscards" class="toc-h2 toc-link" data-title="Cards">Cards</a> + + </li> + + <li> + <a href="#tocscardscustomfields" class="toc-h2 toc-link" data-title="CardsCustomfields">CardsCustomfields</a> + + </li> + + <li> + <a href="#tocschecklistitems" class="toc-h2 toc-link" data-title="ChecklistItems">ChecklistItems</a> + + </li> + + <li> + <a href="#tocschecklists" class="toc-h2 toc-link" data-title="Checklists">Checklists</a> + + </li> + + <li> + <a href="#tocscustomfields" class="toc-h2 toc-link" data-title="CustomFields">CustomFields</a> + + </li> + + <li> + <a href="#tocscustomfieldssettings" class="toc-h2 toc-link" data-title="CustomFieldsSettings">CustomFieldsSettings</a> + + </li> + + <li> + <a href="#tocscustomfieldssettingsdropdownitems" class="toc-h2 toc-link" data-title="CustomFieldsSettingsDropdownitems">CustomFieldsSettingsDropdownitems</a> + + </li> + + <li> + <a href="#tocsintegrations" class="toc-h2 toc-link" data-title="Integrations">Integrations</a> + + </li> + + <li> + <a href="#tocslists" class="toc-h2 toc-link" data-title="Lists">Lists</a> + + </li> + + <li> + <a href="#tocslistswiplimit" class="toc-h2 toc-link" data-title="ListsWiplimit">ListsWiplimit</a> + + </li> + + <li> + <a href="#tocsswimlanes" class="toc-h2 toc-link" data-title="Swimlanes">Swimlanes</a> + + </li> + + <li> + <a href="#tocsusers" class="toc-h2 toc-link" data-title="Users">Users</a> + + </li> + + <li> + <a href="#tocsusersemails" class="toc-h2 toc-link" data-title="UsersEmails">UsersEmails</a> + + </li> + + <li> + <a href="#tocsusersprofile" class="toc-h2 toc-link" data-title="UsersProfile">UsersProfile</a> + + </li> + + </ul> + + </li> + + </ul> + </div> + + <ul class="toc-footer"> + + </ul> + + </div> + <div class="page-wrapper"> + <div class="dark-box"></div> + <div class="content"> + <h1 id="wekan-rest-api">Wekan REST API v2.99</h1> +<blockquote> +<p>Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.</p> +</blockquote> +<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>}, + + } + + 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>}, + + } + + 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> +<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> +<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 \ + -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</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'</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'</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'</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'</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"</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"</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</code></p> +<p><em>Get all public boards</em></p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_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_public_boards-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_public_boards-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_board">new_board</h2> +<p><a id="opIdnew_board"></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 \ + -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</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'</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", + "owner": "string", + "isAdmin": true, + "isActive": true, + "isNoComments": true, + "isCommentOnly": true, + "permission": "string", + "color": "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'</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'</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'</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"</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"</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</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" /> +<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">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">permission:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">color:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="new_board-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>» title</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the new title of the board</td> +</tr> +<tr> +<td>» owner</td> +<td>body</td> +<td>string</td> +<td>true</td> +<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> +</tr> +<tr> +<td>» isActive</td> +<td>body</td> +<td>boolean</td> +<td>false</td> +<td>is the board active (default true)</td> +</tr> +<tr> +<td>» isNoComments</td> +<td>body</td> +<td>boolean</td> +<td>false</td> +<td>disable comments (default false)</td> +</tr> +<tr> +<td>» isCommentOnly</td> +<td>body</td> +<td>boolean</td> +<td>false</td> +<td>only enable comments (default false)</td> +</tr> +<tr> +<td>» permission</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>"private" board <== Set to "public" if you</td> +</tr> +<tr> +<td>» color</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>the color of the board</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<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> +<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">"defaultSwimlaneId"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_board-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_board-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>» defaultSwimlaneId</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_board">get_board</h2> +<p><a id="opIdget_board"></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} \ + -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}</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}'</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}'</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}'</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}'</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}"</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}"</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}</code></p> +<p><em>Get the board with that particular ID</em></p> +<h3 id="get_board-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 to retrieve the data</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the ID of the board 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">"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">"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">"allowsSubtasks"</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> +} +</code></pre> +<h3 id="get_board-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="#schemaboards">Boards</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_board">delete_board</h2> +<p><a id="opIddelete_board"></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} \ + -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}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data)); + } +}) + +</code></pre> +<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); + +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}'</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}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}"</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}</code></p> +<p><em>Delete a board</em></p> +<h3 id="delete_board-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> +<h3 id="delete_board-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="export">export</h2> +<p><a id="opIdexport"></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 = { + <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}/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>, +{ + <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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/export'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/export'</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}/export"</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">"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}/export"</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}/export</code></p> +<p><em>This route is used to export the board.</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="export-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 we are exporting</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the ID of the board we are exporting</p> +<h3 id="export-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="add_board_label">add_board_label</h2> +<p><a id="opIdadd_board_label"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X PUT /api/boards/{board}/labels \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/labels</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}/labels'</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">'{ + "label": "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}/labels'</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/boards/{board}/labels'</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/boards/{board}/labels'</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}/labels"</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/boards/{board}/labels"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<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> +<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</td> +</tr> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» label</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the label value</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: 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-string">"string"</span> +</code></pre> +<h3 id="add_board_label-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>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> +<h2 id="set_board_member_permission">set_board_member_permission</h2> +<p><a id="opIdset_board_member_permission"></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}/members/{member} \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/members/{member}</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> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/members/{member}'</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">'{ + "isAdmin": true, + "isNoComments": true, + "isCommentOnly": true +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/members/{member}'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/members/{member}'</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">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.post(<span class="hljs-string">'/api/boards/{board}/members/{member}'</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}/members/{member}"</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">"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}/members/{member}"</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}/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> + +</code></pre> +<h3 id="set_board_member_permission-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 that we are changing</td> +</tr> +<tr> +<td>member</td> +<td>path</td> +<td>string</td> +<td>true</td> +<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> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<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> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_boards_from_user">get_boards_from_user</h2> +<p><a id="opIdget_boards_from_user"></a></p> +<blockquote> +<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}/boards \ + -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}/boards</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}/boards'</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}/boards'</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}/boards'</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}/boards'</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}/boards"</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}/boards"</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}/boards</code></p> +<p><em>Get all boards attached to a user</em></p> +<h3 id="get_boards_from_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 retrieve the data</td> +</tr> +</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> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="get_boards_from_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> +<h1 id="wekan-rest-api-checklists">Checklists</h1> +<h2 id="get_board_card_checklists">get_board_card_checklists</h2> +<p><a id="opIdget_board_card_checklists"></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}/cards/{card}/checklists \ + -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}/cards/{card}/checklists</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</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}/cards/{card}/checklists'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</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}/cards/{card}/checklists"</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">"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}/cards/{card}/checklists"</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}/cards/{card}/checklists</code></p> +<h3 id="get_board_card_checklists-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_card_checklists-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="post_board_card_checklists">post_board_card_checklists</h2> +<p><a id="opIdpost_board_card_checklists"></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}/cards/{card}/checklists \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists</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> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</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">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</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">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.post(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</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}/cards/{card}/checklists"</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">"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}/cards/{card}/checklists"</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}/cards/{card}/checklists</code></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">title:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="post_board_card_checklists-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</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 value</td> +</tr> +</tbody> +</table> +<h3 id="post_board_card_checklists-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_board_card_checklist">get_board_card_checklist</h2> +<p><a id="opIdget_board_card_checklist"></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}/cards/{card}/checklists/{checklist} \ + -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}/cards/{card}/checklists/{checklist}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</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}/cards/{card}/checklists/{checklist}'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</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}/cards/{card}/checklists/{checklist}"</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">"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}/cards/{card}/checklists/{checklist}"</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}/cards/{card}/checklists/{checklist}</code></p> +<h3 id="get_board_card_checklist-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>checklist</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the checklist value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_card_checklist-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_board_card_checklist">delete_board_card_checklist</h2> +<p><a id="opIddelete_board_card_checklist"></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}/cards/{card}/checklists/{checklist} \ + -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}/cards/{card}/checklists/{checklist}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data)); + } +}) + +</code></pre> +<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); + +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}'</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}/cards/{card}/checklists/{checklist}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/cards/{card}/checklists/{checklist}"</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}/cards/{card}/checklists/{checklist}</code></p> +<h3 id="delete_board_card_checklist-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>checklist</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the checklist value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_card_checklist-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<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-checklistitems">ChecklistItems</h1> +<h2 id="get_board_card_checklist_item">get_board_card_checklist_item</h2> +<p><a id="opIdget_board_card_checklist_item"></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}/cards/{card}/checklists/{checklist}/items/{item} \ + -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}/cards/{card}/checklists/{checklist}/items/{item}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</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}/cards/{card}/checklists/{checklist}/items/{item}'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</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}/cards/{card}/checklists/{checklist}/items/{item}"</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">"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}/cards/{card}/checklists/{checklist}/items/{item}"</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}/cards/{card}/checklists/{checklist}/items/{item}</code></p> +<h3 id="get_board_card_checklist_item-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>checklist</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the checklist value</td> +</tr> +<tr> +<td>item</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the item value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_card_checklist_item-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="put_board_card_checklist_item">put_board_card_checklist_item</h2> +<p><a id="opIdput_board_card_checklist_item"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</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> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</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">'{ + "isFinished": "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">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<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>, + <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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.put <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</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">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.put(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</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}/cards/{card}/checklists/{checklist}/items/{item}"</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">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"PUT"</span>, <span class="hljs-string">"/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</code></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="put_board_card_checklist_item-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>checklist</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the checklist value</td> +</tr> +<tr> +<td>item</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the item value</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>true</td> +<td>the isFinished value</td> +</tr> +<tr> +<td>» title</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the title value</td> +</tr> +</tbody> +</table> +<h3 id="put_board_card_checklist_item-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_board_card_checklist_item">delete_board_card_checklist_item</h2> +<p><a id="opIddelete_board_card_checklist_item"></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}/cards/{card}/checklists/{checklist}/items/{item} \ + -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}/cards/{card}/checklists/{checklist}/items/{item}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data)); + } +}) + +</code></pre> +<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); + +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}'</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}/cards/{card}/checklists/{checklist}/items/{item}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}"</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}/cards/{card}/checklists/{checklist}/items/{item}</code></p> +<h3 id="delete_board_card_checklist_item-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>checklist</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the checklist value</td> +</tr> +<tr> +<td>item</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the item value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_card_checklist_item-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<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-cardcomments">CardComments</h1> +<h2 id="get_all_comments">get_all_comments</h2> +<p><a id="opIdget_all_comments"></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}/cards/{card}/comments \ + -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}/cards/{card}/comments</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}/cards/{card}/comments'</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}/cards/{card}/comments'</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}/cards/{card}/comments'</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}/cards/{card}/comments'</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}/cards/{card}/comments"</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}/cards/{card}/comments"</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}/cards/{card}/comments</code></p> +<p><em>Get all comments attached to a card</em></p> +<h3 id="get_all_comments-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 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> +<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> + } +] +</code></pre> +<h3 id="get_all_comments-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_comments-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>» 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> +</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="post_board_card_comments">post_board_card_comments</h2> +<p><a id="opIdpost_board_card_comments"></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}/cards/{card}/comments \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/comments</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> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/comments'</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">'{ + "authorId": "string", + "comment": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/cards/{card}/comments'</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">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.post(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments'</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}/cards/{card}/comments"</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">"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}/cards/{card}/comments"</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}/cards/{card}/comments</code></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">comment:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="post_board_card_comments-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» authorId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the authorId value</td> +</tr> +<tr> +<td>» comment</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the comment value</td> +</tr> +</tbody> +</table> +<h3 id="post_board_card_comments-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_board_card_comment">get_board_card_comment</h2> +<p><a id="opIdget_board_card_comment"></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}/cards/{card}/comments/{comment} \ + -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}/cards/{card}/comments/{comment}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</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}/cards/{card}/comments/{comment}'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</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}/cards/{card}/comments/{comment}"</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">"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}/cards/{card}/comments/{comment}"</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}/cards/{card}/comments/{comment}</code></p> +<h3 id="get_board_card_comment-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>comment</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the comment value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_card_comment-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_board_card_comment">delete_board_card_comment</h2> +<p><a id="opIddelete_board_card_comment"></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}/cards/{card}/comments/{comment} \ + -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}/cards/{card}/comments/{comment}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data)); + } +}) + +</code></pre> +<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); + +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comment}'</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}/cards/{card}/comments/{comment}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/cards/{card}/comments/{comment}"</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}/cards/{card}/comments/{comment}</code></p> +<h3 id="delete_board_card_comment-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 value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +<tr> +<td>comment</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the comment value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_card_comment-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<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-customfields">CustomFields</h1> +<h2 id="get_all_custom_fields">get_all_custom_fields</h2> +<p><a id="opIdget_all_custom_fields"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/custom-fields \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/custom-fields</span> HTTP/1.1 + +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="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}/custom-fields'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <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}/custom-fields'</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}/custom-fields'</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}/custom-fields'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields"</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}/custom-fields"</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}/custom-fields</code></p> +<p><em>Get the list of Custom Fields attached to a board</em></p> +<h3 id="get_all_custom_fields-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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 value</td> +</tr> +</tbody> +</table> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_all_custom_fields-responses">Responses</h3> +<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_custom_fields-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» name</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» type</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</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_custom_field">new_custom_field</h2> +<p><a id="opIdnew_custom_field"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X POST /api/boards/{board}/custom-fields \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/custom-fields</span> HTTP/1.1 + +<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, + + <span class="hljs-attr">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">'{ + "name": "string", + "type": "string", + "settings": "string", + "showOnCard": true, + "automaticallyOnCard": true, + "showLabelOnMiniCard": true, + "authorId": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields'</span>, +{ + <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}/custom-fields'</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}/custom-fields'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields"</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}/custom-fields"</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}/custom-fields</code></p> +<p><em>Create a Custom Field</em></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">name:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">type:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">settings:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">showOnCard:</span> <span class="hljs-literal">true</span> +<span class="hljs-attr">automaticallyOnCard:</span> <span class="hljs-literal">true</span> +<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span> +<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="new_custom_field-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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 value</td> +</tr> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» name</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the name of the custom field</td> +</tr> +<tr> +<td>» type</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the type of the custom field</td> +</tr> +<tr> +<td>» settings</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the settings object of the custom field</td> +</tr> +<tr> +<td>» showOnCard</td> +<td>body</td> +<td>boolean</td> +<td>true</td> +<td>should we show the custom field on cards?</td> +</tr> +<tr> +<td>» automaticallyOnCard</td> +<td>body</td> +<td>boolean</td> +<td>true</td> +<td>should the custom fields automatically be added on cards?</td> +</tr> +<tr> +<td>» showLabelOnMiniCard</td> +<td>body</td> +<td>boolean</td> +<td>true</td> +<td>should the label of the custom field be shown on minicards?</td> +</tr> +<tr> +<td>» authorId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the authorId value</td> +</tr> +</tbody> +</table> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_custom_field-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_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> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_board_customfield">get_board_customField</h2> +<p><a id="opIdget_board_customField"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/custom-fields/{customField} \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <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}/custom-fields/{customField}'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</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">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>GET /api/boards/{board}/custom-fields/{customField}</code></p> +<h3 id="get_board_customfield-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 value</td> +</tr> +<tr> +<td>customField</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the customField value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_customfield-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_board_customfield">delete_board_customField</h2> +<p><a id="opIddelete_board_customField"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X DELETE /api/boards/{board}/custom-fields/{customField} \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data)); + } +}) + +</code></pre> +<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); + +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/custom-fields/{customField}"</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}/custom-fields/{customField}</code></p> +<h3 id="delete_board_customfield-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 value</td> +</tr> +<tr> +<td>customField</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the customField value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_customfield-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<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-integrations">Integrations</h1> +<h2 id="get_all_integrations">get_all_integrations</h2> +<p><a id="opIdget_all_integrations"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/integrations \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/integrations</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}/integrations'</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}/integrations'</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}/integrations'</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}/integrations'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations"</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}/integrations"</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}/integrations</code></p> +<p><em>Get all integrations in board</em></p> +<h3 id="get_all_integrations-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> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"activities"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_all_integrations-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</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_integrations-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td><em>anonymous</em></td> +<td>[<a href="#schemaintegrations">Integrations</a>]</td> +<td>false</td> +<td>none</td> +<td>[Integration with third-party applications]</td> +</tr> +<tr> +<td>» enabled</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the integration enabled?</td> +</tr> +<tr> +<td>» title</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>name of the integration</td> +</tr> +<tr> +<td>» type</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>type of the integratation (Default to 'outgoing-webhooks')</td> +</tr> +<tr> +<td>» activities</td> +<td>[string]</td> +<td>true</td> +<td>none</td> +<td>activities the integration gets triggered (list)</td> +</tr> +<tr> +<td>» url</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» token</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>token of the integration</td> +</tr> +<tr> +<td>» boardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Board ID of the integration</td> +</tr> +<tr> +<td>» createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Creation date of the integration</td> +</tr> +<tr> +<td>» modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» userId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>user ID who created the interation</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="new_integration">new_integration</h2> +<p><a id="opIdnew_integration"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X POST /api/boards/{board}/integrations \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/integrations</span> HTTP/1.1 + +<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, + + <span class="hljs-attr">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">'{ + "url": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/integrations'</span>, +{ + <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}/integrations'</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}/integrations'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations"</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}/integrations"</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}/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> +<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>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» url</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the URL of the integration</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_integration-responses">Responses</h3> +<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_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> +</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_integration">get_integration</h2> +<p><a id="opIdget_integration"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/integrations/{int} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</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}/integrations/{int}'</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}/integrations/{int}'</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}/integrations/{int}'</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}/integrations/{int}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"GET"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +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}/integrations/{int}"</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}/integrations/{int}</code></p> +<p><em>Get a single integration in board</em></p> +<h3 id="get_integration-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> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"activities"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="get_integration-responses">Responses</h3> +<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="#schemaintegrations">Integrations</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_integration">edit_integration</h2> +<p><a id="opIdedit_integration"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X PUT /api/boards/{board}/integrations/{int} \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</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}/integrations/{int}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'put'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <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">'{ + "enabled": "string", + "title": "string", + "url": "string", + "token": "string", + "activities": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}'</span>, +{ + <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/boards/{board}/integrations/{int}'</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/boards/{board}/integrations/{int}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}"</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/boards/{board}/integrations/{int}"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>PUT /api/boards/{board}/integrations/{int}</code></p> +<p><em>Edit integration data</em></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">enabled:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">title:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">url:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">token:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="edit_integration-parameters">Parameters</h3> +<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> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» enabled</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>is the integration enabled?</td> +</tr> +<tr> +<td>» title</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new name of the integration</td> +</tr> +<tr> +<td>» url</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new URL of the integration</td> +</tr> +<tr> +<td>» token</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new token of the integration</td> +</tr> +<tr> +<td>» activities</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>new list of activities of the integration</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>int</strong>: the integration ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="edit_integration-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_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> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_integration">delete_integration</h2> +<p><a id="opIddelete_integration"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X DELETE /api/boards/{board}/integrations/{int} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}</span> HTTP/1.1 + +<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}/integrations/{int}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <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}/integrations/{int}'</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}/integrations/{int}'</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}/integrations/{int}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}"</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}/integrations/{int}"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>DELETE /api/boards/{board}/integrations/{int}</code></p> +<p><em>Delete integration</em></p> +<h3 id="delete_integration-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> +<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_integration-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_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> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_board_int_activities">delete_board_int_activities</h2> +<p><a id="opIddelete_board_int_activities"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X DELETE /api/boards/{board}/integrations/{int}/activities \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}/activities</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'delete'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(data)); + } +}) + +</code></pre> +<pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); + +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>DELETE /api/boards/{board}/integrations/{int}/activities</code></p> +<h3 id="delete_board_int_activities-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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 value</td> +</tr> +<tr> +<td>int</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the int value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_int_activities-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="post_board_int_activities">post_board_int_activities</h2> +<p><a id="opIdpost_board_int_activities"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X POST /api/boards/{board}/integrations/{int}/activities \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}/activities</span> HTTP/1.1 + +<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'post'</span>, + + <span class="hljs-attr">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">'{ + "activities": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, +{ + <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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.post(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activities'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"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">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"POST"</span>, <span class="hljs-string">"/api/boards/{board}/integrations/{int}/activities"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>POST /api/boards/{board}/integrations/{int}/activities</code></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="post_board_int_activities-parameters">Parameters</h3> +<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 value</td> +</tr> +<tr> +<td>int</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the int value</td> +</tr> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» activities</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the activities value</td> +</tr> +</tbody> +</table> +<h3 id="post_board_int_activities-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<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-lists">Lists</h1> +<h2 id="get_all_lists">get_all_lists</h2> +<p><a id="opIdget_all_lists"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/lists \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists</span> HTTP/1.1 + +<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'</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}/lists'</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}/lists'</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}/lists'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists"</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}/lists"</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}/lists</code></p> +<p><em>Get the list of Lists attached to a board</em></p> +<h3 id="get_all_lists-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_all_lists-responses">Responses</h3> +<table> +<thead> +<tr> +<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_lists-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="new_list">new_list</h2> +<p><a id="opIdnew_list"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X POST /api/boards/{board}/lists \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/lists</span> HTTP/1.1 + +<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists'</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}/lists'</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}/lists'</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}/lists'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists"</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}/lists"</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}/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> +<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>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> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_list-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_list-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_list">get_list</h2> +<p><a id="opIdget_list"></a></p> +<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} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists/{list}</span> HTTP/1.1 + +<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}'</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}/lists/{list}'</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}/lists/{list}'</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}/lists/{list}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}"</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}/lists/{list}"</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}/lists/{list}</code></p> +<p><em>Get a List attached to a board</em></p> +<h3 id="get_list-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the List ID</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>list</strong>: the List ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"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">"swimlaneId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"wipLimit"</span>: { + <span class="hljs-attr">"value"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"soft"</span>: <span class="hljs-literal">true</span> + }, + <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="get_list-responses">Responses</h3> +<table> +<thead> +<tr> +<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="#schemalists">Lists</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_list">delete_list</h2> +<p><a id="opIddelete_list"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X DELETE /api/boards/{board}/lists/{list} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}</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}'</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}/lists/{list}'</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}/lists/{list}'</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}/lists/{list}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}"</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}/lists/{list}"</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}/lists/{list}</code></p> +<p><em>Delete a List</em></p> +<p>This <strong>deletes</strong> a list from a board. +The list is not put in the recycle bin.</p> +<h3 id="delete_list-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the ID of the list to remove</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>list</strong>: the ID of the list to remove</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_list-responses">Responses</h3> +<table> +<thead> +<tr> +<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_list-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +</tbody> +</table> +<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-cards">Cards</h1> +<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> +<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'</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}/lists/{list}/cards'</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}/lists/{list}/cards'</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}/lists/{list}/cards'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards"</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}/lists/{list}/cards"</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}/lists/{list}/cards</code></p> +<p><em>Get all Cards attached to a List</em></p> +<h3 id="get_all_cards-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list ID</td> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>list</strong>: the list ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_all_cards-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_cards-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> +</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_card">new_card</h2> +<p><a id="opIdnew_card"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X POST /api/boards/{board}/lists/{list}/cards \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards</span> HTTP/1.1 + +<span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, + <span class="hljs-attr">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">'{ + "authorId": "string", + "members": "string", + "title": "string", + "description": "string", + "swimlaneId": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>, + <span class="hljs-attr">body</span>: inputBody, + <span class="hljs-attr">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}/lists/{list}/cards'</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}/lists/{list}/cards'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards"</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}/lists/{list}/cards"</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}/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">title:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">description:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">swimlaneId:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="new_card-parameters">Parameters</h3> +<table> +<thead> +<tr> +<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 new card</td> +</tr> +<tr> +<td>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list ID of the new card</td> +</tr> +<tr> +<td>body</td> +<td>body</td> +<td>object</td> +<td>false</td> +<td>none</td> +</tr> +<tr> +<td>» authorId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the authorId value</td> +</tr> +<tr> +<td>» members</td> +<td>body</td> +<td>string</td> +<td>false</td> +<td>the member IDs list of the new card</td> +</tr> +<tr> +<td>» 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_board_list_card">get_board_list_card</h2> +<p><a id="opIdget_board_list_card"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <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">'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}/lists/{list}/cards/{card}'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</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">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>GET /api/boards/{board}/lists/{list}/cards/{card}</code></p> +<h3 id="get_board_list_card-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 value</td> +</tr> +<tr> +<td>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_list_card-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="put_board_list_card">put_board_list_card</h2> +<p><a id="opIdput_board_list_card"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</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> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'put'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <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", + "listId": "string", + "authorId": "string", + "parentId": "string", + "description": "string", + "color": "string", + "labelIds": "string", + "requestedBy": "string", + "assignedBy": "string", + "receivedAt": "string", + "startAt": "string", + "dueAt": "string", + "endAt": "string", + "spentTime": "string", + "isOverTime": "string", + "customFields": "string", + "members": "string", + "swimlaneId": "string" +}'</span>; +<span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'PUT'</span>, + <span class="hljs-attr">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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.put <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.put(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</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">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"PUT"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>, data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + <span class="hljs-comment">// ...</span> +} + +</code></pre> +<p><code>PUT /api/boards/{board}/lists/{list}/cards/{card}</code></p> +<blockquote> +<p>Body parameter</p> +</blockquote> +<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">title:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">listId:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">parentId:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">description:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">color:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">labelIds:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">requestedBy:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">assignedBy:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">receivedAt:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">startAt:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">dueAt:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">endAt:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">spentTime:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">isOverTime:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">customFields:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">members:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">swimlaneId:</span> <span class="hljs-string">string</span> + +</code></pre> +<h3 id="put_board_list_card-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 value</td> +</tr> +<tr> +<td>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</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 value</td> +</tr> +<tr> +<td>» listId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the listId value</td> +</tr> +<tr> +<td>» authorId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the authorId value</td> +</tr> +<tr> +<td>» parentId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the parentId value</td> +</tr> +<tr> +<td>» description</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the description value</td> +</tr> +<tr> +<td>» color</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the color value</td> +</tr> +<tr> +<td>» labelIds</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the labelIds value</td> +</tr> +<tr> +<td>» requestedBy</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the requestedBy value</td> +</tr> +<tr> +<td>» assignedBy</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the assignedBy value</td> +</tr> +<tr> +<td>» receivedAt</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the receivedAt value</td> +</tr> +<tr> +<td>» startAt</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the startAt value</td> +</tr> +<tr> +<td>» dueAt</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the dueAt value</td> +</tr> +<tr> +<td>» endAt</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the endAt value</td> +</tr> +<tr> +<td>» spentTime</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the spentTime value</td> +</tr> +<tr> +<td>» isOverTime</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the isOverTime value</td> +</tr> +<tr> +<td>» customFields</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the customFields value</td> +</tr> +<tr> +<td>» members</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the members value</td> +</tr> +<tr> +<td>» swimlaneId</td> +<td>body</td> +<td>string</td> +<td>true</td> +<td>the swimlaneId value</td> +</tr> +</tbody> +</table> +<h3 id="put_board_list_card-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="delete_board_list_card">delete_board_list_card</h2> +<p><a id="opIddelete_board_list_card"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <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)); + } +}) + +</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}/lists/{list}/cards/{card}'</span>, +{ + <span class="hljs-attr">method</span>: <span class="hljs-string">'DELETE'</span>, + + <span class="hljs-attr">headers</span>: headers +}) +.then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">res</span>) </span>{ + <span class="hljs-keyword">return</span> res.json(); +}).then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">body</span>) </span>{ + <span class="hljs-built_in">console</span>.log(body); +}); + +</code></pre> +<pre class="highlight tab tab-ruby"><code><span class="hljs-keyword">require</span> <span class="hljs-string">'rest-client'</span> +<span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> + +headers = { + <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.delete <span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.delete(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"DELETE"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"DELETE"</span>, <span class="hljs-string">"/api/boards/{board}/lists/{list}/cards/{card}"</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}/lists/{list}/cards/{card}</code></p> +<h3 id="delete_board_list_card-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 value</td> +</tr> +<tr> +<td>list</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the list value</td> +</tr> +<tr> +<td>card</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the card value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_list_card-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_board_swimlane_cards">get_board_swimlane_cards</h2> +<p><a id="opIdget_board_swimlane_cards"></a></p> +<blockquote> +<p>Code samples</p> +</blockquote> +<pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> +curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/swimlanes/{swimlane}/cards</span> HTTP/1.1 + +<span class="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>, + <span class="hljs-attr">method</span>: <span class="hljs-string">'get'</span>, + + <span class="hljs-attr">headers</span>: headers, + <span class="hljs-attr">success</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) </span>{ + <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}/swimlanes/{swimlane}/cards'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.get <span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>, + <span class="hljs-symbol">params:</span> { + }, <span class="hljs-symbol">headers:</span> headers + +p JSON.parse(result) + +</code></pre> +<pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests +headers = { + <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.get(<span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards'</span>, params={ + +}, headers = headers) + +<span class="hljs-keyword">print</span> r.json() + +</code></pre> +<pre class="highlight tab tab-java"><code>URL obj = <span class="hljs-keyword">new</span> URL(<span class="hljs-string">"/api/boards/{board}/swimlanes/{swimlane}/cards"</span>); +HttpURLConnection con = (HttpURLConnection) obj.openConnection(); +con.setRequestMethod(<span class="hljs-string">"GET"</span>); +<span class="hljs-keyword">int</span> responseCode = con.getResponseCode(); +BufferedReader in = <span class="hljs-keyword">new</span> BufferedReader( + <span class="hljs-keyword">new</span> InputStreamReader(con.getInputStream())); +String inputLine; +StringBuffer response = <span class="hljs-keyword">new</span> StringBuffer(); +<span class="hljs-keyword">while</span> ((inputLine = in.readLine()) != <span class="hljs-keyword">null</span>) { + response.append(inputLine); +} +in.close(); +System.out.println(response.toString()); + +</code></pre> +<pre class="highlight tab tab-go"><code><span class="hljs-keyword">package</span> main + +<span class="hljs-keyword">import</span> ( + <span class="hljs-string">"bytes"</span> + <span class="hljs-string">"net/http"</span> +) + +<span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { + + headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, + + } + + data := bytes.NewBuffer([]<span class="hljs-keyword">byte</span>{jsonReq}) + req, err := http.NewRequest(<span class="hljs-string">"GET"</span>, <span class="hljs-string">"/api/boards/{board}/swimlanes/{swimlane}/cards"</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}/cards</code></p> +<h3 id="get_board_swimlane_cards-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 value</td> +</tr> +<tr> +<td>swimlane</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the swimlane value</td> +</tr> +</tbody> +</table> +<h3 id="get_board_swimlane_cards-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<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-users">Users</h1> +<h2 id="add_board_member">add_board_member</h2> +<p><a id="opIdadd_board_member"></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}/members/{user}/add \ + -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}/members/{user}/add</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}/members/{user}/add'</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">'{ + "action": "string", + "isAdmin": true, + "isNoComments": true, + "isCommentOnly": true +}'</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}/members/{user}/add'</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}/members/{user}/add'</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}/members/{user}/add'</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}/members/{user}/add"</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}/members/{user}/add"</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}/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> +<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>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> +</tr> +</tbody> +</table> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<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="add_board_member-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="add_board_member-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="post_board_user_remove">post_board_user_remove</h2> +<p><a id="opIdpost_board_user_remove"></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}/members/{user}/remove \ + -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Authorization: API_KEY'</span> + +</code></pre> +<pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/members/{user}/remove</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> + +</span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/members/{user}/remove'</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">'{ + "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">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +fetch(<span class="hljs-string">'/api/boards/{board}/members/{user}/remove'</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">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> +} + +result = RestClient.post <span class="hljs-string">'/api/boards/{board}/members/{user}/remove'</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">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> +} + +r = requests.post(<span class="hljs-string">'/api/boards/{board}/members/{user}/remove'</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}/members/{user}/remove"</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">"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}/members/{user}/remove"</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}/members/{user}/remove</code></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> + +</code></pre> +<h3 id="post_board_user_remove-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 value</td> +</tr> +<tr> +<td>user</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the user value</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> +</tbody> +</table> +<h3 id="post_board_user_remove-responses">Responses</h3> +<table> +<thead> +<tr> +<th>Status</th> +<th>Meaning</th> +<th>Description</th> +<th>Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td>200</td> +<td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> +<td>200 response</td> +<td>None</td> +</tr> +</tbody> +</table> +<aside class="warning"> +To perform this operation, you must be authenticated by means of one of the following methods: +UserSecurity +</aside> +<h2 id="get_current_user">get_current_user</h2> +<p><a id="opIdget_current_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/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/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/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/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/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/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/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/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/user</code></p> +<p><em>returns the current user</em></p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"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">"hiddenSystemMessages"</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-string">"string"</span> + ], + <span class="hljs-attr">"showCardsCountAt"</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-lists"</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> +} +</code></pre> +<h3 id="get_current_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="get_all_users">get_all_users</h2> +<p><a id="opIdget_all_users"></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 \ + -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</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'</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'</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'</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'</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">"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"</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</code></p> +<p><em>return all the users</em></p> +<p>Only the admin user (the first user) can call the REST API.</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">"username"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_all_users-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_users-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>» username</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_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">"hiddenSystemMessages"</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-string">"string"</span> + ], + <span class="hljs-attr">"showCardsCountAt"</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-lists"</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> +} +</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_board_swimlane">delete_board_swimlane</h2> +<p><a id="opIddelete_board_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">'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="undefined"></span></code></pre> +<pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> + +}; + +$.ajax({ + <span class="hljs-attr">url</span>: <span class="hljs-string">'/api/boards/{board}/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">'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">'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">'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">"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> +<h3 id="delete_board_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 board value</td> +</tr> +<tr> +<td>swimlane</td> +<td>path</td> +<td>string</td> +<td>true</td> +<td>the swimlane value</td> +</tr> +</tbody> +</table> +<h3 id="delete_board_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>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">"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">"allowsSubtasks"</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> +} + +</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>allowsSubtasks</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>Does the board allows subtasks?</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> +</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>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> +} + +</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> +</tbody> +</table> +<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> +</tr> +</thead> +<tbody> +<tr> +<td>boardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the board ID</td> +</tr> +<tr> +<td>cardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the card ID</td> +</tr> +<tr> +<td>text</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the text of the comment</td> +</tr> +<tr> +<td>createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>when was the comment created</td> +</tr> +<tr> +<td>modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>userId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the author ID of the comment</td> +</tr> +</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">"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> +} + +</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>title</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>the title of the card</td> +</tr> +<tr> +<td>archived</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the card archived</td> +</tr> +<tr> +<td>parentId</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>ID of the parent card</td> +</tr> +<tr> +<td>listId</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>List ID where the card is</td> +</tr> +<tr> +<td>swimlaneId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<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> +</tr> +<tr> +<td>coverId</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>Cover ID of the card</td> +</tr> +<tr> +<td>color</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>creation date</td> +</tr> +<tr> +<td>modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>customFields</td> +<td>[<a href="#schemacardscustomfields">CardsCustomfields</a>]|null</td> +<td>false</td> +<td>none</td> +<td>list of custom fields</td> +</tr> +<tr> +<td>dateLastActivity</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Date of last activity</td> +</tr> +<tr> +<td>description</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>description of the card</td> +</tr> +<tr> +<td>requestedBy</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>who requested the card (ID of the user)</td> +</tr> +<tr> +<td>assignedBy</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>who assigned the card (ID of the user)</td> +</tr> +<tr> +<td>labelIds</td> +<td>[string]|null</td> +<td>false</td> +<td>none</td> +<td>list of labels ID the card has</td> +</tr> +<tr> +<td>members</td> +<td>[string]|null</td> +<td>false</td> +<td>none</td> +<td>list of members (user IDs)</td> +</tr> +<tr> +<td>receivedAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>Date the card was received</td> +</tr> +<tr> +<td>startAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>Date the card was started to be worked on</td> +</tr> +<tr> +<td>dueAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>Date the card is due</td> +</tr> +<tr> +<td>endAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>Date the card ended</td> +</tr> +<tr> +<td>spentTime</td> +<td>number|null</td> +<td>false</td> +<td>none</td> +<td>How much time has been spent on this</td> +</tr> +<tr> +<td>isOvertime</td> +<td>boolean|null</td> +<td>false</td> +<td>none</td> +<td>is the card over time?</td> +</tr> +<tr> +<td>userId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>user ID of the author of the card</td> +</tr> +<tr> +<td>sort</td> +<td>number</td> +<td>true</td> +<td>none</td> +<td>Sort value</td> +</tr> +<tr> +<td>subtaskSort</td> +<td>number|null</td> +<td>false</td> +<td>none</td> +<td>subtask sort value</td> +</tr> +<tr> +<td>type</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>type of the card</td> +</tr> +<tr> +<td>linkedId</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>ID of the linked card</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>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>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="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> +<pre class="highlight tab tab-json"><code>{ + <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> +} + +</code></pre> +<p><em>An item in a checklist</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 text of the item</td> +</tr> +<tr> +<td>sort</td> +<td>number</td> +<td>true</td> +<td>none</td> +<td>the sorting field of the item</td> +</tr> +<tr> +<td>isFinished</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>Is the item checked?</td> +</tr> +<tr> +<td>checklistId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the checklist ID the item is attached to</td> +</tr> +<tr> +<td>cardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the card ID the item is attached to</td> +</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> +<h2 id="tocschecklists">Checklists</h2> +<p><a id="schemachecklists"></a></p> +<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">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span> +} + +</code></pre> +<p><em>A Checklist</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>cardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>The ID of the card the checklist is in</td> +</tr> +<tr> +<td>title</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the title of the checklist</td> +</tr> +<tr> +<td>finishedAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>When was the checklist finished</td> +</tr> +<tr> +<td>createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Creation date of the checklist</td> +</tr> +<tr> +<td>modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>sort</td> +<td>number</td> +<td>true</td> +<td>none</td> +<td>sorting value of the checklist</td> +</tr> +</tbody> +</table> +<h2 id="tocscustomfields">CustomFields</h2> +<p><a id="schemacustomfields"></a></p> +<pre class="highlight tab tab-json"><code>{ + <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>: { + <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">"showLabelOnMiniCard"</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> +} + +</code></pre> +<p><em>A custom field on a card in the 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>boardIds</td> +<td>[string]</td> +<td>true</td> +<td>none</td> +<td>the ID of the board</td> +</tr> +<tr> +<td>name</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>name of the custom field</td> +</tr> +<tr> +<td>type</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>type of the custom field</td> +</tr> +<tr> +<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> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>should we show on the cards this custom field</td> +</tr> +<tr> +<td>automaticallyOnCard</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>should the custom fields automatically be added on cards?</td> +</tr> +<tr> +<td>showLabelOnMiniCard</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>should the label of the custom field be shown on minicards?</td> +</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> +<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> +</tbody> +</table> +<h2 id="tocscustomfieldssettings">CustomFieldsSettings</h2> +<p><a id="schemacustomfieldssettings"></a></p> +<pre class="highlight tab tab-json"><code>{ + <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> +<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>, + <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> +<p><em>Integration with third-party applications</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>enabled</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the integration enabled?</td> +</tr> +<tr> +<td>title</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>name of the integration</td> +</tr> +<tr> +<td>type</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>type of the integratation (Default to 'outgoing-webhooks')</td> +</tr> +<tr> +<td>activities</td> +<td>[string]</td> +<td>true</td> +<td>none</td> +<td>activities the integration gets triggered (list)</td> +</tr> +<tr> +<td>url</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>token</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>token of the integration</td> +</tr> +<tr> +<td>boardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Board ID of the integration</td> +</tr> +<tr> +<td>createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Creation date of the integration</td> +</tr> +<tr> +<td>modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>userId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>user ID who created the interation</td> +</tr> +</tbody> +</table> +<h2 id="tocslists">Lists</h2> +<p><a id="schemalists"></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">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"swimlaneId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"updatedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"wipLimit"</span>: { + <span class="hljs-attr">"value"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"soft"</span>: <span class="hljs-literal">true</span> + }, + <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span> +} + +</code></pre> +<p><em>A list (column) in the Wekan 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 list</td> +</tr> +<tr> +<td>archived</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the list archived</td> +</tr> +<tr> +<td>boardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the board associated to this list</td> +</tr> +<tr> +<td>swimlaneId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the swimlane associated to this list. Used for templates</td> +</tr> +<tr> +<td>createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>creation date</td> +</tr> +<tr> +<td>sort</td> +<td>number|null</td> +<td>false</td> +<td>none</td> +<td>is the list sorted</td> +</tr> +<tr> +<td>updatedAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>last update of the list</td> +</tr> +<tr> +<td>modifiedAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<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> +</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> +<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="tocslistswiplimit">ListsWiplimit</h2> +<p><a id="schemalistswiplimit"></a></p> +<pre class="highlight tab tab-json"><code>{ + <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> +} + +</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>value</td> +<td>number</td> +<td>true</td> +<td>none</td> +<td>value of the WIP</td> +</tr> +<tr> +<td>enabled</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the WIP enabled</td> +</tr> +<tr> +<td>soft</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the WIP a soft or hard requirement</td> +</tr> +</tbody> +</table> +<h2 id="tocsswimlanes">Swimlanes</h2> +<p><a id="schemaswimlanes"></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">"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> +<p><em>A swimlane is an line in the kaban 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 swimlane</td> +</tr> +<tr> +<td>archived</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>is the swimlane archived?</td> +</tr> +<tr> +<td>boardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>the ID of the board the swimlane is attached to</td> +</tr> +<tr> +<td>createdAt</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>creation date of the swimlane</td> +</tr> +<tr> +<td>sort</td> +<td>number|null</td> +<td>false</td> +<td>none</td> +<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> +</tr> +<tr> +<td>updatedAt</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>when was the swimlane last edited</td> +</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> +<td>The type of swimlane</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>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> +<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="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">"hiddenSystemMessages"</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-string">"string"</span> + ], + <span class="hljs-attr">"showCardsCountAt"</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-lists"</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> +} + +</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> +</tr> +<tr> +<td>profile</td> +<td><a href="#schemausersprofile">UsersProfile</a></td> +<td>false</td> +<td>none</td> +<td>profile settings</td> +</tr> +<tr> +<td>services</td> +<td>object|null</td> +<td>false</td> +<td>none</td> +<td>services field of the user</td> +</tr> +<tr> +<td>heartbeat</td> +<td>string|null</td> +<td>false</td> +<td>none</td> +<td>last time the user has been seen</td> +</tr> +<tr> +<td>isAdmin</td> +<td>boolean|null</td> +<td>false</td> +<td>none</td> +<td>is the user an admin of the board?</td> +</tr> +<tr> +<td>createdThroughApi</td> +<td>boolean|null</td> +<td>false</td> +<td>none</td> +<td>was the user created through the API?</td> +</tr> +<tr> +<td>loginDisabled</td> +<td>boolean|null</td> +<td>false</td> +<td>none</td> +<td>loginDisabled field of the user</td> +</tr> +<tr> +<td>authenticationMethod</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>authentication method of the user</td> +</tr> +</tbody> +</table> +<h2 id="tocsusersemails">UsersEmails</h2> +<p><a id="schemausersemails"></a></p> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"address"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"verified"</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>address</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>The email address</td> +</tr> +<tr> +<td>verified</td> +<td>boolean</td> +<td>true</td> +<td>none</td> +<td>Has the email been verified</td> +</tr> +</tbody> +</table> +<h2 id="tocsusersprofile">UsersProfile</h2> +<p><a id="schemausersprofile"></a></p> +<pre class="highlight tab tab-json"><code>{ + <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">"hiddenSystemMessages"</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-string">"string"</span> + ], + <span class="hljs-attr">"showCardsCountAt"</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-lists"</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> +} + +</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>avatarUrl</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>URL of the avatar of the user</td> +</tr> +<tr> +<td>emailBuffer</td> +<td>[string]</td> +<td>false</td> +<td>none</td> +<td>list of email buffers of the user</td> +</tr> +<tr> +<td>fullname</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>full name of the user</td> +</tr> +<tr> +<td>hiddenSystemMessages</td> +<td>boolean</td> +<td>false</td> +<td>none</td> +<td>does the user wants to hide system messages?</td> +</tr> +<tr> +<td>initials</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>initials of the user</td> +</tr> +<tr> +<td>invitedBoards</td> +<td>[string]</td> +<td>false</td> +<td>none</td> +<td>board IDs the user has been invited to</td> +</tr> +<tr> +<td>language</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>language of the user</td> +</tr> +<tr> +<td>notifications</td> +<td>[string]</td> +<td>false</td> +<td>none</td> +<td>enabled notifications for the user</td> +</tr> +<tr> +<td>showCardsCountAt</td> +<td>number</td> +<td>false</td> +<td>none</td> +<td>showCardCountAt field of the user</td> +</tr> +<tr> +<td>starredBoards</td> +<td>[string]</td> +<td>false</td> +<td>none</td> +<td>list of starred board IDs</td> +</tr> +<tr> +<td>icode</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>icode</td> +</tr> +<tr> +<td>boardView</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>boardView field of the user</td> +</tr> +<tr> +<td>templatesBoardId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Reference to the templates board</td> +</tr> +<tr> +<td>cardTemplatesSwimlaneId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Reference to the card templates swimlane Id</td> +</tr> +<tr> +<td>listTemplatesSwimlaneId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Reference to the list templates swimlane Id</td> +</tr> +<tr> +<td>boardTemplatesSwimlaneId</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>Reference to the board templates swimlane Id</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>boardView</td> +<td>board-view-lists</td> +</tr> +<tr> +<td>boardView</td> +<td>board-view-swimlanes</td> +</tr> +<tr> +<td>boardView</td> +<td>board-view-cal</td> +</tr> +</tbody> +</table> + + </div> + <div class="dark-box"> + + <div class="lang-selector"> + + + <a href="#" data-language-name="shell">Shell</a> + + + + <a href="#" data-language-name="http">HTTP</a> + + + + <a href="#" data-language-name="javascript">JavaScript</a> + + + + <a href="#" data-language-name="javascript--nodejs">Node.js</a> + + + + <a href="#" data-language-name="ruby">Ruby</a> + + + + <a href="#" data-language-name="python">Python</a> + + + + <a href="#" data-language-name="java">Java</a> + + + + <a href="#" data-language-name="go">Go</a> + + + </div> + + </div> + </div> + </body> +</html> diff --git a/public/api/wekan.yml b/public/api/wekan.yml new file mode 100644 index 00000000..84cade13 --- /dev/null +++ b/public/api/wekan.yml @@ -0,0 +1,2937 @@ +swagger: '2.0' +info: + title: Wekan REST API + version: v2.99 + description: | + The REST API allows you to control and extend Wekan with ease. + + If you are an end-user and not a dev or a tester, [create an issue](https://github.com/wekan/wekan/issues/new) to request new APIs. + + > All API calls in the documentation are made using `curl`. However, you are free to use Java / Python / PHP / Golang / Ruby / Swift / Objective-C / Rust / Scala / C# or any other programming languages. + + # Production Security Concerns + 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: + + * Only call via HTTPS + * Implement a timed authorization token expiration strategy + * Ensure the calling user only has permissions for what they are calling and no more + +schemes: + - http + +securityDefinitions: + UserSecurity: + type: apiKey + in: header + name: Authorization + +paths: + /users/login: + post: + operationId: login + summary: Login with REST API + consumes: + - application/x-www-form-urlencoded + - application/json + tags: + - Login + parameters: + - name: username + in: formData + required: true + description: | + Your username + type: string + - name: password + in: formData + required: true + description: | + Your password + type: string + format: password + responses: + 200: + description: |- + Successful authentication + schema: + items: + properties: + id: + type: string + token: + type: string + tokenExpires: + type: string + 400: + description: | + Error in authentication + schema: + items: + properties: + error: + type: number + reason: + type: string + default: + description: | + Error in authentication + /users/register: + post: + operationId: register + summary: Register with REST API + description: | + Notes: + - You will need to provide the token for any of the authenticated methods. + consumes: + - application/x-www-form-urlencoded + - application/json + tags: + - Login + parameters: + - name: username + in: formData + required: true + description: | + Your username + type: string + - name: password + in: formData + required: true + description: | + Your password + type: string + format: password + - name: email + in: formData + required: true + description: | + Your email + type: string + responses: + 200: + description: |- + Successful registration + schema: + items: + properties: + id: + type: string + token: + type: string + tokenExpires: + type: string + 400: + description: | + Error in registration + schema: + items: + properties: + error: + type: number + reason: + type: string + default: + description: | + Error in registration + + /api/boards: + get: + operationId: get_public_boards + summary: Get all public boards + tags: + - Boards + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + post: + operationId: new_board + summary: Create a board + description: | + This allows to create a board. + + The color has to be chosen between `belize`, `nephritis`, `pomegranate`, + `pumpkin`, `wisteria`, `moderatepink`, `strongcyan`, + `limegreen`, `midnight`, `dark`, `relax`, `corteza`: + + <img src="https://wekan.github.io/board-colors.png" width="40%" alt="Wekan logo" /> + tags: + - Boards + consumes: + - multipart/form-data + - application/json + parameters: + - name: title + in: formData + description: | + the new title of the board + type: string + required: true + - name: owner + in: formData + description: | + "ABCDE12345" <= User ID in Wekan. + (Not username or email) + type: string + required: true + - name: isAdmin + in: formData + description: | + is the owner an admin of the board (default true) + type: boolean + required: false + - name: isActive + in: formData + description: | + is the board active (default true) + type: boolean + required: false + - name: isNoComments + in: formData + description: | + disable comments (default false) + type: boolean + required: false + - name: isCommentOnly + in: formData + description: | + only enable comments (default false) + type: boolean + required: false + - name: permission + in: formData + description: | + "private" board <== Set to "public" if you + want public Wekan board + type: string + required: false + - name: color + in: formData + description: | + the color of the board + type: string + required: false + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + defaultSwimlaneId: + type: string + /api/boards/{board}: + get: + operationId: get_board + summary: Get the board with that particular ID + tags: + - Boards + parameters: + - name: board + in: path + description: | + the ID of the board to retrieve the data + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + $ref: "#/definitions/Boards" + delete: + operationId: delete_board + summary: Delete a board + tags: + - Boards + parameters: + - name: board + in: path + description: | + the ID of the board + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/cards/{card}/checklists: + get: + operationId: get_board_card_checklists + tags: + - Checklists + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + post: + operationId: post_board_card_checklists + tags: + - Checklists + consumes: + - multipart/form-data + - application/json + parameters: + - name: title + in: formData + description: the title value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/cards/{card}/checklists/{checklist}: + get: + operationId: get_board_card_checklist + tags: + - Checklists + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: checklist + in: path + description: the checklist value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + delete: + operationId: delete_board_card_checklist + tags: + - Checklists + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: checklist + in: path + description: the checklist value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}: + get: + operationId: get_board_card_checklist_item + tags: + - ChecklistItems + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: checklist + in: path + description: the checklist value + type: string + required: true + - name: item + in: path + description: the item value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + put: + operationId: put_board_card_checklist_item + tags: + - ChecklistItems + consumes: + - multipart/form-data + - application/json + parameters: + - name: isFinished + in: formData + description: the isFinished value + type: string + required: true + - name: title + in: formData + description: the title value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: checklist + in: path + description: the checklist value + type: string + required: true + - name: item + in: path + description: the item value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + delete: + operationId: delete_board_card_checklist_item + tags: + - ChecklistItems + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: checklist + in: path + description: the checklist value + type: string + required: true + - name: item + in: path + description: the item value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/cards/{card}/comments: + get: + operationId: get_all_comments + summary: Get all comments attached to a card + tags: + - CardComments + parameters: + - name: board + in: path + description: | + the board ID of the card + type: string + required: true + - name: card + in: path + description: | + the ID of the card + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + comment: + type: string + authorId: + type: string + post: + operationId: post_board_card_comments + tags: + - CardComments + consumes: + - multipart/form-data + - application/json + parameters: + - name: authorId + in: formData + description: the authorId value + type: string + required: true + - name: comment + in: formData + description: the comment value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/cards/{card}/comments/{comment}: + get: + operationId: get_board_card_comment + tags: + - CardComments + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: comment + in: path + description: the comment value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + delete: + operationId: delete_board_card_comment + tags: + - CardComments + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + - name: comment + in: path + description: the comment value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/custom-fields: + get: + operationId: get_all_custom_fields + summary: Get the list of Custom Fields attached to a board + tags: + - CustomFields + parameters: + - name: board + in: path + description: the board value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + name: + type: string + type: + type: string + post: + operationId: new_custom_field + summary: Create a Custom Field + tags: + - CustomFields + consumes: + - multipart/form-data + - application/json + parameters: + - name: name + in: formData + description: | + the name of the custom field + type: string + required: true + - name: type + in: formData + description: | + the type of the custom field + type: string + required: true + - name: settings + in: formData + description: | + the settings object of the custom field + type: string + required: true + - name: showOnCard + in: formData + description: | + should we show the custom field on cards? + type: boolean + required: true + - name: automaticallyOnCard + in: formData + description: | + should the custom fields automatically be added on cards? + type: boolean + required: true + - name: showLabelOnMiniCard + in: formData + description: | + should the label of the custom field be shown on minicards? + type: boolean + required: true + - name: authorId + in: formData + description: the authorId value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/custom-fields/{customField}: + get: + operationId: get_board_customField + tags: + - CustomFields + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: customField + in: path + description: the customField value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + delete: + operationId: delete_board_customField + tags: + - CustomFields + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: customField + in: path + description: the customField value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/export: + get: + operationId: export + summary: This route is used to export the board. + description: | + If user is already logged-in, pass loginToken as param + "authToken": '/api/boards/:boardId/export?authToken=:token' + + See https://blog.kayla.com.au/server-side-route-authentication-in-meteor/ + for detailed explanations + tags: + - Boards + parameters: + - name: board + in: path + description: | + the ID of the board we are exporting + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/integrations: + get: + operationId: get_all_integrations + summary: Get all integrations in board + tags: + - Integrations + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + $ref: "#/definitions/Integrations" + post: + operationId: new_integration + summary: Create a new integration + tags: + - Integrations + consumes: + - multipart/form-data + - application/json + parameters: + - name: url + in: formData + description: | + the URL of the integration + type: string + required: true + - name: board + in: path + description: | + the board ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/integrations/{int}: + get: + operationId: get_integration + summary: Get a single integration in board + tags: + - Integrations + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: int + in: path + description: | + the integration ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + $ref: "#/definitions/Integrations" + put: + operationId: edit_integration + summary: Edit integration data + tags: + - Integrations + consumes: + - multipart/form-data + - application/json + parameters: + - name: enabled + in: formData + description: | + is the integration enabled? + type: string + required: false + - name: title + in: formData + description: | + new name of the integration + type: string + required: false + - name: url + in: formData + description: | + new URL of the integration + type: string + required: false + - name: token + in: formData + description: | + new token of the integration + type: string + required: false + - name: activities + in: formData + description: | + new list of activities of the integration + type: string + required: false + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: int + in: path + description: | + the integration ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + delete: + operationId: delete_integration + summary: Delete integration + tags: + - Integrations + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: int + in: path + description: | + the integration ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/integrations/{int}/activities: + delete: + operationId: delete_board_int_activities + tags: + - Integrations + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: int + in: path + description: the int value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + post: + operationId: post_board_int_activities + tags: + - Integrations + consumes: + - multipart/form-data + - application/json + parameters: + - name: activities + in: formData + description: the activities value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + - name: int + in: path + description: the int value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/labels: + put: + operationId: add_board_label + summary: Add a label to a board + description: | + If the board doesn't have the name/color label, this function + adds the label to the board. + tags: + - Boards + consumes: + - multipart/form-data + - application/json + parameters: + - name: label + in: formData + description: the label value + type: string + required: true + - name: board + in: path + description: | + the board + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: string + /api/boards/{board}/lists: + get: + operationId: get_all_lists + summary: Get the list of Lists attached to a board + tags: + - Lists + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + post: + operationId: new_list + summary: Add a List to a board + tags: + - Lists + consumes: + - multipart/form-data + - application/json + parameters: + - name: title + in: formData + description: | + the title of the List + type: string + required: true + - name: board + in: path + description: | + the board ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/lists/{list}: + get: + operationId: get_list + summary: Get a List attached to a board + tags: + - Lists + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: list + in: path + description: | + the List ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + $ref: "#/definitions/Lists" + delete: + operationId: delete_list + summary: Delete a List + description: | + This **deletes** a list from a board. + The list is not put in the recycle bin. + tags: + - Lists + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: list + in: path + description: | + the ID of the list to remove + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/lists/{list}/cards: + get: + operationId: get_all_cards + summary: Get all Cards attached to a List + tags: + - Cards + parameters: + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: list + in: path + description: | + the list ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + description: + type: string + post: + operationId: new_card + summary: Create a new Card + tags: + - Cards + consumes: + - multipart/form-data + - application/json + parameters: + - name: authorId + in: formData + description: the authorId value + type: string + required: true + - name: members + in: formData + description: | + the member IDs list of the new card + type: string + required: false + - name: title + in: formData + description: | + the title of the new card + type: string + required: true + - name: description + in: formData + description: | + the description of the new card + type: string + required: true + - name: swimlaneId + in: formData + description: | + the swimlane ID of the new card + type: string + required: true + - name: board + in: path + description: | + the board ID of the new card + type: string + required: true + - name: list + in: path + description: | + the list ID of the new card + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/lists/{list}/cards/{card}: + get: + operationId: get_board_list_card + tags: + - Cards + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: list + in: path + description: the list value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + put: + operationId: put_board_list_card + tags: + - Cards + consumes: + - multipart/form-data + - application/json + parameters: + - name: title + in: formData + description: the title value + type: string + required: true + - name: listId + in: formData + description: the listId value + type: string + required: true + - name: authorId + in: formData + description: the authorId value + type: string + required: true + - name: parentId + in: formData + description: the parentId value + type: string + required: true + - name: description + in: formData + description: the description value + type: string + required: true + - name: color + in: formData + description: the color value + type: string + required: true + - name: labelIds + in: formData + description: the labelIds value + type: string + required: true + - name: requestedBy + in: formData + description: the requestedBy value + type: string + required: true + - name: assignedBy + in: formData + description: the assignedBy value + type: string + required: true + - name: receivedAt + in: formData + description: the receivedAt value + type: string + required: true + - name: startAt + in: formData + description: the startAt value + type: string + required: true + - name: dueAt + in: formData + description: the dueAt value + type: string + required: true + - name: endAt + in: formData + description: the endAt value + type: string + required: true + - name: spentTime + in: formData + description: the spentTime value + type: string + required: true + - name: isOverTime + in: formData + description: the isOverTime value + type: string + required: true + - name: customFields + in: formData + description: the customFields value + type: string + required: true + - name: members + in: formData + description: the members value + type: string + required: true + - name: swimlaneId + in: formData + description: the swimlaneId value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + - name: list + in: path + description: the list value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + delete: + operationId: delete_board_list_card + tags: + - Cards + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: list + in: path + description: the list value + type: string + required: true + - name: card + in: path + description: the card value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/members/{member}: + post: + operationId: set_board_member_permission + summary: Change the permission of a member of a board + tags: + - Boards + - Users + consumes: + - multipart/form-data + - application/json + parameters: + - name: isAdmin + in: formData + description: | + admin capability + type: boolean + required: true + - name: isNoComments + in: formData + description: | + NoComments capability + type: boolean + required: true + - name: isCommentOnly + in: formData + description: | + CommentsOnly capability + type: boolean + required: true + - name: board + in: path + description: | + the ID of the board that we are changing + type: string + required: true + - name: member + in: path + description: | + the ID of the user to change permissions + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/members/{user}/add: + post: + operationId: add_board_member + summary: Add New Board Member with Role + description: | + Only the admin user (the first user) can call the REST API. + + **Note**: see [Boards.set_board_member_permission](#set_board_member_permission) + to later change the permissions. + tags: + - Users + - Boards + consumes: + - multipart/form-data + - application/json + parameters: + - name: action + in: formData + description: the action value + type: string + required: true + - name: isAdmin + in: formData + description: | + is the user an admin of the board + type: boolean + required: true + - name: isNoComments + in: formData + description: | + disable comments + type: boolean + required: true + - name: isCommentOnly + in: formData + description: | + only enable comments + type: boolean + required: true + - name: board + in: path + description: | + the board ID + type: string + required: true + - name: user + in: path + description: | + the user ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + title: + type: string + /api/boards/{board}/members/{user}/remove: + post: + operationId: post_board_user_remove + tags: + - Users + consumes: + - multipart/form-data + - application/json + parameters: + - name: action + in: formData + description: the action value + type: string + required: true + - name: board + in: path + description: the board value + type: string + required: true + - name: user + in: path + description: the user value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/swimlanes: + get: + operationId: get_all_swimlanes + summary: Get the list of swimlanes attached to a board + tags: + - Swimlanes + parameters: + - name: board + in: path + description: | + the ID of the board + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + post: + operationId: new_swimlane + summary: Add a swimlane to a board + tags: + - Swimlanes + consumes: + - multipart/form-data + - application/json + parameters: + - name: title + in: formData + description: | + the new title of the swimlane + type: string + required: true + - name: board + in: path + description: | + the ID of the board + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/boards/{board}/swimlanes/{swimlane}: + get: + operationId: get_swimlane + summary: Get a swimlane + tags: + - Swimlanes + parameters: + - name: board + in: path + description: | + the ID of the board + type: string + required: true + - name: swimlane + in: path + description: | + the ID of the swimlane + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + $ref: "#/definitions/Swimlanes" + delete: + operationId: delete_board_swimlane + tags: + - Swimlanes + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: swimlane + in: path + description: the swimlane value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/boards/{board}/swimlanes/{swimlane}/cards: + get: + operationId: get_board_swimlane_cards + tags: + - Cards + parameters: + - name: board + in: path + description: the board value + type: string + required: true + - name: swimlane + in: path + description: the swimlane value + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + /api/user: + get: + operationId: get_current_user + summary: returns the current user + tags: + - Users + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + $ref: "#/definitions/Users" + /api/users: + get: + operationId: get_all_users + summary: return all the users + description: | + Only the admin user (the first user) can call the REST API. + tags: + - Users + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + username: + type: string + post: + operationId: new_user + summary: Create a new user + description: | + Only the admin user (the first user) can call the REST API. + tags: + - Users + consumes: + - multipart/form-data + - application/json + parameters: + - name: username + in: formData + description: | + the new username + type: string + required: true + - name: email + in: formData + description: | + the email of the new user + type: string + required: true + - name: password + in: formData + description: | + the password of the new user + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/users/{user}: + get: + operationId: get_user + summary: get a given user + description: | + Only the admin user (the first user) can call the REST API. + tags: + - Users + parameters: + - name: user + in: path + description: | + the user ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + $ref: "#/definitions/Users" + put: + operationId: edit_user + summary: edit a given user + description: | + Only the admin user (the first user) can call the REST API. + + Possible values for *action*: + - `takeOwnership`: The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on. + - `disableLogin`: Disable a user (the user is not allowed to login and his login tokens are purged) + - `enableLogin`: Enable a user + tags: + - Users + consumes: + - multipart/form-data + - application/json + parameters: + - name: action + in: formData + description: | + the action + type: string + required: true + - name: user + in: path + description: | + the user ID + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + title: + type: string + delete: + operationId: delete_user + summary: Delete a user + description: | + Only the admin user (the first user) can call the REST API. + tags: + - Users + parameters: + - name: user + in: path + description: | + the ID of the user to delete + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: object + properties: + _id: + type: string + /api/users/{user}/boards: + get: + operationId: get_boards_from_user + summary: Get all boards attached to a user + tags: + - Boards + parameters: + - name: user + in: path + description: | + the ID of the user to retrieve the data + type: string + required: true + produces: + - application/json + security: + - UserSecurity: [] + responses: + '200': + description: |- + 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string +definitions: + Boards: + type: object + description: This is a Board. + properties: + title: + description: | + The title of the board + type: string + slug: + description: | + The title slugified. + type: string + archived: + description: | + Is the board archived? + type: boolean + createdAt: + description: | + Creation time of the board + type: string + modifiedAt: + description: | + Last modification time of the board + type: string + x-nullable: true + stars: + description: | + How many stars the board has + type: number + labels: + description: | + List of labels attached to a board + type: array + items: + $ref: "#/definitions/BoardsLabels" + members: + description: | + List of members of a board + type: array + items: + $ref: "#/definitions/BoardsMembers" + permission: + description: | + visibility of the board + type: string + enum: + - public + - private + color: + description: | + The color of the board. + type: string + enum: + - belize + - nephritis + - pomegranate + - pumpkin + - wisteria + - moderatepink + - strongcyan + - limegreen + - midnight + - dark + - relax + - corteza + description: + description: | + The description of the board + type: string + x-nullable: true + subtasksDefaultBoardId: + description: | + The default board ID assigned to subtasks. + type: string + x-nullable: true + subtasksDefaultListId: + description: | + The default List ID assigned to subtasks. + type: string + x-nullable: true + allowsSubtasks: + description: | + Does the board allows subtasks? + type: boolean + presentParentTask: + description: | + Controls how to present the parent task: + + - `prefix-with-full-path`: add a prefix with the full path + - `prefix-with-parent`: add a prefisx with the parent name + - `subtext-with-full-path`: add a subtext with the full path + - `subtext-with-parent`: add a subtext with the parent name + - `no-parent`: does not show the parent at all + type: string + enum: + - prefix-with-full-path + - prefix-with-parent + - subtext-with-full-path + - subtext-with-parent + - no-parent + x-nullable: true + startAt: + description: | + Starting date of the board. + type: string + x-nullable: true + dueAt: + description: | + Due date of the board. + type: string + x-nullable: true + endAt: + description: | + End date of the board. + type: string + x-nullable: true + spentTime: + description: | + Time spent in the board. + type: number + x-nullable: true + isOvertime: + description: | + Is the board overtimed? + type: boolean + x-nullable: true + type: + description: | + The type of board + type: string + required: + - title + - slug + - archived + - createdAt + - stars + - labels + - members + - permission + - color + - allowsSubtasks + - type + BoardsLabels: + type: object + properties: + _id: + description: | + Unique id of a label + type: string + name: + description: | + Name of a label + type: string + color: + description: | + color of a label. + + Can be amongst `green`, `yellow`, `orange`, `red`, `purple`, + `blue`, `sky`, `lime`, `pink`, `black`, + `silver`, `peachpuff`, `crimson`, `plum`, `darkgreen`, + `slateblue`, `magenta`, `gold`, `navy`, `gray`, + `saddlebrown`, `paleturquoise`, `mistyrose`, `indigo` + type: string + enum: + - green + - yellow + - orange + - red + - purple + - blue + - sky + - lime + - pink + - black + - silver + - peachpuff + - crimson + - plum + - darkgreen + - slateblue + - magenta + - gold + - navy + - gray + - saddlebrown + - paleturquoise + - mistyrose + - indigo + required: + - _id + - color + BoardsMembers: + type: object + properties: + userId: + description: | + The uniq ID of the member + type: string + isAdmin: + description: | + Is the member an admin of the board? + type: boolean + isActive: + description: | + Is the member active? + type: boolean + isNoComments: + description: | + Is the member not allowed to make comments + type: boolean + isCommentOnly: + description: | + Is the member only allowed to comment on the board + type: boolean + required: + - userId + - isAdmin + - isActive + CardComments: + type: object + description: A comment on a card + properties: + boardId: + description: | + the board ID + type: string + cardId: + description: | + the card ID + type: string + text: + description: | + the text of the comment + type: string + createdAt: + description: | + when was the comment created + type: string + modifiedAt: + type: string + userId: + description: | + the author ID of the comment + type: string + required: + - boardId + - cardId + - text + - createdAt + - modifiedAt + - userId + Cards: + type: object + properties: + title: + description: | + the title of the card + type: string + x-nullable: true + archived: + description: | + is the card archived + type: boolean + parentId: + description: | + ID of the parent card + type: string + x-nullable: true + listId: + description: | + List ID where the card is + type: string + x-nullable: true + swimlaneId: + description: | + Swimlane ID where the card is + type: string + boardId: + description: | + Board ID of the card + type: string + x-nullable: true + coverId: + description: | + Cover ID of the card + type: string + x-nullable: true + color: + type: string + enum: + - white + - green + - yellow + - orange + - red + - purple + - blue + - sky + - lime + - pink + - black + - silver + - peachpuff + - crimson + - plum + - darkgreen + - slateblue + - magenta + - gold + - navy + - gray + - saddlebrown + - paleturquoise + - mistyrose + - indigo + x-nullable: true + createdAt: + description: | + creation date + type: string + modifiedAt: + type: string + customFields: + description: | + list of custom fields + type: array + items: + $ref: "#/definitions/CardsCustomfields" + x-nullable: true + dateLastActivity: + description: | + Date of last activity + type: string + description: + description: | + description of the card + type: string + x-nullable: true + requestedBy: + description: | + who requested the card (ID of the user) + type: string + x-nullable: true + assignedBy: + description: | + who assigned the card (ID of the user) + type: string + x-nullable: true + labelIds: + description: | + list of labels ID the card has + type: array + items: + type: string + x-nullable: true + x-nullable: true + members: + description: | + list of members (user IDs) + type: array + items: + type: string + x-nullable: true + x-nullable: true + receivedAt: + description: | + Date the card was received + type: string + x-nullable: true + startAt: + description: | + Date the card was started to be worked on + type: string + x-nullable: true + dueAt: + description: | + Date the card is due + type: string + x-nullable: true + endAt: + description: | + Date the card ended + type: string + x-nullable: true + spentTime: + description: | + How much time has been spent on this + type: number + x-nullable: true + isOvertime: + description: | + is the card over time? + type: boolean + x-nullable: true + userId: + description: | + user ID of the author of the card + type: string + sort: + description: | + Sort value + type: number + subtaskSort: + description: | + subtask sort value + type: number + x-nullable: true + type: + description: | + type of the card + type: string + linkedId: + description: | + ID of the linked card + type: string + x-nullable: true + required: + - archived + - swimlaneId + - createdAt + - modifiedAt + - dateLastActivity + - userId + - sort + - type + CardsCustomfields: + type: object + ChecklistItems: + type: object + description: An item in a checklist + properties: + title: + description: | + the text of the item + type: string + sort: + description: | + the sorting field of the item + type: number + isFinished: + description: | + Is the item checked? + type: boolean + checklistId: + description: | + the checklist ID the item is attached to + type: string + cardId: + description: | + the card ID the item is attached to + type: string + createdAt: + type: string + x-nullable: true + modifiedAt: + type: string + required: + - title + - sort + - isFinished + - checklistId + - cardId + - modifiedAt + Checklists: + type: object + description: A Checklist + properties: + cardId: + description: | + The ID of the card the checklist is in + type: string + title: + description: | + the title of the checklist + type: string + finishedAt: + description: | + When was the checklist finished + type: string + x-nullable: true + createdAt: + description: | + Creation date of the checklist + type: string + modifiedAt: + type: string + sort: + description: | + sorting value of the checklist + type: number + required: + - cardId + - title + - createdAt + - modifiedAt + - sort + CustomFields: + type: object + description: A custom field on a card in the board + properties: + boardIds: + description: | + the ID of the board + type: array + items: + type: string + name: + description: | + name of the custom field + type: string + type: + description: | + type of the custom field + type: string + enum: + - text + - number + - date + - dropdown + settings: + description: | + settings of the custom field + $ref: "#/definitions/CustomFieldsSettings" + showOnCard: + description: | + should we show on the cards this custom field + type: boolean + automaticallyOnCard: + description: | + should the custom fields automatically be added on cards? + type: boolean + showLabelOnMiniCard: + description: | + should the label of the custom field be shown on minicards? + type: boolean + createdAt: + type: string + x-nullable: true + modifiedAt: + type: string + required: + - boardIds + - name + - type + - settings + - showOnCard + - automaticallyOnCard + - showLabelOnMiniCard + - modifiedAt + CustomFieldsSettings: + type: object + properties: + dropdownItems: + description: | + list of drop down items objects + type: array + items: + $ref: "#/definitions/CustomFieldsSettingsDropdownitems" + CustomFieldsSettingsDropdownitems: + type: object + Integrations: + type: object + description: Integration with third-party applications + properties: + enabled: + description: | + is the integration enabled? + type: boolean + title: + description: | + name of the integration + type: string + x-nullable: true + type: + description: | + type of the integratation (Default to 'outgoing-webhooks') + type: string + activities: + description: | + activities the integration gets triggered (list) + type: array + items: + type: string + url: + type: string + token: + description: | + token of the integration + type: string + x-nullable: true + boardId: + description: | + Board ID of the integration + type: string + createdAt: + description: | + Creation date of the integration + type: string + modifiedAt: + type: string + userId: + description: | + user ID who created the interation + type: string + required: + - enabled + - type + - activities + - url + - boardId + - createdAt + - modifiedAt + - userId + Lists: + type: object + description: A list (column) in the Wekan board. + properties: + title: + description: | + the title of the list + type: string + archived: + description: | + is the list archived + type: boolean + boardId: + description: | + the board associated to this list + type: string + swimlaneId: + description: | + the swimlane associated to this list. Used for templates + type: string + createdAt: + description: | + creation date + type: string + sort: + description: | + is the list sorted + type: number + x-nullable: true + updatedAt: + description: | + last update of the list + type: string + x-nullable: true + modifiedAt: + type: string + wipLimit: + description: | + WIP object, see below + $ref: "#/definitions/ListsWiplimit" + x-nullable: true + color: + description: | + the color of the list + type: string + enum: + - white + - green + - yellow + - orange + - red + - purple + - blue + - sky + - lime + - pink + - black + - peachpuff + - crimson + - plum + - darkgreen + - slateblue + - magenta + - gold + - navy + - gray + - saddlebrown + - paleturquoise + - mistyrose + - indigo + x-nullable: true + type: + description: | + The type of list + type: string + required: + - title + - archived + - boardId + - swimlaneId + - createdAt + - modifiedAt + - type + ListsWiplimit: + type: object + properties: + value: + description: | + value of the WIP + type: number + enabled: + description: | + is the WIP enabled + type: boolean + soft: + description: | + is the WIP a soft or hard requirement + type: boolean + required: + - value + - enabled + - soft + Swimlanes: + type: object + description: A swimlane is an line in the kaban board. + properties: + title: + description: | + the title of the swimlane + type: string + archived: + description: | + is the swimlane archived? + type: boolean + boardId: + description: | + the ID of the board the swimlane is attached to + type: string + createdAt: + description: | + creation date of the swimlane + type: string + sort: + description: | + the sort value of the swimlane + type: number + x-nullable: true + color: + description: | + the color of the swimlane + type: string + enum: + - white + - green + - yellow + - orange + - red + - purple + - blue + - sky + - lime + - pink + - black + - peachpuff + - crimson + - plum + - darkgreen + - slateblue + - magenta + - gold + - navy + - gray + - saddlebrown + - paleturquoise + - mistyrose + - indigo + x-nullable: true + updatedAt: + description: | + when was the swimlane last edited + type: string + x-nullable: true + modifiedAt: + type: string + type: + description: | + The type of swimlane + type: string + required: + - title + - archived + - boardId + - createdAt + - modifiedAt + - type + Users: + type: object + description: A User in wekan + properties: + username: + description: | + the username of the user + type: string + x-nullable: true + emails: + description: | + the list of emails attached to a user + type: array + items: + $ref: "#/definitions/UsersEmails" + x-nullable: true + createdAt: + description: | + creation date of the user + type: string + modifiedAt: + type: string + profile: + description: | + profile settings + $ref: "#/definitions/UsersProfile" + x-nullable: true + services: + description: | + services field of the user + type: object + x-nullable: true + heartbeat: + description: | + last time the user has been seen + type: string + x-nullable: true + isAdmin: + description: | + is the user an admin of the board? + type: boolean + x-nullable: true + createdThroughApi: + description: | + was the user created through the API? + type: boolean + x-nullable: true + loginDisabled: + description: | + loginDisabled field of the user + type: boolean + x-nullable: true + authenticationMethod: + description: | + authentication method of the user + type: string + required: + - createdAt + - modifiedAt + - authenticationMethod + UsersEmails: + type: object + properties: + address: + description: | + The email address + type: string + verified: + description: | + Has the email been verified + type: boolean + required: + - address + - verified + UsersProfile: + type: object + properties: + avatarUrl: + description: | + URL of the avatar of the user + type: string + emailBuffer: + description: | + list of email buffers of the user + type: array + items: + type: string + x-nullable: true + fullname: + description: | + full name of the user + type: string + hiddenSystemMessages: + description: | + does the user wants to hide system messages? + type: boolean + initials: + description: | + initials of the user + type: string + invitedBoards: + description: | + board IDs the user has been invited to + type: array + items: + type: string + x-nullable: true + language: + description: | + language of the user + type: string + notifications: + description: | + enabled notifications for the user + type: array + items: + type: string + x-nullable: true + showCardsCountAt: + description: | + showCardCountAt field of the user + type: number + starredBoards: + description: | + list of starred board IDs + type: array + items: + type: string + x-nullable: true + icode: + description: | + icode + type: string + boardView: + description: | + boardView field of the user + type: string + enum: + - board-view-lists + - board-view-swimlanes + - board-view-cal + templatesBoardId: + description: | + Reference to the templates board + type: string + cardTemplatesSwimlaneId: + description: | + Reference to the card templates swimlane Id + type: string + listTemplatesSwimlaneId: + description: | + Reference to the list templates swimlane Id + type: string + boardTemplatesSwimlaneId: + description: | + Reference to the board templates swimlane Id + type: string + required: + - templatesBoardId + - cardTemplatesSwimlaneId + - listTemplatesSwimlaneId + - boardTemplatesSwimlaneId |