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="#_route113">2.1. GET /v1/healthcheck</a>
448 <ul class="sectlevel3">
449 <li><a href="#_responses">2.1.1. Responses</a></li>
450 <li><a href="#_produces">2.1.2. Produces</a></li>
453 <li><a href="#_route114">2.2. GET /v1/user/getUser</a>
454 <ul class="sectlevel3">
455 <li><a href="#_responses_2">2.2.1. Responses</a></li>
456 <li><a href="#_produces_2">2.2.2. Produces</a></li>
459 <li><a href="#_route112">2.3. GET /v2/clampInformation</a>
460 <ul class="sectlevel3">
461 <li><a href="#_responses_3">2.3.1. Responses</a></li>
462 <li><a href="#_produces_3">2.3.2. Produces</a></li>
465 <li><a href="#_route96">2.4. GET /v2/dictionary</a>
466 <ul class="sectlevel3">
467 <li><a href="#_responses_4">2.4.1. Responses</a></li>
468 <li><a href="#_produces_4">2.4.2. Produces</a></li>
471 <li><a href="#_route99">2.5. PUT /v2/dictionary</a>
472 <ul class="sectlevel3">
473 <li><a href="#_parameters">2.5.1. Parameters</a></li>
474 <li><a href="#_responses_5">2.5.2. Responses</a></li>
475 <li><a href="#_consumes">2.5.3. Consumes</a></li>
476 <li><a href="#_produces_5">2.5.4. Produces</a></li>
479 <li><a href="#_route97">2.6. GET /v2/dictionary/secondary/names</a>
480 <ul class="sectlevel3">
481 <li><a href="#_responses_6">2.6.1. Responses</a></li>
482 <li><a href="#_produces_6">2.6.2. Produces</a></li>
485 <li><a href="#_route98">2.7. GET /v2/dictionary/{dictionaryName}</a>
486 <ul class="sectlevel3">
487 <li><a href="#_parameters_2">2.7.1. Parameters</a></li>
488 <li><a href="#_responses_7">2.7.2. Responses</a></li>
489 <li><a href="#_produces_7">2.7.3. Produces</a></li>
492 <li><a href="#_route100">2.8. PUT /v2/dictionary/{name}</a>
493 <ul class="sectlevel3">
494 <li><a href="#_parameters_3">2.8.1. Parameters</a></li>
495 <li><a href="#_responses_8">2.8.2. Responses</a></li>
496 <li><a href="#_consumes_2">2.8.3. Consumes</a></li>
497 <li><a href="#_produces_8">2.8.4. Produces</a></li>
500 <li><a href="#_route101">2.9. DELETE /v2/dictionary/{name}</a>
501 <ul class="sectlevel3">
502 <li><a href="#_parameters_4">2.9.1. Parameters</a></li>
503 <li><a href="#_responses_9">2.9.2. Responses</a></li>
504 <li><a href="#_produces_9">2.9.3. Produces</a></li>
507 <li><a href="#_route102">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a>
508 <ul class="sectlevel3">
509 <li><a href="#_parameters_5">2.10.1. Parameters</a></li>
510 <li><a href="#_responses_10">2.10.2. Responses</a></li>
511 <li><a href="#_produces_10">2.10.3. Produces</a></li>
514 <li><a href="#_route93">2.11. PUT /v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}</a>
515 <ul class="sectlevel3">
516 <li><a href="#_parameters_6">2.11.1. Parameters</a></li>
517 <li><a href="#_responses_11">2.11.2. Responses</a></li>
518 <li><a href="#_produces_11">2.11.3. Produces</a></li>
521 <li><a href="#_route95">2.12. POST /v2/loop/create/{loopName}?templateName={templateName}</a>
522 <ul class="sectlevel3">
523 <li><a href="#_parameters_7">2.12.1. Parameters</a></li>
524 <li><a href="#_responses_12">2.12.2. Responses</a></li>
525 <li><a href="#_consumes_3">2.12.3. Consumes</a></li>
526 <li><a href="#_produces_12">2.12.4. Produces</a></li>
529 <li><a href="#_route91">2.13. PUT /v2/loop/delete/{loopName}</a>
530 <ul class="sectlevel3">
531 <li><a href="#_parameters_8">2.13.1. Parameters</a></li>
532 <li><a href="#_responses_13">2.13.2. Responses</a></li>
535 <li><a href="#_route84">2.14. PUT /v2/loop/deploy/{loopName}</a>
536 <ul class="sectlevel3">
537 <li><a href="#_parameters_9">2.14.1. Parameters</a></li>
538 <li><a href="#_responses_14">2.14.2. Responses</a></li>
539 <li><a href="#_produces_13">2.14.3. Produces</a></li>
542 <li><a href="#_route78">2.15. GET /v2/loop/getAllNames</a>
543 <ul class="sectlevel3">
544 <li><a href="#_responses_15">2.15.1. Responses</a></li>
545 <li><a href="#_produces_14">2.15.2. Produces</a></li>
548 <li><a href="#_route92">2.16. GET /v2/loop/getstatus/{loopName}</a>
549 <ul class="sectlevel3">
550 <li><a href="#_parameters_10">2.16.1. Parameters</a></li>
551 <li><a href="#_responses_16">2.16.2. Responses</a></li>
552 <li><a href="#_produces_15">2.16.3. Produces</a></li>
555 <li><a href="#_route85">2.17. PUT /v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}</a>
556 <ul class="sectlevel3">
557 <li><a href="#_parameters_11">2.17.1. Parameters</a></li>
558 <li><a href="#_responses_17">2.17.2. Responses</a></li>
559 <li><a href="#_produces_16">2.17.3. Produces</a></li>
562 <li><a href="#_route86">2.18. PUT /v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}</a>
563 <ul class="sectlevel3">
564 <li><a href="#_parameters_12">2.18.1. Parameters</a></li>
565 <li><a href="#_responses_18">2.18.2. Responses</a></li>
566 <li><a href="#_produces_17">2.18.3. Produces</a></li>
569 <li><a href="#_route94">2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}/{policyName}</a>
570 <ul class="sectlevel3">
571 <li><a href="#_parameters_13">2.19.1. Parameters</a></li>
572 <li><a href="#_responses_19">2.19.2. Responses</a></li>
573 <li><a href="#_produces_18">2.19.3. Produces</a></li>
576 <li><a href="#_route89">2.20. PUT /v2/loop/restart/{loopName}</a>
577 <ul class="sectlevel3">
578 <li><a href="#_parameters_14">2.20.1. Parameters</a></li>
579 <li><a href="#_responses_20">2.20.2. Responses</a></li>
580 <li><a href="#_produces_19">2.20.3. Produces</a></li>
583 <li><a href="#_route88">2.21. PUT /v2/loop/stop/{loopName}</a>
584 <ul class="sectlevel3">
585 <li><a href="#_parameters_15">2.21.1. Parameters</a></li>
586 <li><a href="#_responses_21">2.21.2. Responses</a></li>
587 <li><a href="#_produces_20">2.21.3. Produces</a></li>
590 <li><a href="#_route90">2.22. PUT /v2/loop/submit/{loopName}</a>
591 <ul class="sectlevel3">
592 <li><a href="#_parameters_16">2.22.1. Parameters</a></li>
593 <li><a href="#_responses_22">2.22.2. Responses</a></li>
594 <li><a href="#_produces_21">2.22.3. Produces</a></li>
597 <li><a href="#_route80">2.23. GET /v2/loop/svgRepresentation/{loopName}</a>
598 <ul class="sectlevel3">
599 <li><a href="#_parameters_17">2.23.1. Parameters</a></li>
600 <li><a href="#_responses_23">2.23.2. Responses</a></li>
601 <li><a href="#_produces_22">2.23.3. Produces</a></li>
604 <li><a href="#_route87">2.24. PUT /v2/loop/undeploy/{loopName}</a>
605 <ul class="sectlevel3">
606 <li><a href="#_parameters_18">2.24.1. Parameters</a></li>
607 <li><a href="#_responses_24">2.24.2. Responses</a></li>
608 <li><a href="#_produces_23">2.24.3. Produces</a></li>
611 <li><a href="#_route81">2.25. POST /v2/loop/updateGlobalProperties/{loopName}</a>
612 <ul class="sectlevel3">
613 <li><a href="#_parameters_19">2.25.1. Parameters</a></li>
614 <li><a href="#_responses_25">2.25.2. Responses</a></li>
615 <li><a href="#_consumes_4">2.25.3. Consumes</a></li>
616 <li><a href="#_produces_24">2.25.4. Produces</a></li>
619 <li><a href="#_route83">2.26. POST /v2/loop/updateMicroservicePolicy/{loopName}</a>
620 <ul class="sectlevel3">
621 <li><a href="#_parameters_20">2.26.1. Parameters</a></li>
622 <li><a href="#_responses_26">2.26.2. Responses</a></li>
623 <li><a href="#_consumes_5">2.26.3. Consumes</a></li>
624 <li><a href="#_produces_25">2.26.4. Produces</a></li>
627 <li><a href="#_route82">2.27. POST /v2/loop/updateOperationalPolicies/{loopName}</a>
628 <ul class="sectlevel3">
629 <li><a href="#_parameters_21">2.27.1. Parameters</a></li>
630 <li><a href="#_responses_27">2.27.2. Responses</a></li>
631 <li><a href="#_consumes_6">2.27.3. Consumes</a></li>
632 <li><a href="#_produces_26">2.27.4. Produces</a></li>
635 <li><a href="#_route79">2.28. GET /v2/loop/{loopName}</a>
636 <ul class="sectlevel3">
637 <li><a href="#_parameters_22">2.28.1. Parameters</a></li>
638 <li><a href="#_responses_28">2.28.2. Responses</a></li>
639 <li><a href="#_produces_27">2.28.3. Produces</a></li>
642 <li><a href="#_route106">2.29. POST /v2/policyToscaModels</a>
643 <ul class="sectlevel3">
644 <li><a href="#_parameters_23">2.29.1. Parameters</a></li>
645 <li><a href="#_responses_29">2.29.2. Responses</a></li>
646 <li><a href="#_consumes_7">2.29.3. Consumes</a></li>
647 <li><a href="#_produces_28">2.29.4. Produces</a></li>
650 <li><a href="#_route103">2.30. GET /v2/policyToscaModels</a>
651 <ul class="sectlevel3">
652 <li><a href="#_responses_30">2.30.1. Responses</a></li>
653 <li><a href="#_produces_29">2.30.2. Produces</a></li>
656 <li><a href="#_route105">2.31. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}</a>
657 <ul class="sectlevel3">
658 <li><a href="#_parameters_24">2.31.1. Parameters</a></li>
659 <li><a href="#_responses_31">2.31.2. Responses</a></li>
660 <li><a href="#_produces_30">2.31.3. Produces</a></li>
663 <li><a href="#_route104">2.32. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a>
664 <ul class="sectlevel3">
665 <li><a href="#_parameters_25">2.32.1. Parameters</a></li>
666 <li><a href="#_responses_32">2.32.2. Responses</a></li>
667 <li><a href="#_produces_31">2.32.3. Produces</a></li>
670 <li><a href="#_route107">2.33. PUT /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a>
671 <ul class="sectlevel3">
672 <li><a href="#_parameters_26">2.33.1. Parameters</a></li>
673 <li><a href="#_responses_33">2.33.2. Responses</a></li>
674 <li><a href="#_consumes_8">2.33.3. Consumes</a></li>
675 <li><a href="#_produces_32">2.33.4. Produces</a></li>
678 <li><a href="#_route108">2.34. GET /v2/templates</a>
679 <ul class="sectlevel3">
680 <li><a href="#_responses_34">2.34.1. Responses</a></li>
681 <li><a href="#_produces_33">2.34.2. Produces</a></li>
684 <li><a href="#_route110">2.35. GET /v2/templates/names</a>
685 <ul class="sectlevel3">
686 <li><a href="#_responses_35">2.35.1. Responses</a></li>
687 <li><a href="#_produces_34">2.35.2. Produces</a></li>
690 <li><a href="#_route109">2.36. GET /v2/templates/{templateName}</a>
691 <ul class="sectlevel3">
692 <li><a href="#_parameters_27">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="#_route111">2.37. GET /v2/templates/{templateName}/svgRepresentation</a>
698 <ul class="sectlevel3">
699 <li><a href="#_parameters_28">2.37.1. Parameters</a></li>
700 <li><a href="#_responses_37">2.37.2. Responses</a></li>
701 <li><a href="#_produces_36">2.37.3. Produces</a></li>
706 <li><a href="#_definitions">3. Definitions</a>
707 <ul class="sectlevel2">
708 <li><a href="#_clampinformation">3.1. ClampInformation</a></li>
709 <li><a href="#_cldshealthcheck">3.2. CldsHealthCheck</a></li>
710 <li><a href="#_dictionary">3.3. Dictionary</a></li>
711 <li><a href="#_dictionaryelement">3.4. DictionaryElement</a></li>
712 <li><a href="#_externalcomponent">3.5. ExternalComponent</a></li>
713 <li><a href="#_externalcomponentstate">3.6. ExternalComponentState</a></li>
714 <li><a href="#_jsonarray">3.7. JsonArray</a></li>
715 <li><a href="#_jsonnull">3.8. JsonNull</a></li>
716 <li><a href="#_jsonobject">3.9. JsonObject</a></li>
717 <li><a href="#_jsonprimitive">3.10. JsonPrimitive</a></li>
718 <li><a href="#_loop">3.11. Loop</a></li>
719 <li><a href="#_loopelementmodel">3.12. LoopElementModel</a></li>
720 <li><a href="#_looplog">3.13. LoopLog</a></li>
721 <li><a href="#_looptemplate">3.14. LoopTemplate</a></li>
722 <li><a href="#_looptemplateloopelementmodel">3.15. LoopTemplateLoopElementModel</a></li>
723 <li><a href="#_microservicepolicy">3.16. MicroServicePolicy</a></li>
724 <li><a href="#_number">3.17. Number</a></li>
725 <li><a href="#_operationalpolicy">3.18. OperationalPolicy</a></li>
726 <li><a href="#_policymodel">3.19. PolicyModel</a></li>
727 <li><a href="#_service">3.20. Service</a></li>
735 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
736 <div class="sectionbody">
738 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
739 <div class="paragraph">
740 <p><em>Version</em> : 5.1.0-SNAPSHOT</p>
744 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
745 <div class="paragraph">
746 <p><em>Host</em> : localhost:37033<br>
747 <em>BasePath</em> : /restservices/clds/<br>
748 <em>Schemes</em> : HTTP</p>
754 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
755 <div class="sectionbody">
757 <h3 id="_route113"><a class="anchor" href="#_route113"></a><a class="link" href="#_route113">2.1. GET /v1/healthcheck</a></h3>
759 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.1. Responses</a></h4>
760 <table class="tableblock frame-all grid-all stretch">
762 <col style="width: 10%;">
763 <col style="width: 70%;">
764 <col style="width: 20%;">
768 <th class="tableblock halign-left valign-middle">HTTP Code</th>
769 <th class="tableblock halign-left valign-middle">Description</th>
770 <th class="tableblock halign-left valign-middle">Schema</th>
775 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
776 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
777 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
783 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
787 <p><code>application/json</code></p>
794 <h3 id="_route114"><a class="anchor" href="#_route114"></a><a class="link" href="#_route114">2.2. GET /v1/user/getUser</a></h3>
796 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
797 <table class="tableblock frame-all grid-all stretch">
799 <col style="width: 33.3333%;">
800 <col style="width: 66.6667%;">
804 <th class="tableblock halign-left valign-middle">HTTP Code</th>
805 <th class="tableblock halign-left valign-middle">Schema</th>
810 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
811 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
817 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
821 <p><code>text/plain</code></p>
828 <h3 id="_route112"><a class="anchor" href="#_route112"></a><a class="link" href="#_route112">2.3. GET /v2/clampInformation</a></h3>
830 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
831 <table class="tableblock frame-all grid-all stretch">
833 <col style="width: 10%;">
834 <col style="width: 70%;">
835 <col style="width: 20%;">
839 <th class="tableblock halign-left valign-middle">HTTP Code</th>
840 <th class="tableblock halign-left valign-middle">Description</th>
841 <th class="tableblock halign-left valign-middle">Schema</th>
846 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
847 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
848 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_clampinformation">ClampInformation</a></p></td>
854 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
858 <p><code>application/json</code></p>
865 <h3 id="_route96"><a class="anchor" href="#_route96"></a><a class="link" href="#_route96">2.4. GET /v2/dictionary</a></h3>
867 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.1. Responses</a></h4>
868 <table class="tableblock frame-all grid-all stretch">
870 <col style="width: 10%;">
871 <col style="width: 70%;">
872 <col style="width: 20%;">
876 <th class="tableblock halign-left valign-middle">HTTP Code</th>
877 <th class="tableblock halign-left valign-middle">Description</th>
878 <th class="tableblock halign-left valign-middle">Schema</th>
883 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
884 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
885 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
891 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.2. Produces</a></h4>
895 <p><code>application/json</code></p>
902 <h3 id="_route99"><a class="anchor" href="#_route99"></a><a class="link" href="#_route99">2.5. PUT /v2/dictionary</a></h3>
904 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.5.1. Parameters</a></h4>
905 <table class="tableblock frame-all grid-all stretch">
907 <col style="width: 22.2222%;">
908 <col style="width: 33.3333%;">
909 <col style="width: 44.4445%;">
913 <th class="tableblock halign-left valign-middle">Type</th>
914 <th class="tableblock halign-left valign-middle">Name</th>
915 <th class="tableblock halign-left valign-middle">Schema</th>
920 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
921 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
922 <em>required</em></p></td>
923 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
929 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
930 <table class="tableblock frame-all grid-all stretch">
932 <col style="width: 10%;">
933 <col style="width: 70%;">
934 <col style="width: 20%;">
938 <th class="tableblock halign-left valign-middle">HTTP Code</th>
939 <th class="tableblock halign-left valign-middle">Description</th>
940 <th class="tableblock halign-left valign-middle">Schema</th>
945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
946 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
947 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
953 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.5.3. Consumes</a></h4>
957 <p><code>application/json</code></p>
963 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
967 <p><code>application/json</code></p>
974 <h3 id="_route97"><a class="anchor" href="#_route97"></a><a class="link" href="#_route97">2.6. GET /v2/dictionary/secondary/names</a></h3>
976 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
977 <table class="tableblock frame-all grid-all stretch">
979 <col style="width: 10%;">
980 <col style="width: 70%;">
981 <col style="width: 20%;">
985 <th class="tableblock halign-left valign-middle">HTTP Code</th>
986 <th class="tableblock halign-left valign-middle">Description</th>
987 <th class="tableblock halign-left valign-middle">Schema</th>
992 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
993 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
994 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
1000 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
1004 <p><code>application/json</code></p>
1011 <h3 id="_route98"><a class="anchor" href="#_route98"></a><a class="link" href="#_route98">2.7. GET /v2/dictionary/{dictionaryName}</a></h3>
1013 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.7.1. Parameters</a></h4>
1014 <table class="tableblock frame-all grid-all stretch">
1016 <col style="width: 22.2222%;">
1017 <col style="width: 33.3333%;">
1018 <col style="width: 44.4445%;">
1022 <th class="tableblock halign-left valign-middle">Type</th>
1023 <th class="tableblock halign-left valign-middle">Name</th>
1024 <th class="tableblock halign-left valign-middle">Schema</th>
1029 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1031 <em>required</em></p></td>
1032 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1038 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
1039 <table class="tableblock frame-all grid-all stretch">
1041 <col style="width: 10%;">
1042 <col style="width: 70%;">
1043 <col style="width: 20%;">
1047 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1048 <th class="tableblock halign-left valign-middle">Description</th>
1049 <th class="tableblock halign-left valign-middle">Schema</th>
1054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1055 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1056 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1062 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1066 <p><code>application/json</code></p>
1073 <h3 id="_route100"><a class="anchor" href="#_route100"></a><a class="link" href="#_route100">2.8. PUT /v2/dictionary/{name}</a></h3>
1075 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.8.1. Parameters</a></h4>
1076 <table class="tableblock frame-all grid-all stretch">
1078 <col style="width: 22.2222%;">
1079 <col style="width: 33.3333%;">
1080 <col style="width: 44.4445%;">
1084 <th class="tableblock halign-left valign-middle">Type</th>
1085 <th class="tableblock halign-left valign-middle">Name</th>
1086 <th class="tableblock halign-left valign-middle">Schema</th>
1091 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1092 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1093 <em>required</em></p></td>
1094 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1097 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1098 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1099 <em>required</em></p></td>
1100 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1106 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1107 <table class="tableblock frame-all grid-all stretch">
1109 <col style="width: 10%;">
1110 <col style="width: 70%;">
1111 <col style="width: 20%;">
1115 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1116 <th class="tableblock halign-left valign-middle">Description</th>
1117 <th class="tableblock halign-left valign-middle">Schema</th>
1122 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1123 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1130 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.8.3. Consumes</a></h4>
1134 <p><code>application/json</code></p>
1140 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.4. Produces</a></h4>
1144 <p><code>application/json</code></p>
1151 <h3 id="_route101"><a class="anchor" href="#_route101"></a><a class="link" href="#_route101">2.9. DELETE /v2/dictionary/{name}</a></h3>
1153 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.9.1. Parameters</a></h4>
1154 <table class="tableblock frame-all grid-all stretch">
1156 <col style="width: 22.2222%;">
1157 <col style="width: 33.3333%;">
1158 <col style="width: 44.4445%;">
1162 <th class="tableblock halign-left valign-middle">Type</th>
1163 <th class="tableblock halign-left valign-middle">Name</th>
1164 <th class="tableblock halign-left valign-middle">Schema</th>
1169 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1170 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1171 <em>required</em></p></td>
1172 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1178 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1179 <table class="tableblock frame-all grid-all stretch">
1181 <col style="width: 33.3333%;">
1182 <col style="width: 66.6667%;">
1186 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1187 <th class="tableblock halign-left valign-middle">Schema</th>
1192 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1193 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1199 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1203 <p><code>application/json</code></p>
1210 <h3 id="_route102"><a class="anchor" href="#_route102"></a><a class="link" href="#_route102">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a></h3>
1212 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.10.1. Parameters</a></h4>
1213 <table class="tableblock frame-all grid-all stretch">
1215 <col style="width: 22.2222%;">
1216 <col style="width: 33.3333%;">
1217 <col style="width: 44.4445%;">
1221 <th class="tableblock halign-left valign-middle">Type</th>
1222 <th class="tableblock halign-left valign-middle">Name</th>
1223 <th class="tableblock halign-left valign-middle">Schema</th>
1228 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1229 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1230 <em>required</em></p></td>
1231 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1234 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1235 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
1236 <em>required</em></p></td>
1237 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1243 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1244 <table class="tableblock frame-all grid-all stretch">
1246 <col style="width: 33.3333%;">
1247 <col style="width: 66.6667%;">
1251 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1252 <th class="tableblock halign-left valign-middle">Schema</th>
1257 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1258 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1264 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.3. Produces</a></h4>
1268 <p><code>application/json</code></p>
1275 <h3 id="_route93"><a class="anchor" href="#_route93"></a><a class="link" href="#_route93">2.11. PUT /v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}</a></h3>
1277 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.11.1. Parameters</a></h4>
1278 <table class="tableblock frame-all grid-all stretch">
1280 <col style="width: 22.2222%;">
1281 <col style="width: 33.3333%;">
1282 <col style="width: 44.4445%;">
1286 <th class="tableblock halign-left valign-middle">Type</th>
1287 <th class="tableblock halign-left valign-middle">Name</th>
1288 <th class="tableblock halign-left valign-middle">Schema</th>
1293 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1294 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1295 <em>required</em></p></td>
1296 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1299 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
1301 <em>required</em></p></td>
1302 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1305 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyVersion</strong><br>
1307 <em>required</em></p></td>
1308 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1314 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.2. Responses</a></h4>
1315 <table class="tableblock frame-all grid-all stretch">
1317 <col style="width: 10%;">
1318 <col style="width: 70%;">
1319 <col style="width: 20%;">
1323 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1324 <th class="tableblock halign-left valign-middle">Description</th>
1325 <th class="tableblock halign-left valign-middle">Schema</th>
1330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1331 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1338 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.3. Produces</a></h4>
1342 <p><code>application/json</code></p>
1349 <h3 id="_route95"><a class="anchor" href="#_route95"></a><a class="link" href="#_route95">2.12. POST /v2/loop/create/{loopName}?templateName={templateName}</a></h3>
1351 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.12.1. Parameters</a></h4>
1352 <table class="tableblock frame-all grid-all stretch">
1354 <col style="width: 22.2222%;">
1355 <col style="width: 33.3333%;">
1356 <col style="width: 44.4445%;">
1360 <th class="tableblock halign-left valign-middle">Type</th>
1361 <th class="tableblock halign-left valign-middle">Name</th>
1362 <th class="tableblock halign-left valign-middle">Schema</th>
1367 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName}?templateName={templateName</strong><br>
1369 <em>required</em></p></td>
1370 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1376 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1377 <table class="tableblock frame-all grid-all stretch">
1379 <col style="width: 10%;">
1380 <col style="width: 70%;">
1381 <col style="width: 20%;">
1385 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1386 <th class="tableblock halign-left valign-middle">Description</th>
1387 <th class="tableblock halign-left valign-middle">Schema</th>
1392 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1393 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1394 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1400 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.12.3. Consumes</a></h4>
1404 <p><code>application/json</code></p>
1410 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.4. Produces</a></h4>
1414 <p><code>application/json</code></p>
1421 <h3 id="_route91"><a class="anchor" href="#_route91"></a><a class="link" href="#_route91">2.13. PUT /v2/loop/delete/{loopName}</a></h3>
1423 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.13.1. Parameters</a></h4>
1424 <table class="tableblock frame-all grid-all stretch">
1426 <col style="width: 22.2222%;">
1427 <col style="width: 33.3333%;">
1428 <col style="width: 44.4445%;">
1432 <th class="tableblock halign-left valign-middle">Type</th>
1433 <th class="tableblock halign-left valign-middle">Name</th>
1434 <th class="tableblock halign-left valign-middle">Schema</th>
1439 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1440 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1441 <em>required</em></p></td>
1442 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1448 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.2. Responses</a></h4>
1449 <table class="tableblock frame-all grid-all stretch">
1451 <col style="width: 33.3333%;">
1452 <col style="width: 66.6667%;">
1456 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1457 <th class="tableblock halign-left valign-middle">Schema</th>
1462 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1463 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1470 <h3 id="_route84"><a class="anchor" href="#_route84"></a><a class="link" href="#_route84">2.14. PUT /v2/loop/deploy/{loopName}</a></h3>
1472 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.14.1. Parameters</a></h4>
1473 <table class="tableblock frame-all grid-all stretch">
1475 <col style="width: 22.2222%;">
1476 <col style="width: 33.3333%;">
1477 <col style="width: 44.4445%;">
1481 <th class="tableblock halign-left valign-middle">Type</th>
1482 <th class="tableblock halign-left valign-middle">Name</th>
1483 <th class="tableblock halign-left valign-middle">Schema</th>
1488 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1489 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1490 <em>required</em></p></td>
1491 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1497 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1498 <table class="tableblock frame-all grid-all stretch">
1500 <col style="width: 10%;">
1501 <col style="width: 70%;">
1502 <col style="width: 20%;">
1506 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1507 <th class="tableblock halign-left valign-middle">Description</th>
1508 <th class="tableblock halign-left valign-middle">Schema</th>
1513 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1514 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1515 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1521 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.3. Produces</a></h4>
1525 <p><code>application/json</code></p>
1532 <h3 id="_route78"><a class="anchor" href="#_route78"></a><a class="link" href="#_route78">2.15. GET /v2/loop/getAllNames</a></h3>
1534 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.1. Responses</a></h4>
1535 <table class="tableblock frame-all grid-all stretch">
1537 <col style="width: 10%;">
1538 <col style="width: 70%;">
1539 <col style="width: 20%;">
1543 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1544 <th class="tableblock halign-left valign-middle">Description</th>
1545 <th class="tableblock halign-left valign-middle">Schema</th>
1550 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1551 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1552 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
1558 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.2. Produces</a></h4>
1562 <p><code>application/json</code></p>
1569 <h3 id="_route92"><a class="anchor" href="#_route92"></a><a class="link" href="#_route92">2.16. GET /v2/loop/getstatus/{loopName}</a></h3>
1571 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.16.1. Parameters</a></h4>
1572 <table class="tableblock frame-all grid-all stretch">
1574 <col style="width: 22.2222%;">
1575 <col style="width: 33.3333%;">
1576 <col style="width: 44.4445%;">
1580 <th class="tableblock halign-left valign-middle">Type</th>
1581 <th class="tableblock halign-left valign-middle">Name</th>
1582 <th class="tableblock halign-left valign-middle">Schema</th>
1587 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1589 <em>required</em></p></td>
1590 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1596 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1597 <table class="tableblock frame-all grid-all stretch">
1599 <col style="width: 10%;">
1600 <col style="width: 70%;">
1601 <col style="width: 20%;">
1605 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1606 <th class="tableblock halign-left valign-middle">Description</th>
1607 <th class="tableblock halign-left valign-middle">Schema</th>
1612 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1613 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1614 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1620 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1624 <p><code>application/json</code></p>
1631 <h3 id="_route85"><a class="anchor" href="#_route85"></a><a class="link" href="#_route85">2.17. PUT /v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}</a></h3>
1633 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.17.1. Parameters</a></h4>
1634 <table class="tableblock frame-all grid-all stretch">
1636 <col style="width: 22.2222%;">
1637 <col style="width: 33.3333%;">
1638 <col style="width: 44.4445%;">
1642 <th class="tableblock halign-left valign-middle">Type</th>
1643 <th class="tableblock halign-left valign-middle">Name</th>
1644 <th class="tableblock halign-left valign-middle">Schema</th>
1649 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1650 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1651 <em>required</em></p></td>
1652 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1656 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicyName</strong><br>
1657 <em>required</em></p></td>
1658 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1664 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1665 <table class="tableblock frame-all grid-all stretch">
1667 <col style="width: 10%;">
1668 <col style="width: 70%;">
1669 <col style="width: 20%;">
1673 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1674 <th class="tableblock halign-left valign-middle">Description</th>
1675 <th class="tableblock halign-left valign-middle">Schema</th>
1680 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1681 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1682 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1688 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.17.3. Produces</a></h4>
1692 <p><code>application/json</code></p>
1699 <h3 id="_route86"><a class="anchor" href="#_route86"></a><a class="link" href="#_route86">2.18. PUT /v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}</a></h3>
1701 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.18.1. Parameters</a></h4>
1702 <table class="tableblock frame-all grid-all stretch">
1704 <col style="width: 22.2222%;">
1705 <col style="width: 33.3333%;">
1706 <col style="width: 44.4445%;">
1710 <th class="tableblock halign-left valign-middle">Type</th>
1711 <th class="tableblock halign-left valign-middle">Name</th>
1712 <th class="tableblock halign-left valign-middle">Schema</th>
1717 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1718 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1719 <em>required</em></p></td>
1720 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicyName</strong><br>
1725 <em>required</em></p></td>
1726 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1732 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.2. Responses</a></h4>
1733 <table class="tableblock frame-all grid-all stretch">
1735 <col style="width: 10%;">
1736 <col style="width: 70%;">
1737 <col style="width: 20%;">
1741 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1742 <th class="tableblock halign-left valign-middle">Description</th>
1743 <th class="tableblock halign-left valign-middle">Schema</th>
1748 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1749 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1750 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1756 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.18.3. Produces</a></h4>
1760 <p><code>application/json</code></p>
1767 <h3 id="_route94"><a class="anchor" href="#_route94"></a><a class="link" href="#_route94">2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}/{policyName}</a></h3>
1769 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.19.1. Parameters</a></h4>
1770 <table class="tableblock frame-all grid-all stretch">
1772 <col style="width: 22.2222%;">
1773 <col style="width: 33.3333%;">
1774 <col style="width: 44.4445%;">
1778 <th class="tableblock halign-left valign-middle">Type</th>
1779 <th class="tableblock halign-left valign-middle">Name</th>
1780 <th class="tableblock halign-left valign-middle">Schema</th>
1785 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1786 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1787 <em>required</em></p></td>
1788 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1791 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1792 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyName</strong><br>
1793 <em>required</em></p></td>
1794 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1797 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1798 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
1799 <em>required</em></p></td>
1800 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1803 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1804 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyVersion</strong><br>
1805 <em>required</em></p></td>
1806 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1812 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1813 <table class="tableblock frame-all grid-all stretch">
1815 <col style="width: 10%;">
1816 <col style="width: 70%;">
1817 <col style="width: 20%;">
1821 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1822 <th class="tableblock halign-left valign-middle">Description</th>
1823 <th class="tableblock halign-left valign-middle">Schema</th>
1828 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1829 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1830 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1836 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.19.3. Produces</a></h4>
1840 <p><code>application/json</code></p>
1847 <h3 id="_route89"><a class="anchor" href="#_route89"></a><a class="link" href="#_route89">2.20. PUT /v2/loop/restart/{loopName}</a></h3>
1849 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.20.1. Parameters</a></h4>
1850 <table class="tableblock frame-all grid-all stretch">
1852 <col style="width: 22.2222%;">
1853 <col style="width: 33.3333%;">
1854 <col style="width: 44.4445%;">
1858 <th class="tableblock halign-left valign-middle">Type</th>
1859 <th class="tableblock halign-left valign-middle">Name</th>
1860 <th class="tableblock halign-left valign-middle">Schema</th>
1865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1866 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1867 <em>required</em></p></td>
1868 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1874 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.2. Responses</a></h4>
1875 <table class="tableblock frame-all grid-all stretch">
1877 <col style="width: 10%;">
1878 <col style="width: 70%;">
1879 <col style="width: 20%;">
1883 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1884 <th class="tableblock halign-left valign-middle">Description</th>
1885 <th class="tableblock halign-left valign-middle">Schema</th>
1890 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1891 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1892 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1898 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.20.3. Produces</a></h4>
1902 <p><code>application/json</code></p>
1909 <h3 id="_route88"><a class="anchor" href="#_route88"></a><a class="link" href="#_route88">2.21. PUT /v2/loop/stop/{loopName}</a></h3>
1911 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.21.1. Parameters</a></h4>
1912 <table class="tableblock frame-all grid-all stretch">
1914 <col style="width: 22.2222%;">
1915 <col style="width: 33.3333%;">
1916 <col style="width: 44.4445%;">
1920 <th class="tableblock halign-left valign-middle">Type</th>
1921 <th class="tableblock halign-left valign-middle">Name</th>
1922 <th class="tableblock halign-left valign-middle">Schema</th>
1927 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1928 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1929 <em>required</em></p></td>
1930 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1936 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
1937 <table class="tableblock frame-all grid-all stretch">
1939 <col style="width: 10%;">
1940 <col style="width: 70%;">
1941 <col style="width: 20%;">
1945 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1946 <th class="tableblock halign-left valign-middle">Description</th>
1947 <th class="tableblock halign-left valign-middle">Schema</th>
1952 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1953 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1954 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1960 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.21.3. Produces</a></h4>
1964 <p><code>application/json</code></p>
1971 <h3 id="_route90"><a class="anchor" href="#_route90"></a><a class="link" href="#_route90">2.22. PUT /v2/loop/submit/{loopName}</a></h3>
1973 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.22.1. Parameters</a></h4>
1974 <table class="tableblock frame-all grid-all stretch">
1976 <col style="width: 22.2222%;">
1977 <col style="width: 33.3333%;">
1978 <col style="width: 44.4445%;">
1982 <th class="tableblock halign-left valign-middle">Type</th>
1983 <th class="tableblock halign-left valign-middle">Name</th>
1984 <th class="tableblock halign-left valign-middle">Schema</th>
1989 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1990 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1991 <em>required</em></p></td>
1992 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1998 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.2. Responses</a></h4>
1999 <table class="tableblock frame-all grid-all stretch">
2001 <col style="width: 10%;">
2002 <col style="width: 70%;">
2003 <col style="width: 20%;">
2007 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2008 <th class="tableblock halign-left valign-middle">Description</th>
2009 <th class="tableblock halign-left valign-middle">Schema</th>
2014 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2015 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2016 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2022 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.22.3. Produces</a></h4>
2026 <p><code>application/json</code></p>
2033 <h3 id="_route80"><a class="anchor" href="#_route80"></a><a class="link" href="#_route80">2.23. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
2035 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.23.1. Parameters</a></h4>
2036 <table class="tableblock frame-all grid-all stretch">
2038 <col style="width: 22.2222%;">
2039 <col style="width: 33.3333%;">
2040 <col style="width: 44.4445%;">
2044 <th class="tableblock halign-left valign-middle">Type</th>
2045 <th class="tableblock halign-left valign-middle">Name</th>
2046 <th class="tableblock halign-left valign-middle">Schema</th>
2051 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2052 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2053 <em>required</em></p></td>
2054 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2060 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.2. Responses</a></h4>
2061 <table class="tableblock frame-all grid-all stretch">
2063 <col style="width: 10%;">
2064 <col style="width: 70%;">
2065 <col style="width: 20%;">
2069 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2070 <th class="tableblock halign-left valign-middle">Description</th>
2071 <th class="tableblock halign-left valign-middle">Schema</th>
2076 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2077 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2078 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2084 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.23.3. Produces</a></h4>
2088 <p><code>application/xml</code></p>
2095 <h3 id="_route87"><a class="anchor" href="#_route87"></a><a class="link" href="#_route87">2.24. PUT /v2/loop/undeploy/{loopName}</a></h3>
2097 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.24.1. Parameters</a></h4>
2098 <table class="tableblock frame-all grid-all stretch">
2100 <col style="width: 22.2222%;">
2101 <col style="width: 33.3333%;">
2102 <col style="width: 44.4445%;">
2106 <th class="tableblock halign-left valign-middle">Type</th>
2107 <th class="tableblock halign-left valign-middle">Name</th>
2108 <th class="tableblock halign-left valign-middle">Schema</th>
2113 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2115 <em>required</em></p></td>
2116 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2122 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.2. Responses</a></h4>
2123 <table class="tableblock frame-all grid-all stretch">
2125 <col style="width: 10%;">
2126 <col style="width: 70%;">
2127 <col style="width: 20%;">
2131 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2132 <th class="tableblock halign-left valign-middle">Description</th>
2133 <th class="tableblock halign-left valign-middle">Schema</th>
2138 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2139 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2140 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2146 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.24.3. Produces</a></h4>
2150 <p><code>application/json</code></p>
2157 <h3 id="_route81"><a class="anchor" href="#_route81"></a><a class="link" href="#_route81">2.25. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
2159 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.25.1. Parameters</a></h4>
2160 <table class="tableblock frame-all grid-all stretch">
2162 <col style="width: 22.2222%;">
2163 <col style="width: 33.3333%;">
2164 <col style="width: 44.4445%;">
2168 <th class="tableblock halign-left valign-middle">Type</th>
2169 <th class="tableblock halign-left valign-middle">Name</th>
2170 <th class="tableblock halign-left valign-middle">Schema</th>
2175 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2176 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2177 <em>required</em></p></td>
2178 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2181 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2182 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2183 <em>required</em></p></td>
2184 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2190 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.2. Responses</a></h4>
2191 <table class="tableblock frame-all grid-all stretch">
2193 <col style="width: 10%;">
2194 <col style="width: 70%;">
2195 <col style="width: 20%;">
2199 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2200 <th class="tableblock halign-left valign-middle">Description</th>
2201 <th class="tableblock halign-left valign-middle">Schema</th>
2206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2207 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2214 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.25.3. Consumes</a></h4>
2218 <p><code>application/json</code></p>
2224 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.25.4. Produces</a></h4>
2228 <p><code>application/json</code></p>
2235 <h3 id="_route83"><a class="anchor" href="#_route83"></a><a class="link" href="#_route83">2.26. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
2237 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a><a class="link" href="#_parameters_20">2.26.1. Parameters</a></h4>
2238 <table class="tableblock frame-all grid-all stretch">
2240 <col style="width: 22.2222%;">
2241 <col style="width: 33.3333%;">
2242 <col style="width: 44.4445%;">
2246 <th class="tableblock halign-left valign-middle">Type</th>
2247 <th class="tableblock halign-left valign-middle">Name</th>
2248 <th class="tableblock halign-left valign-middle">Schema</th>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2255 <em>required</em></p></td>
2256 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2259 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2260 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2261 <em>required</em></p></td>
2262 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2268 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2269 <table class="tableblock frame-all grid-all stretch">
2271 <col style="width: 10%;">
2272 <col style="width: 70%;">
2273 <col style="width: 20%;">
2277 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2278 <th class="tableblock halign-left valign-middle">Description</th>
2279 <th class="tableblock halign-left valign-middle">Schema</th>
2284 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2285 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2286 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2292 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.26.3. Consumes</a></h4>
2296 <p><code>application/json</code></p>
2302 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.26.4. Produces</a></h4>
2306 <p><code>application/json</code></p>
2313 <h3 id="_route82"><a class="anchor" href="#_route82"></a><a class="link" href="#_route82">2.27. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
2315 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a><a class="link" href="#_parameters_21">2.27.1. Parameters</a></h4>
2316 <table class="tableblock frame-all grid-all stretch">
2318 <col style="width: 22.2222%;">
2319 <col style="width: 33.3333%;">
2320 <col style="width: 44.4445%;">
2324 <th class="tableblock halign-left valign-middle">Type</th>
2325 <th class="tableblock halign-left valign-middle">Name</th>
2326 <th class="tableblock halign-left valign-middle">Schema</th>
2331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2333 <em>required</em></p></td>
2334 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2337 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2339 <em>required</em></p></td>
2340 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2346 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.2. Responses</a></h4>
2347 <table class="tableblock frame-all grid-all stretch">
2349 <col style="width: 10%;">
2350 <col style="width: 70%;">
2351 <col style="width: 20%;">
2355 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2356 <th class="tableblock halign-left valign-middle">Description</th>
2357 <th class="tableblock halign-left valign-middle">Schema</th>
2362 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2363 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2364 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2370 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.27.3. Consumes</a></h4>
2374 <p><code>application/json</code></p>
2380 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.27.4. Produces</a></h4>
2384 <p><code>application/json</code></p>
2391 <h3 id="_route79"><a class="anchor" href="#_route79"></a><a class="link" href="#_route79">2.28. GET /v2/loop/{loopName}</a></h3>
2393 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a><a class="link" href="#_parameters_22">2.28.1. Parameters</a></h4>
2394 <table class="tableblock frame-all grid-all stretch">
2396 <col style="width: 22.2222%;">
2397 <col style="width: 33.3333%;">
2398 <col style="width: 44.4445%;">
2402 <th class="tableblock halign-left valign-middle">Type</th>
2403 <th class="tableblock halign-left valign-middle">Name</th>
2404 <th class="tableblock halign-left valign-middle">Schema</th>
2409 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2410 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2411 <em>required</em></p></td>
2412 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2418 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.2. Responses</a></h4>
2419 <table class="tableblock frame-all grid-all stretch">
2421 <col style="width: 10%;">
2422 <col style="width: 70%;">
2423 <col style="width: 20%;">
2427 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2428 <th class="tableblock halign-left valign-middle">Description</th>
2429 <th class="tableblock halign-left valign-middle">Schema</th>
2434 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2435 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2442 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.28.3. Produces</a></h4>
2446 <p><code>application/json</code></p>
2453 <h3 id="_route106"><a class="anchor" href="#_route106"></a><a class="link" href="#_route106">2.29. POST /v2/policyToscaModels</a></h3>
2455 <h4 id="_parameters_23"><a class="anchor" href="#_parameters_23"></a><a class="link" href="#_parameters_23">2.29.1. Parameters</a></h4>
2456 <table class="tableblock frame-all grid-all stretch">
2458 <col style="width: 22.2222%;">
2459 <col style="width: 33.3333%;">
2460 <col style="width: 44.4445%;">
2464 <th class="tableblock halign-left valign-middle">Type</th>
2465 <th class="tableblock halign-left valign-middle">Name</th>
2466 <th class="tableblock halign-left valign-middle">Schema</th>
2471 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2472 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2473 <em>required</em></p></td>
2474 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2480 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.2. Responses</a></h4>
2481 <table class="tableblock frame-all grid-all stretch">
2483 <col style="width: 10%;">
2484 <col style="width: 70%;">
2485 <col style="width: 20%;">
2489 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2490 <th class="tableblock halign-left valign-middle">Description</th>
2491 <th class="tableblock halign-left valign-middle">Schema</th>
2496 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2497 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2498 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2504 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a><a class="link" href="#_consumes_7">2.29.3. Consumes</a></h4>
2508 <p><code>plain/text</code></p>
2514 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.29.4. Produces</a></h4>
2518 <p><code>application/json</code></p>
2525 <h3 id="_route103"><a class="anchor" href="#_route103"></a><a class="link" href="#_route103">2.30. GET /v2/policyToscaModels</a></h3>
2527 <h4 id="_responses_30"><a class="anchor" href="#_responses_30"></a><a class="link" href="#_responses_30">2.30.1. Responses</a></h4>
2528 <table class="tableblock frame-all grid-all stretch">
2530 <col style="width: 10%;">
2531 <col style="width: 70%;">
2532 <col style="width: 20%;">
2536 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2537 <th class="tableblock halign-left valign-middle">Description</th>
2538 <th class="tableblock halign-left valign-middle">Schema</th>
2543 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2544 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2545 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2551 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.30.2. Produces</a></h4>
2555 <p><code>application/json</code></p>
2562 <h3 id="_route105"><a class="anchor" href="#_route105"></a><a class="link" href="#_route105">2.31. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}</a></h3>
2564 <h4 id="_parameters_24"><a class="anchor" href="#_parameters_24"></a><a class="link" href="#_parameters_24">2.31.1. Parameters</a></h4>
2565 <table class="tableblock frame-all grid-all stretch">
2567 <col style="width: 22.2222%;">
2568 <col style="width: 33.3333%;">
2569 <col style="width: 44.4445%;">
2573 <th class="tableblock halign-left valign-middle">Type</th>
2574 <th class="tableblock halign-left valign-middle">Name</th>
2575 <th class="tableblock halign-left valign-middle">Schema</th>
2580 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2581 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2582 <em>required</em></p></td>
2583 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2586 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2587 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2588 <em>required</em></p></td>
2589 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2595 <h4 id="_responses_31"><a class="anchor" href="#_responses_31"></a><a class="link" href="#_responses_31">2.31.2. Responses</a></h4>
2596 <table class="tableblock frame-all grid-all stretch">
2598 <col style="width: 10%;">
2599 <col style="width: 70%;">
2600 <col style="width: 20%;">
2604 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2605 <th class="tableblock halign-left valign-middle">Description</th>
2606 <th class="tableblock halign-left valign-middle">Schema</th>
2611 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2612 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2613 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2619 <h4 id="_produces_30"><a class="anchor" href="#_produces_30"></a><a class="link" href="#_produces_30">2.31.3. Produces</a></h4>
2623 <p><code>application/json</code></p>
2630 <h3 id="_route104"><a class="anchor" href="#_route104"></a><a class="link" href="#_route104">2.32. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a></h3>
2632 <h4 id="_parameters_25"><a class="anchor" href="#_parameters_25"></a><a class="link" href="#_parameters_25">2.32.1. Parameters</a></h4>
2633 <table class="tableblock frame-all grid-all stretch">
2635 <col style="width: 22.2222%;">
2636 <col style="width: 33.3333%;">
2637 <col style="width: 44.4445%;">
2641 <th class="tableblock halign-left valign-middle">Type</th>
2642 <th class="tableblock halign-left valign-middle">Name</th>
2643 <th class="tableblock halign-left valign-middle">Schema</th>
2648 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2649 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2650 <em>required</em></p></td>
2651 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2654 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2656 <em>required</em></p></td>
2657 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2663 <h4 id="_responses_32"><a class="anchor" href="#_responses_32"></a><a class="link" href="#_responses_32">2.32.2. Responses</a></h4>
2664 <table class="tableblock frame-all grid-all stretch">
2666 <col style="width: 10%;">
2667 <col style="width: 70%;">
2668 <col style="width: 20%;">
2672 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2673 <th class="tableblock halign-left valign-middle">Description</th>
2674 <th class="tableblock halign-left valign-middle">Schema</th>
2679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2680 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2681 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2687 <h4 id="_produces_31"><a class="anchor" href="#_produces_31"></a><a class="link" href="#_produces_31">2.32.3. Produces</a></h4>
2691 <p><code>application/json</code></p>
2698 <h3 id="_route107"><a class="anchor" href="#_route107"></a><a class="link" href="#_route107">2.33. PUT /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a></h3>
2700 <h4 id="_parameters_26"><a class="anchor" href="#_parameters_26"></a><a class="link" href="#_parameters_26">2.33.1. Parameters</a></h4>
2701 <table class="tableblock frame-all grid-all stretch">
2703 <col style="width: 22.2222%;">
2704 <col style="width: 33.3333%;">
2705 <col style="width: 44.4445%;">
2709 <th class="tableblock halign-left valign-middle">Type</th>
2710 <th class="tableblock halign-left valign-middle">Name</th>
2711 <th class="tableblock halign-left valign-middle">Schema</th>
2716 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2717 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2718 <em>required</em></p></td>
2719 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2722 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2724 <em>required</em></p></td>
2725 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2730 <em>required</em></p></td>
2731 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2737 <h4 id="_responses_33"><a class="anchor" href="#_responses_33"></a><a class="link" href="#_responses_33">2.33.2. Responses</a></h4>
2738 <table class="tableblock frame-all grid-all stretch">
2740 <col style="width: 10%;">
2741 <col style="width: 70%;">
2742 <col style="width: 20%;">
2746 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2747 <th class="tableblock halign-left valign-middle">Description</th>
2748 <th class="tableblock halign-left valign-middle">Schema</th>
2753 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2754 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2755 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2761 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a><a class="link" href="#_consumes_8">2.33.3. Consumes</a></h4>
2765 <p><code>plain/text</code></p>
2771 <h4 id="_produces_32"><a class="anchor" href="#_produces_32"></a><a class="link" href="#_produces_32">2.33.4. Produces</a></h4>
2775 <p><code>application/json</code></p>
2782 <h3 id="_route108"><a class="anchor" href="#_route108"></a><a class="link" href="#_route108">2.34. GET /v2/templates</a></h3>
2784 <h4 id="_responses_34"><a class="anchor" href="#_responses_34"></a><a class="link" href="#_responses_34">2.34.1. Responses</a></h4>
2785 <table class="tableblock frame-all grid-all stretch">
2787 <col style="width: 10%;">
2788 <col style="width: 70%;">
2789 <col style="width: 20%;">
2793 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2794 <th class="tableblock halign-left valign-middle">Description</th>
2795 <th class="tableblock halign-left valign-middle">Schema</th>
2800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2801 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2802 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2808 <h4 id="_produces_33"><a class="anchor" href="#_produces_33"></a><a class="link" href="#_produces_33">2.34.2. Produces</a></h4>
2812 <p><code>application/json</code></p>
2819 <h3 id="_route110"><a class="anchor" href="#_route110"></a><a class="link" href="#_route110">2.35. GET /v2/templates/names</a></h3>
2821 <h4 id="_responses_35"><a class="anchor" href="#_responses_35"></a><a class="link" href="#_responses_35">2.35.1. Responses</a></h4>
2822 <table class="tableblock frame-all grid-all stretch">
2824 <col style="width: 10%;">
2825 <col style="width: 70%;">
2826 <col style="width: 20%;">
2830 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2831 <th class="tableblock halign-left valign-middle">Description</th>
2832 <th class="tableblock halign-left valign-middle">Schema</th>
2837 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2838 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2839 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
2845 <h4 id="_produces_34"><a class="anchor" href="#_produces_34"></a><a class="link" href="#_produces_34">2.35.2. Produces</a></h4>
2849 <p><code>application/json</code></p>
2856 <h3 id="_route109"><a class="anchor" href="#_route109"></a><a class="link" href="#_route109">2.36. GET /v2/templates/{templateName}</a></h3>
2858 <h4 id="_parameters_27"><a class="anchor" href="#_parameters_27"></a><a class="link" href="#_parameters_27">2.36.1. Parameters</a></h4>
2859 <table class="tableblock frame-all grid-all stretch">
2861 <col style="width: 22.2222%;">
2862 <col style="width: 33.3333%;">
2863 <col style="width: 44.4445%;">
2867 <th class="tableblock halign-left valign-middle">Type</th>
2868 <th class="tableblock halign-left valign-middle">Name</th>
2869 <th class="tableblock halign-left valign-middle">Schema</th>
2874 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2875 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2876 <em>required</em></p></td>
2877 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2883 <h4 id="_responses_36"><a class="anchor" href="#_responses_36"></a><a class="link" href="#_responses_36">2.36.2. Responses</a></h4>
2884 <table class="tableblock frame-all grid-all stretch">
2886 <col style="width: 10%;">
2887 <col style="width: 70%;">
2888 <col style="width: 20%;">
2892 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2893 <th class="tableblock halign-left valign-middle">Description</th>
2894 <th class="tableblock halign-left valign-middle">Schema</th>
2899 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2900 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2901 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2907 <h4 id="_produces_35"><a class="anchor" href="#_produces_35"></a><a class="link" href="#_produces_35">2.36.3. Produces</a></h4>
2911 <p><code>application/json</code></p>
2918 <h3 id="_route111"><a class="anchor" href="#_route111"></a><a class="link" href="#_route111">2.37. GET /v2/templates/{templateName}/svgRepresentation</a></h3>
2920 <h4 id="_parameters_28"><a class="anchor" href="#_parameters_28"></a><a class="link" href="#_parameters_28">2.37.1. Parameters</a></h4>
2921 <table class="tableblock frame-all grid-all stretch">
2923 <col style="width: 22.2222%;">
2924 <col style="width: 33.3333%;">
2925 <col style="width: 44.4445%;">
2929 <th class="tableblock halign-left valign-middle">Type</th>
2930 <th class="tableblock halign-left valign-middle">Name</th>
2931 <th class="tableblock halign-left valign-middle">Schema</th>
2936 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2938 <em>required</em></p></td>
2939 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2945 <h4 id="_responses_37"><a class="anchor" href="#_responses_37"></a><a class="link" href="#_responses_37">2.37.2. Responses</a></h4>
2946 <table class="tableblock frame-all grid-all stretch">
2948 <col style="width: 10%;">
2949 <col style="width: 70%;">
2950 <col style="width: 20%;">
2954 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2955 <th class="tableblock halign-left valign-middle">Description</th>
2956 <th class="tableblock halign-left valign-middle">Schema</th>
2961 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2962 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2963 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2969 <h4 id="_produces_36"><a class="anchor" href="#_produces_36"></a><a class="link" href="#_produces_36">2.37.3. Produces</a></h4>
2973 <p><code>application/xml</code></p>
2982 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
2983 <div class="sectionbody">
2985 <h3 id="_clampinformation"><a class="anchor" href="#_clampinformation"></a><a class="link" href="#_clampinformation">3.1. ClampInformation</a></h3>
2986 <table class="tableblock frame-all grid-all stretch">
2988 <col style="width: 42.8571%;">
2989 <col style="width: 57.1429%;">
2993 <th class="tableblock halign-left valign-middle">Name</th>
2994 <th class="tableblock halign-left valign-middle">Schema</th>
2999 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allPermissions</strong><br>
3000 <em>optional</em></p></td>
3001 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
3004 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
3005 <em>optional</em></p></td>
3006 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3009 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
3010 <em>optional</em></p></td>
3011 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3017 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a><a class="link" href="#_cldshealthcheck">3.2. CldsHealthCheck</a></h3>
3018 <table class="tableblock frame-all grid-all stretch">
3020 <col style="width: 42.8571%;">
3021 <col style="width: 57.1429%;">
3025 <th class="tableblock halign-left valign-middle">Name</th>
3026 <th class="tableblock halign-left valign-middle">Schema</th>
3031 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3032 <em>optional</em></p></td>
3033 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3036 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
3037 <em>optional</em></p></td>
3038 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3041 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
3042 <em>optional</em></p></td>
3043 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3049 <h3 id="_dictionary"><a class="anchor" href="#_dictionary"></a><a class="link" href="#_dictionary">3.3. Dictionary</a></h3>
3050 <table class="tableblock frame-all grid-all stretch">
3052 <col style="width: 42.8571%;">
3053 <col style="width: 57.1429%;">
3057 <th class="tableblock halign-left valign-middle">Name</th>
3058 <th class="tableblock halign-left valign-middle">Schema</th>
3063 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3064 <em>optional</em></p></td>
3065 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3068 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3069 <em>optional</em></p></td>
3070 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3073 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryElements</strong><br>
3074 <em>optional</em></p></td>
3075 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_dictionaryelement">DictionaryElement</a> > array</p></td>
3078 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3079 <em>optional</em></p></td>
3080 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3083 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>secondLevelDictionary</strong><br>
3084 <em>optional</em></p></td>
3085 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3088 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionaryType</strong><br>
3089 <em>optional</em></p></td>
3090 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3093 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3094 <em>optional</em></p></td>
3095 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3098 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3099 <em>optional</em></p></td>
3100 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3106 <h3 id="_dictionaryelement"><a class="anchor" href="#_dictionaryelement"></a><a class="link" href="#_dictionaryelement">3.4. DictionaryElement</a></h3>
3107 <table class="tableblock frame-all grid-all stretch">
3109 <col style="width: 42.8571%;">
3110 <col style="width: 57.1429%;">
3114 <th class="tableblock halign-left valign-middle">Name</th>
3115 <th class="tableblock halign-left valign-middle">Schema</th>
3120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3121 <em>optional</em></p></td>
3122 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3126 <em>optional</em></p></td>
3127 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3130 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3131 <em>optional</em></p></td>
3132 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3135 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3136 <em>optional</em></p></td>
3137 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3140 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
3141 <em>optional</em></p></td>
3142 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3145 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionary</strong><br>
3146 <em>optional</em></p></td>
3147 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3150 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
3151 <em>optional</em></p></td>
3152 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3155 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3156 <em>optional</em></p></td>
3157 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3160 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3161 <em>optional</em></p></td>
3162 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3165 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByDictionaries</strong><br>
3166 <em>optional</em></p></td>
3167 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_dictionary">Dictionary</a> > array</p></td>
3173 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.5. ExternalComponent</a></h3>
3174 <table class="tableblock frame-all grid-all stretch">
3176 <col style="width: 42.8571%;">
3177 <col style="width: 57.1429%;">
3181 <th class="tableblock halign-left valign-middle">Name</th>
3182 <th class="tableblock halign-left valign-middle">Schema</th>
3187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
3188 <em>optional</em></p></td>
3189 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3192 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
3193 <em>optional</em></p></td>
3194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
3200 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.6. ExternalComponentState</a></h3>
3201 <table class="tableblock frame-all grid-all stretch">
3203 <col style="width: 42.8571%;">
3204 <col style="width: 57.1429%;">
3208 <th class="tableblock halign-left valign-middle">Name</th>
3209 <th class="tableblock halign-left valign-middle">Schema</th>
3214 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3215 <em>optional</em></p></td>
3216 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3219 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
3220 <em>optional</em></p></td>
3221 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3224 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
3225 <em>optional</em></p></td>
3226 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3232 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.7. JsonArray</a></h3>
3233 <table class="tableblock frame-all grid-all stretch">
3235 <col style="width: 42.8571%;">
3236 <col style="width: 57.1429%;">
3240 <th class="tableblock halign-left valign-middle">Name</th>
3241 <th class="tableblock halign-left valign-middle">Schema</th>
3246 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3247 <em>optional</em></p></td>
3248 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3252 <em>optional</em></p></td>
3253 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3256 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3257 <em>optional</em></p></td>
3258 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3261 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3262 <em>optional</em></p></td>
3263 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3266 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3267 <em>optional</em></p></td>
3268 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3271 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3272 <em>optional</em></p></td>
3273 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3276 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3277 <em>optional</em></p></td>
3278 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3281 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3282 <em>optional</em></p></td>
3283 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3286 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3287 <em>optional</em></p></td>
3288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3291 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3292 <em>optional</em></p></td>
3293 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3296 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3297 <em>optional</em></p></td>
3298 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3301 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3302 <em>optional</em></p></td>
3303 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3307 <em>optional</em></p></td>
3308 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3311 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3312 <em>optional</em></p></td>
3313 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3317 <em>optional</em></p></td>
3318 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3321 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3322 <em>optional</em></p></td>
3323 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3327 <em>optional</em></p></td>
3328 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3332 <em>optional</em></p></td>
3333 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3337 <em>optional</em></p></td>
3338 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3341 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3342 <em>optional</em></p></td>
3343 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3349 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.8. JsonNull</a></h3>
3350 <table class="tableblock frame-all grid-all stretch">
3352 <col style="width: 42.8571%;">
3353 <col style="width: 57.1429%;">
3357 <th class="tableblock halign-left valign-middle">Name</th>
3358 <th class="tableblock halign-left valign-middle">Schema</th>
3363 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3364 <em>optional</em></p></td>
3365 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3369 <em>optional</em></p></td>
3370 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3373 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3374 <em>optional</em></p></td>
3375 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3378 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3379 <em>optional</em></p></td>
3380 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3383 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3384 <em>optional</em></p></td>
3385 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3388 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3389 <em>optional</em></p></td>
3390 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3393 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3394 <em>optional</em></p></td>
3395 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3398 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3399 <em>optional</em></p></td>
3400 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3403 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3404 <em>optional</em></p></td>
3405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3408 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3409 <em>optional</em></p></td>
3410 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3413 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3414 <em>optional</em></p></td>
3415 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3418 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3419 <em>optional</em></p></td>
3420 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3423 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3424 <em>optional</em></p></td>
3425 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3428 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3429 <em>optional</em></p></td>
3430 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3434 <em>optional</em></p></td>
3435 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3438 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3439 <em>optional</em></p></td>
3440 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3443 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3444 <em>optional</em></p></td>
3445 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3448 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3449 <em>optional</em></p></td>
3450 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3453 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3454 <em>optional</em></p></td>
3455 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3458 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3459 <em>optional</em></p></td>
3460 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3466 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.9. JsonObject</a></h3>
3467 <table class="tableblock frame-all grid-all stretch">
3469 <col style="width: 42.8571%;">
3470 <col style="width: 57.1429%;">
3474 <th class="tableblock halign-left valign-middle">Name</th>
3475 <th class="tableblock halign-left valign-middle">Schema</th>
3480 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3481 <em>optional</em></p></td>
3482 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3485 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3486 <em>optional</em></p></td>
3487 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3490 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3491 <em>optional</em></p></td>
3492 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3495 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3496 <em>optional</em></p></td>
3497 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3500 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3501 <em>optional</em></p></td>
3502 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3505 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3506 <em>optional</em></p></td>
3507 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3510 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3511 <em>optional</em></p></td>
3512 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3515 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3516 <em>optional</em></p></td>
3517 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3520 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3521 <em>optional</em></p></td>
3522 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3525 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3526 <em>optional</em></p></td>
3527 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3530 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3531 <em>optional</em></p></td>
3532 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3535 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3536 <em>optional</em></p></td>
3537 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3541 <em>optional</em></p></td>
3542 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3545 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3546 <em>optional</em></p></td>
3547 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3550 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3551 <em>optional</em></p></td>
3552 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3555 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</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>jsonArray</strong><br>
3561 <em>optional</em></p></td>
3562 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3565 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3566 <em>optional</em></p></td>
3567 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3570 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3571 <em>optional</em></p></td>
3572 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3575 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3576 <em>optional</em></p></td>
3577 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3583 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.10. JsonPrimitive</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>asBigDecimal</strong><br>
3598 <em>optional</em></p></td>
3599 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3603 <em>optional</em></p></td>
3604 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3607 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3608 <em>optional</em></p></td>
3609 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3612 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3613 <em>optional</em></p></td>
3614 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3617 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</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>asDouble</strong><br>
3623 <em>optional</em></p></td>
3624 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3627 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3628 <em>optional</em></p></td>
3629 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3632 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3633 <em>optional</em></p></td>
3634 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3637 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3638 <em>optional</em></p></td>
3639 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3642 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3643 <em>optional</em></p></td>
3644 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3647 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3648 <em>optional</em></p></td>
3649 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3653 <em>optional</em></p></td>
3654 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3657 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3658 <em>optional</em></p></td>
3659 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3662 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3663 <em>optional</em></p></td>
3664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3667 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3668 <em>optional</em></p></td>
3669 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3672 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3673 <em>optional</em></p></td>
3674 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3677 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
3678 <em>optional</em></p></td>
3679 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3682 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3683 <em>optional</em></p></td>
3684 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3687 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3688 <em>optional</em></p></td>
3689 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3692 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3693 <em>optional</em></p></td>
3694 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3697 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3698 <em>optional</em></p></td>
3699 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3702 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
3703 <em>optional</em></p></td>
3704 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3707 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
3708 <em>optional</em></p></td>
3709 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3715 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.11. Loop</a></h3>
3716 <table class="tableblock frame-all grid-all stretch">
3718 <col style="width: 42.8571%;">
3719 <col style="width: 57.1429%;">
3723 <th class="tableblock halign-left valign-middle">Name</th>
3724 <th class="tableblock halign-left valign-middle">Schema</th>
3729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
3730 <em>optional</em></p></td>
3731 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string, <a href="#_externalcomponent">ExternalComponent</a> > map</p></td>
3734 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3735 <em>optional</em></p></td>
3736 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3739 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3740 <em>optional</em></p></td>
3741 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3744 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
3745 <em>optional</em></p></td>
3746 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3749 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
3750 <em>optional</em></p></td>
3751 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3754 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
3755 <em>optional</em></p></td>
3756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
3760 <em>optional</em></p></td>
3761 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
3764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
3765 <em>optional</em></p></td>
3766 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looplog">LoopLog</a> > array</p></td>
3769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
3770 <em>optional</em></p></td>
3771 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3774 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
3775 <em>optional</em></p></td>
3776 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_microservicepolicy">MicroServicePolicy</a> > array</p></td>
3779 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3780 <em>optional</em></p></td>
3781 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3784 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3785 <em>optional</em></p></td>
3786 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3789 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
3790 <em>optional</em></p></td>
3791 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_operationalpolicy">OperationalPolicy</a> > array</p></td>
3794 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3795 <em>optional</em></p></td>
3796 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3800 <em>optional</em></p></td>
3801 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3804 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3805 <em>optional</em></p></td>
3806 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3812 <h3 id="_loopelementmodel"><a class="anchor" href="#_loopelementmodel"></a><a class="link" href="#_loopelementmodel">3.12. LoopElementModel</a></h3>
3813 <table class="tableblock frame-all grid-all stretch">
3815 <col style="width: 42.8571%;">
3816 <col style="width: 57.1429%;">
3820 <th class="tableblock halign-left valign-middle">Name</th>
3821 <th class="tableblock halign-left valign-middle">Schema</th>
3826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3827 <em>optional</em></p></td>
3828 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3831 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3832 <em>optional</em></p></td>
3833 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3836 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3837 <em>optional</em></p></td>
3838 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3842 <em>optional</em></p></td>
3843 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3846 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementType</strong><br>
3847 <em>optional</em></p></td>
3848 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3851 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3852 <em>optional</em></p></td>
3853 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3856 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModels</strong><br>
3857 <em>optional</em></p></td>
3858 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_policymodel">PolicyModel</a> > array</p></td>
3861 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
3862 <em>optional</em></p></td>
3863 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3866 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3867 <em>optional</em></p></td>
3868 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3872 <em>optional</em></p></td>
3873 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoopTemplates</strong><br>
3877 <em>optional</em></p></td>
3878 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> > array</p></td>
3884 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.13. LoopLog</a></h3>
3885 <table class="tableblock frame-all grid-all stretch">
3887 <col style="width: 42.8571%;">
3888 <col style="width: 57.1429%;">
3892 <th class="tableblock halign-left valign-middle">Name</th>
3893 <th class="tableblock halign-left valign-middle">Schema</th>
3898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3899 <em>optional</em></p></td>
3900 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3903 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
3904 <em>optional</em></p></td>
3905 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3908 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
3909 <em>optional</em></p></td>
3910 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3913 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
3914 <em>optional</em></p></td>
3915 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
3918 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
3919 <em>optional</em></p></td>
3920 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3923 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
3924 <em>optional</em></p></td>
3925 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3931 <h3 id="_looptemplate"><a class="anchor" href="#_looptemplate"></a><a class="link" href="#_looptemplate">3.14. LoopTemplate</a></h3>
3932 <table class="tableblock frame-all grid-all stretch">
3934 <col style="width: 42.8571%;">
3935 <col style="width: 57.1429%;">
3939 <th class="tableblock halign-left valign-middle">Name</th>
3940 <th class="tableblock halign-left valign-middle">Schema</th>
3945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allowedLoopType</strong><br>
3946 <em>optional</em></p></td>
3947 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (OPEN, CLOSED, HYBRID)</p></td>
3950 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3951 <em>optional</em></p></td>
3952 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3956 <em>optional</em></p></td>
3957 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3960 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3961 <em>optional</em></p></td>
3962 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3965 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3966 <em>optional</em></p></td>
3967 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3970 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModelsUsed</strong><br>
3971 <em>optional</em></p></td>
3972 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> > array</p></td>
3975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>maximumInstancesAllowed</strong><br>
3976 <em>optional</em></p></td>
3977 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3980 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3981 <em>optional</em></p></td>
3982 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3986 <em>optional</em></p></td>
3987 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3990 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3991 <em>optional</em></p></td>
3992 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3995 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>uniqueBlueprint</strong><br>
3996 <em>optional</em></p></td>
3997 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4000 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4001 <em>optional</em></p></td>
4002 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4005 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4006 <em>optional</em></p></td>
4007 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4013 <h3 id="_looptemplateloopelementmodel"><a class="anchor" href="#_looptemplateloopelementmodel"></a><a class="link" href="#_looptemplateloopelementmodel">3.15. LoopTemplateLoopElementModel</a></h3>
4014 <table class="tableblock frame-all grid-all stretch">
4016 <col style="width: 42.8571%;">
4017 <col style="width: 57.1429%;">
4021 <th class="tableblock halign-left valign-middle">Name</th>
4022 <th class="tableblock halign-left valign-middle">Schema</th>
4027 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>flowOrder</strong><br>
4028 <em>optional</em></p></td>
4029 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4032 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
4033 <em>optional</em></p></td>
4034 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
4037 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
4038 <em>optional</em></p></td>
4039 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
4045 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.16. MicroServicePolicy</a></h3>
4046 <table class="tableblock frame-all grid-all stretch">
4048 <col style="width: 42.8571%;">
4049 <col style="width: 57.1429%;">
4053 <th class="tableblock halign-left valign-middle">Name</th>
4054 <th class="tableblock halign-left valign-middle">Schema</th>
4059 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
4060 <em>optional</em></p></td>
4061 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>context</strong><br>
4065 <em>optional</em></p></td>
4066 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4069 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4070 <em>optional</em></p></td>
4071 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4074 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4075 <em>optional</em></p></td>
4076 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4079 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
4080 <em>optional</em></p></td>
4081 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
4085 <em>optional</em></p></td>
4086 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4089 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
4090 <em>optional</em></p></td>
4091 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4094 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deviceTypeScope</strong><br>
4095 <em>optional</em></p></td>
4096 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4099 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
4100 <em>optional</em></p></td>
4101 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>legacy</strong><br>
4105 <em>optional</em></p></td>
4106 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4109 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
4110 <em>optional</em></p></td>
4111 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
4114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4115 <em>optional</em></p></td>
4116 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4119 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
4120 <em>optional</em></p></td>
4121 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
4125 <em>optional</em></p></td>
4126 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4129 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
4130 <em>optional</em></p></td>
4131 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
4134 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
4135 <em>optional</em></p></td>
4136 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4139 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4140 <em>optional</em></p></td>
4141 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4144 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4145 <em>optional</em></p></td>
4146 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4149 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
4150 <em>optional</em></p></td>
4151 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_loop">Loop</a> > array</p></td>
4157 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.17. Number</a></h3>
4158 <div class="paragraph">
4159 <p><em>Type</em> : object</p>
4163 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.18. OperationalPolicy</a></h3>
4164 <table class="tableblock frame-all grid-all stretch">
4166 <col style="width: 42.8571%;">
4167 <col style="width: 57.1429%;">
4171 <th class="tableblock halign-left valign-middle">Name</th>
4172 <th class="tableblock halign-left valign-middle">Schema</th>
4177 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
4178 <em>optional</em></p></td>
4179 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4182 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4183 <em>optional</em></p></td>
4184 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4188 <em>optional</em></p></td>
4189 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4192 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
4193 <em>optional</em></p></td>
4194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4197 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>legacy</strong><br>
4198 <em>optional</em></p></td>
4199 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4202 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
4203 <em>optional</em></p></td>
4204 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
4207 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
4208 <em>optional</em></p></td>
4209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
4212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4213 <em>optional</em></p></td>
4214 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4217 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
4218 <em>optional</em></p></td>
4219 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4222 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
4223 <em>optional</em></p></td>
4224 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4227 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
4228 <em>optional</em></p></td>
4229 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
4232 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4233 <em>optional</em></p></td>
4234 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4237 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4238 <em>optional</em></p></td>
4239 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4245 <h3 id="_policymodel"><a class="anchor" href="#_policymodel"></a><a class="link" href="#_policymodel">3.19. PolicyModel</a></h3>
4246 <table class="tableblock frame-all grid-all stretch">
4248 <col style="width: 42.8571%;">
4249 <col style="width: 57.1429%;">
4253 <th class="tableblock halign-left valign-middle">Name</th>
4254 <th class="tableblock halign-left valign-middle">Schema</th>
4259 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4260 <em>optional</em></p></td>
4261 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4264 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4265 <em>optional</em></p></td>
4266 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4269 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyAcronym</strong><br>
4270 <em>optional</em></p></td>
4271 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4274 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelTosca</strong><br>
4275 <em>optional</em></p></td>
4276 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4279 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
4280 <em>optional</em></p></td>
4281 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4284 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyPdpGroup</strong><br>
4285 <em>optional</em></p></td>
4286 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4289 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4290 <em>optional</em></p></td>
4291 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4294 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4295 <em>optional</em></p></td>
4296 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4299 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByElementModels</strong><br>
4300 <em>optional</em></p></td>
4301 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_loopelementmodel">LoopElementModel</a> > array</p></td>
4304 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
4305 <em>optional</em></p></td>
4306 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4312 <h3 id="_service"><a class="anchor" href="#_service"></a><a class="link" href="#_service">3.20. Service</a></h3>
4313 <table class="tableblock frame-all grid-all stretch">
4315 <col style="width: 42.8571%;">
4316 <col style="width: 57.1429%;">
4320 <th class="tableblock halign-left valign-middle">Name</th>
4321 <th class="tableblock halign-left valign-middle">Schema</th>
4326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4327 <em>optional</em></p></td>
4328 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceDetails</strong><br>
4332 <em>optional</em></p></td>
4333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceDetails</strong><br>
4337 <em>optional</em></p></td>
4338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4341 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUuid</strong><br>
4342 <em>optional</em></p></td>
4343 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4346 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
4347 <em>optional</em></p></td>
4348 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4357 <div id="footer-text">
4358 Last updated 2020-02-12 11:20:53 CET