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">
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"}
32 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
36 svg:not(:root){overflow:hidden}
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}
63 img,object,svg{display:inline-block;vertical-align:middle}
64 textarea{height:auto;min-height:50px}
66 .center{margin-left:auto;margin-right:auto}
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}
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}
78 h2{font-size:1.6875em}
79 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
80 h4,h5{font-size:1.125em}
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}
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}
343 .aqua-background{background-color:#00fafa}
345 .black-background{background-color:#000}
347 .blue-background{background-color:#0000fa}
348 .fuchsia{color:#bf00bf}
349 .fuchsia-background{background-color:#fa00fa}
351 .gray-background{background-color:#7d7d7d}
352 .green{color:#006000}
353 .green-background{background-color:#007d00}
355 .lime-background{background-color:#00fa00}
356 .maroon{color:#600000}
357 .maroon-background{background-color:#7d0000}
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}
365 .red-background{background-color:#fa0000}
366 .silver{color:#909090}
367 .silver-background{background-color:#bcbcbc}
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}
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}
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}}
433 <body class="book toc2 toc-left">
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>
445 <li><a href="#_paths">2. Paths</a>
446 <ul class="sectlevel2">
447 <li><a href="#_route32">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>
453 <li><a href="#_route33">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>
459 <li><a href="#_route34">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>
465 <li><a href="#_route30">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>
471 <li><a href="#_route25">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>
478 <li><a href="#_route19">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>
484 <li><a href="#_route31">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>
491 <li><a href="#_route28">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>
498 <li><a href="#_route27">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>
505 <li><a href="#_route29">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>
512 <li><a href="#_route21">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>
519 <li><a href="#_route26">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>
526 <li><a href="#_route22">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>
534 <li><a href="#_route24">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>
542 <li><a href="#_route23">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>
550 <li><a href="#_route20">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>
559 <li><a href="#_definitions">3. Definitions</a>
560 <ul class="sectlevel2">
561 <li><a href="#_cldsinfo">3.1. CldsInfo</a></li>
562 <li><a href="#_externalcomponent">3.2. ExternalComponent</a></li>
563 <li><a href="#_externalcomponentstate">3.3. ExternalComponentState</a></li>
564 <li><a href="#_jsonarray">3.4. JsonArray</a></li>
565 <li><a href="#_jsonnull">3.5. JsonNull</a></li>
566 <li><a href="#_jsonobject">3.6. JsonObject</a></li>
567 <li><a href="#_jsonprimitive">3.7. JsonPrimitive</a></li>
568 <li><a href="#_loop">3.8. Loop</a></li>
569 <li><a href="#_looplog">3.9. LoopLog</a></li>
570 <li><a href="#_microservicepolicy">3.10. MicroServicePolicy</a></li>
571 <li><a href="#_number">3.11. Number</a></li>
572 <li><a href="#_operationalpolicy">3.12. OperationalPolicy</a></li>
580 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
581 <div class="sectionbody">
583 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
584 <div class="paragraph">
585 <p><em>Version</em> : 4.1.2-SNAPSHOT</p>
589 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
590 <div class="paragraph">
591 <p><em>Host</em> : localhost:36829<br>
592 <em>BasePath</em> : /restservices/clds/<br>
593 <em>Schemes</em> : HTTP</p>
599 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
600 <div class="sectionbody">
602 <h3 id="_route32"><a class="anchor" href="#_route32"></a><a class="link" href="#_route32">2.1. GET /v1/clds/cldsInfo</a></h3>
604 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.1. Responses</a></h4>
605 <table class="tableblock frame-all grid-all stretch">
607 <col style="width: 10%;">
608 <col style="width: 70%;">
609 <col style="width: 20%;">
613 <th class="tableblock halign-left valign-middle">HTTP Code</th>
614 <th class="tableblock halign-left valign-middle">Description</th>
615 <th class="tableblock halign-left valign-middle">Schema</th>
620 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
621 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
628 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
632 <p><code>application/json</code></p>
639 <h3 id="_route33"><a class="anchor" href="#_route33"></a><a class="link" href="#_route33">2.2. GET /v1/healthcheck</a></h3>
641 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
642 <table class="tableblock frame-all grid-all stretch">
644 <col style="width: 33.3333%;">
645 <col style="width: 66.6667%;">
649 <th class="tableblock halign-left valign-middle">HTTP Code</th>
650 <th class="tableblock halign-left valign-middle">Schema</th>
655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
656 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
662 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
666 <p><code>application/json</code></p>
673 <h3 id="_route34"><a class="anchor" href="#_route34"></a><a class="link" href="#_route34">2.3. GET /v1/user/getUser</a></h3>
675 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
676 <table class="tableblock frame-all grid-all stretch">
678 <col style="width: 33.3333%;">
679 <col style="width: 66.6667%;">
683 <th class="tableblock halign-left valign-middle">HTTP Code</th>
684 <th class="tableblock halign-left valign-middle">Schema</th>
689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
690 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
696 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
700 <p><code>text/plain</code></p>
707 <h3 id="_route30"><a class="anchor" href="#_route30"></a><a class="link" href="#_route30">2.4. PUT /v2/loop/delete/{loopName}</a></h3>
709 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.4.1. Parameters</a></h4>
710 <table class="tableblock frame-all grid-all stretch">
712 <col style="width: 22.2222%;">
713 <col style="width: 33.3333%;">
714 <col style="width: 44.4445%;">
718 <th class="tableblock halign-left valign-middle">Type</th>
719 <th class="tableblock halign-left valign-middle">Name</th>
720 <th class="tableblock halign-left valign-middle">Schema</th>
725 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
727 <em>required</em></p></td>
728 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
734 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.2. Responses</a></h4>
735 <table class="tableblock frame-all grid-all stretch">
737 <col style="width: 33.3333%;">
738 <col style="width: 66.6667%;">
742 <th class="tableblock halign-left valign-middle">HTTP Code</th>
743 <th class="tableblock halign-left valign-middle">Schema</th>
748 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
749 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
756 <h3 id="_route25"><a class="anchor" href="#_route25"></a><a class="link" href="#_route25">2.5. PUT /v2/loop/deploy/{loopName}</a></h3>
758 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.5.1. Parameters</a></h4>
759 <table class="tableblock frame-all grid-all stretch">
761 <col style="width: 22.2222%;">
762 <col style="width: 33.3333%;">
763 <col style="width: 44.4445%;">
767 <th class="tableblock halign-left valign-middle">Type</th>
768 <th class="tableblock halign-left valign-middle">Name</th>
769 <th class="tableblock halign-left valign-middle">Schema</th>
774 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
775 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
776 <em>required</em></p></td>
777 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
783 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
784 <table class="tableblock frame-all grid-all stretch">
786 <col style="width: 10%;">
787 <col style="width: 70%;">
788 <col style="width: 20%;">
792 <th class="tableblock halign-left valign-middle">HTTP Code</th>
793 <th class="tableblock halign-left valign-middle">Description</th>
794 <th class="tableblock halign-left valign-middle">Schema</th>
799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
800 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
801 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
807 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.5.3. Produces</a></h4>
811 <p><code>application/json</code></p>
818 <h3 id="_route19"><a class="anchor" href="#_route19"></a><a class="link" href="#_route19">2.6. GET /v2/loop/getAllNames</a></h3>
820 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
821 <table class="tableblock frame-all grid-all stretch">
823 <col style="width: 10%;">
824 <col style="width: 70%;">
825 <col style="width: 20%;">
829 <th class="tableblock halign-left valign-middle">HTTP Code</th>
830 <th class="tableblock halign-left valign-middle">Description</th>
831 <th class="tableblock halign-left valign-middle">Schema</th>
836 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
837 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
838 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
844 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.6.2. Produces</a></h4>
848 <p><code>application/json</code></p>
855 <h3 id="_route31"><a class="anchor" href="#_route31"></a><a class="link" href="#_route31">2.7. GET /v2/loop/getstatus/{loopName}</a></h3>
857 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.7.1. Parameters</a></h4>
858 <table class="tableblock frame-all grid-all stretch">
860 <col style="width: 22.2222%;">
861 <col style="width: 33.3333%;">
862 <col style="width: 44.4445%;">
866 <th class="tableblock halign-left valign-middle">Type</th>
867 <th class="tableblock halign-left valign-middle">Name</th>
868 <th class="tableblock halign-left valign-middle">Schema</th>
873 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
874 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
875 <em>required</em></p></td>
876 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
882 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
883 <table class="tableblock frame-all grid-all stretch">
885 <col style="width: 10%;">
886 <col style="width: 70%;">
887 <col style="width: 20%;">
891 <th class="tableblock halign-left valign-middle">HTTP Code</th>
892 <th class="tableblock halign-left valign-middle">Description</th>
893 <th class="tableblock halign-left valign-middle">Schema</th>
898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
899 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
900 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
906 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.7.3. Produces</a></h4>
910 <p><code>application/json</code></p>
917 <h3 id="_route28"><a class="anchor" href="#_route28"></a><a class="link" href="#_route28">2.8. PUT /v2/loop/restart/{loopName}</a></h3>
919 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.8.1. Parameters</a></h4>
920 <table class="tableblock frame-all grid-all stretch">
922 <col style="width: 22.2222%;">
923 <col style="width: 33.3333%;">
924 <col style="width: 44.4445%;">
928 <th class="tableblock halign-left valign-middle">Type</th>
929 <th class="tableblock halign-left valign-middle">Name</th>
930 <th class="tableblock halign-left valign-middle">Schema</th>
935 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
936 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
937 <em>required</em></p></td>
938 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
944 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
945 <table class="tableblock frame-all grid-all stretch">
947 <col style="width: 10%;">
948 <col style="width: 70%;">
949 <col style="width: 20%;">
953 <th class="tableblock halign-left valign-middle">HTTP Code</th>
954 <th class="tableblock halign-left valign-middle">Description</th>
955 <th class="tableblock halign-left valign-middle">Schema</th>
960 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
961 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
962 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
968 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.8.3. Produces</a></h4>
972 <p><code>application/json</code></p>
979 <h3 id="_route27"><a class="anchor" href="#_route27"></a><a class="link" href="#_route27">2.9. PUT /v2/loop/stop/{loopName}</a></h3>
981 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.9.1. Parameters</a></h4>
982 <table class="tableblock frame-all grid-all stretch">
984 <col style="width: 22.2222%;">
985 <col style="width: 33.3333%;">
986 <col style="width: 44.4445%;">
990 <th class="tableblock halign-left valign-middle">Type</th>
991 <th class="tableblock halign-left valign-middle">Name</th>
992 <th class="tableblock halign-left valign-middle">Schema</th>
997 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
998 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
999 <em>required</em></p></td>
1000 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1006 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1007 <table class="tableblock frame-all grid-all stretch">
1009 <col style="width: 10%;">
1010 <col style="width: 70%;">
1011 <col style="width: 20%;">
1015 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1016 <th class="tableblock halign-left valign-middle">Description</th>
1017 <th class="tableblock halign-left valign-middle">Schema</th>
1022 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1023 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1024 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1030 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.9.3. Produces</a></h4>
1034 <p><code>application/json</code></p>
1041 <h3 id="_route29"><a class="anchor" href="#_route29"></a><a class="link" href="#_route29">2.10. PUT /v2/loop/submit/{loopName}</a></h3>
1043 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.10.1. Parameters</a></h4>
1044 <table class="tableblock frame-all grid-all stretch">
1046 <col style="width: 22.2222%;">
1047 <col style="width: 33.3333%;">
1048 <col style="width: 44.4445%;">
1052 <th class="tableblock halign-left valign-middle">Type</th>
1053 <th class="tableblock halign-left valign-middle">Name</th>
1054 <th class="tableblock halign-left valign-middle">Schema</th>
1059 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1060 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1061 <em>required</em></p></td>
1062 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1068 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1069 <table class="tableblock frame-all grid-all stretch">
1071 <col style="width: 10%;">
1072 <col style="width: 70%;">
1073 <col style="width: 20%;">
1077 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1078 <th class="tableblock halign-left valign-middle">Description</th>
1079 <th class="tableblock halign-left valign-middle">Schema</th>
1084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1085 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1086 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1092 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.10.3. Produces</a></h4>
1096 <p><code>application/json</code></p>
1103 <h3 id="_route21"><a class="anchor" href="#_route21"></a><a class="link" href="#_route21">2.11. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
1105 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.11.1. Parameters</a></h4>
1106 <table class="tableblock frame-all grid-all stretch">
1108 <col style="width: 22.2222%;">
1109 <col style="width: 33.3333%;">
1110 <col style="width: 44.4445%;">
1114 <th class="tableblock halign-left valign-middle">Type</th>
1115 <th class="tableblock halign-left valign-middle">Name</th>
1116 <th class="tableblock halign-left valign-middle">Schema</th>
1121 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1122 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1123 <em>required</em></p></td>
1124 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1130 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.2. Responses</a></h4>
1131 <table class="tableblock frame-all grid-all stretch">
1133 <col style="width: 10%;">
1134 <col style="width: 70%;">
1135 <col style="width: 20%;">
1139 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1140 <th class="tableblock halign-left valign-middle">Description</th>
1141 <th class="tableblock halign-left valign-middle">Schema</th>
1146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1147 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1148 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1154 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.11.3. Produces</a></h4>
1158 <p><code>application/xml</code></p>
1165 <h3 id="_route26"><a class="anchor" href="#_route26"></a><a class="link" href="#_route26">2.12. PUT /v2/loop/undeploy/{loopName}</a></h3>
1167 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.12.1. Parameters</a></h4>
1168 <table class="tableblock frame-all grid-all stretch">
1170 <col style="width: 22.2222%;">
1171 <col style="width: 33.3333%;">
1172 <col style="width: 44.4445%;">
1176 <th class="tableblock halign-left valign-middle">Type</th>
1177 <th class="tableblock halign-left valign-middle">Name</th>
1178 <th class="tableblock halign-left valign-middle">Schema</th>
1183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1184 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1185 <em>required</em></p></td>
1186 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1192 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1193 <table class="tableblock frame-all grid-all stretch">
1195 <col style="width: 10%;">
1196 <col style="width: 70%;">
1197 <col style="width: 20%;">
1201 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1202 <th class="tableblock halign-left valign-middle">Description</th>
1203 <th class="tableblock halign-left valign-middle">Schema</th>
1208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1209 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1210 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1216 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.12.3. Produces</a></h4>
1220 <p><code>application/json</code></p>
1227 <h3 id="_route22"><a class="anchor" href="#_route22"></a><a class="link" href="#_route22">2.13. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
1229 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.13.1. Parameters</a></h4>
1230 <table class="tableblock frame-all grid-all stretch">
1232 <col style="width: 22.2222%;">
1233 <col style="width: 33.3333%;">
1234 <col style="width: 44.4445%;">
1238 <th class="tableblock halign-left valign-middle">Type</th>
1239 <th class="tableblock halign-left valign-middle">Name</th>
1240 <th class="tableblock halign-left valign-middle">Schema</th>
1245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1246 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1247 <em>required</em></p></td>
1248 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1252 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1253 <em>required</em></p></td>
1254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1260 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.2. Responses</a></h4>
1261 <table class="tableblock frame-all grid-all stretch">
1263 <col style="width: 10%;">
1264 <col style="width: 70%;">
1265 <col style="width: 20%;">
1269 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1270 <th class="tableblock halign-left valign-middle">Description</th>
1271 <th class="tableblock halign-left valign-middle">Schema</th>
1276 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1277 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1284 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.13.3. Consumes</a></h4>
1288 <p><code>application/json</code></p>
1294 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.13.4. Produces</a></h4>
1298 <p><code>application/json</code></p>
1305 <h3 id="_route24"><a class="anchor" href="#_route24"></a><a class="link" href="#_route24">2.14. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
1307 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.14.1. Parameters</a></h4>
1308 <table class="tableblock frame-all grid-all stretch">
1310 <col style="width: 22.2222%;">
1311 <col style="width: 33.3333%;">
1312 <col style="width: 44.4445%;">
1316 <th class="tableblock halign-left valign-middle">Type</th>
1317 <th class="tableblock halign-left valign-middle">Name</th>
1318 <th class="tableblock halign-left valign-middle">Schema</th>
1323 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1324 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1325 <em>required</em></p></td>
1326 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1329 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1331 <em>required</em></p></td>
1332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1338 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1339 <table class="tableblock frame-all grid-all stretch">
1341 <col style="width: 10%;">
1342 <col style="width: 70%;">
1343 <col style="width: 20%;">
1347 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1348 <th class="tableblock halign-left valign-middle">Description</th>
1349 <th class="tableblock halign-left valign-middle">Schema</th>
1354 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1355 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1356 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1362 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.14.3. Consumes</a></h4>
1366 <p><code>application/json</code></p>
1372 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.4. Produces</a></h4>
1376 <p><code>application/json</code></p>
1383 <h3 id="_route23"><a class="anchor" href="#_route23"></a><a class="link" href="#_route23">2.15. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
1385 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.15.1. Parameters</a></h4>
1386 <table class="tableblock frame-all grid-all stretch">
1388 <col style="width: 22.2222%;">
1389 <col style="width: 33.3333%;">
1390 <col style="width: 44.4445%;">
1394 <th class="tableblock halign-left valign-middle">Type</th>
1395 <th class="tableblock halign-left valign-middle">Name</th>
1396 <th class="tableblock halign-left valign-middle">Schema</th>
1401 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1402 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1403 <em>required</em></p></td>
1404 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1407 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1408 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1409 <em>required</em></p></td>
1410 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1416 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.2. Responses</a></h4>
1417 <table class="tableblock frame-all grid-all stretch">
1419 <col style="width: 10%;">
1420 <col style="width: 70%;">
1421 <col style="width: 20%;">
1425 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1426 <th class="tableblock halign-left valign-middle">Description</th>
1427 <th class="tableblock halign-left valign-middle">Schema</th>
1432 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1433 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1434 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1440 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.15.3. Consumes</a></h4>
1444 <p><code>application/json</code></p>
1450 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.4. Produces</a></h4>
1454 <p><code>application/json</code></p>
1461 <h3 id="_route20"><a class="anchor" href="#_route20"></a><a class="link" href="#_route20">2.16. GET /v2/loop/{loopName}</a></h3>
1463 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.16.1. Parameters</a></h4>
1464 <table class="tableblock frame-all grid-all stretch">
1466 <col style="width: 22.2222%;">
1467 <col style="width: 33.3333%;">
1468 <col style="width: 44.4445%;">
1472 <th class="tableblock halign-left valign-middle">Type</th>
1473 <th class="tableblock halign-left valign-middle">Name</th>
1474 <th class="tableblock halign-left valign-middle">Schema</th>
1479 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1480 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1481 <em>required</em></p></td>
1482 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1488 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1489 <table class="tableblock frame-all grid-all stretch">
1491 <col style="width: 10%;">
1492 <col style="width: 70%;">
1493 <col style="width: 20%;">
1497 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1498 <th class="tableblock halign-left valign-middle">Description</th>
1499 <th class="tableblock halign-left valign-middle">Schema</th>
1504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1505 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1506 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1512 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1516 <p><code>application/json</code></p>
1525 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
1526 <div class="sectionbody">
1528 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a><a class="link" href="#_cldsinfo">3.1. CldsInfo</a></h3>
1529 <table class="tableblock frame-all grid-all stretch">
1531 <col style="width: 42.8571%;">
1532 <col style="width: 57.1429%;">
1536 <th class="tableblock halign-left valign-middle">Name</th>
1537 <th class="tableblock halign-left valign-middle">Schema</th>
1542 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
1543 <em>optional</em></p></td>
1544 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1547 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
1548 <em>optional</em></p></td>
1549 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1552 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
1553 <em>optional</em></p></td>
1554 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1557 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTosca</strong><br>
1558 <em>optional</em></p></td>
1559 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1562 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
1563 <em>optional</em></p></td>
1564 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1567 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
1568 <em>optional</em></p></td>
1569 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1572 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTosca</strong><br>
1573 <em>optional</em></p></td>
1574 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1577 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
1578 <em>optional</em></p></td>
1579 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1585 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.2. ExternalComponent</a></h3>
1586 <table class="tableblock frame-all grid-all stretch">
1588 <col style="width: 42.8571%;">
1589 <col style="width: 57.1429%;">
1593 <th class="tableblock halign-left valign-middle">Name</th>
1594 <th class="tableblock halign-left valign-middle">Schema</th>
1599 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
1600 <em>optional</em></p></td>
1601 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1604 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
1605 <em>optional</em></p></td>
1606 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
1612 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.3. ExternalComponentState</a></h3>
1613 <table class="tableblock frame-all grid-all stretch">
1615 <col style="width: 42.8571%;">
1616 <col style="width: 57.1429%;">
1620 <th class="tableblock halign-left valign-middle">Name</th>
1621 <th class="tableblock halign-left valign-middle">Schema</th>
1626 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1627 <em>optional</em></p></td>
1628 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1631 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
1632 <em>optional</em></p></td>
1633 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1636 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
1637 <em>optional</em></p></td>
1638 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1644 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.4. JsonArray</a></h3>
1645 <table class="tableblock frame-all grid-all stretch">
1647 <col style="width: 42.8571%;">
1648 <col style="width: 57.1429%;">
1652 <th class="tableblock halign-left valign-middle">Name</th>
1653 <th class="tableblock halign-left valign-middle">Schema</th>
1658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
1659 <em>optional</em></p></td>
1660 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
1663 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
1664 <em>optional</em></p></td>
1665 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
1668 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
1669 <em>optional</em></p></td>
1670 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1673 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
1674 <em>optional</em></p></td>
1675 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
1678 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
1679 <em>optional</em></p></td>
1680 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1683 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
1684 <em>optional</em></p></td>
1685 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
1688 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
1689 <em>optional</em></p></td>
1690 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
1693 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
1694 <em>optional</em></p></td>
1695 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1698 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
1699 <em>optional</em></p></td>
1700 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1703 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
1704 <em>optional</em></p></td>
1705 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
1708 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
1709 <em>optional</em></p></td>
1710 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1713 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
1714 <em>optional</em></p></td>
1715 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
1718 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
1719 <em>optional</em></p></td>
1720 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
1723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
1724 <em>optional</em></p></td>
1725 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
1728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
1729 <em>optional</em></p></td>
1730 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1733 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
1734 <em>optional</em></p></td>
1735 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1738 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
1739 <em>optional</em></p></td>
1740 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1743 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
1744 <em>optional</em></p></td>
1745 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1748 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
1749 <em>optional</em></p></td>
1750 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1753 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
1754 <em>optional</em></p></td>
1755 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1761 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.5. JsonNull</a></h3>
1762 <table class="tableblock frame-all grid-all stretch">
1764 <col style="width: 42.8571%;">
1765 <col style="width: 57.1429%;">
1769 <th class="tableblock halign-left valign-middle">Name</th>
1770 <th class="tableblock halign-left valign-middle">Schema</th>
1775 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
1776 <em>optional</em></p></td>
1777 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
1780 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
1781 <em>optional</em></p></td>
1782 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
1785 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
1786 <em>optional</em></p></td>
1787 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1790 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
1791 <em>optional</em></p></td>
1792 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
1795 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
1796 <em>optional</em></p></td>
1797 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
1801 <em>optional</em></p></td>
1802 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
1805 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
1806 <em>optional</em></p></td>
1807 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
1810 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
1811 <em>optional</em></p></td>
1812 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1815 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
1816 <em>optional</em></p></td>
1817 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
1821 <em>optional</em></p></td>
1822 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
1825 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
1826 <em>optional</em></p></td>
1827 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1830 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
1831 <em>optional</em></p></td>
1832 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
1835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
1836 <em>optional</em></p></td>
1837 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
1840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
1841 <em>optional</em></p></td>
1842 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
1845 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
1846 <em>optional</em></p></td>
1847 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
1851 <em>optional</em></p></td>
1852 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
1856 <em>optional</em></p></td>
1857 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
1861 <em>optional</em></p></td>
1862 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
1866 <em>optional</em></p></td>
1867 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1870 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
1871 <em>optional</em></p></td>
1872 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1878 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.6. JsonObject</a></h3>
1879 <table class="tableblock frame-all grid-all stretch">
1881 <col style="width: 42.8571%;">
1882 <col style="width: 57.1429%;">
1886 <th class="tableblock halign-left valign-middle">Name</th>
1887 <th class="tableblock halign-left valign-middle">Schema</th>
1892 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
1893 <em>optional</em></p></td>
1894 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
1897 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
1898 <em>optional</em></p></td>
1899 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
1902 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
1903 <em>optional</em></p></td>
1904 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1907 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
1908 <em>optional</em></p></td>
1909 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
1913 <em>optional</em></p></td>
1914 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1917 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
1918 <em>optional</em></p></td>
1919 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
1922 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
1923 <em>optional</em></p></td>
1924 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
1927 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
1928 <em>optional</em></p></td>
1929 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1932 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
1933 <em>optional</em></p></td>
1934 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
1938 <em>optional</em></p></td>
1939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
1942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
1943 <em>optional</em></p></td>
1944 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1947 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
1948 <em>optional</em></p></td>
1949 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
1952 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
1953 <em>optional</em></p></td>
1954 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
1957 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
1958 <em>optional</em></p></td>
1959 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
1962 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
1963 <em>optional</em></p></td>
1964 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1967 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
1968 <em>optional</em></p></td>
1969 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1972 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
1973 <em>optional</em></p></td>
1974 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1977 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
1978 <em>optional</em></p></td>
1979 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1982 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
1983 <em>optional</em></p></td>
1984 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
1988 <em>optional</em></p></td>
1989 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1995 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.7. JsonPrimitive</a></h3>
1996 <table class="tableblock frame-all grid-all stretch">
1998 <col style="width: 42.8571%;">
1999 <col style="width: 57.1429%;">
2003 <th class="tableblock halign-left valign-middle">Name</th>
2004 <th class="tableblock halign-left valign-middle">Schema</th>
2009 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2010 <em>optional</em></p></td>
2011 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2014 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2015 <em>optional</em></p></td>
2016 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2019 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2020 <em>optional</em></p></td>
2021 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2024 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2025 <em>optional</em></p></td>
2026 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2029 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2030 <em>optional</em></p></td>
2031 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2034 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2035 <em>optional</em></p></td>
2036 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2039 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2040 <em>optional</em></p></td>
2041 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2044 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2045 <em>optional</em></p></td>
2046 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2049 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2050 <em>optional</em></p></td>
2051 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2055 <em>optional</em></p></td>
2056 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2059 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2060 <em>optional</em></p></td>
2061 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2065 <em>optional</em></p></td>
2066 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2069 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2070 <em>optional</em></p></td>
2071 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2074 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2075 <em>optional</em></p></td>
2076 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2079 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2080 <em>optional</em></p></td>
2081 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2085 <em>optional</em></p></td>
2086 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2089 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
2090 <em>optional</em></p></td>
2091 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2094 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2095 <em>optional</em></p></td>
2096 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2099 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2100 <em>optional</em></p></td>
2101 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2105 <em>optional</em></p></td>
2106 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2109 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2110 <em>optional</em></p></td>
2111 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
2115 <em>optional</em></p></td>
2116 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2119 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
2120 <em>optional</em></p></td>
2121 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2127 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.8. Loop</a></h3>
2128 <table class="tableblock frame-all grid-all stretch">
2130 <col style="width: 42.8571%;">
2131 <col style="width: 57.1429%;">
2135 <th class="tableblock halign-left valign-middle">Name</th>
2136 <th class="tableblock halign-left valign-middle">Schema</th>
2141 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
2142 <em>optional</em></p></td>
2143 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
2147 <em>optional</em></p></td>
2148 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string, <a href="#_externalcomponent">ExternalComponent</a> > map</p></td>
2151 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
2152 <em>optional</em></p></td>
2153 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2156 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
2157 <em>optional</em></p></td>
2158 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
2162 <em>optional</em></p></td>
2163 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2166 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
2167 <em>optional</em></p></td>
2168 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2171 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
2172 <em>optional</em></p></td>
2173 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
2176 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
2177 <em>optional</em></p></td>
2178 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looplog">LoopLog</a> > array</p></td>
2181 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
2182 <em>optional</em></p></td>
2183 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_microservicepolicy">MicroServicePolicy</a> > array</p></td>
2186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelPropertiesJson</strong><br>
2187 <em>optional</em></p></td>
2188 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2192 <em>optional</em></p></td>
2193 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2196 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
2197 <em>optional</em></p></td>
2198 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_operationalpolicy">OperationalPolicy</a> > array</p></td>
2201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
2202 <em>optional</em></p></td>
2203 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2209 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.9. LoopLog</a></h3>
2210 <table class="tableblock frame-all grid-all stretch">
2212 <col style="width: 42.8571%;">
2213 <col style="width: 57.1429%;">
2217 <th class="tableblock halign-left valign-middle">Name</th>
2218 <th class="tableblock halign-left valign-middle">Schema</th>
2223 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2224 <em>optional</em></p></td>
2225 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2228 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
2229 <em>optional</em></p></td>
2230 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2233 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
2234 <em>optional</em></p></td>
2235 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2238 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
2239 <em>optional</em></p></td>
2240 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
2243 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
2244 <em>optional</em></p></td>
2245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
2249 <em>optional</em></p></td>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2256 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.10. MicroServicePolicy</a></h3>
2257 <table class="tableblock frame-all grid-all stretch">
2259 <col style="width: 42.8571%;">
2260 <col style="width: 57.1429%;">
2264 <th class="tableblock halign-left valign-middle">Name</th>
2265 <th class="tableblock halign-left valign-middle">Schema</th>
2270 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
2271 <em>optional</em></p></td>
2272 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2275 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelType</strong><br>
2276 <em>optional</em></p></td>
2277 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2280 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2281 <em>optional</em></p></td>
2282 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2285 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyTosca</strong><br>
2286 <em>optional</em></p></td>
2287 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2290 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>properties</strong><br>
2291 <em>optional</em></p></td>
2292 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2295 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
2296 <em>optional</em></p></td>
2297 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
2301 <em>optional</em></p></td>
2302 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_loop">Loop</a> > array</p></td>
2308 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.11. Number</a></h3>
2309 <div class="paragraph">
2310 <p><em>Type</em> : object</p>
2314 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.12. OperationalPolicy</a></h3>
2315 <table class="tableblock frame-all grid-all stretch">
2317 <col style="width: 42.8571%;">
2318 <col style="width: 57.1429%;">
2322 <th class="tableblock halign-left valign-middle">Name</th>
2323 <th class="tableblock halign-left valign-middle">Schema</th>
2328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
2329 <em>optional</em></p></td>
2330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
2334 <em>optional</em></p></td>
2335 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
2339 <em>optional</em></p></td>
2340 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2343 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2344 <em>optional</em></p></td>
2345 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2354 <div id="footer-text">
2355 Last updated 2019-08-12 12:34:46 CEST