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="#_route23">2.1. PUT /v1/clds/action/{action}/{modelName}?test={test}</a>
448 <ul class="sectlevel3">
449 <li><a href="#_parameters">2.1.1. Parameters</a></li>
450 <li><a href="#_responses">2.1.2. Responses</a></li>
451 <li><a href="#_consumes">2.1.3. Consumes</a></li>
452 <li><a href="#_produces">2.1.4. Produces</a></li>
455 <li><a href="#_route15">2.2. GET /v1/clds/cldsDetails</a>
456 <ul class="sectlevel3">
457 <li><a href="#_responses_2">2.2.1. Responses</a></li>
458 <li><a href="#_produces_2">2.2.2. Produces</a></li>
461 <li><a href="#_route16">2.3. GET /v1/clds/cldsInfo</a>
462 <ul class="sectlevel3">
463 <li><a href="#_responses_3">2.3.1. Responses</a></li>
464 <li><a href="#_produces_3">2.3.2. Produces</a></li>
467 <li><a href="#_route24">2.4. POST /v1/clds/dcae/event?test={test}</a>
468 <ul class="sectlevel3">
469 <li><a href="#_parameters_2">2.4.1. Parameters</a></li>
470 <li><a href="#_responses_4">2.4.2. Responses</a></li>
471 <li><a href="#_consumes_2">2.4.3. Consumes</a></li>
472 <li><a href="#_produces_4">2.4.4. Produces</a></li>
475 <li><a href="#_route26">2.5. PUT /v1/clds/deploy/{modelName}</a>
476 <ul class="sectlevel3">
477 <li><a href="#_parameters_3">2.5.1. Parameters</a></li>
478 <li><a href="#_responses_5">2.5.2. Responses</a></li>
479 <li><a href="#_consumes_3">2.5.3. Consumes</a></li>
480 <li><a href="#_produces_5">2.5.4. Produces</a></li>
483 <li><a href="#_route22">2.6. GET /v1/clds/model-names</a>
484 <ul class="sectlevel3">
485 <li><a href="#_responses_6">2.6.1. Responses</a></li>
486 <li><a href="#_produces_6">2.6.2. Produces</a></li>
489 <li><a href="#_route18">2.7. GET /v1/clds/model/bpmn/{modelName}</a>
490 <ul class="sectlevel3">
491 <li><a href="#_parameters_4">2.7.1. Parameters</a></li>
492 <li><a href="#_responses_7">2.7.2. Responses</a></li>
493 <li><a href="#_produces_7">2.7.3. Produces</a></li>
496 <li><a href="#_route19">2.8. GET /v1/clds/model/image/{modelName}</a>
497 <ul class="sectlevel3">
498 <li><a href="#_parameters_5">2.8.1. Parameters</a></li>
499 <li><a href="#_responses_8">2.8.2. Responses</a></li>
500 <li><a href="#_produces_8">2.8.3. Produces</a></li>
503 <li><a href="#_route20">2.9. GET /v1/clds/model/{modelName}</a>
504 <ul class="sectlevel3">
505 <li><a href="#_parameters_6">2.9.1. Parameters</a></li>
506 <li><a href="#_responses_9">2.9.2. Responses</a></li>
507 <li><a href="#_produces_9">2.9.3. Produces</a></li>
510 <li><a href="#_route21">2.10. PUT /v1/clds/model/{modelName}</a>
511 <ul class="sectlevel3">
512 <li><a href="#_parameters_7">2.10.1. Parameters</a></li>
513 <li><a href="#_responses_10">2.10.2. Responses</a></li>
514 <li><a href="#_consumes_4">2.10.3. Consumes</a></li>
515 <li><a href="#_produces_10">2.10.4. Produces</a></li>
518 <li><a href="#_route25">2.11. GET /v1/clds/properties</a>
519 <ul class="sectlevel3">
520 <li><a href="#_responses_11">2.11.1. Responses</a></li>
521 <li><a href="#_produces_11">2.11.2. Produces</a></li>
524 <li><a href="#_route27">2.12. PUT /v1/clds/undeploy/{modelName}</a>
525 <ul class="sectlevel3">
526 <li><a href="#_parameters_8">2.12.1. Parameters</a></li>
527 <li><a href="#_responses_12">2.12.2. Responses</a></li>
528 <li><a href="#_consumes_5">2.12.3. Consumes</a></li>
529 <li><a href="#_produces_12">2.12.4. Produces</a></li>
532 <li><a href="#_route32">2.13. GET /v1/cldsTempate/template-names</a>
533 <ul class="sectlevel3">
534 <li><a href="#_responses_13">2.13.1. Responses</a></li>
535 <li><a href="#_produces_13">2.13.2. Produces</a></li>
538 <li><a href="#_route28">2.14. GET /v1/cldsTempate/template/bpmn/{templateName}</a>
539 <ul class="sectlevel3">
540 <li><a href="#_parameters_9">2.14.1. Parameters</a></li>
541 <li><a href="#_responses_14">2.14.2. Responses</a></li>
542 <li><a href="#_produces_14">2.14.3. Produces</a></li>
545 <li><a href="#_route29">2.15. GET /v1/cldsTempate/template/image/{templateName}</a>
546 <ul class="sectlevel3">
547 <li><a href="#_parameters_10">2.15.1. Parameters</a></li>
548 <li><a href="#_responses_15">2.15.2. Responses</a></li>
549 <li><a href="#_produces_15">2.15.3. Produces</a></li>
552 <li><a href="#_route30">2.16. GET /v1/cldsTempate/template/{templateName}</a>
553 <ul class="sectlevel3">
554 <li><a href="#_parameters_11">2.16.1. Parameters</a></li>
555 <li><a href="#_responses_16">2.16.2. Responses</a></li>
556 <li><a href="#_produces_16">2.16.3. Produces</a></li>
559 <li><a href="#_route31">2.17. PUT /v1/cldsTempate/template/{templateName}</a>
560 <ul class="sectlevel3">
561 <li><a href="#_parameters_12">2.17.1. Parameters</a></li>
562 <li><a href="#_responses_17">2.17.2. Responses</a></li>
563 <li><a href="#_consumes_6">2.17.3. Consumes</a></li>
564 <li><a href="#_produces_17">2.17.4. Produces</a></li>
567 <li><a href="#_route40">2.18. GET /v1/dictionary</a>
568 <ul class="sectlevel3">
569 <li><a href="#_responses_18">2.18.1. Responses</a></li>
570 <li><a href="#_produces_18">2.18.2. Produces</a></li>
573 <li><a href="#_route39">2.19. PUT /v1/dictionary/{dictionaryName}</a>
574 <ul class="sectlevel3">
575 <li><a href="#_parameters_13">2.19.1. Parameters</a></li>
576 <li><a href="#_responses_19">2.19.2. Responses</a></li>
577 <li><a href="#_consumes_7">2.19.3. Consumes</a></li>
578 <li><a href="#_produces_19">2.19.4. Produces</a></li>
581 <li><a href="#_v1_dictionary_dictionaryname_items_get">2.20. GET /v1/dictionary/{dictionaryName}/items</a>
582 <ul class="sectlevel3">
583 <li><a href="#_parameters_14">2.20.1. Parameters</a></li>
584 <li><a href="#_responses_20">2.20.2. Responses</a></li>
585 <li><a href="#_produces_20">2.20.3. Produces</a></li>
588 <li><a href="#_v1_dictionary_dictionaryname_items_put">2.21. PUT /v1/dictionary/{dictionaryName}/items</a>
589 <ul class="sectlevel3">
590 <li><a href="#_parameters_15">2.21.1. Parameters</a></li>
591 <li><a href="#_responses_21">2.21.2. Responses</a></li>
592 <li><a href="#_consumes_8">2.21.3. Consumes</a></li>
593 <li><a href="#_produces_21">2.21.4. Produces</a></li>
596 <li><a href="#_route17">2.22. GET /v1/healthcheck</a>
597 <ul class="sectlevel3">
598 <li><a href="#_responses_22">2.22.1. Responses</a></li>
599 <li><a href="#_produces_22">2.22.2. Produces</a></li>
602 <li><a href="#_route36">2.23. GET /v1/tosca/models</a>
603 <ul class="sectlevel3">
604 <li><a href="#_responses_23">2.23.1. Responses</a></li>
605 <li><a href="#_produces_23">2.23.2. Produces</a></li>
608 <li><a href="#_route34">2.24. GET /v1/tosca/models/policyType/{policyType}</a>
609 <ul class="sectlevel3">
610 <li><a href="#_parameters_16">2.24.1. Parameters</a></li>
611 <li><a href="#_responses_24">2.24.2. Responses</a></li>
612 <li><a href="#_produces_24">2.24.3. Produces</a></li>
615 <li><a href="#_v1_tosca_models_toscamodelname_get">2.25. GET /v1/tosca/models/{toscaModelName}</a>
616 <ul class="sectlevel3">
617 <li><a href="#_parameters_17">2.25.1. Parameters</a></li>
618 <li><a href="#_responses_25">2.25.2. Responses</a></li>
619 <li><a href="#_produces_25">2.25.3. Produces</a></li>
622 <li><a href="#_route33">2.26. PUT /v1/tosca/models/{toscaModelName}</a>
623 <ul class="sectlevel3">
624 <li><a href="#_parameters_18">2.26.1. Parameters</a></li>
625 <li><a href="#_responses_26">2.26.2. Responses</a></li>
626 <li><a href="#_consumes_9">2.26.3. Consumes</a></li>
627 <li><a href="#_produces_26">2.26.4. Produces</a></li>
630 <li><a href="#_route41">2.27. GET /v1/user/getUser</a>
631 <ul class="sectlevel3">
632 <li><a href="#_responses_27">2.27.1. Responses</a></li>
633 <li><a href="#_produces_27">2.27.2. Produces</a></li>
636 <li><a href="#_route13">2.28. PUT /v2/loop/delete/{loopName}</a>
637 <ul class="sectlevel3">
638 <li><a href="#_parameters_19">2.28.1. Parameters</a></li>
639 <li><a href="#_responses_28">2.28.2. Responses</a></li>
642 <li><a href="#_route8">2.29. PUT /v2/loop/deployLoop/{loopName}</a>
643 <ul class="sectlevel3">
644 <li><a href="#_parameters_20">2.29.1. Parameters</a></li>
645 <li><a href="#_responses_29">2.29.2. Responses</a></li>
646 <li><a href="#_produces_28">2.29.3. Produces</a></li>
649 <li><a href="#_route2">2.30. GET /v2/loop/getAllNames</a>
650 <ul class="sectlevel3">
651 <li><a href="#_responses_30">2.30.1. Responses</a></li>
652 <li><a href="#_produces_29">2.30.2. Produces</a></li>
655 <li><a href="#_route14">2.31. GET /v2/loop/getstatus/{loopName}</a>
656 <ul class="sectlevel3">
657 <li><a href="#_parameters_21">2.31.1. Parameters</a></li>
658 <li><a href="#_responses_31">2.31.2. Responses</a></li>
659 <li><a href="#_produces_30">2.31.3. Produces</a></li>
662 <li><a href="#_route11">2.32. PUT /v2/loop/restart/{loopName}</a>
663 <ul class="sectlevel3">
664 <li><a href="#_parameters_22">2.32.1. Parameters</a></li>
665 <li><a href="#_responses_32">2.32.2. Responses</a></li>
666 <li><a href="#_produces_31">2.32.3. Produces</a></li>
669 <li><a href="#_route10">2.33. PUT /v2/loop/stop/{loopName}</a>
670 <ul class="sectlevel3">
671 <li><a href="#_parameters_23">2.33.1. Parameters</a></li>
672 <li><a href="#_responses_33">2.33.2. Responses</a></li>
673 <li><a href="#_produces_32">2.33.3. Produces</a></li>
676 <li><a href="#_route12">2.34. PUT /v2/loop/submit/{loopName}</a>
677 <ul class="sectlevel3">
678 <li><a href="#_parameters_24">2.34.1. Parameters</a></li>
679 <li><a href="#_responses_34">2.34.2. Responses</a></li>
680 <li><a href="#_produces_33">2.34.3. Produces</a></li>
683 <li><a href="#_route4">2.35. GET /v2/loop/svgRepresentation/{loopName}</a>
684 <ul class="sectlevel3">
685 <li><a href="#_parameters_25">2.35.1. Parameters</a></li>
686 <li><a href="#_responses_35">2.35.2. Responses</a></li>
687 <li><a href="#_produces_34">2.35.3. Produces</a></li>
690 <li><a href="#_route9">2.36. PUT /v2/loop/undeployLoop/{loopName}</a>
691 <ul class="sectlevel3">
692 <li><a href="#_parameters_26">2.36.1. Parameters</a></li>
693 <li><a href="#_responses_36">2.36.2. Responses</a></li>
694 <li><a href="#_produces_35">2.36.3. Produces</a></li>
697 <li><a href="#_route5">2.37. POST /v2/loop/updateGlobalProperties/{loopName}</a>
698 <ul class="sectlevel3">
699 <li><a href="#_parameters_27">2.37.1. Parameters</a></li>
700 <li><a href="#_responses_37">2.37.2. Responses</a></li>
701 <li><a href="#_consumes_10">2.37.3. Consumes</a></li>
702 <li><a href="#_produces_36">2.37.4. Produces</a></li>
705 <li><a href="#_route7">2.38. POST /v2/loop/updateMicroservicePolicy/{loopName}</a>
706 <ul class="sectlevel3">
707 <li><a href="#_parameters_28">2.38.1. Parameters</a></li>
708 <li><a href="#_responses_38">2.38.2. Responses</a></li>
709 <li><a href="#_consumes_11">2.38.3. Consumes</a></li>
710 <li><a href="#_produces_37">2.38.4. Produces</a></li>
713 <li><a href="#_route6">2.39. POST /v2/loop/updateOperationalPolicies/{loopName}</a>
714 <ul class="sectlevel3">
715 <li><a href="#_parameters_29">2.39.1. Parameters</a></li>
716 <li><a href="#_responses_39">2.39.2. Responses</a></li>
717 <li><a href="#_consumes_12">2.39.3. Consumes</a></li>
718 <li><a href="#_produces_38">2.39.4. Produces</a></li>
721 <li><a href="#_route3">2.40. GET /v2/loop/{loopName}</a>
722 <ul class="sectlevel3">
723 <li><a href="#_parameters_30">2.40.1. Parameters</a></li>
724 <li><a href="#_responses_40">2.40.2. Responses</a></li>
725 <li><a href="#_produces_39">2.40.3. Produces</a></li>
730 <li><a href="#_definitions">3. Definitions</a>
731 <ul class="sectlevel2">
732 <li><a href="#_cldsdictionary">3.1. CldsDictionary</a></li>
733 <li><a href="#_cldsdictionaryitem">3.2. CldsDictionaryItem</a></li>
734 <li><a href="#_cldsevent">3.3. CldsEvent</a></li>
735 <li><a href="#_cldsinfo">3.4. CldsInfo</a></li>
736 <li><a href="#_cldsmodel">3.5. CldsModel</a></li>
737 <li><a href="#_cldsmodelinstance">3.6. CldsModelInstance</a></li>
738 <li><a href="#_cldsmonitoringdetails">3.7. CldsMonitoringDetails</a></li>
739 <li><a href="#_cldstemplate">3.8. CldsTemplate</a></li>
740 <li><a href="#_cldstoscamodel">3.9. CldsToscaModel</a></li>
741 <li><a href="#_dcaeevent">3.10. DcaeEvent</a></li>
742 <li><a href="#_jsonarray">3.11. JsonArray</a></li>
743 <li><a href="#_jsonnull">3.12. JsonNull</a></li>
744 <li><a href="#_jsonobject">3.13. JsonObject</a></li>
745 <li><a href="#_jsonprimitive">3.14. JsonPrimitive</a></li>
746 <li><a href="#_loop">3.15. Loop</a></li>
747 <li><a href="#_looplog">3.16. LoopLog</a></li>
748 <li><a href="#_microservicepolicy">3.17. MicroServicePolicy</a></li>
749 <li><a href="#_number">3.18. Number</a></li>
750 <li><a href="#_operationalpolicy">3.19. OperationalPolicy</a></li>
751 <li><a href="#_valueitem">3.20. ValueItem</a></li>
759 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
760 <div class="sectionbody">
762 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
763 <div class="paragraph">
764 <p><em>Version</em> : 4.0.3-SNAPSHOT</p>
768 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
769 <div class="paragraph">
770 <p><em>Host</em> : localhost:46235<br>
771 <em>BasePath</em> : /restservices/clds/<br>
772 <em>Schemes</em> : HTTP</p>
778 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
779 <div class="sectionbody">
781 <h3 id="_route23"><a class="anchor" href="#_route23"></a><a class="link" href="#_route23">2.1. PUT /v1/clds/action/{action}/{modelName}?test={test}</a></h3>
783 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.1.1. Parameters</a></h4>
784 <table class="tableblock frame-all grid-all stretch">
786 <col style="width: 22.2222%;">
787 <col style="width: 33.3333%;">
788 <col style="width: 44.4445%;">
792 <th class="tableblock halign-left valign-middle">Type</th>
793 <th class="tableblock halign-left valign-middle">Name</th>
794 <th class="tableblock halign-left valign-middle">Schema</th>
799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
801 <em>required</em></p></td>
802 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
805 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
806 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName}?test={test</strong><br>
807 <em>required</em></p></td>
808 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
811 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
812 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
813 <em>required</em></p></td>
814 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
820 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.2. Responses</a></h4>
821 <table class="tableblock frame-all grid-all stretch">
823 <col style="width: 33.3333%;">
824 <col style="width: 66.6667%;">
828 <th class="tableblock halign-left valign-middle">HTTP Code</th>
829 <th class="tableblock halign-left valign-middle">Schema</th>
834 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
835 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
841 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.1.3. Consumes</a></h4>
845 <p><code>application/json</code></p>
851 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.4. Produces</a></h4>
855 <p><code>application/json</code></p>
862 <h3 id="_route15"><a class="anchor" href="#_route15"></a><a class="link" href="#_route15">2.2. GET /v1/clds/cldsDetails</a></h3>
864 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
865 <table class="tableblock frame-all grid-all stretch">
867 <col style="width: 10%;">
868 <col style="width: 70%;">
869 <col style="width: 20%;">
873 <th class="tableblock halign-left valign-middle">HTTP Code</th>
874 <th class="tableblock halign-left valign-middle">Description</th>
875 <th class="tableblock halign-left valign-middle">Schema</th>
880 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
881 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
882 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmonitoringdetails">CldsMonitoringDetails</a></p></td>
888 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
892 <p><code>application/json</code></p>
899 <h3 id="_route16"><a class="anchor" href="#_route16"></a><a class="link" href="#_route16">2.3. GET /v1/clds/cldsInfo</a></h3>
901 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
902 <table class="tableblock frame-all grid-all stretch">
904 <col style="width: 10%;">
905 <col style="width: 70%;">
906 <col style="width: 20%;">
910 <th class="tableblock halign-left valign-middle">HTTP Code</th>
911 <th class="tableblock halign-left valign-middle">Description</th>
912 <th class="tableblock halign-left valign-middle">Schema</th>
917 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
918 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
919 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
925 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
929 <p><code>application/json</code></p>
936 <h3 id="_route24"><a class="anchor" href="#_route24"></a><a class="link" href="#_route24">2.4. POST /v1/clds/dcae/event?test={test}</a></h3>
938 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.4.1. Parameters</a></h4>
939 <table class="tableblock frame-all grid-all stretch">
941 <col style="width: 22.2222%;">
942 <col style="width: 33.3333%;">
943 <col style="width: 44.4445%;">
947 <th class="tableblock halign-left valign-middle">Type</th>
948 <th class="tableblock halign-left valign-middle">Name</th>
949 <th class="tableblock halign-left valign-middle">Schema</th>
954 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
956 <em>required</em></p></td>
957 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dcaeevent">DcaeEvent</a></p></td>
963 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.2. Responses</a></h4>
964 <table class="tableblock frame-all grid-all stretch">
966 <col style="width: 33.3333%;">
967 <col style="width: 66.6667%;">
971 <th class="tableblock halign-left valign-middle">HTTP Code</th>
972 <th class="tableblock halign-left valign-middle">Schema</th>
977 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
978 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
984 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.4.3. Consumes</a></h4>
988 <p><code>application/json</code></p>
994 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.4. Produces</a></h4>
998 <p><code>application/json</code></p>
1005 <h3 id="_route26"><a class="anchor" href="#_route26"></a><a class="link" href="#_route26">2.5. PUT /v1/clds/deploy/{modelName}</a></h3>
1007 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.5.1. Parameters</a></h4>
1008 <table class="tableblock frame-all grid-all stretch">
1010 <col style="width: 22.2222%;">
1011 <col style="width: 33.3333%;">
1012 <col style="width: 44.4445%;">
1016 <th class="tableblock halign-left valign-middle">Type</th>
1017 <th class="tableblock halign-left valign-middle">Name</th>
1018 <th class="tableblock halign-left valign-middle">Schema</th>
1023 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1024 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1025 <em>required</em></p></td>
1026 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1029 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1031 <em>required</em></p></td>
1032 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1038 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
1039 <table class="tableblock frame-all grid-all stretch">
1041 <col style="width: 33.3333%;">
1042 <col style="width: 66.6667%;">
1046 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1047 <th class="tableblock halign-left valign-middle">Schema</th>
1052 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1053 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1059 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.5.3. Consumes</a></h4>
1063 <p><code>application/json</code></p>
1069 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
1073 <p><code>application/json</code></p>
1080 <h3 id="_route22"><a class="anchor" href="#_route22"></a><a class="link" href="#_route22">2.6. GET /v1/clds/model-names</a></h3>
1082 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
1083 <table class="tableblock frame-all grid-all stretch">
1085 <col style="width: 10%;">
1086 <col style="width: 70%;">
1087 <col style="width: 20%;">
1091 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1092 <th class="tableblock halign-left valign-middle">Description</th>
1093 <th class="tableblock halign-left valign-middle">Schema</th>
1098 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1099 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1100 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_valueitem">ValueItem</a></p></td>
1106 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
1110 <p><code>application/json</code></p>
1117 <h3 id="_route18"><a class="anchor" href="#_route18"></a><a class="link" href="#_route18">2.7. GET /v1/clds/model/bpmn/{modelName}</a></h3>
1119 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.7.1. Parameters</a></h4>
1120 <table class="tableblock frame-all grid-all stretch">
1122 <col style="width: 22.2222%;">
1123 <col style="width: 33.3333%;">
1124 <col style="width: 44.4445%;">
1128 <th class="tableblock halign-left valign-middle">Type</th>
1129 <th class="tableblock halign-left valign-middle">Name</th>
1130 <th class="tableblock halign-left valign-middle">Schema</th>
1135 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1136 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1137 <em>required</em></p></td>
1138 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1144 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
1145 <table class="tableblock frame-all grid-all stretch">
1147 <col style="width: 33.3333%;">
1148 <col style="width: 66.6667%;">
1152 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1153 <th class="tableblock halign-left valign-middle">Schema</th>
1158 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1159 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1165 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1169 <p><code>text/xml</code></p>
1176 <h3 id="_route19"><a class="anchor" href="#_route19"></a><a class="link" href="#_route19">2.8. GET /v1/clds/model/image/{modelName}</a></h3>
1178 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.8.1. Parameters</a></h4>
1179 <table class="tableblock frame-all grid-all stretch">
1181 <col style="width: 22.2222%;">
1182 <col style="width: 33.3333%;">
1183 <col style="width: 44.4445%;">
1187 <th class="tableblock halign-left valign-middle">Type</th>
1188 <th class="tableblock halign-left valign-middle">Name</th>
1189 <th class="tableblock halign-left valign-middle">Schema</th>
1194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1195 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1196 <em>required</em></p></td>
1197 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1203 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1204 <table class="tableblock frame-all grid-all stretch">
1206 <col style="width: 33.3333%;">
1207 <col style="width: 66.6667%;">
1211 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1212 <th class="tableblock halign-left valign-middle">Schema</th>
1217 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1218 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1224 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.3. Produces</a></h4>
1228 <p><code>text/xml</code></p>
1235 <h3 id="_route20"><a class="anchor" href="#_route20"></a><a class="link" href="#_route20">2.9. GET /v1/clds/model/{modelName}</a></h3>
1237 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.9.1. Parameters</a></h4>
1238 <table class="tableblock frame-all grid-all stretch">
1240 <col style="width: 22.2222%;">
1241 <col style="width: 33.3333%;">
1242 <col style="width: 44.4445%;">
1246 <th class="tableblock halign-left valign-middle">Type</th>
1247 <th class="tableblock halign-left valign-middle">Name</th>
1248 <th class="tableblock halign-left valign-middle">Schema</th>
1253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1255 <em>required</em></p></td>
1256 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1262 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1263 <table class="tableblock frame-all grid-all stretch">
1265 <col style="width: 10%;">
1266 <col style="width: 70%;">
1267 <col style="width: 20%;">
1271 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1272 <th class="tableblock halign-left valign-middle">Description</th>
1273 <th class="tableblock halign-left valign-middle">Schema</th>
1278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1279 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1280 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1286 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1290 <p><code>application/json</code></p>
1297 <h3 id="_route21"><a class="anchor" href="#_route21"></a><a class="link" href="#_route21">2.10. PUT /v1/clds/model/{modelName}</a></h3>
1299 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.10.1. Parameters</a></h4>
1300 <table class="tableblock frame-all grid-all stretch">
1302 <col style="width: 22.2222%;">
1303 <col style="width: 33.3333%;">
1304 <col style="width: 44.4445%;">
1308 <th class="tableblock halign-left valign-middle">Type</th>
1309 <th class="tableblock halign-left valign-middle">Name</th>
1310 <th class="tableblock halign-left valign-middle">Schema</th>
1315 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1317 <em>required</em></p></td>
1318 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1321 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1322 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1323 <em>required</em></p></td>
1324 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1330 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1331 <table class="tableblock frame-all grid-all stretch">
1333 <col style="width: 10%;">
1334 <col style="width: 70%;">
1335 <col style="width: 20%;">
1339 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1340 <th class="tableblock halign-left valign-middle">Description</th>
1341 <th class="tableblock halign-left valign-middle">Schema</th>
1346 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1347 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1348 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1354 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.10.3. Consumes</a></h4>
1358 <p><code>application/json</code></p>
1364 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.4. Produces</a></h4>
1368 <p><code>application/json</code></p>
1375 <h3 id="_route25"><a class="anchor" href="#_route25"></a><a class="link" href="#_route25">2.11. GET /v1/clds/properties</a></h3>
1377 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.1. Responses</a></h4>
1378 <table class="tableblock frame-all grid-all stretch">
1380 <col style="width: 33.3333%;">
1381 <col style="width: 66.6667%;">
1385 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1386 <th class="tableblock halign-left valign-middle">Schema</th>
1391 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1392 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1398 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.2. Produces</a></h4>
1402 <p><code>application/json</code></p>
1409 <h3 id="_route27"><a class="anchor" href="#_route27"></a><a class="link" href="#_route27">2.12. PUT /v1/clds/undeploy/{modelName}</a></h3>
1411 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.12.1. Parameters</a></h4>
1412 <table class="tableblock frame-all grid-all stretch">
1414 <col style="width: 22.2222%;">
1415 <col style="width: 33.3333%;">
1416 <col style="width: 44.4445%;">
1420 <th class="tableblock halign-left valign-middle">Type</th>
1421 <th class="tableblock halign-left valign-middle">Name</th>
1422 <th class="tableblock halign-left valign-middle">Schema</th>
1427 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1428 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1429 <em>required</em></p></td>
1430 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1434 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1435 <em>required</em></p></td>
1436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1442 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1443 <table class="tableblock frame-all grid-all stretch">
1445 <col style="width: 33.3333%;">
1446 <col style="width: 66.6667%;">
1450 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1451 <th class="tableblock halign-left valign-middle">Schema</th>
1456 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1457 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1463 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.12.3. Consumes</a></h4>
1467 <p><code>application/json</code></p>
1473 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.4. Produces</a></h4>
1477 <p><code>application/json</code></p>
1484 <h3 id="_route32"><a class="anchor" href="#_route32"></a><a class="link" href="#_route32">2.13. GET /v1/cldsTempate/template-names</a></h3>
1486 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.1. Responses</a></h4>
1487 <table class="tableblock frame-all grid-all stretch">
1489 <col style="width: 10%;">
1490 <col style="width: 70%;">
1491 <col style="width: 20%;">
1495 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1496 <th class="tableblock halign-left valign-middle">Description</th>
1497 <th class="tableblock halign-left valign-middle">Schema</th>
1502 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1503 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_valueitem">ValueItem</a></p></td>
1510 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.13.2. Produces</a></h4>
1514 <p><code>application/json</code></p>
1521 <h3 id="_route28"><a class="anchor" href="#_route28"></a><a class="link" href="#_route28">2.14. GET /v1/cldsTempate/template/bpmn/{templateName}</a></h3>
1523 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.14.1. Parameters</a></h4>
1524 <table class="tableblock frame-all grid-all stretch">
1526 <col style="width: 22.2222%;">
1527 <col style="width: 33.3333%;">
1528 <col style="width: 44.4445%;">
1532 <th class="tableblock halign-left valign-middle">Type</th>
1533 <th class="tableblock halign-left valign-middle">Name</th>
1534 <th class="tableblock halign-left valign-middle">Schema</th>
1539 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1541 <em>required</em></p></td>
1542 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1548 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1549 <table class="tableblock frame-all grid-all stretch">
1551 <col style="width: 33.3333%;">
1552 <col style="width: 66.6667%;">
1556 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1557 <th class="tableblock halign-left valign-middle">Schema</th>
1562 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1563 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1569 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.14.3. Produces</a></h4>
1573 <p><code>text/xml</code></p>
1580 <h3 id="_route29"><a class="anchor" href="#_route29"></a><a class="link" href="#_route29">2.15. GET /v1/cldsTempate/template/image/{templateName}</a></h3>
1582 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.15.1. Parameters</a></h4>
1583 <table class="tableblock frame-all grid-all stretch">
1585 <col style="width: 22.2222%;">
1586 <col style="width: 33.3333%;">
1587 <col style="width: 44.4445%;">
1591 <th class="tableblock halign-left valign-middle">Type</th>
1592 <th class="tableblock halign-left valign-middle">Name</th>
1593 <th class="tableblock halign-left valign-middle">Schema</th>
1598 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1599 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1600 <em>required</em></p></td>
1601 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1607 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.2. Responses</a></h4>
1608 <table class="tableblock frame-all grid-all stretch">
1610 <col style="width: 33.3333%;">
1611 <col style="width: 66.6667%;">
1615 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1616 <th class="tableblock halign-left valign-middle">Schema</th>
1621 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1622 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1628 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.15.3. Produces</a></h4>
1632 <p><code>text/xml</code></p>
1639 <h3 id="_route30"><a class="anchor" href="#_route30"></a><a class="link" href="#_route30">2.16. GET /v1/cldsTempate/template/{templateName}</a></h3>
1641 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.16.1. Parameters</a></h4>
1642 <table class="tableblock frame-all grid-all stretch">
1644 <col style="width: 22.2222%;">
1645 <col style="width: 33.3333%;">
1646 <col style="width: 44.4445%;">
1650 <th class="tableblock halign-left valign-middle">Type</th>
1651 <th class="tableblock halign-left valign-middle">Name</th>
1652 <th class="tableblock halign-left valign-middle">Schema</th>
1657 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1659 <em>required</em></p></td>
1660 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1666 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1667 <table class="tableblock frame-all grid-all stretch">
1669 <col style="width: 10%;">
1670 <col style="width: 70%;">
1671 <col style="width: 20%;">
1675 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1676 <th class="tableblock halign-left valign-middle">Description</th>
1677 <th class="tableblock halign-left valign-middle">Schema</th>
1682 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1683 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1690 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.16.3. Produces</a></h4>
1694 <p><code>application/json</code></p>
1701 <h3 id="_route31"><a class="anchor" href="#_route31"></a><a class="link" href="#_route31">2.17. PUT /v1/cldsTempate/template/{templateName}</a></h3>
1703 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.17.1. Parameters</a></h4>
1704 <table class="tableblock frame-all grid-all stretch">
1706 <col style="width: 22.2222%;">
1707 <col style="width: 33.3333%;">
1708 <col style="width: 44.4445%;">
1712 <th class="tableblock halign-left valign-middle">Type</th>
1713 <th class="tableblock halign-left valign-middle">Name</th>
1714 <th class="tableblock halign-left valign-middle">Schema</th>
1719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1720 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1721 <em>required</em></p></td>
1722 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1725 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1727 <em>required</em></p></td>
1728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1734 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1735 <table class="tableblock frame-all grid-all stretch">
1737 <col style="width: 10%;">
1738 <col style="width: 70%;">
1739 <col style="width: 20%;">
1743 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1744 <th class="tableblock halign-left valign-middle">Description</th>
1745 <th class="tableblock halign-left valign-middle">Schema</th>
1750 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1751 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1752 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1758 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.17.3. Consumes</a></h4>
1762 <p><code>application/json</code></p>
1768 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.17.4. Produces</a></h4>
1772 <p><code>application/json</code></p>
1779 <h3 id="_route40"><a class="anchor" href="#_route40"></a><a class="link" href="#_route40">2.18. GET /v1/dictionary</a></h3>
1781 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.1. Responses</a></h4>
1782 <table class="tableblock frame-all grid-all stretch">
1784 <col style="width: 10%;">
1785 <col style="width: 70%;">
1786 <col style="width: 20%;">
1790 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1791 <th class="tableblock halign-left valign-middle">Description</th>
1792 <th class="tableblock halign-left valign-middle">Schema</th>
1797 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1798 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1805 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.18.2. Produces</a></h4>
1809 <p><code>application/json</code></p>
1816 <h3 id="_route39"><a class="anchor" href="#_route39"></a><a class="link" href="#_route39">2.19. PUT /v1/dictionary/{dictionaryName}</a></h3>
1818 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.19.1. Parameters</a></h4>
1819 <table class="tableblock frame-all grid-all stretch">
1821 <col style="width: 22.2222%;">
1822 <col style="width: 33.3333%;">
1823 <col style="width: 44.4445%;">
1827 <th class="tableblock halign-left valign-middle">Type</th>
1828 <th class="tableblock halign-left valign-middle">Name</th>
1829 <th class="tableblock halign-left valign-middle">Schema</th>
1834 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1836 <em>required</em></p></td>
1837 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1842 <em>required</em></p></td>
1843 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1849 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1850 <table class="tableblock frame-all grid-all stretch">
1852 <col style="width: 10%;">
1853 <col style="width: 70%;">
1854 <col style="width: 20%;">
1858 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1859 <th class="tableblock halign-left valign-middle">Description</th>
1860 <th class="tableblock halign-left valign-middle">Schema</th>
1865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1866 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1867 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1873 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a><a class="link" href="#_consumes_7">2.19.3. Consumes</a></h4>
1877 <p><code>application/json</code></p>
1883 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.19.4. Produces</a></h4>
1887 <p><code>application/json</code></p>
1894 <h3 id="_v1_dictionary_dictionaryname_items_get"><a class="anchor" href="#_v1_dictionary_dictionaryname_items_get"></a><a class="link" href="#_v1_dictionary_dictionaryname_items_get">2.20. GET /v1/dictionary/{dictionaryName}/items</a></h3>
1896 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.20.1. Parameters</a></h4>
1897 <table class="tableblock frame-all grid-all stretch">
1899 <col style="width: 22.2222%;">
1900 <col style="width: 33.3333%;">
1901 <col style="width: 44.4445%;">
1905 <th class="tableblock halign-left valign-middle">Type</th>
1906 <th class="tableblock halign-left valign-middle">Name</th>
1907 <th class="tableblock halign-left valign-middle">Schema</th>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1913 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1914 <em>required</em></p></td>
1915 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1921 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.2. Responses</a></h4>
1922 <table class="tableblock frame-all grid-all stretch">
1924 <col style="width: 10%;">
1925 <col style="width: 70%;">
1926 <col style="width: 20%;">
1930 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1931 <th class="tableblock halign-left valign-middle">Description</th>
1932 <th class="tableblock halign-left valign-middle">Schema</th>
1937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1938 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1945 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.20.3. Produces</a></h4>
1949 <p><code>application/json</code></p>
1956 <h3 id="_v1_dictionary_dictionaryname_items_put"><a class="anchor" href="#_v1_dictionary_dictionaryname_items_put"></a><a class="link" href="#_v1_dictionary_dictionaryname_items_put">2.21. PUT /v1/dictionary/{dictionaryName}/items</a></h3>
1958 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.21.1. Parameters</a></h4>
1959 <table class="tableblock frame-all grid-all stretch">
1961 <col style="width: 22.2222%;">
1962 <col style="width: 33.3333%;">
1963 <col style="width: 44.4445%;">
1967 <th class="tableblock halign-left valign-middle">Type</th>
1968 <th class="tableblock halign-left valign-middle">Name</th>
1969 <th class="tableblock halign-left valign-middle">Schema</th>
1974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1976 <em>required</em></p></td>
1977 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1980 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1981 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1982 <em>required</em></p></td>
1983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionaryitem">CldsDictionaryItem</a></p></td>
1989 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
1990 <table class="tableblock frame-all grid-all stretch">
1992 <col style="width: 10%;">
1993 <col style="width: 70%;">
1994 <col style="width: 20%;">
1998 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1999 <th class="tableblock halign-left valign-middle">Description</th>
2000 <th class="tableblock halign-left valign-middle">Schema</th>
2005 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2006 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2007 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionaryitem">CldsDictionaryItem</a></p></td>
2013 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a><a class="link" href="#_consumes_8">2.21.3. Consumes</a></h4>
2017 <p><code>application/json</code></p>
2023 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.21.4. Produces</a></h4>
2027 <p><code>application/json</code></p>
2034 <h3 id="_route17"><a class="anchor" href="#_route17"></a><a class="link" href="#_route17">2.22. GET /v1/healthcheck</a></h3>
2036 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.1. Responses</a></h4>
2037 <table class="tableblock frame-all grid-all stretch">
2039 <col style="width: 33.3333%;">
2040 <col style="width: 66.6667%;">
2044 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2045 <th class="tableblock halign-left valign-middle">Schema</th>
2050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2051 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2057 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.22.2. Produces</a></h4>
2061 <p><code>application/json</code></p>
2068 <h3 id="_route36"><a class="anchor" href="#_route36"></a><a class="link" href="#_route36">2.23. GET /v1/tosca/models</a></h3>
2070 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.1. Responses</a></h4>
2071 <table class="tableblock frame-all grid-all stretch">
2073 <col style="width: 10%;">
2074 <col style="width: 70%;">
2075 <col style="width: 20%;">
2079 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2080 <th class="tableblock halign-left valign-middle">Description</th>
2081 <th class="tableblock halign-left valign-middle">Schema</th>
2086 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2087 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2088 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2094 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.23.2. Produces</a></h4>
2098 <p><code>application/json</code></p>
2105 <h3 id="_route34"><a class="anchor" href="#_route34"></a><a class="link" href="#_route34">2.24. GET /v1/tosca/models/policyType/{policyType}</a></h3>
2107 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.24.1. Parameters</a></h4>
2108 <table class="tableblock frame-all grid-all stretch">
2110 <col style="width: 22.2222%;">
2111 <col style="width: 33.3333%;">
2112 <col style="width: 44.4445%;">
2116 <th class="tableblock halign-left valign-middle">Type</th>
2117 <th class="tableblock halign-left valign-middle">Name</th>
2118 <th class="tableblock halign-left valign-middle">Schema</th>
2123 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
2125 <em>required</em></p></td>
2126 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2132 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.2. Responses</a></h4>
2133 <table class="tableblock frame-all grid-all stretch">
2135 <col style="width: 10%;">
2136 <col style="width: 70%;">
2137 <col style="width: 20%;">
2141 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2142 <th class="tableblock halign-left valign-middle">Description</th>
2143 <th class="tableblock halign-left valign-middle">Schema</th>
2148 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2149 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2150 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2156 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.24.3. Produces</a></h4>
2160 <p><code>application/json</code></p>
2167 <h3 id="_v1_tosca_models_toscamodelname_get"><a class="anchor" href="#_v1_tosca_models_toscamodelname_get"></a><a class="link" href="#_v1_tosca_models_toscamodelname_get">2.25. GET /v1/tosca/models/{toscaModelName}</a></h3>
2169 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.25.1. Parameters</a></h4>
2170 <table class="tableblock frame-all grid-all stretch">
2172 <col style="width: 22.2222%;">
2173 <col style="width: 33.3333%;">
2174 <col style="width: 44.4445%;">
2178 <th class="tableblock halign-left valign-middle">Type</th>
2179 <th class="tableblock halign-left valign-middle">Name</th>
2180 <th class="tableblock halign-left valign-middle">Schema</th>
2185 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelName</strong><br>
2187 <em>required</em></p></td>
2188 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2194 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.2. Responses</a></h4>
2195 <table class="tableblock frame-all grid-all stretch">
2197 <col style="width: 10%;">
2198 <col style="width: 70%;">
2199 <col style="width: 20%;">
2203 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2204 <th class="tableblock halign-left valign-middle">Description</th>
2205 <th class="tableblock halign-left valign-middle">Schema</th>
2210 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2211 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2218 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.25.3. Produces</a></h4>
2222 <p><code>application/json</code></p>
2229 <h3 id="_route33"><a class="anchor" href="#_route33"></a><a class="link" href="#_route33">2.26. PUT /v1/tosca/models/{toscaModelName}</a></h3>
2231 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.26.1. Parameters</a></h4>
2232 <table class="tableblock frame-all grid-all stretch">
2234 <col style="width: 22.2222%;">
2235 <col style="width: 33.3333%;">
2236 <col style="width: 44.4445%;">
2240 <th class="tableblock halign-left valign-middle">Type</th>
2241 <th class="tableblock halign-left valign-middle">Name</th>
2242 <th class="tableblock halign-left valign-middle">Schema</th>
2247 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelName</strong><br>
2249 <em>required</em></p></td>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2255 <em>required</em></p></td>
2256 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2262 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2263 <table class="tableblock frame-all grid-all stretch">
2265 <col style="width: 33.3333%;">
2266 <col style="width: 66.6667%;">
2270 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2271 <th class="tableblock halign-left valign-middle">Schema</th>
2276 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2277 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2283 <h4 id="_consumes_9"><a class="anchor" href="#_consumes_9"></a><a class="link" href="#_consumes_9">2.26.3. Consumes</a></h4>
2287 <p><code>application/json</code></p>
2293 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.26.4. Produces</a></h4>
2297 <p><code>application/json</code></p>
2304 <h3 id="_route41"><a class="anchor" href="#_route41"></a><a class="link" href="#_route41">2.27. GET /v1/user/getUser</a></h3>
2306 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.1. Responses</a></h4>
2307 <table class="tableblock frame-all grid-all stretch">
2309 <col style="width: 33.3333%;">
2310 <col style="width: 66.6667%;">
2314 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2315 <th class="tableblock halign-left valign-middle">Schema</th>
2320 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2321 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2327 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.27.2. Produces</a></h4>
2331 <p><code>text/plain</code></p>
2338 <h3 id="_route13"><a class="anchor" href="#_route13"></a><a class="link" href="#_route13">2.28. PUT /v2/loop/delete/{loopName}</a></h3>
2340 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.28.1. Parameters</a></h4>
2341 <table class="tableblock frame-all grid-all stretch">
2343 <col style="width: 22.2222%;">
2344 <col style="width: 33.3333%;">
2345 <col style="width: 44.4445%;">
2349 <th class="tableblock halign-left valign-middle">Type</th>
2350 <th class="tableblock halign-left valign-middle">Name</th>
2351 <th class="tableblock halign-left valign-middle">Schema</th>
2356 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2357 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2358 <em>required</em></p></td>
2359 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2365 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.2. Responses</a></h4>
2366 <table class="tableblock frame-all grid-all stretch">
2368 <col style="width: 33.3333%;">
2369 <col style="width: 66.6667%;">
2373 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2374 <th class="tableblock halign-left valign-middle">Schema</th>
2379 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2380 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2387 <h3 id="_route8"><a class="anchor" href="#_route8"></a><a class="link" href="#_route8">2.29. PUT /v2/loop/deployLoop/{loopName}</a></h3>
2389 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a><a class="link" href="#_parameters_20">2.29.1. Parameters</a></h4>
2390 <table class="tableblock frame-all grid-all stretch">
2392 <col style="width: 22.2222%;">
2393 <col style="width: 33.3333%;">
2394 <col style="width: 44.4445%;">
2398 <th class="tableblock halign-left valign-middle">Type</th>
2399 <th class="tableblock halign-left valign-middle">Name</th>
2400 <th class="tableblock halign-left valign-middle">Schema</th>
2405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2406 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2407 <em>required</em></p></td>
2408 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2414 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.2. Responses</a></h4>
2415 <table class="tableblock frame-all grid-all stretch">
2417 <col style="width: 10%;">
2418 <col style="width: 70%;">
2419 <col style="width: 20%;">
2423 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2424 <th class="tableblock halign-left valign-middle">Description</th>
2425 <th class="tableblock halign-left valign-middle">Schema</th>
2430 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2431 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2432 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2438 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.29.3. Produces</a></h4>
2442 <p><code>application/json</code></p>
2449 <h3 id="_route2"><a class="anchor" href="#_route2"></a><a class="link" href="#_route2">2.30. GET /v2/loop/getAllNames</a></h3>
2451 <h4 id="_responses_30"><a class="anchor" href="#_responses_30"></a><a class="link" href="#_responses_30">2.30.1. Responses</a></h4>
2452 <table class="tableblock frame-all grid-all stretch">
2454 <col style="width: 10%;">
2455 <col style="width: 70%;">
2456 <col style="width: 20%;">
2460 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2461 <th class="tableblock halign-left valign-middle">Description</th>
2462 <th class="tableblock halign-left valign-middle">Schema</th>
2467 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2468 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2469 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
2475 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.30.2. Produces</a></h4>
2479 <p><code>application/json</code></p>
2486 <h3 id="_route14"><a class="anchor" href="#_route14"></a><a class="link" href="#_route14">2.31. GET /v2/loop/getstatus/{loopName}</a></h3>
2488 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a><a class="link" href="#_parameters_21">2.31.1. Parameters</a></h4>
2489 <table class="tableblock frame-all grid-all stretch">
2491 <col style="width: 22.2222%;">
2492 <col style="width: 33.3333%;">
2493 <col style="width: 44.4445%;">
2497 <th class="tableblock halign-left valign-middle">Type</th>
2498 <th class="tableblock halign-left valign-middle">Name</th>
2499 <th class="tableblock halign-left valign-middle">Schema</th>
2504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2505 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2506 <em>required</em></p></td>
2507 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2513 <h4 id="_responses_31"><a class="anchor" href="#_responses_31"></a><a class="link" href="#_responses_31">2.31.2. Responses</a></h4>
2514 <table class="tableblock frame-all grid-all stretch">
2516 <col style="width: 10%;">
2517 <col style="width: 70%;">
2518 <col style="width: 20%;">
2522 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2523 <th class="tableblock halign-left valign-middle">Description</th>
2524 <th class="tableblock halign-left valign-middle">Schema</th>
2529 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2530 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2531 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2537 <h4 id="_produces_30"><a class="anchor" href="#_produces_30"></a><a class="link" href="#_produces_30">2.31.3. Produces</a></h4>
2541 <p><code>application/json</code></p>
2548 <h3 id="_route11"><a class="anchor" href="#_route11"></a><a class="link" href="#_route11">2.32. PUT /v2/loop/restart/{loopName}</a></h3>
2550 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a><a class="link" href="#_parameters_22">2.32.1. Parameters</a></h4>
2551 <table class="tableblock frame-all grid-all stretch">
2553 <col style="width: 22.2222%;">
2554 <col style="width: 33.3333%;">
2555 <col style="width: 44.4445%;">
2559 <th class="tableblock halign-left valign-middle">Type</th>
2560 <th class="tableblock halign-left valign-middle">Name</th>
2561 <th class="tableblock halign-left valign-middle">Schema</th>
2566 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2567 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2568 <em>required</em></p></td>
2569 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2575 <h4 id="_responses_32"><a class="anchor" href="#_responses_32"></a><a class="link" href="#_responses_32">2.32.2. Responses</a></h4>
2576 <table class="tableblock frame-all grid-all stretch">
2578 <col style="width: 10%;">
2579 <col style="width: 70%;">
2580 <col style="width: 20%;">
2584 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2585 <th class="tableblock halign-left valign-middle">Description</th>
2586 <th class="tableblock halign-left valign-middle">Schema</th>
2591 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2592 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2593 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2599 <h4 id="_produces_31"><a class="anchor" href="#_produces_31"></a><a class="link" href="#_produces_31">2.32.3. Produces</a></h4>
2603 <p><code>application/json</code></p>
2610 <h3 id="_route10"><a class="anchor" href="#_route10"></a><a class="link" href="#_route10">2.33. PUT /v2/loop/stop/{loopName}</a></h3>
2612 <h4 id="_parameters_23"><a class="anchor" href="#_parameters_23"></a><a class="link" href="#_parameters_23">2.33.1. Parameters</a></h4>
2613 <table class="tableblock frame-all grid-all stretch">
2615 <col style="width: 22.2222%;">
2616 <col style="width: 33.3333%;">
2617 <col style="width: 44.4445%;">
2621 <th class="tableblock halign-left valign-middle">Type</th>
2622 <th class="tableblock halign-left valign-middle">Name</th>
2623 <th class="tableblock halign-left valign-middle">Schema</th>
2628 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2629 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2630 <em>required</em></p></td>
2631 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2637 <h4 id="_responses_33"><a class="anchor" href="#_responses_33"></a><a class="link" href="#_responses_33">2.33.2. Responses</a></h4>
2638 <table class="tableblock frame-all grid-all stretch">
2640 <col style="width: 10%;">
2641 <col style="width: 70%;">
2642 <col style="width: 20%;">
2646 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2647 <th class="tableblock halign-left valign-middle">Description</th>
2648 <th class="tableblock halign-left valign-middle">Schema</th>
2653 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2654 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2661 <h4 id="_produces_32"><a class="anchor" href="#_produces_32"></a><a class="link" href="#_produces_32">2.33.3. Produces</a></h4>
2665 <p><code>application/json</code></p>
2672 <h3 id="_route12"><a class="anchor" href="#_route12"></a><a class="link" href="#_route12">2.34. PUT /v2/loop/submit/{loopName}</a></h3>
2674 <h4 id="_parameters_24"><a class="anchor" href="#_parameters_24"></a><a class="link" href="#_parameters_24">2.34.1. Parameters</a></h4>
2675 <table class="tableblock frame-all grid-all stretch">
2677 <col style="width: 22.2222%;">
2678 <col style="width: 33.3333%;">
2679 <col style="width: 44.4445%;">
2683 <th class="tableblock halign-left valign-middle">Type</th>
2684 <th class="tableblock halign-left valign-middle">Name</th>
2685 <th class="tableblock halign-left valign-middle">Schema</th>
2690 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2691 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2692 <em>required</em></p></td>
2693 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2699 <h4 id="_responses_34"><a class="anchor" href="#_responses_34"></a><a class="link" href="#_responses_34">2.34.2. Responses</a></h4>
2700 <table class="tableblock frame-all grid-all stretch">
2702 <col style="width: 10%;">
2703 <col style="width: 70%;">
2704 <col style="width: 20%;">
2708 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2709 <th class="tableblock halign-left valign-middle">Description</th>
2710 <th class="tableblock halign-left valign-middle">Schema</th>
2715 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2716 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2717 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2723 <h4 id="_produces_33"><a class="anchor" href="#_produces_33"></a><a class="link" href="#_produces_33">2.34.3. Produces</a></h4>
2727 <p><code>application/json</code></p>
2734 <h3 id="_route4"><a class="anchor" href="#_route4"></a><a class="link" href="#_route4">2.35. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
2736 <h4 id="_parameters_25"><a class="anchor" href="#_parameters_25"></a><a class="link" href="#_parameters_25">2.35.1. Parameters</a></h4>
2737 <table class="tableblock frame-all grid-all stretch">
2739 <col style="width: 22.2222%;">
2740 <col style="width: 33.3333%;">
2741 <col style="width: 44.4445%;">
2745 <th class="tableblock halign-left valign-middle">Type</th>
2746 <th class="tableblock halign-left valign-middle">Name</th>
2747 <th class="tableblock halign-left valign-middle">Schema</th>
2752 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2753 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2754 <em>required</em></p></td>
2755 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2761 <h4 id="_responses_35"><a class="anchor" href="#_responses_35"></a><a class="link" href="#_responses_35">2.35.2. Responses</a></h4>
2762 <table class="tableblock frame-all grid-all stretch">
2764 <col style="width: 10%;">
2765 <col style="width: 70%;">
2766 <col style="width: 20%;">
2770 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2771 <th class="tableblock halign-left valign-middle">Description</th>
2772 <th class="tableblock halign-left valign-middle">Schema</th>
2777 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2778 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2779 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2785 <h4 id="_produces_34"><a class="anchor" href="#_produces_34"></a><a class="link" href="#_produces_34">2.35.3. Produces</a></h4>
2789 <p><code>application/xml</code></p>
2796 <h3 id="_route9"><a class="anchor" href="#_route9"></a><a class="link" href="#_route9">2.36. PUT /v2/loop/undeployLoop/{loopName}</a></h3>
2798 <h4 id="_parameters_26"><a class="anchor" href="#_parameters_26"></a><a class="link" href="#_parameters_26">2.36.1. Parameters</a></h4>
2799 <table class="tableblock frame-all grid-all stretch">
2801 <col style="width: 22.2222%;">
2802 <col style="width: 33.3333%;">
2803 <col style="width: 44.4445%;">
2807 <th class="tableblock halign-left valign-middle">Type</th>
2808 <th class="tableblock halign-left valign-middle">Name</th>
2809 <th class="tableblock halign-left valign-middle">Schema</th>
2814 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2815 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2816 <em>required</em></p></td>
2817 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2823 <h4 id="_responses_36"><a class="anchor" href="#_responses_36"></a><a class="link" href="#_responses_36">2.36.2. Responses</a></h4>
2824 <table class="tableblock frame-all grid-all stretch">
2826 <col style="width: 10%;">
2827 <col style="width: 70%;">
2828 <col style="width: 20%;">
2832 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2833 <th class="tableblock halign-left valign-middle">Description</th>
2834 <th class="tableblock halign-left valign-middle">Schema</th>
2839 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2840 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2847 <h4 id="_produces_35"><a class="anchor" href="#_produces_35"></a><a class="link" href="#_produces_35">2.36.3. Produces</a></h4>
2851 <p><code>application/json</code></p>
2858 <h3 id="_route5"><a class="anchor" href="#_route5"></a><a class="link" href="#_route5">2.37. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
2860 <h4 id="_parameters_27"><a class="anchor" href="#_parameters_27"></a><a class="link" href="#_parameters_27">2.37.1. Parameters</a></h4>
2861 <table class="tableblock frame-all grid-all stretch">
2863 <col style="width: 22.2222%;">
2864 <col style="width: 33.3333%;">
2865 <col style="width: 44.4445%;">
2869 <th class="tableblock halign-left valign-middle">Type</th>
2870 <th class="tableblock halign-left valign-middle">Name</th>
2871 <th class="tableblock halign-left valign-middle">Schema</th>
2876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2877 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2878 <em>required</em></p></td>
2879 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2882 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2883 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2884 <em>required</em></p></td>
2885 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2891 <h4 id="_responses_37"><a class="anchor" href="#_responses_37"></a><a class="link" href="#_responses_37">2.37.2. Responses</a></h4>
2892 <table class="tableblock frame-all grid-all stretch">
2894 <col style="width: 10%;">
2895 <col style="width: 70%;">
2896 <col style="width: 20%;">
2900 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2901 <th class="tableblock halign-left valign-middle">Description</th>
2902 <th class="tableblock halign-left valign-middle">Schema</th>
2907 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2908 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2909 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2915 <h4 id="_consumes_10"><a class="anchor" href="#_consumes_10"></a><a class="link" href="#_consumes_10">2.37.3. Consumes</a></h4>
2919 <p><code>application/json</code></p>
2925 <h4 id="_produces_36"><a class="anchor" href="#_produces_36"></a><a class="link" href="#_produces_36">2.37.4. Produces</a></h4>
2929 <p><code>application/json</code></p>
2936 <h3 id="_route7"><a class="anchor" href="#_route7"></a><a class="link" href="#_route7">2.38. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
2938 <h4 id="_parameters_28"><a class="anchor" href="#_parameters_28"></a><a class="link" href="#_parameters_28">2.38.1. Parameters</a></h4>
2939 <table class="tableblock frame-all grid-all stretch">
2941 <col style="width: 22.2222%;">
2942 <col style="width: 33.3333%;">
2943 <col style="width: 44.4445%;">
2947 <th class="tableblock halign-left valign-middle">Type</th>
2948 <th class="tableblock halign-left valign-middle">Name</th>
2949 <th class="tableblock halign-left valign-middle">Schema</th>
2954 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2956 <em>required</em></p></td>
2957 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2960 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2961 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2962 <em>required</em></p></td>
2963 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2969 <h4 id="_responses_38"><a class="anchor" href="#_responses_38"></a><a class="link" href="#_responses_38">2.38.2. Responses</a></h4>
2970 <table class="tableblock frame-all grid-all stretch">
2972 <col style="width: 10%;">
2973 <col style="width: 70%;">
2974 <col style="width: 20%;">
2978 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2979 <th class="tableblock halign-left valign-middle">Description</th>
2980 <th class="tableblock halign-left valign-middle">Schema</th>
2985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2986 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2993 <h4 id="_consumes_11"><a class="anchor" href="#_consumes_11"></a><a class="link" href="#_consumes_11">2.38.3. Consumes</a></h4>
2997 <p><code>application/json</code></p>
3003 <h4 id="_produces_37"><a class="anchor" href="#_produces_37"></a><a class="link" href="#_produces_37">2.38.4. Produces</a></h4>
3007 <p><code>application/json</code></p>
3014 <h3 id="_route6"><a class="anchor" href="#_route6"></a><a class="link" href="#_route6">2.39. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
3016 <h4 id="_parameters_29"><a class="anchor" href="#_parameters_29"></a><a class="link" href="#_parameters_29">2.39.1. Parameters</a></h4>
3017 <table class="tableblock frame-all grid-all stretch">
3019 <col style="width: 22.2222%;">
3020 <col style="width: 33.3333%;">
3021 <col style="width: 44.4445%;">
3025 <th class="tableblock halign-left valign-middle">Type</th>
3026 <th class="tableblock halign-left valign-middle">Name</th>
3027 <th class="tableblock halign-left valign-middle">Schema</th>
3032 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
3033 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
3034 <em>required</em></p></td>
3035 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3038 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3039 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3040 <em>required</em></p></td>
3041 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3047 <h4 id="_responses_39"><a class="anchor" href="#_responses_39"></a><a class="link" href="#_responses_39">2.39.2. Responses</a></h4>
3048 <table class="tableblock frame-all grid-all stretch">
3050 <col style="width: 10%;">
3051 <col style="width: 70%;">
3052 <col style="width: 20%;">
3056 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3057 <th class="tableblock halign-left valign-middle">Description</th>
3058 <th class="tableblock halign-left valign-middle">Schema</th>
3063 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3064 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3065 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3071 <h4 id="_consumes_12"><a class="anchor" href="#_consumes_12"></a><a class="link" href="#_consumes_12">2.39.3. Consumes</a></h4>
3075 <p><code>application/json</code></p>
3081 <h4 id="_produces_38"><a class="anchor" href="#_produces_38"></a><a class="link" href="#_produces_38">2.39.4. Produces</a></h4>
3085 <p><code>application/json</code></p>
3092 <h3 id="_route3"><a class="anchor" href="#_route3"></a><a class="link" href="#_route3">2.40. GET /v2/loop/{loopName}</a></h3>
3094 <h4 id="_parameters_30"><a class="anchor" href="#_parameters_30"></a><a class="link" href="#_parameters_30">2.40.1. Parameters</a></h4>
3095 <table class="tableblock frame-all grid-all stretch">
3097 <col style="width: 22.2222%;">
3098 <col style="width: 33.3333%;">
3099 <col style="width: 44.4445%;">
3103 <th class="tableblock halign-left valign-middle">Type</th>
3104 <th class="tableblock halign-left valign-middle">Name</th>
3105 <th class="tableblock halign-left valign-middle">Schema</th>
3110 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
3111 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
3112 <em>required</em></p></td>
3113 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3119 <h4 id="_responses_40"><a class="anchor" href="#_responses_40"></a><a class="link" href="#_responses_40">2.40.2. Responses</a></h4>
3120 <table class="tableblock frame-all grid-all stretch">
3122 <col style="width: 10%;">
3123 <col style="width: 70%;">
3124 <col style="width: 20%;">
3128 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3129 <th class="tableblock halign-left valign-middle">Description</th>
3130 <th class="tableblock halign-left valign-middle">Schema</th>
3135 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3136 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3137 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3143 <h4 id="_produces_39"><a class="anchor" href="#_produces_39"></a><a class="link" href="#_produces_39">2.40.3. Produces</a></h4>
3147 <p><code>application/json</code></p>
3156 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
3157 <div class="sectionbody">
3159 <h3 id="_cldsdictionary"><a class="anchor" href="#_cldsdictionary"></a><a class="link" href="#_cldsdictionary">3.1. CldsDictionary</a></h3>
3160 <table class="tableblock frame-all grid-all stretch">
3162 <col style="width: 42.8571%;">
3163 <col style="width: 57.1429%;">
3167 <th class="tableblock halign-left valign-middle">Name</th>
3168 <th class="tableblock halign-left valign-middle">Schema</th>
3173 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsDictionaryItems</strong><br>
3174 <em>optional</em></p></td>
3175 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsdictionaryitem">CldsDictionaryItem</a> > array</p></td>
3178 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3179 <em>optional</em></p></td>
3180 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryId</strong><br>
3184 <em>optional</em></p></td>
3185 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3188 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
3189 <em>optional</em></p></td>
3190 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastUpdatedDate</strong><br>
3194 <em>optional</em></p></td>
3195 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3199 <em>optional</em></p></td>
3200 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3206 <h3 id="_cldsdictionaryitem"><a class="anchor" href="#_cldsdictionaryitem"></a><a class="link" href="#_cldsdictionaryitem">3.2. CldsDictionaryItem</a></h3>
3207 <table class="tableblock frame-all grid-all stretch">
3209 <col style="width: 42.8571%;">
3210 <col style="width: 57.1429%;">
3214 <th class="tableblock halign-left valign-middle">Name</th>
3215 <th class="tableblock halign-left valign-middle">Schema</th>
3220 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3221 <em>optional</em></p></td>
3222 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3225 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementDesc</strong><br>
3226 <em>optional</em></p></td>
3227 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3230 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementId</strong><br>
3231 <em>optional</em></p></td>
3232 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3235 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementName</strong><br>
3236 <em>optional</em></p></td>
3237 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3240 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementShortName</strong><br>
3241 <em>optional</em></p></td>
3242 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementType</strong><br>
3246 <em>optional</em></p></td>
3247 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3250 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryId</strong><br>
3251 <em>optional</em></p></td>
3252 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastUpdatedDate</strong><br>
3256 <em>optional</em></p></td>
3257 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3260 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3261 <em>optional</em></p></td>
3262 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3268 <h3 id="_cldsevent"><a class="anchor" href="#_cldsevent"></a><a class="link" href="#_cldsevent">3.3. CldsEvent</a></h3>
3269 <table class="tableblock frame-all grid-all stretch">
3271 <col style="width: 42.8571%;">
3272 <col style="width: 57.1429%;">
3276 <th class="tableblock halign-left valign-middle">Name</th>
3277 <th class="tableblock halign-left valign-middle">Schema</th>
3282 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionCd</strong><br>
3283 <em>optional</em></p></td>
3284 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3287 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionStateCd</strong><br>
3288 <em>optional</em></p></td>
3289 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3292 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3293 <em>optional</em></p></td>
3294 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3297 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>processInstanceId</strong><br>
3298 <em>optional</em></p></td>
3299 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3302 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
3303 <em>optional</em></p></td>
3304 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3310 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a><a class="link" href="#_cldsinfo">3.4. CldsInfo</a></h3>
3311 <table class="tableblock frame-all grid-all stretch">
3313 <col style="width: 42.8571%;">
3314 <col style="width: 57.1429%;">
3318 <th class="tableblock halign-left valign-middle">Name</th>
3319 <th class="tableblock halign-left valign-middle">Schema</th>
3324 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
3325 <em>optional</em></p></td>
3326 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3329 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
3330 <em>optional</em></p></td>
3331 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3334 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
3335 <em>optional</em></p></td>
3336 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3339 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTosca</strong><br>
3340 <em>optional</em></p></td>
3341 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3344 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
3345 <em>optional</em></p></td>
3346 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3349 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
3350 <em>optional</em></p></td>
3351 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3354 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTosca</strong><br>
3355 <em>optional</em></p></td>
3356 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3359 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
3360 <em>optional</em></p></td>
3361 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3367 <h3 id="_cldsmodel"><a class="anchor" href="#_cldsmodel"></a><a class="link" href="#_cldsmodel">3.5. CldsModel</a></h3>
3368 <table class="tableblock frame-all grid-all stretch">
3370 <col style="width: 42.8571%;">
3371 <col style="width: 57.1429%;">
3375 <th class="tableblock halign-left valign-middle">Name</th>
3376 <th class="tableblock halign-left valign-middle">Schema</th>
3381 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprintText</strong><br>
3382 <em>optional</em></p></td>
3383 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3386 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
3387 <em>optional</em></p></td>
3388 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3391 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsModelInstanceList</strong><br>
3392 <em>optional</em></p></td>
3393 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
3396 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
3397 <em>optional</em></p></td>
3398 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3401 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
3402 <em>optional</em></p></td>
3403 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3406 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
3407 <em>optional</em></p></td>
3408 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3411 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
3412 <em>optional</em></p></td>
3413 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3416 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentStatusUrl</strong><br>
3417 <em>optional</em></p></td>
3418 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3421 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>docText</strong><br>
3422 <em>optional</em></p></td>
3423 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3426 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>errorMessageForUi</strong><br>
3427 <em>optional</em></p></td>
3428 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3431 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
3432 <em>optional</em></p></td>
3433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsevent">CldsEvent</a></p></td>
3436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3437 <em>optional</em></p></td>
3438 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3441 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
3442 <em>optional</em></p></td>
3443 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3446 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3447 <em>optional</em></p></td>
3448 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3451 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permittedActionCd</strong><br>
3452 <em>optional</em></p></td>
3453 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
3456 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
3457 <em>optional</em></p></td>
3458 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3461 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
3462 <em>optional</em></p></td>
3463 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3466 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateId</strong><br>
3467 <em>optional</em></p></td>
3468 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3471 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
3472 <em>optional</em></p></td>
3473 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3476 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeId</strong><br>
3477 <em>optional</em></p></td>
3478 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3481 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeName</strong><br>
3482 <em>optional</em></p></td>
3483 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3489 <h3 id="_cldsmodelinstance"><a class="anchor" href="#_cldsmodelinstance"></a><a class="link" href="#_cldsmodelinstance">3.6. CldsModelInstance</a></h3>
3490 <table class="tableblock frame-all grid-all stretch">
3492 <col style="width: 42.8571%;">
3493 <col style="width: 57.1429%;">
3497 <th class="tableblock halign-left valign-middle">Name</th>
3498 <th class="tableblock halign-left valign-middle">Schema</th>
3503 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>location</strong><br>
3504 <em>optional</em></p></td>
3505 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3508 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelInstanceId</strong><br>
3509 <em>optional</em></p></td>
3510 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3513 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>vmName</strong><br>
3514 <em>optional</em></p></td>
3515 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3521 <h3 id="_cldsmonitoringdetails"><a class="anchor" href="#_cldsmonitoringdetails"></a><a class="link" href="#_cldsmonitoringdetails">3.7. CldsMonitoringDetails</a></h3>
3522 <table class="tableblock frame-all grid-all stretch">
3524 <col style="width: 42.8571%;">
3525 <col style="width: 57.1429%;">
3529 <th class="tableblock halign-left valign-middle">Name</th>
3530 <th class="tableblock halign-left valign-middle">Schema</th>
3535 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
3536 <em>optional</em></p></td>
3537 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>closeloopName</strong><br>
3541 <em>optional</em></p></td>
3542 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3545 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
3546 <em>optional</em></p></td>
3547 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3550 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelId</strong><br>
3551 <em>optional</em></p></td>
3552 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3555 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
3556 <em>optional</em></p></td>
3557 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3560 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceTypeId</strong><br>
3561 <em>optional</em></p></td>
3562 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3565 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
3566 <em>optional</em></p></td>
3567 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3570 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>timestamp</strong><br>
3571 <em>optional</em></p></td>
3572 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3575 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
3576 <em>optional</em></p></td>
3577 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3583 <h3 id="_cldstemplate"><a class="anchor" href="#_cldstemplate"></a><a class="link" href="#_cldstemplate">3.8. CldsTemplate</a></h3>
3584 <table class="tableblock frame-all grid-all stretch">
3586 <col style="width: 42.8571%;">
3587 <col style="width: 57.1429%;">
3591 <th class="tableblock halign-left valign-middle">Name</th>
3592 <th class="tableblock halign-left valign-middle">Schema</th>
3597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnId</strong><br>
3598 <em>optional</em></p></td>
3599 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
3603 <em>optional</em></p></td>
3604 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3607 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnUserid</strong><br>
3608 <em>optional</em></p></td>
3609 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3612 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
3613 <em>optional</em></p></td>
3614 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3617 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
3618 <em>optional</em></p></td>
3619 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3623 <em>optional</em></p></td>
3624 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3627 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageId</strong><br>
3628 <em>optional</em></p></td>
3629 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3632 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
3633 <em>optional</em></p></td>
3634 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3637 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageUserid</strong><br>
3638 <em>optional</em></p></td>
3639 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3642 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3643 <em>optional</em></p></td>
3644 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3647 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propId</strong><br>
3648 <em>optional</em></p></td>
3649 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
3653 <em>optional</em></p></td>
3654 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3657 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propUserid</strong><br>
3658 <em>optional</em></p></td>
3659 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3662 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userAuthorizedToUpdate</strong><br>
3663 <em>optional</em></p></td>
3664 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3670 <h3 id="_cldstoscamodel"><a class="anchor" href="#_cldstoscamodel"></a><a class="link" href="#_cldstoscamodel">3.9. CldsToscaModel</a></h3>
3671 <table class="tableblock frame-all grid-all stretch">
3673 <col style="width: 42.8571%;">
3674 <col style="width: 57.1429%;">
3678 <th class="tableblock halign-left valign-middle">Name</th>
3679 <th class="tableblock halign-left valign-middle">Schema</th>
3684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3685 <em>optional</em></p></td>
3686 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3690 <em>optional</em></p></td>
3691 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3694 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastUpdatedDate</strong><br>
3695 <em>optional</em></p></td>
3696 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3699 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
3700 <em>optional</em></p></td>
3701 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3704 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>revisionId</strong><br>
3705 <em>optional</em></p></td>
3706 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3709 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelJson</strong><br>
3710 <em>optional</em></p></td>
3711 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3714 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelName</strong><br>
3715 <em>optional</em></p></td>
3716 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelYaml</strong><br>
3720 <em>optional</em></p></td>
3721 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userId</strong><br>
3725 <em>optional</em></p></td>
3726 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
3730 <em>optional</em></p></td>
3731 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3737 <h3 id="_dcaeevent"><a class="anchor" href="#_dcaeevent"></a><a class="link" href="#_dcaeevent">3.10. DcaeEvent</a></h3>
3738 <table class="tableblock frame-all grid-all stretch">
3740 <col style="width: 42.8571%;">
3741 <col style="width: 57.1429%;">
3745 <th class="tableblock halign-left valign-middle">Name</th>
3746 <th class="tableblock halign-left valign-middle">Schema</th>
3751 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactName</strong><br>
3752 <em>optional</em></p></td>
3753 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsActionCd</strong><br>
3757 <em>optional</em></p></td>
3758 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
3762 <em>optional</em></p></td>
3763 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3766 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
3767 <em>optional</em></p></td>
3768 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3771 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>instances</strong><br>
3772 <em>optional</em></p></td>
3773 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
3776 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceUUID</strong><br>
3777 <em>optional</em></p></td>
3778 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3781 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUUID</strong><br>
3782 <em>optional</em></p></td>
3783 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3789 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.11. JsonArray</a></h3>
3790 <table class="tableblock frame-all grid-all stretch">
3792 <col style="width: 42.8571%;">
3793 <col style="width: 57.1429%;">
3797 <th class="tableblock halign-left valign-middle">Name</th>
3798 <th class="tableblock halign-left valign-middle">Schema</th>
3803 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3804 <em>optional</em></p></td>
3805 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3809 <em>optional</em></p></td>
3810 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3813 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3814 <em>optional</em></p></td>
3815 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3818 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3819 <em>optional</em></p></td>
3820 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3823 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3824 <em>optional</em></p></td>
3825 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3828 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3829 <em>optional</em></p></td>
3830 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3833 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3834 <em>optional</em></p></td>
3835 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3838 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3839 <em>optional</em></p></td>
3840 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3843 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3844 <em>optional</em></p></td>
3845 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3848 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3849 <em>optional</em></p></td>
3850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3853 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3854 <em>optional</em></p></td>
3855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3859 <em>optional</em></p></td>
3860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3863 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3864 <em>optional</em></p></td>
3865 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3869 <em>optional</em></p></td>
3870 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3873 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3874 <em>optional</em></p></td>
3875 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3879 <em>optional</em></p></td>
3880 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3883 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3884 <em>optional</em></p></td>
3885 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3888 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3889 <em>optional</em></p></td>
3890 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3893 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3894 <em>optional</em></p></td>
3895 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3899 <em>optional</em></p></td>
3900 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3906 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.12. JsonNull</a></h3>
3907 <table class="tableblock frame-all grid-all stretch">
3909 <col style="width: 42.8571%;">
3910 <col style="width: 57.1429%;">
3914 <th class="tableblock halign-left valign-middle">Name</th>
3915 <th class="tableblock halign-left valign-middle">Schema</th>
3920 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3921 <em>optional</em></p></td>
3922 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3925 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3926 <em>optional</em></p></td>
3927 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3931 <em>optional</em></p></td>
3932 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3935 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3936 <em>optional</em></p></td>
3937 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3940 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3941 <em>optional</em></p></td>
3942 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3946 <em>optional</em></p></td>
3947 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3950 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3951 <em>optional</em></p></td>
3952 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3956 <em>optional</em></p></td>
3957 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3960 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3961 <em>optional</em></p></td>
3962 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3965 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3966 <em>optional</em></p></td>
3967 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3970 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3971 <em>optional</em></p></td>
3972 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3976 <em>optional</em></p></td>
3977 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3980 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3981 <em>optional</em></p></td>
3982 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3986 <em>optional</em></p></td>
3987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3990 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3991 <em>optional</em></p></td>
3992 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3995 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3996 <em>optional</em></p></td>
3997 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4000 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4001 <em>optional</em></p></td>
4002 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4005 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4006 <em>optional</em></p></td>
4007 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4011 <em>optional</em></p></td>
4012 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4015 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4016 <em>optional</em></p></td>
4017 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4023 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.13. JsonObject</a></h3>
4024 <table class="tableblock frame-all grid-all stretch">
4026 <col style="width: 42.8571%;">
4027 <col style="width: 57.1429%;">
4031 <th class="tableblock halign-left valign-middle">Name</th>
4032 <th class="tableblock halign-left valign-middle">Schema</th>
4037 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4038 <em>optional</em></p></td>
4039 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4042 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4043 <em>optional</em></p></td>
4044 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4047 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4048 <em>optional</em></p></td>
4049 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4052 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4053 <em>optional</em></p></td>
4054 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4057 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4058 <em>optional</em></p></td>
4059 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4062 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4063 <em>optional</em></p></td>
4064 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4067 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4068 <em>optional</em></p></td>
4069 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4072 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4073 <em>optional</em></p></td>
4074 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4077 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4078 <em>optional</em></p></td>
4079 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4082 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4083 <em>optional</em></p></td>
4084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4087 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4088 <em>optional</em></p></td>
4089 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4092 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4093 <em>optional</em></p></td>
4094 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4097 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4098 <em>optional</em></p></td>
4099 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4102 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4103 <em>optional</em></p></td>
4104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4107 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4108 <em>optional</em></p></td>
4109 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4112 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4113 <em>optional</em></p></td>
4114 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4117 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4118 <em>optional</em></p></td>
4119 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4122 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4123 <em>optional</em></p></td>
4124 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4127 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4128 <em>optional</em></p></td>
4129 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4132 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4133 <em>optional</em></p></td>
4134 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4140 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.14. JsonPrimitive</a></h3>
4141 <table class="tableblock frame-all grid-all stretch">
4143 <col style="width: 42.8571%;">
4144 <col style="width: 57.1429%;">
4148 <th class="tableblock halign-left valign-middle">Name</th>
4149 <th class="tableblock halign-left valign-middle">Schema</th>
4154 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4155 <em>optional</em></p></td>
4156 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4159 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4160 <em>optional</em></p></td>
4161 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4164 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4165 <em>optional</em></p></td>
4166 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4169 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4170 <em>optional</em></p></td>
4171 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4174 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4175 <em>optional</em></p></td>
4176 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4179 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4180 <em>optional</em></p></td>
4181 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4184 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4185 <em>optional</em></p></td>
4186 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4189 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4190 <em>optional</em></p></td>
4191 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4195 <em>optional</em></p></td>
4196 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4199 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4200 <em>optional</em></p></td>
4201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4204 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4205 <em>optional</em></p></td>
4206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4210 <em>optional</em></p></td>
4211 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4214 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4215 <em>optional</em></p></td>
4216 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4219 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4220 <em>optional</em></p></td>
4221 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4224 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4225 <em>optional</em></p></td>
4226 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4229 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4230 <em>optional</em></p></td>
4231 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4234 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
4235 <em>optional</em></p></td>
4236 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4239 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4240 <em>optional</em></p></td>
4241 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4244 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4245 <em>optional</em></p></td>
4246 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4249 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4250 <em>optional</em></p></td>
4251 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4255 <em>optional</em></p></td>
4256 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4259 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
4260 <em>optional</em></p></td>
4261 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4264 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
4265 <em>optional</em></p></td>
4266 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4272 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.15. Loop</a></h3>
4273 <table class="tableblock frame-all grid-all stretch">
4275 <col style="width: 42.8571%;">
4276 <col style="width: 57.1429%;">
4280 <th class="tableblock halign-left valign-middle">Name</th>
4281 <th class="tableblock halign-left valign-middle">Schema</th>
4286 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
4287 <em>optional</em></p></td>
4288 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4291 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
4292 <em>optional</em></p></td>
4293 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4296 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
4297 <em>optional</em></p></td>
4298 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4301 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
4302 <em>optional</em></p></td>
4303 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
4307 <em>optional</em></p></td>
4308 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4311 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
4312 <em>optional</em></p></td>
4313 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
4316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
4317 <em>optional</em></p></td>
4318 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looplog">LoopLog</a> > array</p></td>
4321 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
4322 <em>optional</em></p></td>
4323 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_microservicepolicy">MicroServicePolicy</a> > array</p></td>
4326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelPropertiesJson</strong><br>
4327 <em>optional</em></p></td>
4328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4332 <em>optional</em></p></td>
4333 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
4337 <em>optional</em></p></td>
4338 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_operationalpolicy">OperationalPolicy</a> > array</p></td>
4341 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
4342 <em>optional</em></p></td>
4343 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4349 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.16. LoopLog</a></h3>
4350 <table class="tableblock frame-all grid-all stretch">
4352 <col style="width: 42.8571%;">
4353 <col style="width: 57.1429%;">
4357 <th class="tableblock halign-left valign-middle">Name</th>
4358 <th class="tableblock halign-left valign-middle">Schema</th>
4363 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
4364 <em>optional</em></p></td>
4365 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
4369 <em>optional</em></p></td>
4370 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4373 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
4374 <em>optional</em></p></td>
4375 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
4378 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
4379 <em>optional</em></p></td>
4380 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
4383 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
4384 <em>optional</em></p></td>
4385 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4391 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.17. MicroServicePolicy</a></h3>
4392 <table class="tableblock frame-all grid-all stretch">
4394 <col style="width: 42.8571%;">
4395 <col style="width: 57.1429%;">
4399 <th class="tableblock halign-left valign-middle">Name</th>
4400 <th class="tableblock halign-left valign-middle">Schema</th>
4405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
4406 <em>optional</em></p></td>
4407 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4410 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelType</strong><br>
4411 <em>optional</em></p></td>
4412 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4415 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4416 <em>optional</em></p></td>
4417 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4420 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyTosca</strong><br>
4421 <em>optional</em></p></td>
4422 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4425 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>properties</strong><br>
4426 <em>optional</em></p></td>
4427 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4430 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
4431 <em>optional</em></p></td>
4432 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4435 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
4436 <em>optional</em></p></td>
4437 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_loop">Loop</a> > array</p></td>
4443 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.18. Number</a></h3>
4444 <div class="paragraph">
4445 <p><em>Type</em> : object</p>
4449 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.19. OperationalPolicy</a></h3>
4450 <table class="tableblock frame-all grid-all stretch">
4452 <col style="width: 42.8571%;">
4453 <col style="width: 57.1429%;">
4457 <th class="tableblock halign-left valign-middle">Name</th>
4458 <th class="tableblock halign-left valign-middle">Schema</th>
4463 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
4464 <em>optional</em></p></td>
4465 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4468 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
4469 <em>optional</em></p></td>
4470 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4473 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
4474 <em>optional</em></p></td>
4475 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
4478 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4479 <em>optional</em></p></td>
4480 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4486 <h3 id="_valueitem"><a class="anchor" href="#_valueitem"></a><a class="link" href="#_valueitem">3.20. ValueItem</a></h3>
4487 <table class="tableblock frame-all grid-all stretch">
4489 <col style="width: 42.8571%;">
4490 <col style="width: 57.1429%;">
4494 <th class="tableblock halign-left valign-middle">Name</th>
4495 <th class="tableblock halign-left valign-middle">Schema</th>
4500 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
4501 <em>optional</em></p></td>
4502 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4511 <div id="footer-text">
4512 Last updated 2018-07-06 11:58:45 CEST