Remove Policy dependencies
[clamp.git] / src / main / resources / META-INF / resources / swagger.html
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8">
5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
7 <meta name="generator" content="Asciidoctor 1.5.7.1">
8 <title>Clamp Rest API</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
10 <style>
11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
12 /* Uncomment @import statement below to use as custom stylesheet */
13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
15 audio,canvas,video{display:inline-block}
16 audio:not([controls]){display:none;height:0}
17 script{display:none!important}
18 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
19 a{background:transparent}
20 a:focus{outline:thin dotted}
21 a:active,a:hover{outline:0}
22 h1{font-size:2em;margin:.67em 0}
23 abbr[title]{border-bottom:1px dotted}
24 b,strong{font-weight:bold}
25 dfn{font-style:italic}
26 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
27 mark{background:#ff0;color:#000}
28 code,kbd,pre,samp{font-family:monospace;font-size:1em}
29 pre{white-space:pre-wrap}
30 q{quotes:"\201C" "\201D" "\2018" "\2019"}
31 small{font-size:80%}
32 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
33 sup{top:-.5em}
34 sub{bottom:-.25em}
35 img{border:0}
36 svg:not(:root){overflow:hidden}
37 figure{margin:0}
38 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
39 legend{border:0;padding:0}
40 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
41 button,input{line-height:normal}
42 button,select{text-transform:none}
43 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
44 button[disabled],html input[disabled]{cursor:default}
45 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
46 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
47 textarea{overflow:auto;vertical-align:top}
48 table{border-collapse:collapse;border-spacing:0}
49 *,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
50 html,body{font-size:100%}
51 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
52 a:hover{cursor:pointer}
53 img,object,embed{max-width:100%;height:auto}
54 object,embed{height:100%}
55 img{-ms-interpolation-mode:bicubic}
56 .left{float:left!important}
57 .right{float:right!important}
58 .text-left{text-align:left!important}
59 .text-right{text-align:right!important}
60 .text-center{text-align:center!important}
61 .text-justify{text-align:justify!important}
62 .hide{display:none}
63 img,object,svg{display:inline-block;vertical-align:middle}
64 textarea{height:auto;min-height:50px}
65 select{width:100%}
66 .center{margin-left:auto;margin-right:auto}
67 .stretch{width:100%}
68 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
69 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
70 a{color:#2156a5;text-decoration:underline;line-height:inherit}
71 a:hover,a:focus{color:#1d4b8f}
72 a img{border:none}
73 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
74 p aside{font-size:.875em;line-height:1.35;font-style:italic}
75 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
76 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
77 h1{font-size:2.125em}
78 h2{font-size:1.6875em}
79 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
80 h4,h5{font-size:1.125em}
81 h6{font-size:1em}
82 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
83 em,i{font-style:italic;line-height:inherit}
84 strong,b{font-weight:bold;line-height:inherit}
85 small{font-size:60%;line-height:inherit}
86 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
87 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
88 ul,ol{margin-left:1.5em}
89 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
90 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
91 ul.square{list-style-type:square}
92 ul.circle{list-style-type:circle}
93 ul.disc{list-style-type:disc}
94 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
95 dl dt{margin-bottom:.3125em;font-weight:bold}
96 dl dd{margin-bottom:1.25em}
97 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
98 abbr{text-transform:none}
99 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
100 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
101 blockquote cite::before{content:"\2014 \0020"}
102 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
103 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
104 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
105 h1{font-size:2.75em}
106 h2{font-size:2.3125em}
107 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
108 h4{font-size:1.4375em}}
109 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
110 table thead,table tfoot{background:#f7f8f7}
111 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
112 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
113 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
114 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
115 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
116 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
117 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
118 .clearfix::after,.float-group::after{clear:both}
119 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
120 *:not(pre)>code.nobreak{word-wrap:normal}
121 *:not(pre)>code.nowrap{white-space:nowrap}
122 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
123 em em{font-style:normal}
124 strong strong{font-weight:400}
125 .keyseq{color:rgba(51,51,51,.8)}
126 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
127 .keyseq kbd:first-child{margin-left:0}
128 .keyseq kbd:last-child{margin-right:0}
129 .menuseq,.menuref{color:#000}
130 .menuseq b:not(.caret),.menuref{font-weight:inherit}
131 .menuseq{word-spacing:-.02em}
132 .menuseq b.caret{font-size:1.25em;line-height:.8}
133 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
134 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
135 b.button::before{content:"[";padding:0 3px 0 2px}
136 b.button::after{content:"]";padding:0 2px 0 3px}
137 p a>code:hover{color:rgba(0,0,0,.9)}
138 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
139 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
140 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
141 #content{margin-top:1.25em}
142 #content::before{content:none}
143 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
144 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
145 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
146 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
147 #header .details span:first-child{margin-left:-.125em}
148 #header .details span.email a{color:rgba(0,0,0,.85)}
149 #header .details br{display:none}
150 #header .details br+span::before{content:"\00a0\2013\00a0"}
151 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
152 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
153 #header #revnumber{text-transform:capitalize}
154 #header #revnumber::after{content:"\00a0"}
155 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
156 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
157 #toc>ul{margin-left:.125em}
158 #toc ul.sectlevel0>li>a{font-style:italic}
159 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
160 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
161 #toc li{line-height:1.3334;margin-top:.3334em}
162 #toc a{text-decoration:none}
163 #toc a:active{text-decoration:underline}
164 #toctitle{color:#7a2518;font-size:1.2em}
165 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
166 body.toc2{padding-left:15em;padding-right:0}
167 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
168 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
169 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
170 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
171 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
172 body.toc2.toc-right{padding-left:0;padding-right:15em}
173 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
174 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
175 #toc.toc2{width:20em}
176 #toc.toc2 #toctitle{font-size:1.375em}
177 #toc.toc2>ul{font-size:.95em}
178 #toc.toc2 ul ul{padding-left:1.25em}
179 body.toc2.toc-right{padding-left:0;padding-right:20em}}
180 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
181 #content #toc>:first-child{margin-top:0}
182 #content #toc>:last-child{margin-bottom:0}
183 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
184 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
185 #content{margin-bottom:.625em}
186 .sect1{padding-bottom:.625em}
187 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
188 .sect1{padding-bottom:1.25em}}
189 .sect1:last-child{padding-bottom:0}
190 .sect1+.sect1{border-top:1px solid #efefed}
191 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
192 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
193 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
194 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
195 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
196 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
197 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
198 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
199 .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
200 table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
201 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
202 .admonitionblock>table td.icon{text-align:center;width:80px}
203 .admonitionblock>table td.icon img{max-width:none}
204 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
205 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
206 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
207 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
208 .exampleblock>.content>:first-child{margin-top:0}
209 .exampleblock>.content>:last-child{margin-bottom:0}
210 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
211 .sidebarblock>:first-child{margin-top:0}
212 .sidebarblock>:last-child{margin-bottom:0}
213 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
216 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
217 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
218 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
219 @media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
220 @media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
221 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
222 .listingblock pre.highlightjs{padding:0}
223 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
224 .listingblock pre.prettyprint{border-width:0}
225 .listingblock>.content{position:relative}
226 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
227 .listingblock:hover code[data-lang]::before{display:block}
228 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999}
229 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
230 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
231 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
232 table.pyhltable td.code{padding-left:.75em;padding-right:0}
233 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
234 pre.pygments .lineno{display:inline-block;margin-right:.25em}
235 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
236 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
237 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
238 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
239 .quoteblock blockquote{margin:0;padding:0;border:0}
240 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
241 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
242 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
243 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
244 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
245 .quoteblock .quoteblock blockquote::before{display:none}
246 .verseblock{margin:0 1em 1.25em}
247 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248 .verseblock pre strong{font-weight:400}
249 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251 .quoteblock .attribution br,.verseblock .attribution br{display:none}
252 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
254 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{word-spacing:0;line-height:1.6}
256 .quoteblock.abstract blockquote::before,.quoteblock.abstract p::before{display:none}
257 table.tableblock{max-width:100%;border-collapse:separate}
258 p.tableblock:last-child{margin-bottom:0}
259 td.tableblock>.content{margin-bottom:-1.25em}
260 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
261 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
262 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
263 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
264 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
265 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
266 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
267 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
268 table.frame-all{border-width:1px}
269 table.frame-sides{border-width:0 1px}
270 table.frame-topbot,table.frame-ends{border-width:1px 0}
271 table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7}
272 table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none}
273 th.halign-left,td.halign-left{text-align:left}
274 th.halign-right,td.halign-right{text-align:right}
275 th.halign-center,td.halign-center{text-align:center}
276 th.valign-top,td.valign-top{vertical-align:top}
277 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
278 th.valign-middle,td.valign-middle{vertical-align:middle}
279 table thead th,table tfoot th{font-weight:bold}
280 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
281 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
282 p.tableblock>code:only-child{background:none;padding:0}
283 p.tableblock{font-size:1em}
284 td>div.verse{white-space:pre}
285 ol{margin-left:1.75em}
286 ul li ol{margin-left:1.5em}
287 dl dd{margin-left:1.125em}
288 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
289 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
290 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
291 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
292 ul.unstyled,ol.unstyled{margin-left:0}
293 ul.checklist{margin-left:.625em}
294 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
295 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
296 ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
297 ul.inline>li{margin-left:1.25em}
298 .unstyled dl dt{font-weight:400;font-style:normal}
299 ol.arabic{list-style-type:decimal}
300 ol.decimal{list-style-type:decimal-leading-zero}
301 ol.loweralpha{list-style-type:lower-alpha}
302 ol.upperalpha{list-style-type:upper-alpha}
303 ol.lowerroman{list-style-type:lower-roman}
304 ol.upperroman{list-style-type:upper-roman}
305 ol.lowergreek{list-style-type:lower-greek}
306 .hdlist>table,.colist>table{border:0;background:none}
307 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
308 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
309 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
310 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
311 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
312 .colist td:not([class]):first-child img{max-width:none}
313 .colist td:not([class]):last-child{padding:.25em 0}
314 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
315 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
316 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
317 .imageblock>.title{margin-bottom:0}
318 .imageblock.thumb,.imageblock.th{border-width:6px}
319 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
320 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
321 .image.left{margin-right:.625em}
322 .image.right{margin-left:.625em}
323 a.image{text-decoration:none;display:inline-block}
324 a.image object{pointer-events:none}
325 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
326 sup.footnote a,sup.footnoteref a{text-decoration:none}
327 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
328 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
329 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
330 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
331 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
332 #footnotes .footnote:last-of-type{margin-bottom:0}
333 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
334 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
335 .gist .file-data>table td.line-data{width:99%}
336 div.unbreakable{page-break-inside:avoid}
337 .big{font-size:larger}
338 .small{font-size:smaller}
339 .underline{text-decoration:underline}
340 .overline{text-decoration:overline}
341 .line-through{text-decoration:line-through}
342 .aqua{color:#00bfbf}
343 .aqua-background{background-color:#00fafa}
344 .black{color:#000}
345 .black-background{background-color:#000}
346 .blue{color:#0000bf}
347 .blue-background{background-color:#0000fa}
348 .fuchsia{color:#bf00bf}
349 .fuchsia-background{background-color:#fa00fa}
350 .gray{color:#606060}
351 .gray-background{background-color:#7d7d7d}
352 .green{color:#006000}
353 .green-background{background-color:#007d00}
354 .lime{color:#00bf00}
355 .lime-background{background-color:#00fa00}
356 .maroon{color:#600000}
357 .maroon-background{background-color:#7d0000}
358 .navy{color:#000060}
359 .navy-background{background-color:#00007d}
360 .olive{color:#606000}
361 .olive-background{background-color:#7d7d00}
362 .purple{color:#600060}
363 .purple-background{background-color:#7d007d}
364 .red{color:#bf0000}
365 .red-background{background-color:#fa0000}
366 .silver{color:#909090}
367 .silver-background{background-color:#bcbcbc}
368 .teal{color:#006060}
369 .teal-background{background-color:#007d7d}
370 .white{color:#bfbfbf}
371 .white-background{background-color:#fafafa}
372 .yellow{color:#bfbf00}
373 .yellow-background{background-color:#fafa00}
374 span.icon>.fa{cursor:default}
375 a span.icon>.fa{cursor:inherit}
376 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
377 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
378 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
379 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
380 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
381 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
382 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
383 .conum[data-value] *{color:#fff!important}
384 .conum[data-value]+b{display:none}
385 .conum[data-value]::after{content:attr(data-value)}
386 pre .conum[data-value]{position:relative;top:-.125em}
387 b.conum *{color:inherit!important}
388 .conum:not([data-value]):empty{display:none}
389 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
390 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
391 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
392 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
393 p{margin-bottom:1.25rem}
394 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
395 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
396 .print-only{display:none!important}
397 @page{margin:1.25cm .75cm}
398 @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
399 html{font-size:80%}
400 a{color:inherit!important;text-decoration:underline!important}
401 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
402 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
403 abbr[title]::after{content:" (" attr(title) ")"}
404 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
405 thead{display:table-header-group}
406 svg{max-width:100%}
407 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
408 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
409 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
410 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
411 body.book #header{text-align:center}
412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
413 body.book #header .details{border:0!important;display:block;padding:0!important}
414 body.book #header .details span:first-child{margin-left:0!important}
415 body.book #header .details br{display:block}
416 body.book #header .details br+span::before{content:none!important}
417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
419 .listingblock code[data-lang]::before{display:block}
420 #footer{padding:0 .9375em}
421 .hide-on-print{display:none!important}
422 .print-only{display:block!important}
423 .hide-for-print{display:none!important}
424 .show-for-print{display:inherit!important}}
425 @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
426 .sect1{padding:0!important}
427 .sect1+.sect1{border:0}
428 #footer{background:none}
429 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
430 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
431 </style>
432 </head>
433 <body class="book toc2 toc-left">
434 <div id="header">
435 <h1>Clamp Rest API</h1>
436 <div id="toc" class="toc2">
437 <div id="toctitle">Table of Contents</div>
438 <ul class="sectlevel1">
439 <li><a href="#_overview">1. Overview</a>
440 <ul class="sectlevel2">
441 <li><a href="#_version_information">1.1. Version information</a></li>
442 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
443 </ul>
444 </li>
445 <li><a href="#_paths">2. Paths</a>
446 <ul class="sectlevel2">
447 <li><a href="#_route15">2.1. GET /v1/clds/cldsInfo</a>
448 <ul class="sectlevel3">
449 <li><a href="#_responses">2.1.1. Responses</a></li>
450 <li><a href="#_produces">2.1.2. Produces</a></li>
451 </ul>
452 </li>
453 <li><a href="#_route16">2.2. GET /v1/healthcheck</a>
454 <ul class="sectlevel3">
455 <li><a href="#_responses_2">2.2.1. Responses</a></li>
456 <li><a href="#_produces_2">2.2.2. Produces</a></li>
457 </ul>
458 </li>
459 <li><a href="#_route17">2.3. GET /v1/user/getUser</a>
460 <ul class="sectlevel3">
461 <li><a href="#_responses_3">2.3.1. Responses</a></li>
462 <li><a href="#_produces_3">2.3.2. Produces</a></li>
463 </ul>
464 </li>
465 <li><a href="#_route13">2.4. PUT /v2/loop/delete/{loopName}</a>
466 <ul class="sectlevel3">
467 <li><a href="#_parameters">2.4.1. Parameters</a></li>
468 <li><a href="#_responses_4">2.4.2. Responses</a></li>
469 </ul>
470 </li>
471 <li><a href="#_route8">2.5. PUT /v2/loop/deploy/{loopName}</a>
472 <ul class="sectlevel3">
473 <li><a href="#_parameters_2">2.5.1. Parameters</a></li>
474 <li><a href="#_responses_5">2.5.2. Responses</a></li>
475 <li><a href="#_produces_4">2.5.3. Produces</a></li>
476 </ul>
477 </li>
478 <li><a href="#_route2">2.6. GET /v2/loop/getAllNames</a>
479 <ul class="sectlevel3">
480 <li><a href="#_responses_6">2.6.1. Responses</a></li>
481 <li><a href="#_produces_5">2.6.2. Produces</a></li>
482 </ul>
483 </li>
484 <li><a href="#_route14">2.7. GET /v2/loop/getstatus/{loopName}</a>
485 <ul class="sectlevel3">
486 <li><a href="#_parameters_3">2.7.1. Parameters</a></li>
487 <li><a href="#_responses_7">2.7.2. Responses</a></li>
488 <li><a href="#_produces_6">2.7.3. Produces</a></li>
489 </ul>
490 </li>
491 <li><a href="#_route11">2.8. PUT /v2/loop/restart/{loopName}</a>
492 <ul class="sectlevel3">
493 <li><a href="#_parameters_4">2.8.1. Parameters</a></li>
494 <li><a href="#_responses_8">2.8.2. Responses</a></li>
495 <li><a href="#_produces_7">2.8.3. Produces</a></li>
496 </ul>
497 </li>
498 <li><a href="#_route10">2.9. PUT /v2/loop/stop/{loopName}</a>
499 <ul class="sectlevel3">
500 <li><a href="#_parameters_5">2.9.1. Parameters</a></li>
501 <li><a href="#_responses_9">2.9.2. Responses</a></li>
502 <li><a href="#_produces_8">2.9.3. Produces</a></li>
503 </ul>
504 </li>
505 <li><a href="#_route12">2.10. PUT /v2/loop/submit/{loopName}</a>
506 <ul class="sectlevel3">
507 <li><a href="#_parameters_6">2.10.1. Parameters</a></li>
508 <li><a href="#_responses_10">2.10.2. Responses</a></li>
509 <li><a href="#_produces_9">2.10.3. Produces</a></li>
510 </ul>
511 </li>
512 <li><a href="#_route4">2.11. GET /v2/loop/svgRepresentation/{loopName}</a>
513 <ul class="sectlevel3">
514 <li><a href="#_parameters_7">2.11.1. Parameters</a></li>
515 <li><a href="#_responses_11">2.11.2. Responses</a></li>
516 <li><a href="#_produces_10">2.11.3. Produces</a></li>
517 </ul>
518 </li>
519 <li><a href="#_route9">2.12. PUT /v2/loop/undeploy/{loopName}</a>
520 <ul class="sectlevel3">
521 <li><a href="#_parameters_8">2.12.1. Parameters</a></li>
522 <li><a href="#_responses_12">2.12.2. Responses</a></li>
523 <li><a href="#_produces_11">2.12.3. Produces</a></li>
524 </ul>
525 </li>
526 <li><a href="#_route5">2.13. POST /v2/loop/updateGlobalProperties/{loopName}</a>
527 <ul class="sectlevel3">
528 <li><a href="#_parameters_9">2.13.1. Parameters</a></li>
529 <li><a href="#_responses_13">2.13.2. Responses</a></li>
530 <li><a href="#_consumes">2.13.3. Consumes</a></li>
531 <li><a href="#_produces_12">2.13.4. Produces</a></li>
532 </ul>
533 </li>
534 <li><a href="#_route7">2.14. POST /v2/loop/updateMicroservicePolicy/{loopName}</a>
535 <ul class="sectlevel3">
536 <li><a href="#_parameters_10">2.14.1. Parameters</a></li>
537 <li><a href="#_responses_14">2.14.2. Responses</a></li>
538 <li><a href="#_consumes_2">2.14.3. Consumes</a></li>
539 <li><a href="#_produces_13">2.14.4. Produces</a></li>
540 </ul>
541 </li>
542 <li><a href="#_route6">2.15. POST /v2/loop/updateOperationalPolicies/{loopName}</a>
543 <ul class="sectlevel3">
544 <li><a href="#_parameters_11">2.15.1. Parameters</a></li>
545 <li><a href="#_responses_15">2.15.2. Responses</a></li>
546 <li><a href="#_consumes_3">2.15.3. Consumes</a></li>
547 <li><a href="#_produces_14">2.15.4. Produces</a></li>
548 </ul>
549 </li>
550 <li><a href="#_route3">2.16. GET /v2/loop/{loopName}</a>
551 <ul class="sectlevel3">
552 <li><a href="#_parameters_12">2.16.1. Parameters</a></li>
553 <li><a href="#_responses_16">2.16.2. Responses</a></li>
554 <li><a href="#_produces_15">2.16.3. Produces</a></li>
555 </ul>
556 </li>
557 </ul>
558 </li>
559 <li><a href="#_definitions">3. Definitions</a>
560 <ul class="sectlevel2">
561 <li><a href="#_cldshealthcheck">3.1. CldsHealthCheck</a></li>
562 <li><a href="#_cldsinfo">3.2. CldsInfo</a></li>
563 <li><a href="#_externalcomponent">3.3. ExternalComponent</a></li>
564 <li><a href="#_externalcomponentstate">3.4. ExternalComponentState</a></li>
565 <li><a href="#_jsonarray">3.5. JsonArray</a></li>
566 <li><a href="#_jsonnull">3.6. JsonNull</a></li>
567 <li><a href="#_jsonobject">3.7. JsonObject</a></li>
568 <li><a href="#_jsonprimitive">3.8. JsonPrimitive</a></li>
569 <li><a href="#_loop">3.9. Loop</a></li>
570 <li><a href="#_looplog">3.10. LoopLog</a></li>
571 <li><a href="#_microservicepolicy">3.11. MicroServicePolicy</a></li>
572 <li><a href="#_number">3.12. Number</a></li>
573 <li><a href="#_operationalpolicy">3.13. OperationalPolicy</a></li>
574 </ul>
575 </li>
576 </ul>
577 </div>
578 </div>
579 <div id="content">
580 <div class="sect1">
581 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
582 <div class="sectionbody">
583 <div class="sect2">
584 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
585 <div class="paragraph">
586 <p><em>Version</em> : 4.1.2-SNAPSHOT</p>
587 </div>
588 </div>
589 <div class="sect2">
590 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
591 <div class="paragraph">
592 <p><em>Host</em> : localhost:34219<br>
593 <em>BasePath</em> : /restservices/clds/<br>
594 <em>Schemes</em> : HTTP</p>
595 </div>
596 </div>
597 </div>
598 </div>
599 <div class="sect1">
600 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
601 <div class="sectionbody">
602 <div class="sect2">
603 <h3 id="_route15"><a class="anchor" href="#_route15"></a><a class="link" href="#_route15">2.1. GET /v1/clds/cldsInfo</a></h3>
604 <div class="sect3">
605 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.1. Responses</a></h4>
606 <table class="tableblock frame-all grid-all stretch">
607 <colgroup>
608 <col style="width: 10%;">
609 <col style="width: 70%;">
610 <col style="width: 20%;">
611 </colgroup>
612 <thead>
613 <tr>
614 <th class="tableblock halign-left valign-middle">HTTP Code</th>
615 <th class="tableblock halign-left valign-middle">Description</th>
616 <th class="tableblock halign-left valign-middle">Schema</th>
617 </tr>
618 </thead>
619 <tbody>
620 <tr>
621 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
622 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
623 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
624 </tr>
625 </tbody>
626 </table>
627 </div>
628 <div class="sect3">
629 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
630 <div class="ulist">
631 <ul>
632 <li>
633 <p><code>application/json</code></p>
634 </li>
635 </ul>
636 </div>
637 </div>
638 </div>
639 <div class="sect2">
640 <h3 id="_route16"><a class="anchor" href="#_route16"></a><a class="link" href="#_route16">2.2. GET /v1/healthcheck</a></h3>
641 <div class="sect3">
642 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
643 <table class="tableblock frame-all grid-all stretch">
644 <colgroup>
645 <col style="width: 10%;">
646 <col style="width: 70%;">
647 <col style="width: 20%;">
648 </colgroup>
649 <thead>
650 <tr>
651 <th class="tableblock halign-left valign-middle">HTTP Code</th>
652 <th class="tableblock halign-left valign-middle">Description</th>
653 <th class="tableblock halign-left valign-middle">Schema</th>
654 </tr>
655 </thead>
656 <tbody>
657 <tr>
658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
659 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
660 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
661 </tr>
662 </tbody>
663 </table>
664 </div>
665 <div class="sect3">
666 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
667 <div class="ulist">
668 <ul>
669 <li>
670 <p><code>application/json</code></p>
671 </li>
672 </ul>
673 </div>
674 </div>
675 </div>
676 <div class="sect2">
677 <h3 id="_route17"><a class="anchor" href="#_route17"></a><a class="link" href="#_route17">2.3. GET /v1/user/getUser</a></h3>
678 <div class="sect3">
679 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
680 <table class="tableblock frame-all grid-all stretch">
681 <colgroup>
682 <col style="width: 33.3333%;">
683 <col style="width: 66.6667%;">
684 </colgroup>
685 <thead>
686 <tr>
687 <th class="tableblock halign-left valign-middle">HTTP Code</th>
688 <th class="tableblock halign-left valign-middle">Schema</th>
689 </tr>
690 </thead>
691 <tbody>
692 <tr>
693 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
694 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
695 </tr>
696 </tbody>
697 </table>
698 </div>
699 <div class="sect3">
700 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
701 <div class="ulist">
702 <ul>
703 <li>
704 <p><code>text/plain</code></p>
705 </li>
706 </ul>
707 </div>
708 </div>
709 </div>
710 <div class="sect2">
711 <h3 id="_route13"><a class="anchor" href="#_route13"></a><a class="link" href="#_route13">2.4. PUT /v2/loop/delete/{loopName}</a></h3>
712 <div class="sect3">
713 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.4.1. Parameters</a></h4>
714 <table class="tableblock frame-all grid-all stretch">
715 <colgroup>
716 <col style="width: 22.2222%;">
717 <col style="width: 33.3333%;">
718 <col style="width: 44.4445%;">
719 </colgroup>
720 <thead>
721 <tr>
722 <th class="tableblock halign-left valign-middle">Type</th>
723 <th class="tableblock halign-left valign-middle">Name</th>
724 <th class="tableblock halign-left valign-middle">Schema</th>
725 </tr>
726 </thead>
727 <tbody>
728 <tr>
729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
730 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
731 <em>required</em></p></td>
732 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
733 </tr>
734 </tbody>
735 </table>
736 </div>
737 <div class="sect3">
738 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.2. Responses</a></h4>
739 <table class="tableblock frame-all grid-all stretch">
740 <colgroup>
741 <col style="width: 33.3333%;">
742 <col style="width: 66.6667%;">
743 </colgroup>
744 <thead>
745 <tr>
746 <th class="tableblock halign-left valign-middle">HTTP Code</th>
747 <th class="tableblock halign-left valign-middle">Schema</th>
748 </tr>
749 </thead>
750 <tbody>
751 <tr>
752 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
753 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
754 </tr>
755 </tbody>
756 </table>
757 </div>
758 </div>
759 <div class="sect2">
760 <h3 id="_route8"><a class="anchor" href="#_route8"></a><a class="link" href="#_route8">2.5. PUT /v2/loop/deploy/{loopName}</a></h3>
761 <div class="sect3">
762 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.5.1. Parameters</a></h4>
763 <table class="tableblock frame-all grid-all stretch">
764 <colgroup>
765 <col style="width: 22.2222%;">
766 <col style="width: 33.3333%;">
767 <col style="width: 44.4445%;">
768 </colgroup>
769 <thead>
770 <tr>
771 <th class="tableblock halign-left valign-middle">Type</th>
772 <th class="tableblock halign-left valign-middle">Name</th>
773 <th class="tableblock halign-left valign-middle">Schema</th>
774 </tr>
775 </thead>
776 <tbody>
777 <tr>
778 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
779 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
780 <em>required</em></p></td>
781 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
782 </tr>
783 </tbody>
784 </table>
785 </div>
786 <div class="sect3">
787 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
788 <table class="tableblock frame-all grid-all stretch">
789 <colgroup>
790 <col style="width: 10%;">
791 <col style="width: 70%;">
792 <col style="width: 20%;">
793 </colgroup>
794 <thead>
795 <tr>
796 <th class="tableblock halign-left valign-middle">HTTP Code</th>
797 <th class="tableblock halign-left valign-middle">Description</th>
798 <th class="tableblock halign-left valign-middle">Schema</th>
799 </tr>
800 </thead>
801 <tbody>
802 <tr>
803 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
804 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
805 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
806 </tr>
807 </tbody>
808 </table>
809 </div>
810 <div class="sect3">
811 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.5.3. Produces</a></h4>
812 <div class="ulist">
813 <ul>
814 <li>
815 <p><code>application/json</code></p>
816 </li>
817 </ul>
818 </div>
819 </div>
820 </div>
821 <div class="sect2">
822 <h3 id="_route2"><a class="anchor" href="#_route2"></a><a class="link" href="#_route2">2.6. GET /v2/loop/getAllNames</a></h3>
823 <div class="sect3">
824 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
825 <table class="tableblock frame-all grid-all stretch">
826 <colgroup>
827 <col style="width: 10%;">
828 <col style="width: 70%;">
829 <col style="width: 20%;">
830 </colgroup>
831 <thead>
832 <tr>
833 <th class="tableblock halign-left valign-middle">HTTP Code</th>
834 <th class="tableblock halign-left valign-middle">Description</th>
835 <th class="tableblock halign-left valign-middle">Schema</th>
836 </tr>
837 </thead>
838 <tbody>
839 <tr>
840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
841 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
842 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
843 </tr>
844 </tbody>
845 </table>
846 </div>
847 <div class="sect3">
848 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.6.2. Produces</a></h4>
849 <div class="ulist">
850 <ul>
851 <li>
852 <p><code>application/json</code></p>
853 </li>
854 </ul>
855 </div>
856 </div>
857 </div>
858 <div class="sect2">
859 <h3 id="_route14"><a class="anchor" href="#_route14"></a><a class="link" href="#_route14">2.7. GET /v2/loop/getstatus/{loopName}</a></h3>
860 <div class="sect3">
861 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.7.1. Parameters</a></h4>
862 <table class="tableblock frame-all grid-all stretch">
863 <colgroup>
864 <col style="width: 22.2222%;">
865 <col style="width: 33.3333%;">
866 <col style="width: 44.4445%;">
867 </colgroup>
868 <thead>
869 <tr>
870 <th class="tableblock halign-left valign-middle">Type</th>
871 <th class="tableblock halign-left valign-middle">Name</th>
872 <th class="tableblock halign-left valign-middle">Schema</th>
873 </tr>
874 </thead>
875 <tbody>
876 <tr>
877 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
879 <em>required</em></p></td>
880 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
881 </tr>
882 </tbody>
883 </table>
884 </div>
885 <div class="sect3">
886 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
887 <table class="tableblock frame-all grid-all stretch">
888 <colgroup>
889 <col style="width: 10%;">
890 <col style="width: 70%;">
891 <col style="width: 20%;">
892 </colgroup>
893 <thead>
894 <tr>
895 <th class="tableblock halign-left valign-middle">HTTP Code</th>
896 <th class="tableblock halign-left valign-middle">Description</th>
897 <th class="tableblock halign-left valign-middle">Schema</th>
898 </tr>
899 </thead>
900 <tbody>
901 <tr>
902 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
903 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
904 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
905 </tr>
906 </tbody>
907 </table>
908 </div>
909 <div class="sect3">
910 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.7.3. Produces</a></h4>
911 <div class="ulist">
912 <ul>
913 <li>
914 <p><code>application/json</code></p>
915 </li>
916 </ul>
917 </div>
918 </div>
919 </div>
920 <div class="sect2">
921 <h3 id="_route11"><a class="anchor" href="#_route11"></a><a class="link" href="#_route11">2.8. PUT /v2/loop/restart/{loopName}</a></h3>
922 <div class="sect3">
923 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.8.1. Parameters</a></h4>
924 <table class="tableblock frame-all grid-all stretch">
925 <colgroup>
926 <col style="width: 22.2222%;">
927 <col style="width: 33.3333%;">
928 <col style="width: 44.4445%;">
929 </colgroup>
930 <thead>
931 <tr>
932 <th class="tableblock halign-left valign-middle">Type</th>
933 <th class="tableblock halign-left valign-middle">Name</th>
934 <th class="tableblock halign-left valign-middle">Schema</th>
935 </tr>
936 </thead>
937 <tbody>
938 <tr>
939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
940 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
941 <em>required</em></p></td>
942 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
943 </tr>
944 </tbody>
945 </table>
946 </div>
947 <div class="sect3">
948 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
949 <table class="tableblock frame-all grid-all stretch">
950 <colgroup>
951 <col style="width: 10%;">
952 <col style="width: 70%;">
953 <col style="width: 20%;">
954 </colgroup>
955 <thead>
956 <tr>
957 <th class="tableblock halign-left valign-middle">HTTP Code</th>
958 <th class="tableblock halign-left valign-middle">Description</th>
959 <th class="tableblock halign-left valign-middle">Schema</th>
960 </tr>
961 </thead>
962 <tbody>
963 <tr>
964 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
965 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
966 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
967 </tr>
968 </tbody>
969 </table>
970 </div>
971 <div class="sect3">
972 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.8.3. Produces</a></h4>
973 <div class="ulist">
974 <ul>
975 <li>
976 <p><code>application/json</code></p>
977 </li>
978 </ul>
979 </div>
980 </div>
981 </div>
982 <div class="sect2">
983 <h3 id="_route10"><a class="anchor" href="#_route10"></a><a class="link" href="#_route10">2.9. PUT /v2/loop/stop/{loopName}</a></h3>
984 <div class="sect3">
985 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.9.1. Parameters</a></h4>
986 <table class="tableblock frame-all grid-all stretch">
987 <colgroup>
988 <col style="width: 22.2222%;">
989 <col style="width: 33.3333%;">
990 <col style="width: 44.4445%;">
991 </colgroup>
992 <thead>
993 <tr>
994 <th class="tableblock halign-left valign-middle">Type</th>
995 <th class="tableblock halign-left valign-middle">Name</th>
996 <th class="tableblock halign-left valign-middle">Schema</th>
997 </tr>
998 </thead>
999 <tbody>
1000 <tr>
1001 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1002 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1003 <em>required</em></p></td>
1004 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1005 </tr>
1006 </tbody>
1007 </table>
1008 </div>
1009 <div class="sect3">
1010 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1011 <table class="tableblock frame-all grid-all stretch">
1012 <colgroup>
1013 <col style="width: 10%;">
1014 <col style="width: 70%;">
1015 <col style="width: 20%;">
1016 </colgroup>
1017 <thead>
1018 <tr>
1019 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1020 <th class="tableblock halign-left valign-middle">Description</th>
1021 <th class="tableblock halign-left valign-middle">Schema</th>
1022 </tr>
1023 </thead>
1024 <tbody>
1025 <tr>
1026 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1027 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1028 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1029 </tr>
1030 </tbody>
1031 </table>
1032 </div>
1033 <div class="sect3">
1034 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.9.3. Produces</a></h4>
1035 <div class="ulist">
1036 <ul>
1037 <li>
1038 <p><code>application/json</code></p>
1039 </li>
1040 </ul>
1041 </div>
1042 </div>
1043 </div>
1044 <div class="sect2">
1045 <h3 id="_route12"><a class="anchor" href="#_route12"></a><a class="link" href="#_route12">2.10. PUT /v2/loop/submit/{loopName}</a></h3>
1046 <div class="sect3">
1047 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.10.1. Parameters</a></h4>
1048 <table class="tableblock frame-all grid-all stretch">
1049 <colgroup>
1050 <col style="width: 22.2222%;">
1051 <col style="width: 33.3333%;">
1052 <col style="width: 44.4445%;">
1053 </colgroup>
1054 <thead>
1055 <tr>
1056 <th class="tableblock halign-left valign-middle">Type</th>
1057 <th class="tableblock halign-left valign-middle">Name</th>
1058 <th class="tableblock halign-left valign-middle">Schema</th>
1059 </tr>
1060 </thead>
1061 <tbody>
1062 <tr>
1063 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1065 <em>required</em></p></td>
1066 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1067 </tr>
1068 </tbody>
1069 </table>
1070 </div>
1071 <div class="sect3">
1072 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1073 <table class="tableblock frame-all grid-all stretch">
1074 <colgroup>
1075 <col style="width: 10%;">
1076 <col style="width: 70%;">
1077 <col style="width: 20%;">
1078 </colgroup>
1079 <thead>
1080 <tr>
1081 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1082 <th class="tableblock halign-left valign-middle">Description</th>
1083 <th class="tableblock halign-left valign-middle">Schema</th>
1084 </tr>
1085 </thead>
1086 <tbody>
1087 <tr>
1088 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1089 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1090 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1091 </tr>
1092 </tbody>
1093 </table>
1094 </div>
1095 <div class="sect3">
1096 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.10.3. Produces</a></h4>
1097 <div class="ulist">
1098 <ul>
1099 <li>
1100 <p><code>application/json</code></p>
1101 </li>
1102 </ul>
1103 </div>
1104 </div>
1105 </div>
1106 <div class="sect2">
1107 <h3 id="_route4"><a class="anchor" href="#_route4"></a><a class="link" href="#_route4">2.11. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
1108 <div class="sect3">
1109 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.11.1. Parameters</a></h4>
1110 <table class="tableblock frame-all grid-all stretch">
1111 <colgroup>
1112 <col style="width: 22.2222%;">
1113 <col style="width: 33.3333%;">
1114 <col style="width: 44.4445%;">
1115 </colgroup>
1116 <thead>
1117 <tr>
1118 <th class="tableblock halign-left valign-middle">Type</th>
1119 <th class="tableblock halign-left valign-middle">Name</th>
1120 <th class="tableblock halign-left valign-middle">Schema</th>
1121 </tr>
1122 </thead>
1123 <tbody>
1124 <tr>
1125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1127 <em>required</em></p></td>
1128 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1129 </tr>
1130 </tbody>
1131 </table>
1132 </div>
1133 <div class="sect3">
1134 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.2. Responses</a></h4>
1135 <table class="tableblock frame-all grid-all stretch">
1136 <colgroup>
1137 <col style="width: 10%;">
1138 <col style="width: 70%;">
1139 <col style="width: 20%;">
1140 </colgroup>
1141 <thead>
1142 <tr>
1143 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1144 <th class="tableblock halign-left valign-middle">Description</th>
1145 <th class="tableblock halign-left valign-middle">Schema</th>
1146 </tr>
1147 </thead>
1148 <tbody>
1149 <tr>
1150 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1151 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1152 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1153 </tr>
1154 </tbody>
1155 </table>
1156 </div>
1157 <div class="sect3">
1158 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.11.3. Produces</a></h4>
1159 <div class="ulist">
1160 <ul>
1161 <li>
1162 <p><code>application/xml</code></p>
1163 </li>
1164 </ul>
1165 </div>
1166 </div>
1167 </div>
1168 <div class="sect2">
1169 <h3 id="_route9"><a class="anchor" href="#_route9"></a><a class="link" href="#_route9">2.12. PUT /v2/loop/undeploy/{loopName}</a></h3>
1170 <div class="sect3">
1171 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.12.1. Parameters</a></h4>
1172 <table class="tableblock frame-all grid-all stretch">
1173 <colgroup>
1174 <col style="width: 22.2222%;">
1175 <col style="width: 33.3333%;">
1176 <col style="width: 44.4445%;">
1177 </colgroup>
1178 <thead>
1179 <tr>
1180 <th class="tableblock halign-left valign-middle">Type</th>
1181 <th class="tableblock halign-left valign-middle">Name</th>
1182 <th class="tableblock halign-left valign-middle">Schema</th>
1183 </tr>
1184 </thead>
1185 <tbody>
1186 <tr>
1187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1188 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1189 <em>required</em></p></td>
1190 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1191 </tr>
1192 </tbody>
1193 </table>
1194 </div>
1195 <div class="sect3">
1196 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1197 <table class="tableblock frame-all grid-all stretch">
1198 <colgroup>
1199 <col style="width: 10%;">
1200 <col style="width: 70%;">
1201 <col style="width: 20%;">
1202 </colgroup>
1203 <thead>
1204 <tr>
1205 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1206 <th class="tableblock halign-left valign-middle">Description</th>
1207 <th class="tableblock halign-left valign-middle">Schema</th>
1208 </tr>
1209 </thead>
1210 <tbody>
1211 <tr>
1212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1213 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1214 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1215 </tr>
1216 </tbody>
1217 </table>
1218 </div>
1219 <div class="sect3">
1220 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.12.3. Produces</a></h4>
1221 <div class="ulist">
1222 <ul>
1223 <li>
1224 <p><code>application/json</code></p>
1225 </li>
1226 </ul>
1227 </div>
1228 </div>
1229 </div>
1230 <div class="sect2">
1231 <h3 id="_route5"><a class="anchor" href="#_route5"></a><a class="link" href="#_route5">2.13. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
1232 <div class="sect3">
1233 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.13.1. Parameters</a></h4>
1234 <table class="tableblock frame-all grid-all stretch">
1235 <colgroup>
1236 <col style="width: 22.2222%;">
1237 <col style="width: 33.3333%;">
1238 <col style="width: 44.4445%;">
1239 </colgroup>
1240 <thead>
1241 <tr>
1242 <th class="tableblock halign-left valign-middle">Type</th>
1243 <th class="tableblock halign-left valign-middle">Name</th>
1244 <th class="tableblock halign-left valign-middle">Schema</th>
1245 </tr>
1246 </thead>
1247 <tbody>
1248 <tr>
1249 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1250 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1251 <em>required</em></p></td>
1252 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1253 </tr>
1254 <tr>
1255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1256 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1257 <em>required</em></p></td>
1258 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1259 </tr>
1260 </tbody>
1261 </table>
1262 </div>
1263 <div class="sect3">
1264 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.2. Responses</a></h4>
1265 <table class="tableblock frame-all grid-all stretch">
1266 <colgroup>
1267 <col style="width: 10%;">
1268 <col style="width: 70%;">
1269 <col style="width: 20%;">
1270 </colgroup>
1271 <thead>
1272 <tr>
1273 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1274 <th class="tableblock halign-left valign-middle">Description</th>
1275 <th class="tableblock halign-left valign-middle">Schema</th>
1276 </tr>
1277 </thead>
1278 <tbody>
1279 <tr>
1280 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1281 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1282 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1283 </tr>
1284 </tbody>
1285 </table>
1286 </div>
1287 <div class="sect3">
1288 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.13.3. Consumes</a></h4>
1289 <div class="ulist">
1290 <ul>
1291 <li>
1292 <p><code>application/json</code></p>
1293 </li>
1294 </ul>
1295 </div>
1296 </div>
1297 <div class="sect3">
1298 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.13.4. Produces</a></h4>
1299 <div class="ulist">
1300 <ul>
1301 <li>
1302 <p><code>application/json</code></p>
1303 </li>
1304 </ul>
1305 </div>
1306 </div>
1307 </div>
1308 <div class="sect2">
1309 <h3 id="_route7"><a class="anchor" href="#_route7"></a><a class="link" href="#_route7">2.14. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
1310 <div class="sect3">
1311 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.14.1. Parameters</a></h4>
1312 <table class="tableblock frame-all grid-all stretch">
1313 <colgroup>
1314 <col style="width: 22.2222%;">
1315 <col style="width: 33.3333%;">
1316 <col style="width: 44.4445%;">
1317 </colgroup>
1318 <thead>
1319 <tr>
1320 <th class="tableblock halign-left valign-middle">Type</th>
1321 <th class="tableblock halign-left valign-middle">Name</th>
1322 <th class="tableblock halign-left valign-middle">Schema</th>
1323 </tr>
1324 </thead>
1325 <tbody>
1326 <tr>
1327 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1329 <em>required</em></p></td>
1330 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1331 </tr>
1332 <tr>
1333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1334 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1335 <em>required</em></p></td>
1336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1337 </tr>
1338 </tbody>
1339 </table>
1340 </div>
1341 <div class="sect3">
1342 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1343 <table class="tableblock frame-all grid-all stretch">
1344 <colgroup>
1345 <col style="width: 10%;">
1346 <col style="width: 70%;">
1347 <col style="width: 20%;">
1348 </colgroup>
1349 <thead>
1350 <tr>
1351 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1352 <th class="tableblock halign-left valign-middle">Description</th>
1353 <th class="tableblock halign-left valign-middle">Schema</th>
1354 </tr>
1355 </thead>
1356 <tbody>
1357 <tr>
1358 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1359 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1360 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1361 </tr>
1362 </tbody>
1363 </table>
1364 </div>
1365 <div class="sect3">
1366 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.14.3. Consumes</a></h4>
1367 <div class="ulist">
1368 <ul>
1369 <li>
1370 <p><code>application/json</code></p>
1371 </li>
1372 </ul>
1373 </div>
1374 </div>
1375 <div class="sect3">
1376 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.4. Produces</a></h4>
1377 <div class="ulist">
1378 <ul>
1379 <li>
1380 <p><code>application/json</code></p>
1381 </li>
1382 </ul>
1383 </div>
1384 </div>
1385 </div>
1386 <div class="sect2">
1387 <h3 id="_route6"><a class="anchor" href="#_route6"></a><a class="link" href="#_route6">2.15. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
1388 <div class="sect3">
1389 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.15.1. Parameters</a></h4>
1390 <table class="tableblock frame-all grid-all stretch">
1391 <colgroup>
1392 <col style="width: 22.2222%;">
1393 <col style="width: 33.3333%;">
1394 <col style="width: 44.4445%;">
1395 </colgroup>
1396 <thead>
1397 <tr>
1398 <th class="tableblock halign-left valign-middle">Type</th>
1399 <th class="tableblock halign-left valign-middle">Name</th>
1400 <th class="tableblock halign-left valign-middle">Schema</th>
1401 </tr>
1402 </thead>
1403 <tbody>
1404 <tr>
1405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1406 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1407 <em>required</em></p></td>
1408 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1409 </tr>
1410 <tr>
1411 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1412 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1413 <em>required</em></p></td>
1414 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1415 </tr>
1416 </tbody>
1417 </table>
1418 </div>
1419 <div class="sect3">
1420 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.2. Responses</a></h4>
1421 <table class="tableblock frame-all grid-all stretch">
1422 <colgroup>
1423 <col style="width: 10%;">
1424 <col style="width: 70%;">
1425 <col style="width: 20%;">
1426 </colgroup>
1427 <thead>
1428 <tr>
1429 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1430 <th class="tableblock halign-left valign-middle">Description</th>
1431 <th class="tableblock halign-left valign-middle">Schema</th>
1432 </tr>
1433 </thead>
1434 <tbody>
1435 <tr>
1436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1437 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1438 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1439 </tr>
1440 </tbody>
1441 </table>
1442 </div>
1443 <div class="sect3">
1444 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.15.3. Consumes</a></h4>
1445 <div class="ulist">
1446 <ul>
1447 <li>
1448 <p><code>application/json</code></p>
1449 </li>
1450 </ul>
1451 </div>
1452 </div>
1453 <div class="sect3">
1454 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.4. Produces</a></h4>
1455 <div class="ulist">
1456 <ul>
1457 <li>
1458 <p><code>application/json</code></p>
1459 </li>
1460 </ul>
1461 </div>
1462 </div>
1463 </div>
1464 <div class="sect2">
1465 <h3 id="_route3"><a class="anchor" href="#_route3"></a><a class="link" href="#_route3">2.16. GET /v2/loop/{loopName}</a></h3>
1466 <div class="sect3">
1467 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.16.1. Parameters</a></h4>
1468 <table class="tableblock frame-all grid-all stretch">
1469 <colgroup>
1470 <col style="width: 22.2222%;">
1471 <col style="width: 33.3333%;">
1472 <col style="width: 44.4445%;">
1473 </colgroup>
1474 <thead>
1475 <tr>
1476 <th class="tableblock halign-left valign-middle">Type</th>
1477 <th class="tableblock halign-left valign-middle">Name</th>
1478 <th class="tableblock halign-left valign-middle">Schema</th>
1479 </tr>
1480 </thead>
1481 <tbody>
1482 <tr>
1483 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1484 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1485 <em>required</em></p></td>
1486 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1487 </tr>
1488 </tbody>
1489 </table>
1490 </div>
1491 <div class="sect3">
1492 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1493 <table class="tableblock frame-all grid-all stretch">
1494 <colgroup>
1495 <col style="width: 10%;">
1496 <col style="width: 70%;">
1497 <col style="width: 20%;">
1498 </colgroup>
1499 <thead>
1500 <tr>
1501 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1502 <th class="tableblock halign-left valign-middle">Description</th>
1503 <th class="tableblock halign-left valign-middle">Schema</th>
1504 </tr>
1505 </thead>
1506 <tbody>
1507 <tr>
1508 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1509 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1510 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1511 </tr>
1512 </tbody>
1513 </table>
1514 </div>
1515 <div class="sect3">
1516 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1517 <div class="ulist">
1518 <ul>
1519 <li>
1520 <p><code>application/json</code></p>
1521 </li>
1522 </ul>
1523 </div>
1524 </div>
1525 </div>
1526 </div>
1527 </div>
1528 <div class="sect1">
1529 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
1530 <div class="sectionbody">
1531 <div class="sect2">
1532 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a><a class="link" href="#_cldshealthcheck">3.1. CldsHealthCheck</a></h3>
1533 <table class="tableblock frame-all grid-all stretch">
1534 <colgroup>
1535 <col style="width: 42.8571%;">
1536 <col style="width: 57.1429%;">
1537 </colgroup>
1538 <thead>
1539 <tr>
1540 <th class="tableblock halign-left valign-middle">Name</th>
1541 <th class="tableblock halign-left valign-middle">Schema</th>
1542 </tr>
1543 </thead>
1544 <tbody>
1545 <tr>
1546 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1547 <em>optional</em></p></td>
1548 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1549 </tr>
1550 <tr>
1551 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
1552 <em>optional</em></p></td>
1553 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1554 </tr>
1555 <tr>
1556 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
1557 <em>optional</em></p></td>
1558 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1559 </tr>
1560 </tbody>
1561 </table>
1562 </div>
1563 <div class="sect2">
1564 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a><a class="link" href="#_cldsinfo">3.2. CldsInfo</a></h3>
1565 <table class="tableblock frame-all grid-all stretch">
1566 <colgroup>
1567 <col style="width: 42.8571%;">
1568 <col style="width: 57.1429%;">
1569 </colgroup>
1570 <thead>
1571 <tr>
1572 <th class="tableblock halign-left valign-middle">Name</th>
1573 <th class="tableblock halign-left valign-middle">Schema</th>
1574 </tr>
1575 </thead>
1576 <tbody>
1577 <tr>
1578 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
1579 <em>optional</em></p></td>
1580 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1581 </tr>
1582 <tr>
1583 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
1584 <em>optional</em></p></td>
1585 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1586 </tr>
1587 <tr>
1588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
1589 <em>optional</em></p></td>
1590 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1591 </tr>
1592 <tr>
1593 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTosca</strong><br>
1594 <em>optional</em></p></td>
1595 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1596 </tr>
1597 <tr>
1598 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
1599 <em>optional</em></p></td>
1600 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1601 </tr>
1602 <tr>
1603 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
1604 <em>optional</em></p></td>
1605 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1606 </tr>
1607 <tr>
1608 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTosca</strong><br>
1609 <em>optional</em></p></td>
1610 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1611 </tr>
1612 <tr>
1613 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
1614 <em>optional</em></p></td>
1615 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1616 </tr>
1617 </tbody>
1618 </table>
1619 </div>
1620 <div class="sect2">
1621 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.3. ExternalComponent</a></h3>
1622 <table class="tableblock frame-all grid-all stretch">
1623 <colgroup>
1624 <col style="width: 42.8571%;">
1625 <col style="width: 57.1429%;">
1626 </colgroup>
1627 <thead>
1628 <tr>
1629 <th class="tableblock halign-left valign-middle">Name</th>
1630 <th class="tableblock halign-left valign-middle">Schema</th>
1631 </tr>
1632 </thead>
1633 <tbody>
1634 <tr>
1635 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
1636 <em>optional</em></p></td>
1637 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1638 </tr>
1639 <tr>
1640 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
1641 <em>optional</em></p></td>
1642 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
1643 </tr>
1644 </tbody>
1645 </table>
1646 </div>
1647 <div class="sect2">
1648 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.4. ExternalComponentState</a></h3>
1649 <table class="tableblock frame-all grid-all stretch">
1650 <colgroup>
1651 <col style="width: 42.8571%;">
1652 <col style="width: 57.1429%;">
1653 </colgroup>
1654 <thead>
1655 <tr>
1656 <th class="tableblock halign-left valign-middle">Name</th>
1657 <th class="tableblock halign-left valign-middle">Schema</th>
1658 </tr>
1659 </thead>
1660 <tbody>
1661 <tr>
1662 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1663 <em>optional</em></p></td>
1664 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1665 </tr>
1666 <tr>
1667 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
1668 <em>optional</em></p></td>
1669 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1670 </tr>
1671 <tr>
1672 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
1673 <em>optional</em></p></td>
1674 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1675 </tr>
1676 </tbody>
1677 </table>
1678 </div>
1679 <div class="sect2">
1680 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.5. JsonArray</a></h3>
1681 <table class="tableblock frame-all grid-all stretch">
1682 <colgroup>
1683 <col style="width: 42.8571%;">
1684 <col style="width: 57.1429%;">
1685 </colgroup>
1686 <thead>
1687 <tr>
1688 <th class="tableblock halign-left valign-middle">Name</th>
1689 <th class="tableblock halign-left valign-middle">Schema</th>
1690 </tr>
1691 </thead>
1692 <tbody>
1693 <tr>
1694 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
1695 <em>optional</em></p></td>
1696 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
1697 </tr>
1698 <tr>
1699 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
1700 <em>optional</em></p></td>
1701 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
1702 </tr>
1703 <tr>
1704 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
1705 <em>optional</em></p></td>
1706 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1707 </tr>
1708 <tr>
1709 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
1710 <em>optional</em></p></td>
1711 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
1712 </tr>
1713 <tr>
1714 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
1715 <em>optional</em></p></td>
1716 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1717 </tr>
1718 <tr>
1719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
1720 <em>optional</em></p></td>
1721 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
1722 </tr>
1723 <tr>
1724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
1725 <em>optional</em></p></td>
1726 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
1727 </tr>
1728 <tr>
1729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
1730 <em>optional</em></p></td>
1731 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1732 </tr>
1733 <tr>
1734 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
1735 <em>optional</em></p></td>
1736 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1737 </tr>
1738 <tr>
1739 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
1740 <em>optional</em></p></td>
1741 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
1742 </tr>
1743 <tr>
1744 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
1745 <em>optional</em></p></td>
1746 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1747 </tr>
1748 <tr>
1749 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
1750 <em>optional</em></p></td>
1751 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
1752 </tr>
1753 <tr>
1754 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
1755 <em>optional</em></p></td>
1756 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
1757 </tr>
1758 <tr>
1759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
1760 <em>optional</em></p></td>
1761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
1762 </tr>
1763 <tr>
1764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
1765 <em>optional</em></p></td>
1766 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1767 </tr>
1768 <tr>
1769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
1770 <em>optional</em></p></td>
1771 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1772 </tr>
1773 <tr>
1774 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
1775 <em>optional</em></p></td>
1776 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1777 </tr>
1778 <tr>
1779 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
1780 <em>optional</em></p></td>
1781 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1782 </tr>
1783 <tr>
1784 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
1785 <em>optional</em></p></td>
1786 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1787 </tr>
1788 <tr>
1789 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
1790 <em>optional</em></p></td>
1791 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1792 </tr>
1793 </tbody>
1794 </table>
1795 </div>
1796 <div class="sect2">
1797 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.6. JsonNull</a></h3>
1798 <table class="tableblock frame-all grid-all stretch">
1799 <colgroup>
1800 <col style="width: 42.8571%;">
1801 <col style="width: 57.1429%;">
1802 </colgroup>
1803 <thead>
1804 <tr>
1805 <th class="tableblock halign-left valign-middle">Name</th>
1806 <th class="tableblock halign-left valign-middle">Schema</th>
1807 </tr>
1808 </thead>
1809 <tbody>
1810 <tr>
1811 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
1812 <em>optional</em></p></td>
1813 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
1814 </tr>
1815 <tr>
1816 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
1817 <em>optional</em></p></td>
1818 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
1819 </tr>
1820 <tr>
1821 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
1822 <em>optional</em></p></td>
1823 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1824 </tr>
1825 <tr>
1826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
1827 <em>optional</em></p></td>
1828 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
1829 </tr>
1830 <tr>
1831 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
1832 <em>optional</em></p></td>
1833 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1834 </tr>
1835 <tr>
1836 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
1837 <em>optional</em></p></td>
1838 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
1839 </tr>
1840 <tr>
1841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
1842 <em>optional</em></p></td>
1843 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
1844 </tr>
1845 <tr>
1846 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
1847 <em>optional</em></p></td>
1848 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1849 </tr>
1850 <tr>
1851 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
1852 <em>optional</em></p></td>
1853 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1854 </tr>
1855 <tr>
1856 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
1857 <em>optional</em></p></td>
1858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
1859 </tr>
1860 <tr>
1861 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
1862 <em>optional</em></p></td>
1863 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1864 </tr>
1865 <tr>
1866 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
1867 <em>optional</em></p></td>
1868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
1869 </tr>
1870 <tr>
1871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
1872 <em>optional</em></p></td>
1873 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
1874 </tr>
1875 <tr>
1876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
1877 <em>optional</em></p></td>
1878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
1879 </tr>
1880 <tr>
1881 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
1882 <em>optional</em></p></td>
1883 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1884 </tr>
1885 <tr>
1886 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
1887 <em>optional</em></p></td>
1888 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1889 </tr>
1890 <tr>
1891 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
1892 <em>optional</em></p></td>
1893 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1894 </tr>
1895 <tr>
1896 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
1897 <em>optional</em></p></td>
1898 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1899 </tr>
1900 <tr>
1901 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
1902 <em>optional</em></p></td>
1903 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1904 </tr>
1905 <tr>
1906 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
1907 <em>optional</em></p></td>
1908 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1909 </tr>
1910 </tbody>
1911 </table>
1912 </div>
1913 <div class="sect2">
1914 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.7. JsonObject</a></h3>
1915 <table class="tableblock frame-all grid-all stretch">
1916 <colgroup>
1917 <col style="width: 42.8571%;">
1918 <col style="width: 57.1429%;">
1919 </colgroup>
1920 <thead>
1921 <tr>
1922 <th class="tableblock halign-left valign-middle">Name</th>
1923 <th class="tableblock halign-left valign-middle">Schema</th>
1924 </tr>
1925 </thead>
1926 <tbody>
1927 <tr>
1928 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
1929 <em>optional</em></p></td>
1930 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
1931 </tr>
1932 <tr>
1933 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
1934 <em>optional</em></p></td>
1935 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
1936 </tr>
1937 <tr>
1938 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
1939 <em>optional</em></p></td>
1940 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1941 </tr>
1942 <tr>
1943 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
1944 <em>optional</em></p></td>
1945 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
1946 </tr>
1947 <tr>
1948 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
1949 <em>optional</em></p></td>
1950 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1951 </tr>
1952 <tr>
1953 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
1954 <em>optional</em></p></td>
1955 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
1956 </tr>
1957 <tr>
1958 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
1959 <em>optional</em></p></td>
1960 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
1961 </tr>
1962 <tr>
1963 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
1964 <em>optional</em></p></td>
1965 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1966 </tr>
1967 <tr>
1968 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
1969 <em>optional</em></p></td>
1970 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1971 </tr>
1972 <tr>
1973 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
1974 <em>optional</em></p></td>
1975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
1976 </tr>
1977 <tr>
1978 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
1979 <em>optional</em></p></td>
1980 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1981 </tr>
1982 <tr>
1983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
1984 <em>optional</em></p></td>
1985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
1986 </tr>
1987 <tr>
1988 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
1989 <em>optional</em></p></td>
1990 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
1991 </tr>
1992 <tr>
1993 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
1994 <em>optional</em></p></td>
1995 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
1996 </tr>
1997 <tr>
1998 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
1999 <em>optional</em></p></td>
2000 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2001 </tr>
2002 <tr>
2003 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2004 <em>optional</em></p></td>
2005 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2006 </tr>
2007 <tr>
2008 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2009 <em>optional</em></p></td>
2010 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2011 </tr>
2012 <tr>
2013 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2014 <em>optional</em></p></td>
2015 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2016 </tr>
2017 <tr>
2018 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2019 <em>optional</em></p></td>
2020 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2021 </tr>
2022 <tr>
2023 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2024 <em>optional</em></p></td>
2025 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2026 </tr>
2027 </tbody>
2028 </table>
2029 </div>
2030 <div class="sect2">
2031 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.8. JsonPrimitive</a></h3>
2032 <table class="tableblock frame-all grid-all stretch">
2033 <colgroup>
2034 <col style="width: 42.8571%;">
2035 <col style="width: 57.1429%;">
2036 </colgroup>
2037 <thead>
2038 <tr>
2039 <th class="tableblock halign-left valign-middle">Name</th>
2040 <th class="tableblock halign-left valign-middle">Schema</th>
2041 </tr>
2042 </thead>
2043 <tbody>
2044 <tr>
2045 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2046 <em>optional</em></p></td>
2047 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2048 </tr>
2049 <tr>
2050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2051 <em>optional</em></p></td>
2052 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2053 </tr>
2054 <tr>
2055 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2056 <em>optional</em></p></td>
2057 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2058 </tr>
2059 <tr>
2060 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2061 <em>optional</em></p></td>
2062 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2063 </tr>
2064 <tr>
2065 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2066 <em>optional</em></p></td>
2067 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2068 </tr>
2069 <tr>
2070 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2071 <em>optional</em></p></td>
2072 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2073 </tr>
2074 <tr>
2075 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2076 <em>optional</em></p></td>
2077 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2078 </tr>
2079 <tr>
2080 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2081 <em>optional</em></p></td>
2082 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2083 </tr>
2084 <tr>
2085 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2086 <em>optional</em></p></td>
2087 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2088 </tr>
2089 <tr>
2090 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2091 <em>optional</em></p></td>
2092 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2093 </tr>
2094 <tr>
2095 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2096 <em>optional</em></p></td>
2097 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2098 </tr>
2099 <tr>
2100 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2101 <em>optional</em></p></td>
2102 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2103 </tr>
2104 <tr>
2105 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2106 <em>optional</em></p></td>
2107 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2108 </tr>
2109 <tr>
2110 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2111 <em>optional</em></p></td>
2112 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2113 </tr>
2114 <tr>
2115 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2116 <em>optional</em></p></td>
2117 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2118 </tr>
2119 <tr>
2120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2121 <em>optional</em></p></td>
2122 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2123 </tr>
2124 <tr>
2125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
2126 <em>optional</em></p></td>
2127 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2128 </tr>
2129 <tr>
2130 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2131 <em>optional</em></p></td>
2132 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2133 </tr>
2134 <tr>
2135 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2136 <em>optional</em></p></td>
2137 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2138 </tr>
2139 <tr>
2140 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2141 <em>optional</em></p></td>
2142 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2143 </tr>
2144 <tr>
2145 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2146 <em>optional</em></p></td>
2147 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2148 </tr>
2149 <tr>
2150 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
2151 <em>optional</em></p></td>
2152 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2153 </tr>
2154 <tr>
2155 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
2156 <em>optional</em></p></td>
2157 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2158 </tr>
2159 </tbody>
2160 </table>
2161 </div>
2162 <div class="sect2">
2163 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.9. Loop</a></h3>
2164 <table class="tableblock frame-all grid-all stretch">
2165 <colgroup>
2166 <col style="width: 42.8571%;">
2167 <col style="width: 57.1429%;">
2168 </colgroup>
2169 <thead>
2170 <tr>
2171 <th class="tableblock halign-left valign-middle">Name</th>
2172 <th class="tableblock halign-left valign-middle">Schema</th>
2173 </tr>
2174 </thead>
2175 <tbody>
2176 <tr>
2177 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
2178 <em>optional</em></p></td>
2179 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2180 </tr>
2181 <tr>
2182 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
2183 <em>optional</em></p></td>
2184 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string, <a href="#_externalcomponent">ExternalComponent</a> &gt; map</p></td>
2185 </tr>
2186 <tr>
2187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
2188 <em>optional</em></p></td>
2189 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2190 </tr>
2191 <tr>
2192 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
2193 <em>optional</em></p></td>
2194 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2195 </tr>
2196 <tr>
2197 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
2198 <em>optional</em></p></td>
2199 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2200 </tr>
2201 <tr>
2202 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
2203 <em>optional</em></p></td>
2204 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2205 </tr>
2206 <tr>
2207 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
2208 <em>optional</em></p></td>
2209 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
2210 </tr>
2211 <tr>
2212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
2213 <em>optional</em></p></td>
2214 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looplog">LoopLog</a> &gt; array</p></td>
2215 </tr>
2216 <tr>
2217 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
2218 <em>optional</em></p></td>
2219 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_microservicepolicy">MicroServicePolicy</a> &gt; array</p></td>
2220 </tr>
2221 <tr>
2222 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelPropertiesJson</strong><br>
2223 <em>optional</em></p></td>
2224 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2225 </tr>
2226 <tr>
2227 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2228 <em>optional</em></p></td>
2229 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2230 </tr>
2231 <tr>
2232 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
2233 <em>optional</em></p></td>
2234 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_operationalpolicy">OperationalPolicy</a> &gt; array</p></td>
2235 </tr>
2236 <tr>
2237 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
2238 <em>optional</em></p></td>
2239 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2240 </tr>
2241 </tbody>
2242 </table>
2243 </div>
2244 <div class="sect2">
2245 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.10. LoopLog</a></h3>
2246 <table class="tableblock frame-all grid-all stretch">
2247 <colgroup>
2248 <col style="width: 42.8571%;">
2249 <col style="width: 57.1429%;">
2250 </colgroup>
2251 <thead>
2252 <tr>
2253 <th class="tableblock halign-left valign-middle">Name</th>
2254 <th class="tableblock halign-left valign-middle">Schema</th>
2255 </tr>
2256 </thead>
2257 <tbody>
2258 <tr>
2259 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2260 <em>optional</em></p></td>
2261 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2262 </tr>
2263 <tr>
2264 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
2265 <em>optional</em></p></td>
2266 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2267 </tr>
2268 <tr>
2269 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
2270 <em>optional</em></p></td>
2271 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2272 </tr>
2273 <tr>
2274 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
2275 <em>optional</em></p></td>
2276 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
2277 </tr>
2278 <tr>
2279 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
2280 <em>optional</em></p></td>
2281 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2282 </tr>
2283 <tr>
2284 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
2285 <em>optional</em></p></td>
2286 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2287 </tr>
2288 </tbody>
2289 </table>
2290 </div>
2291 <div class="sect2">
2292 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.11. MicroServicePolicy</a></h3>
2293 <table class="tableblock frame-all grid-all stretch">
2294 <colgroup>
2295 <col style="width: 42.8571%;">
2296 <col style="width: 57.1429%;">
2297 </colgroup>
2298 <thead>
2299 <tr>
2300 <th class="tableblock halign-left valign-middle">Name</th>
2301 <th class="tableblock halign-left valign-middle">Schema</th>
2302 </tr>
2303 </thead>
2304 <tbody>
2305 <tr>
2306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
2307 <em>optional</em></p></td>
2308 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2309 </tr>
2310 <tr>
2311 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelType</strong><br>
2312 <em>optional</em></p></td>
2313 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2314 </tr>
2315 <tr>
2316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2317 <em>optional</em></p></td>
2318 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2319 </tr>
2320 <tr>
2321 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyTosca</strong><br>
2322 <em>optional</em></p></td>
2323 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2324 </tr>
2325 <tr>
2326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>properties</strong><br>
2327 <em>optional</em></p></td>
2328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2329 </tr>
2330 <tr>
2331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
2332 <em>optional</em></p></td>
2333 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2334 </tr>
2335 <tr>
2336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
2337 <em>optional</em></p></td>
2338 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loop">Loop</a> &gt; array</p></td>
2339 </tr>
2340 </tbody>
2341 </table>
2342 </div>
2343 <div class="sect2">
2344 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.12. Number</a></h3>
2345 <div class="paragraph">
2346 <p><em>Type</em> : object</p>
2347 </div>
2348 </div>
2349 <div class="sect2">
2350 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.13. OperationalPolicy</a></h3>
2351 <table class="tableblock frame-all grid-all stretch">
2352 <colgroup>
2353 <col style="width: 42.8571%;">
2354 <col style="width: 57.1429%;">
2355 </colgroup>
2356 <thead>
2357 <tr>
2358 <th class="tableblock halign-left valign-middle">Name</th>
2359 <th class="tableblock halign-left valign-middle">Schema</th>
2360 </tr>
2361 </thead>
2362 <tbody>
2363 <tr>
2364 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
2365 <em>optional</em></p></td>
2366 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2367 </tr>
2368 <tr>
2369 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
2370 <em>optional</em></p></td>
2371 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2372 </tr>
2373 <tr>
2374 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
2375 <em>optional</em></p></td>
2376 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2377 </tr>
2378 <tr>
2379 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2380 <em>optional</em></p></td>
2381 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2382 </tr>
2383 </tbody>
2384 </table>
2385 </div>
2386 </div>
2387 </div>
2388 </div>
2389 <div id="footer">
2390 <div id="footer-text">
2391 Last updated 2019-05-27 14:30:20 CEST
2392 </div>
2393 </div>
2394 </body>
2395 </html>