Fix the CDS calls
[clamp.git] / src / main / resources / META-INF / resources / swagger.html
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8">
5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
7 <meta name="generator" content="Asciidoctor 1.5.7.1">
8 <title>Clamp Rest API</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
10 <style>
11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
12 /* Uncomment @import statement below to use as custom stylesheet */
13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
15 audio,canvas,video{display:inline-block}
16 audio:not([controls]){display:none;height:0}
17 script{display:none!important}
18 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
19 a{background:transparent}
20 a:focus{outline:thin dotted}
21 a:active,a:hover{outline:0}
22 h1{font-size:2em;margin:.67em 0}
23 abbr[title]{border-bottom:1px dotted}
24 b,strong{font-weight:bold}
25 dfn{font-style:italic}
26 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
27 mark{background:#ff0;color:#000}
28 code,kbd,pre,samp{font-family:monospace;font-size:1em}
29 pre{white-space:pre-wrap}
30 q{quotes:"\201C" "\201D" "\2018" "\2019"}
31 small{font-size:80%}
32 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
33 sup{top:-.5em}
34 sub{bottom:-.25em}
35 img{border:0}
36 svg:not(:root){overflow:hidden}
37 figure{margin:0}
38 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
39 legend{border:0;padding:0}
40 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
41 button,input{line-height:normal}
42 button,select{text-transform:none}
43 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
44 button[disabled],html input[disabled]{cursor:default}
45 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
46 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
47 textarea{overflow:auto;vertical-align:top}
48 table{border-collapse:collapse;border-spacing:0}
49 *,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
50 html,body{font-size:100%}
51 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
52 a:hover{cursor:pointer}
53 img,object,embed{max-width:100%;height:auto}
54 object,embed{height:100%}
55 img{-ms-interpolation-mode:bicubic}
56 .left{float:left!important}
57 .right{float:right!important}
58 .text-left{text-align:left!important}
59 .text-right{text-align:right!important}
60 .text-center{text-align:center!important}
61 .text-justify{text-align:justify!important}
62 .hide{display:none}
63 img,object,svg{display:inline-block;vertical-align:middle}
64 textarea{height:auto;min-height:50px}
65 select{width:100%}
66 .center{margin-left:auto;margin-right:auto}
67 .stretch{width:100%}
68 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
69 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
70 a{color:#2156a5;text-decoration:underline;line-height:inherit}
71 a:hover,a:focus{color:#1d4b8f}
72 a img{border:none}
73 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
74 p aside{font-size:.875em;line-height:1.35;font-style:italic}
75 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
76 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
77 h1{font-size:2.125em}
78 h2{font-size:1.6875em}
79 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
80 h4,h5{font-size:1.125em}
81 h6{font-size:1em}
82 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
83 em,i{font-style:italic;line-height:inherit}
84 strong,b{font-weight:bold;line-height:inherit}
85 small{font-size:60%;line-height:inherit}
86 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
87 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
88 ul,ol{margin-left:1.5em}
89 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
90 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
91 ul.square{list-style-type:square}
92 ul.circle{list-style-type:circle}
93 ul.disc{list-style-type:disc}
94 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
95 dl dt{margin-bottom:.3125em;font-weight:bold}
96 dl dd{margin-bottom:1.25em}
97 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
98 abbr{text-transform:none}
99 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
100 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
101 blockquote cite::before{content:"\2014 \0020"}
102 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
103 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
104 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
105 h1{font-size:2.75em}
106 h2{font-size:2.3125em}
107 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
108 h4{font-size:1.4375em}}
109 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
110 table thead,table tfoot{background:#f7f8f7}
111 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
112 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
113 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
114 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
115 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
116 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
117 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
118 .clearfix::after,.float-group::after{clear:both}
119 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
120 *:not(pre)>code.nobreak{word-wrap:normal}
121 *:not(pre)>code.nowrap{white-space:nowrap}
122 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
123 em em{font-style:normal}
124 strong strong{font-weight:400}
125 .keyseq{color:rgba(51,51,51,.8)}
126 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
127 .keyseq kbd:first-child{margin-left:0}
128 .keyseq kbd:last-child{margin-right:0}
129 .menuseq,.menuref{color:#000}
130 .menuseq b:not(.caret),.menuref{font-weight:inherit}
131 .menuseq{word-spacing:-.02em}
132 .menuseq b.caret{font-size:1.25em;line-height:.8}
133 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
134 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
135 b.button::before{content:"[";padding:0 3px 0 2px}
136 b.button::after{content:"]";padding:0 2px 0 3px}
137 p a>code:hover{color:rgba(0,0,0,.9)}
138 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
139 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
140 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
141 #content{margin-top:1.25em}
142 #content::before{content:none}
143 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
144 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
145 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
146 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
147 #header .details span:first-child{margin-left:-.125em}
148 #header .details span.email a{color:rgba(0,0,0,.85)}
149 #header .details br{display:none}
150 #header .details br+span::before{content:"\00a0\2013\00a0"}
151 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
152 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
153 #header #revnumber{text-transform:capitalize}
154 #header #revnumber::after{content:"\00a0"}
155 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
156 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
157 #toc>ul{margin-left:.125em}
158 #toc ul.sectlevel0>li>a{font-style:italic}
159 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
160 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
161 #toc li{line-height:1.3334;margin-top:.3334em}
162 #toc a{text-decoration:none}
163 #toc a:active{text-decoration:underline}
164 #toctitle{color:#7a2518;font-size:1.2em}
165 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
166 body.toc2{padding-left:15em;padding-right:0}
167 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
168 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
169 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
170 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
171 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
172 body.toc2.toc-right{padding-left:0;padding-right:15em}
173 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
174 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
175 #toc.toc2{width:20em}
176 #toc.toc2 #toctitle{font-size:1.375em}
177 #toc.toc2>ul{font-size:.95em}
178 #toc.toc2 ul ul{padding-left:1.25em}
179 body.toc2.toc-right{padding-left:0;padding-right:20em}}
180 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
181 #content #toc>:first-child{margin-top:0}
182 #content #toc>:last-child{margin-bottom:0}
183 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
184 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
185 #content{margin-bottom:.625em}
186 .sect1{padding-bottom:.625em}
187 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
188 .sect1{padding-bottom:1.25em}}
189 .sect1:last-child{padding-bottom:0}
190 .sect1+.sect1{border-top:1px solid #efefed}
191 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
192 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
193 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
194 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
195 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
196 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
197 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
198 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
199 .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
200 table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
201 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
202 .admonitionblock>table td.icon{text-align:center;width:80px}
203 .admonitionblock>table td.icon img{max-width:none}
204 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
205 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
206 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
207 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
208 .exampleblock>.content>:first-child{margin-top:0}
209 .exampleblock>.content>:last-child{margin-bottom:0}
210 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
211 .sidebarblock>:first-child{margin-top:0}
212 .sidebarblock>:last-child{margin-bottom:0}
213 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
216 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
217 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
218 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
219 @media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
220 @media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
221 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
222 .listingblock pre.highlightjs{padding:0}
223 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
224 .listingblock pre.prettyprint{border-width:0}
225 .listingblock>.content{position:relative}
226 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
227 .listingblock:hover code[data-lang]::before{display:block}
228 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999}
229 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
230 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
231 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
232 table.pyhltable td.code{padding-left:.75em;padding-right:0}
233 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
234 pre.pygments .lineno{display:inline-block;margin-right:.25em}
235 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
236 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
237 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
238 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
239 .quoteblock blockquote{margin:0;padding:0;border:0}
240 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
241 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
242 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
243 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
244 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
245 .quoteblock .quoteblock blockquote::before{display:none}
246 .verseblock{margin:0 1em 1.25em}
247 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248 .verseblock pre strong{font-weight:400}
249 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251 .quoteblock .attribution br,.verseblock .attribution br{display:none}
252 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
254 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{word-spacing:0;line-height:1.6}
256 .quoteblock.abstract blockquote::before,.quoteblock.abstract p::before{display:none}
257 table.tableblock{max-width:100%;border-collapse:separate}
258 p.tableblock:last-child{margin-bottom:0}
259 td.tableblock>.content{margin-bottom:-1.25em}
260 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
261 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
262 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
263 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
264 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
265 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
266 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
267 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
268 table.frame-all{border-width:1px}
269 table.frame-sides{border-width:0 1px}
270 table.frame-topbot,table.frame-ends{border-width:1px 0}
271 table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7}
272 table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none}
273 th.halign-left,td.halign-left{text-align:left}
274 th.halign-right,td.halign-right{text-align:right}
275 th.halign-center,td.halign-center{text-align:center}
276 th.valign-top,td.valign-top{vertical-align:top}
277 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
278 th.valign-middle,td.valign-middle{vertical-align:middle}
279 table thead th,table tfoot th{font-weight:bold}
280 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
281 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
282 p.tableblock>code:only-child{background:none;padding:0}
283 p.tableblock{font-size:1em}
284 td>div.verse{white-space:pre}
285 ol{margin-left:1.75em}
286 ul li ol{margin-left:1.5em}
287 dl dd{margin-left:1.125em}
288 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
289 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
290 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
291 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
292 ul.unstyled,ol.unstyled{margin-left:0}
293 ul.checklist{margin-left:.625em}
294 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
295 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
296 ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
297 ul.inline>li{margin-left:1.25em}
298 .unstyled dl dt{font-weight:400;font-style:normal}
299 ol.arabic{list-style-type:decimal}
300 ol.decimal{list-style-type:decimal-leading-zero}
301 ol.loweralpha{list-style-type:lower-alpha}
302 ol.upperalpha{list-style-type:upper-alpha}
303 ol.lowerroman{list-style-type:lower-roman}
304 ol.upperroman{list-style-type:upper-roman}
305 ol.lowergreek{list-style-type:lower-greek}
306 .hdlist>table,.colist>table{border:0;background:none}
307 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
308 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
309 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
310 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
311 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
312 .colist td:not([class]):first-child img{max-width:none}
313 .colist td:not([class]):last-child{padding:.25em 0}
314 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
315 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
316 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
317 .imageblock>.title{margin-bottom:0}
318 .imageblock.thumb,.imageblock.th{border-width:6px}
319 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
320 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
321 .image.left{margin-right:.625em}
322 .image.right{margin-left:.625em}
323 a.image{text-decoration:none;display:inline-block}
324 a.image object{pointer-events:none}
325 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
326 sup.footnote a,sup.footnoteref a{text-decoration:none}
327 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
328 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
329 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
330 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
331 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
332 #footnotes .footnote:last-of-type{margin-bottom:0}
333 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
334 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
335 .gist .file-data>table td.line-data{width:99%}
336 div.unbreakable{page-break-inside:avoid}
337 .big{font-size:larger}
338 .small{font-size:smaller}
339 .underline{text-decoration:underline}
340 .overline{text-decoration:overline}
341 .line-through{text-decoration:line-through}
342 .aqua{color:#00bfbf}
343 .aqua-background{background-color:#00fafa}
344 .black{color:#000}
345 .black-background{background-color:#000}
346 .blue{color:#0000bf}
347 .blue-background{background-color:#0000fa}
348 .fuchsia{color:#bf00bf}
349 .fuchsia-background{background-color:#fa00fa}
350 .gray{color:#606060}
351 .gray-background{background-color:#7d7d7d}
352 .green{color:#006000}
353 .green-background{background-color:#007d00}
354 .lime{color:#00bf00}
355 .lime-background{background-color:#00fa00}
356 .maroon{color:#600000}
357 .maroon-background{background-color:#7d0000}
358 .navy{color:#000060}
359 .navy-background{background-color:#00007d}
360 .olive{color:#606000}
361 .olive-background{background-color:#7d7d00}
362 .purple{color:#600060}
363 .purple-background{background-color:#7d007d}
364 .red{color:#bf0000}
365 .red-background{background-color:#fa0000}
366 .silver{color:#909090}
367 .silver-background{background-color:#bcbcbc}
368 .teal{color:#006060}
369 .teal-background{background-color:#007d7d}
370 .white{color:#bfbfbf}
371 .white-background{background-color:#fafafa}
372 .yellow{color:#bfbf00}
373 .yellow-background{background-color:#fafa00}
374 span.icon>.fa{cursor:default}
375 a span.icon>.fa{cursor:inherit}
376 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
377 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
378 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
379 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
380 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
381 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
382 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
383 .conum[data-value] *{color:#fff!important}
384 .conum[data-value]+b{display:none}
385 .conum[data-value]::after{content:attr(data-value)}
386 pre .conum[data-value]{position:relative;top:-.125em}
387 b.conum *{color:inherit!important}
388 .conum:not([data-value]):empty{display:none}
389 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
390 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
391 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
392 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
393 p{margin-bottom:1.25rem}
394 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
395 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
396 .print-only{display:none!important}
397 @page{margin:1.25cm .75cm}
398 @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
399 html{font-size:80%}
400 a{color:inherit!important;text-decoration:underline!important}
401 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
402 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
403 abbr[title]::after{content:" (" attr(title) ")"}
404 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
405 thead{display:table-header-group}
406 svg{max-width:100%}
407 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
408 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
409 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
410 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
411 body.book #header{text-align:center}
412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
413 body.book #header .details{border:0!important;display:block;padding:0!important}
414 body.book #header .details span:first-child{margin-left:0!important}
415 body.book #header .details br{display:block}
416 body.book #header .details br+span::before{content:none!important}
417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
419 .listingblock code[data-lang]::before{display:block}
420 #footer{padding:0 .9375em}
421 .hide-on-print{display:none!important}
422 .print-only{display:block!important}
423 .hide-for-print{display:none!important}
424 .show-for-print{display:inherit!important}}
425 @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
426 .sect1{padding:0!important}
427 .sect1+.sect1{border:0}
428 #footer{background:none}
429 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
430 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
431 </style>
432 </head>
433 <body class="book toc2 toc-left">
434 <div id="header">
435 <h1>Clamp Rest API</h1>
436 <div id="toc" class="toc2">
437 <div id="toctitle">Table of Contents</div>
438 <ul class="sectlevel1">
439 <li><a href="#_overview">1. Overview</a>
440 <ul class="sectlevel2">
441 <li><a href="#_version_information">1.1. Version information</a></li>
442 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
443 </ul>
444 </li>
445 <li><a href="#_paths">2. Paths</a>
446 <ul class="sectlevel2">
447 <li><a href="#_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>
451 </ul>
452 </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>
457 </ul>
458 </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>
463 </ul>
464 </li>
465 <li><a href="#_route98">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>
469 </ul>
470 </li>
471 <li><a href="#_route100">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>
477 </ul>
478 </li>
479 <li><a href="#_v2_dictionary_secondary_names_get">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>
483 </ul>
484 </li>
485 <li><a href="#_v2_dictionary_dictionaryname_get">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>
490 </ul>
491 </li>
492 <li><a href="#_v2_dictionary_name_put">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>
498 </ul>
499 </li>
500 <li><a href="#_route102">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>
505 </ul>
506 </li>
507 <li><a href="#_v2_dictionary_name_elements_shortname_delete">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>
512 </ul>
513 </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>
519 </ul>
520 </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>
527 </ul>
528 </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>
533 </ul>
534 </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>
540 </ul>
541 </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>
546 </ul>
547 </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>
553 </ul>
554 </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>
560 </ul>
561 </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>
567 </ul>
568 </li>
569 <li><a href="#_route94">2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}</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>
574 </ul>
575 </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>
581 </ul>
582 </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>
588 </ul>
589 </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>
595 </ul>
596 </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>
602 </ul>
603 </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>
609 </ul>
610 </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>
617 </ul>
618 </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>
625 </ul>
626 </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>
633 </ul>
634 </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>
640 </ul>
641 </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>
648 </ul>
649 </li>
650 <li><a href="#_route105">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>
654 </ul>
655 </li>
656 <li><a href="#_v2_policytoscamodels_yaml_policymodeltype_policymodelversion_get">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>
661 </ul>
662 </li>
663 <li><a href="#_v2_policytoscamodels_policymodeltype_policymodelversion_get">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>
668 </ul>
669 </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>
676 </ul>
677 </li>
678 <li><a href="#_route111">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>
682 </ul>
683 </li>
684 <li><a href="#_v2_templates_names_get">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>
688 </ul>
689 </li>
690 <li><a href="#_v2_templates_templatename_get">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>
695 </ul>
696 </li>
697 <li><a href="#_v2_templates_templatename_svgrepresentation_get">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>
702 </ul>
703 </li>
704 </ul>
705 </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>
728 </ul>
729 </li>
730 </ul>
731 </div>
732 </div>
733 <div id="content">
734 <div class="sect1">
735 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
736 <div class="sectionbody">
737 <div class="sect2">
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.0.0-SNAPSHOT</p>
741 </div>
742 </div>
743 <div class="sect2">
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:42393<br>
747 <em>BasePath</em> : /restservices/clds/<br>
748 <em>Schemes</em> : HTTP</p>
749 </div>
750 </div>
751 </div>
752 </div>
753 <div class="sect1">
754 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
755 <div class="sectionbody">
756 <div class="sect2">
757 <h3 id="_route113"><a class="anchor" href="#_route113"></a><a class="link" href="#_route113">2.1. GET /v1/healthcheck</a></h3>
758 <div class="sect3">
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">
761 <colgroup>
762 <col style="width: 10%;">
763 <col style="width: 70%;">
764 <col style="width: 20%;">
765 </colgroup>
766 <thead>
767 <tr>
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>
771 </tr>
772 </thead>
773 <tbody>
774 <tr>
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>
778 </tr>
779 </tbody>
780 </table>
781 </div>
782 <div class="sect3">
783 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
784 <div class="ulist">
785 <ul>
786 <li>
787 <p><code>application/json</code></p>
788 </li>
789 </ul>
790 </div>
791 </div>
792 </div>
793 <div class="sect2">
794 <h3 id="_route114"><a class="anchor" href="#_route114"></a><a class="link" href="#_route114">2.2. GET /v1/user/getUser</a></h3>
795 <div class="sect3">
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">
798 <colgroup>
799 <col style="width: 33.3333%;">
800 <col style="width: 66.6667%;">
801 </colgroup>
802 <thead>
803 <tr>
804 <th class="tableblock halign-left valign-middle">HTTP Code</th>
805 <th class="tableblock halign-left valign-middle">Schema</th>
806 </tr>
807 </thead>
808 <tbody>
809 <tr>
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>
812 </tr>
813 </tbody>
814 </table>
815 </div>
816 <div class="sect3">
817 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
818 <div class="ulist">
819 <ul>
820 <li>
821 <p><code>text/plain</code></p>
822 </li>
823 </ul>
824 </div>
825 </div>
826 </div>
827 <div class="sect2">
828 <h3 id="_route112"><a class="anchor" href="#_route112"></a><a class="link" href="#_route112">2.3. GET /v2/clampInformation</a></h3>
829 <div class="sect3">
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">
832 <colgroup>
833 <col style="width: 10%;">
834 <col style="width: 70%;">
835 <col style="width: 20%;">
836 </colgroup>
837 <thead>
838 <tr>
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>
842 </tr>
843 </thead>
844 <tbody>
845 <tr>
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>
849 </tr>
850 </tbody>
851 </table>
852 </div>
853 <div class="sect3">
854 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
855 <div class="ulist">
856 <ul>
857 <li>
858 <p><code>application/json</code></p>
859 </li>
860 </ul>
861 </div>
862 </div>
863 </div>
864 <div class="sect2">
865 <h3 id="_route98"><a class="anchor" href="#_route98"></a><a class="link" href="#_route98">2.4. GET /v2/dictionary</a></h3>
866 <div class="sect3">
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">
869 <colgroup>
870 <col style="width: 10%;">
871 <col style="width: 70%;">
872 <col style="width: 20%;">
873 </colgroup>
874 <thead>
875 <tr>
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>
879 </tr>
880 </thead>
881 <tbody>
882 <tr>
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>
886 </tr>
887 </tbody>
888 </table>
889 </div>
890 <div class="sect3">
891 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.2. Produces</a></h4>
892 <div class="ulist">
893 <ul>
894 <li>
895 <p><code>application/json</code></p>
896 </li>
897 </ul>
898 </div>
899 </div>
900 </div>
901 <div class="sect2">
902 <h3 id="_route100"><a class="anchor" href="#_route100"></a><a class="link" href="#_route100">2.5. PUT /v2/dictionary</a></h3>
903 <div class="sect3">
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">
906 <colgroup>
907 <col style="width: 22.2222%;">
908 <col style="width: 33.3333%;">
909 <col style="width: 44.4445%;">
910 </colgroup>
911 <thead>
912 <tr>
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>
916 </tr>
917 </thead>
918 <tbody>
919 <tr>
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>
924 </tr>
925 </tbody>
926 </table>
927 </div>
928 <div class="sect3">
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">
931 <colgroup>
932 <col style="width: 10%;">
933 <col style="width: 70%;">
934 <col style="width: 20%;">
935 </colgroup>
936 <thead>
937 <tr>
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>
941 </tr>
942 </thead>
943 <tbody>
944 <tr>
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>
948 </tr>
949 </tbody>
950 </table>
951 </div>
952 <div class="sect3">
953 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.5.3. Consumes</a></h4>
954 <div class="ulist">
955 <ul>
956 <li>
957 <p><code>application/json</code></p>
958 </li>
959 </ul>
960 </div>
961 </div>
962 <div class="sect3">
963 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
964 <div class="ulist">
965 <ul>
966 <li>
967 <p><code>application/json</code></p>
968 </li>
969 </ul>
970 </div>
971 </div>
972 </div>
973 <div class="sect2">
974 <h3 id="_v2_dictionary_secondary_names_get"><a class="anchor" href="#_v2_dictionary_secondary_names_get"></a><a class="link" href="#_v2_dictionary_secondary_names_get">2.6. GET /v2/dictionary/secondary/names</a></h3>
975 <div class="sect3">
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">
978 <colgroup>
979 <col style="width: 10%;">
980 <col style="width: 70%;">
981 <col style="width: 20%;">
982 </colgroup>
983 <thead>
984 <tr>
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>
988 </tr>
989 </thead>
990 <tbody>
991 <tr>
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">&lt; string &gt; array</p></td>
995 </tr>
996 </tbody>
997 </table>
998 </div>
999 <div class="sect3">
1000 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
1001 <div class="ulist">
1002 <ul>
1003 <li>
1004 <p><code>application/json</code></p>
1005 </li>
1006 </ul>
1007 </div>
1008 </div>
1009 </div>
1010 <div class="sect2">
1011 <h3 id="_v2_dictionary_dictionaryname_get"><a class="anchor" href="#_v2_dictionary_dictionaryname_get"></a><a class="link" href="#_v2_dictionary_dictionaryname_get">2.7. GET /v2/dictionary/{dictionaryName}</a></h3>
1012 <div class="sect3">
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">
1015 <colgroup>
1016 <col style="width: 22.2222%;">
1017 <col style="width: 33.3333%;">
1018 <col style="width: 44.4445%;">
1019 </colgroup>
1020 <thead>
1021 <tr>
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>
1025 </tr>
1026 </thead>
1027 <tbody>
1028 <tr>
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>
1033 </tr>
1034 </tbody>
1035 </table>
1036 </div>
1037 <div class="sect3">
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">
1040 <colgroup>
1041 <col style="width: 10%;">
1042 <col style="width: 70%;">
1043 <col style="width: 20%;">
1044 </colgroup>
1045 <thead>
1046 <tr>
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>
1050 </tr>
1051 </thead>
1052 <tbody>
1053 <tr>
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>
1057 </tr>
1058 </tbody>
1059 </table>
1060 </div>
1061 <div class="sect3">
1062 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1063 <div class="ulist">
1064 <ul>
1065 <li>
1066 <p><code>application/json</code></p>
1067 </li>
1068 </ul>
1069 </div>
1070 </div>
1071 </div>
1072 <div class="sect2">
1073 <h3 id="_v2_dictionary_name_put"><a class="anchor" href="#_v2_dictionary_name_put"></a><a class="link" href="#_v2_dictionary_name_put">2.8. PUT /v2/dictionary/{name}</a></h3>
1074 <div class="sect3">
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">
1077 <colgroup>
1078 <col style="width: 22.2222%;">
1079 <col style="width: 33.3333%;">
1080 <col style="width: 44.4445%;">
1081 </colgroup>
1082 <thead>
1083 <tr>
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>
1087 </tr>
1088 </thead>
1089 <tbody>
1090 <tr>
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>
1095 </tr>
1096 <tr>
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>
1101 </tr>
1102 </tbody>
1103 </table>
1104 </div>
1105 <div class="sect3">
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">
1108 <colgroup>
1109 <col style="width: 10%;">
1110 <col style="width: 70%;">
1111 <col style="width: 20%;">
1112 </colgroup>
1113 <thead>
1114 <tr>
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>
1118 </tr>
1119 </thead>
1120 <tbody>
1121 <tr>
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>
1125 </tr>
1126 </tbody>
1127 </table>
1128 </div>
1129 <div class="sect3">
1130 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.8.3. Consumes</a></h4>
1131 <div class="ulist">
1132 <ul>
1133 <li>
1134 <p><code>application/json</code></p>
1135 </li>
1136 </ul>
1137 </div>
1138 </div>
1139 <div class="sect3">
1140 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.4. Produces</a></h4>
1141 <div class="ulist">
1142 <ul>
1143 <li>
1144 <p><code>application/json</code></p>
1145 </li>
1146 </ul>
1147 </div>
1148 </div>
1149 </div>
1150 <div class="sect2">
1151 <h3 id="_route102"><a class="anchor" href="#_route102"></a><a class="link" href="#_route102">2.9. DELETE /v2/dictionary/{name}</a></h3>
1152 <div class="sect3">
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">
1155 <colgroup>
1156 <col style="width: 22.2222%;">
1157 <col style="width: 33.3333%;">
1158 <col style="width: 44.4445%;">
1159 </colgroup>
1160 <thead>
1161 <tr>
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>
1165 </tr>
1166 </thead>
1167 <tbody>
1168 <tr>
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>
1173 </tr>
1174 </tbody>
1175 </table>
1176 </div>
1177 <div class="sect3">
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">
1180 <colgroup>
1181 <col style="width: 33.3333%;">
1182 <col style="width: 66.6667%;">
1183 </colgroup>
1184 <thead>
1185 <tr>
1186 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1187 <th class="tableblock halign-left valign-middle">Schema</th>
1188 </tr>
1189 </thead>
1190 <tbody>
1191 <tr>
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>
1194 </tr>
1195 </tbody>
1196 </table>
1197 </div>
1198 <div class="sect3">
1199 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1200 <div class="ulist">
1201 <ul>
1202 <li>
1203 <p><code>application/json</code></p>
1204 </li>
1205 </ul>
1206 </div>
1207 </div>
1208 </div>
1209 <div class="sect2">
1210 <h3 id="_v2_dictionary_name_elements_shortname_delete"><a class="anchor" href="#_v2_dictionary_name_elements_shortname_delete"></a><a class="link" href="#_v2_dictionary_name_elements_shortname_delete">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a></h3>
1211 <div class="sect3">
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">
1214 <colgroup>
1215 <col style="width: 22.2222%;">
1216 <col style="width: 33.3333%;">
1217 <col style="width: 44.4445%;">
1218 </colgroup>
1219 <thead>
1220 <tr>
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>
1224 </tr>
1225 </thead>
1226 <tbody>
1227 <tr>
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>
1232 </tr>
1233 <tr>
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>
1238 </tr>
1239 </tbody>
1240 </table>
1241 </div>
1242 <div class="sect3">
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">
1245 <colgroup>
1246 <col style="width: 33.3333%;">
1247 <col style="width: 66.6667%;">
1248 </colgroup>
1249 <thead>
1250 <tr>
1251 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1252 <th class="tableblock halign-left valign-middle">Schema</th>
1253 </tr>
1254 </thead>
1255 <tbody>
1256 <tr>
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>
1259 </tr>
1260 </tbody>
1261 </table>
1262 </div>
1263 <div class="sect3">
1264 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.3. Produces</a></h4>
1265 <div class="ulist">
1266 <ul>
1267 <li>
1268 <p><code>application/json</code></p>
1269 </li>
1270 </ul>
1271 </div>
1272 </div>
1273 </div>
1274 <div class="sect2">
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>
1276 <div class="sect3">
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">
1279 <colgroup>
1280 <col style="width: 22.2222%;">
1281 <col style="width: 33.3333%;">
1282 <col style="width: 44.4445%;">
1283 </colgroup>
1284 <thead>
1285 <tr>
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>
1289 </tr>
1290 </thead>
1291 <tbody>
1292 <tr>
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>
1297 </tr>
1298 <tr>
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>
1303 </tr>
1304 <tr>
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>
1309 </tr>
1310 </tbody>
1311 </table>
1312 </div>
1313 <div class="sect3">
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">
1316 <colgroup>
1317 <col style="width: 10%;">
1318 <col style="width: 70%;">
1319 <col style="width: 20%;">
1320 </colgroup>
1321 <thead>
1322 <tr>
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>
1326 </tr>
1327 </thead>
1328 <tbody>
1329 <tr>
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>
1333 </tr>
1334 </tbody>
1335 </table>
1336 </div>
1337 <div class="sect3">
1338 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.3. Produces</a></h4>
1339 <div class="ulist">
1340 <ul>
1341 <li>
1342 <p><code>application/json</code></p>
1343 </li>
1344 </ul>
1345 </div>
1346 </div>
1347 </div>
1348 <div class="sect2">
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>
1350 <div class="sect3">
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">
1353 <colgroup>
1354 <col style="width: 22.2222%;">
1355 <col style="width: 33.3333%;">
1356 <col style="width: 44.4445%;">
1357 </colgroup>
1358 <thead>
1359 <tr>
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>
1363 </tr>
1364 </thead>
1365 <tbody>
1366 <tr>
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>
1371 </tr>
1372 </tbody>
1373 </table>
1374 </div>
1375 <div class="sect3">
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">
1378 <colgroup>
1379 <col style="width: 10%;">
1380 <col style="width: 70%;">
1381 <col style="width: 20%;">
1382 </colgroup>
1383 <thead>
1384 <tr>
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>
1388 </tr>
1389 </thead>
1390 <tbody>
1391 <tr>
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>
1395 </tr>
1396 </tbody>
1397 </table>
1398 </div>
1399 <div class="sect3">
1400 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.12.3. Consumes</a></h4>
1401 <div class="ulist">
1402 <ul>
1403 <li>
1404 <p><code>application/json</code></p>
1405 </li>
1406 </ul>
1407 </div>
1408 </div>
1409 <div class="sect3">
1410 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.4. Produces</a></h4>
1411 <div class="ulist">
1412 <ul>
1413 <li>
1414 <p><code>application/json</code></p>
1415 </li>
1416 </ul>
1417 </div>
1418 </div>
1419 </div>
1420 <div class="sect2">
1421 <h3 id="_route91"><a class="anchor" href="#_route91"></a><a class="link" href="#_route91">2.13. PUT /v2/loop/delete/{loopName}</a></h3>
1422 <div class="sect3">
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">
1425 <colgroup>
1426 <col style="width: 22.2222%;">
1427 <col style="width: 33.3333%;">
1428 <col style="width: 44.4445%;">
1429 </colgroup>
1430 <thead>
1431 <tr>
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>
1435 </tr>
1436 </thead>
1437 <tbody>
1438 <tr>
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>
1443 </tr>
1444 </tbody>
1445 </table>
1446 </div>
1447 <div class="sect3">
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">
1450 <colgroup>
1451 <col style="width: 33.3333%;">
1452 <col style="width: 66.6667%;">
1453 </colgroup>
1454 <thead>
1455 <tr>
1456 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1457 <th class="tableblock halign-left valign-middle">Schema</th>
1458 </tr>
1459 </thead>
1460 <tbody>
1461 <tr>
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>
1464 </tr>
1465 </tbody>
1466 </table>
1467 </div>
1468 </div>
1469 <div class="sect2">
1470 <h3 id="_route84"><a class="anchor" href="#_route84"></a><a class="link" href="#_route84">2.14. PUT /v2/loop/deploy/{loopName}</a></h3>
1471 <div class="sect3">
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">
1474 <colgroup>
1475 <col style="width: 22.2222%;">
1476 <col style="width: 33.3333%;">
1477 <col style="width: 44.4445%;">
1478 </colgroup>
1479 <thead>
1480 <tr>
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>
1484 </tr>
1485 </thead>
1486 <tbody>
1487 <tr>
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>
1492 </tr>
1493 </tbody>
1494 </table>
1495 </div>
1496 <div class="sect3">
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">
1499 <colgroup>
1500 <col style="width: 10%;">
1501 <col style="width: 70%;">
1502 <col style="width: 20%;">
1503 </colgroup>
1504 <thead>
1505 <tr>
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>
1509 </tr>
1510 </thead>
1511 <tbody>
1512 <tr>
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>
1516 </tr>
1517 </tbody>
1518 </table>
1519 </div>
1520 <div class="sect3">
1521 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.3. Produces</a></h4>
1522 <div class="ulist">
1523 <ul>
1524 <li>
1525 <p><code>application/json</code></p>
1526 </li>
1527 </ul>
1528 </div>
1529 </div>
1530 </div>
1531 <div class="sect2">
1532 <h3 id="_route78"><a class="anchor" href="#_route78"></a><a class="link" href="#_route78">2.15. GET /v2/loop/getAllNames</a></h3>
1533 <div class="sect3">
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">
1536 <colgroup>
1537 <col style="width: 10%;">
1538 <col style="width: 70%;">
1539 <col style="width: 20%;">
1540 </colgroup>
1541 <thead>
1542 <tr>
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>
1546 </tr>
1547 </thead>
1548 <tbody>
1549 <tr>
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">&lt; string &gt; array</p></td>
1553 </tr>
1554 </tbody>
1555 </table>
1556 </div>
1557 <div class="sect3">
1558 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.2. Produces</a></h4>
1559 <div class="ulist">
1560 <ul>
1561 <li>
1562 <p><code>application/json</code></p>
1563 </li>
1564 </ul>
1565 </div>
1566 </div>
1567 </div>
1568 <div class="sect2">
1569 <h3 id="_route92"><a class="anchor" href="#_route92"></a><a class="link" href="#_route92">2.16. GET /v2/loop/getstatus/{loopName}</a></h3>
1570 <div class="sect3">
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">
1573 <colgroup>
1574 <col style="width: 22.2222%;">
1575 <col style="width: 33.3333%;">
1576 <col style="width: 44.4445%;">
1577 </colgroup>
1578 <thead>
1579 <tr>
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>
1583 </tr>
1584 </thead>
1585 <tbody>
1586 <tr>
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>
1591 </tr>
1592 </tbody>
1593 </table>
1594 </div>
1595 <div class="sect3">
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">
1598 <colgroup>
1599 <col style="width: 10%;">
1600 <col style="width: 70%;">
1601 <col style="width: 20%;">
1602 </colgroup>
1603 <thead>
1604 <tr>
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>
1608 </tr>
1609 </thead>
1610 <tbody>
1611 <tr>
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>
1615 </tr>
1616 </tbody>
1617 </table>
1618 </div>
1619 <div class="sect3">
1620 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1621 <div class="ulist">
1622 <ul>
1623 <li>
1624 <p><code>application/json</code></p>
1625 </li>
1626 </ul>
1627 </div>
1628 </div>
1629 </div>
1630 <div class="sect2">
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>
1632 <div class="sect3">
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">
1635 <colgroup>
1636 <col style="width: 22.2222%;">
1637 <col style="width: 33.3333%;">
1638 <col style="width: 44.4445%;">
1639 </colgroup>
1640 <thead>
1641 <tr>
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>
1645 </tr>
1646 </thead>
1647 <tbody>
1648 <tr>
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>
1653 </tr>
1654 <tr>
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>
1659 </tr>
1660 </tbody>
1661 </table>
1662 </div>
1663 <div class="sect3">
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">
1666 <colgroup>
1667 <col style="width: 10%;">
1668 <col style="width: 70%;">
1669 <col style="width: 20%;">
1670 </colgroup>
1671 <thead>
1672 <tr>
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>
1676 </tr>
1677 </thead>
1678 <tbody>
1679 <tr>
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>
1683 </tr>
1684 </tbody>
1685 </table>
1686 </div>
1687 <div class="sect3">
1688 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.17.3. Produces</a></h4>
1689 <div class="ulist">
1690 <ul>
1691 <li>
1692 <p><code>application/json</code></p>
1693 </li>
1694 </ul>
1695 </div>
1696 </div>
1697 </div>
1698 <div class="sect2">
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>
1700 <div class="sect3">
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">
1703 <colgroup>
1704 <col style="width: 22.2222%;">
1705 <col style="width: 33.3333%;">
1706 <col style="width: 44.4445%;">
1707 </colgroup>
1708 <thead>
1709 <tr>
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>
1713 </tr>
1714 </thead>
1715 <tbody>
1716 <tr>
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>
1721 </tr>
1722 <tr>
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>
1727 </tr>
1728 </tbody>
1729 </table>
1730 </div>
1731 <div class="sect3">
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">
1734 <colgroup>
1735 <col style="width: 10%;">
1736 <col style="width: 70%;">
1737 <col style="width: 20%;">
1738 </colgroup>
1739 <thead>
1740 <tr>
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>
1744 </tr>
1745 </thead>
1746 <tbody>
1747 <tr>
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>
1751 </tr>
1752 </tbody>
1753 </table>
1754 </div>
1755 <div class="sect3">
1756 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.18.3. Produces</a></h4>
1757 <div class="ulist">
1758 <ul>
1759 <li>
1760 <p><code>application/json</code></p>
1761 </li>
1762 </ul>
1763 </div>
1764 </div>
1765 </div>
1766 <div class="sect2">
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}</a></h3>
1768 <div class="sect3">
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">
1771 <colgroup>
1772 <col style="width: 22.2222%;">
1773 <col style="width: 33.3333%;">
1774 <col style="width: 44.4445%;">
1775 </colgroup>
1776 <thead>
1777 <tr>
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>
1781 </tr>
1782 </thead>
1783 <tbody>
1784 <tr>
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>
1789 </tr>
1790 <tr>
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>policyType</strong><br>
1793 <em>required</em></p></td>
1794 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1795 </tr>
1796 <tr>
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>policyVersion</strong><br>
1799 <em>required</em></p></td>
1800 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1801 </tr>
1802 </tbody>
1803 </table>
1804 </div>
1805 <div class="sect3">
1806 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1807 <table class="tableblock frame-all grid-all stretch">
1808 <colgroup>
1809 <col style="width: 10%;">
1810 <col style="width: 70%;">
1811 <col style="width: 20%;">
1812 </colgroup>
1813 <thead>
1814 <tr>
1815 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1816 <th class="tableblock halign-left valign-middle">Description</th>
1817 <th class="tableblock halign-left valign-middle">Schema</th>
1818 </tr>
1819 </thead>
1820 <tbody>
1821 <tr>
1822 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1823 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1824 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1825 </tr>
1826 </tbody>
1827 </table>
1828 </div>
1829 <div class="sect3">
1830 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.19.3. Produces</a></h4>
1831 <div class="ulist">
1832 <ul>
1833 <li>
1834 <p><code>application/json</code></p>
1835 </li>
1836 </ul>
1837 </div>
1838 </div>
1839 </div>
1840 <div class="sect2">
1841 <h3 id="_route89"><a class="anchor" href="#_route89"></a><a class="link" href="#_route89">2.20. PUT /v2/loop/restart/{loopName}</a></h3>
1842 <div class="sect3">
1843 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.20.1. Parameters</a></h4>
1844 <table class="tableblock frame-all grid-all stretch">
1845 <colgroup>
1846 <col style="width: 22.2222%;">
1847 <col style="width: 33.3333%;">
1848 <col style="width: 44.4445%;">
1849 </colgroup>
1850 <thead>
1851 <tr>
1852 <th class="tableblock halign-left valign-middle">Type</th>
1853 <th class="tableblock halign-left valign-middle">Name</th>
1854 <th class="tableblock halign-left valign-middle">Schema</th>
1855 </tr>
1856 </thead>
1857 <tbody>
1858 <tr>
1859 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1861 <em>required</em></p></td>
1862 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1863 </tr>
1864 </tbody>
1865 </table>
1866 </div>
1867 <div class="sect3">
1868 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.2. Responses</a></h4>
1869 <table class="tableblock frame-all grid-all stretch">
1870 <colgroup>
1871 <col style="width: 10%;">
1872 <col style="width: 70%;">
1873 <col style="width: 20%;">
1874 </colgroup>
1875 <thead>
1876 <tr>
1877 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1878 <th class="tableblock halign-left valign-middle">Description</th>
1879 <th class="tableblock halign-left valign-middle">Schema</th>
1880 </tr>
1881 </thead>
1882 <tbody>
1883 <tr>
1884 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1885 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1886 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1887 </tr>
1888 </tbody>
1889 </table>
1890 </div>
1891 <div class="sect3">
1892 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.20.3. Produces</a></h4>
1893 <div class="ulist">
1894 <ul>
1895 <li>
1896 <p><code>application/json</code></p>
1897 </li>
1898 </ul>
1899 </div>
1900 </div>
1901 </div>
1902 <div class="sect2">
1903 <h3 id="_route88"><a class="anchor" href="#_route88"></a><a class="link" href="#_route88">2.21. PUT /v2/loop/stop/{loopName}</a></h3>
1904 <div class="sect3">
1905 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.21.1. Parameters</a></h4>
1906 <table class="tableblock frame-all grid-all stretch">
1907 <colgroup>
1908 <col style="width: 22.2222%;">
1909 <col style="width: 33.3333%;">
1910 <col style="width: 44.4445%;">
1911 </colgroup>
1912 <thead>
1913 <tr>
1914 <th class="tableblock halign-left valign-middle">Type</th>
1915 <th class="tableblock halign-left valign-middle">Name</th>
1916 <th class="tableblock halign-left valign-middle">Schema</th>
1917 </tr>
1918 </thead>
1919 <tbody>
1920 <tr>
1921 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1922 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1923 <em>required</em></p></td>
1924 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1925 </tr>
1926 </tbody>
1927 </table>
1928 </div>
1929 <div class="sect3">
1930 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
1931 <table class="tableblock frame-all grid-all stretch">
1932 <colgroup>
1933 <col style="width: 10%;">
1934 <col style="width: 70%;">
1935 <col style="width: 20%;">
1936 </colgroup>
1937 <thead>
1938 <tr>
1939 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1940 <th class="tableblock halign-left valign-middle">Description</th>
1941 <th class="tableblock halign-left valign-middle">Schema</th>
1942 </tr>
1943 </thead>
1944 <tbody>
1945 <tr>
1946 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1947 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1948 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1949 </tr>
1950 </tbody>
1951 </table>
1952 </div>
1953 <div class="sect3">
1954 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.21.3. Produces</a></h4>
1955 <div class="ulist">
1956 <ul>
1957 <li>
1958 <p><code>application/json</code></p>
1959 </li>
1960 </ul>
1961 </div>
1962 </div>
1963 </div>
1964 <div class="sect2">
1965 <h3 id="_route90"><a class="anchor" href="#_route90"></a><a class="link" href="#_route90">2.22. PUT /v2/loop/submit/{loopName}</a></h3>
1966 <div class="sect3">
1967 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.22.1. Parameters</a></h4>
1968 <table class="tableblock frame-all grid-all stretch">
1969 <colgroup>
1970 <col style="width: 22.2222%;">
1971 <col style="width: 33.3333%;">
1972 <col style="width: 44.4445%;">
1973 </colgroup>
1974 <thead>
1975 <tr>
1976 <th class="tableblock halign-left valign-middle">Type</th>
1977 <th class="tableblock halign-left valign-middle">Name</th>
1978 <th class="tableblock halign-left valign-middle">Schema</th>
1979 </tr>
1980 </thead>
1981 <tbody>
1982 <tr>
1983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1984 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1985 <em>required</em></p></td>
1986 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1987 </tr>
1988 </tbody>
1989 </table>
1990 </div>
1991 <div class="sect3">
1992 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.2. Responses</a></h4>
1993 <table class="tableblock frame-all grid-all stretch">
1994 <colgroup>
1995 <col style="width: 10%;">
1996 <col style="width: 70%;">
1997 <col style="width: 20%;">
1998 </colgroup>
1999 <thead>
2000 <tr>
2001 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2002 <th class="tableblock halign-left valign-middle">Description</th>
2003 <th class="tableblock halign-left valign-middle">Schema</th>
2004 </tr>
2005 </thead>
2006 <tbody>
2007 <tr>
2008 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2009 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2011 </tr>
2012 </tbody>
2013 </table>
2014 </div>
2015 <div class="sect3">
2016 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.22.3. Produces</a></h4>
2017 <div class="ulist">
2018 <ul>
2019 <li>
2020 <p><code>application/json</code></p>
2021 </li>
2022 </ul>
2023 </div>
2024 </div>
2025 </div>
2026 <div class="sect2">
2027 <h3 id="_route80"><a class="anchor" href="#_route80"></a><a class="link" href="#_route80">2.23. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
2028 <div class="sect3">
2029 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.23.1. Parameters</a></h4>
2030 <table class="tableblock frame-all grid-all stretch">
2031 <colgroup>
2032 <col style="width: 22.2222%;">
2033 <col style="width: 33.3333%;">
2034 <col style="width: 44.4445%;">
2035 </colgroup>
2036 <thead>
2037 <tr>
2038 <th class="tableblock halign-left valign-middle">Type</th>
2039 <th class="tableblock halign-left valign-middle">Name</th>
2040 <th class="tableblock halign-left valign-middle">Schema</th>
2041 </tr>
2042 </thead>
2043 <tbody>
2044 <tr>
2045 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2046 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2047 <em>required</em></p></td>
2048 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2049 </tr>
2050 </tbody>
2051 </table>
2052 </div>
2053 <div class="sect3">
2054 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.2. Responses</a></h4>
2055 <table class="tableblock frame-all grid-all stretch">
2056 <colgroup>
2057 <col style="width: 10%;">
2058 <col style="width: 70%;">
2059 <col style="width: 20%;">
2060 </colgroup>
2061 <thead>
2062 <tr>
2063 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2064 <th class="tableblock halign-left valign-middle">Description</th>
2065 <th class="tableblock halign-left valign-middle">Schema</th>
2066 </tr>
2067 </thead>
2068 <tbody>
2069 <tr>
2070 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2071 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2072 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2073 </tr>
2074 </tbody>
2075 </table>
2076 </div>
2077 <div class="sect3">
2078 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.23.3. Produces</a></h4>
2079 <div class="ulist">
2080 <ul>
2081 <li>
2082 <p><code>application/xml</code></p>
2083 </li>
2084 </ul>
2085 </div>
2086 </div>
2087 </div>
2088 <div class="sect2">
2089 <h3 id="_route87"><a class="anchor" href="#_route87"></a><a class="link" href="#_route87">2.24. PUT /v2/loop/undeploy/{loopName}</a></h3>
2090 <div class="sect3">
2091 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.24.1. Parameters</a></h4>
2092 <table class="tableblock frame-all grid-all stretch">
2093 <colgroup>
2094 <col style="width: 22.2222%;">
2095 <col style="width: 33.3333%;">
2096 <col style="width: 44.4445%;">
2097 </colgroup>
2098 <thead>
2099 <tr>
2100 <th class="tableblock halign-left valign-middle">Type</th>
2101 <th class="tableblock halign-left valign-middle">Name</th>
2102 <th class="tableblock halign-left valign-middle">Schema</th>
2103 </tr>
2104 </thead>
2105 <tbody>
2106 <tr>
2107 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2108 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2109 <em>required</em></p></td>
2110 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2111 </tr>
2112 </tbody>
2113 </table>
2114 </div>
2115 <div class="sect3">
2116 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.2. Responses</a></h4>
2117 <table class="tableblock frame-all grid-all stretch">
2118 <colgroup>
2119 <col style="width: 10%;">
2120 <col style="width: 70%;">
2121 <col style="width: 20%;">
2122 </colgroup>
2123 <thead>
2124 <tr>
2125 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2126 <th class="tableblock halign-left valign-middle">Description</th>
2127 <th class="tableblock halign-left valign-middle">Schema</th>
2128 </tr>
2129 </thead>
2130 <tbody>
2131 <tr>
2132 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2133 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2134 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2135 </tr>
2136 </tbody>
2137 </table>
2138 </div>
2139 <div class="sect3">
2140 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.24.3. Produces</a></h4>
2141 <div class="ulist">
2142 <ul>
2143 <li>
2144 <p><code>application/json</code></p>
2145 </li>
2146 </ul>
2147 </div>
2148 </div>
2149 </div>
2150 <div class="sect2">
2151 <h3 id="_route81"><a class="anchor" href="#_route81"></a><a class="link" href="#_route81">2.25. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
2152 <div class="sect3">
2153 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.25.1. Parameters</a></h4>
2154 <table class="tableblock frame-all grid-all stretch">
2155 <colgroup>
2156 <col style="width: 22.2222%;">
2157 <col style="width: 33.3333%;">
2158 <col style="width: 44.4445%;">
2159 </colgroup>
2160 <thead>
2161 <tr>
2162 <th class="tableblock halign-left valign-middle">Type</th>
2163 <th class="tableblock halign-left valign-middle">Name</th>
2164 <th class="tableblock halign-left valign-middle">Schema</th>
2165 </tr>
2166 </thead>
2167 <tbody>
2168 <tr>
2169 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2170 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2171 <em>required</em></p></td>
2172 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2173 </tr>
2174 <tr>
2175 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2176 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2177 <em>required</em></p></td>
2178 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2179 </tr>
2180 </tbody>
2181 </table>
2182 </div>
2183 <div class="sect3">
2184 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.2. Responses</a></h4>
2185 <table class="tableblock frame-all grid-all stretch">
2186 <colgroup>
2187 <col style="width: 10%;">
2188 <col style="width: 70%;">
2189 <col style="width: 20%;">
2190 </colgroup>
2191 <thead>
2192 <tr>
2193 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2194 <th class="tableblock halign-left valign-middle">Description</th>
2195 <th class="tableblock halign-left valign-middle">Schema</th>
2196 </tr>
2197 </thead>
2198 <tbody>
2199 <tr>
2200 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2201 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2202 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2203 </tr>
2204 </tbody>
2205 </table>
2206 </div>
2207 <div class="sect3">
2208 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.25.3. Consumes</a></h4>
2209 <div class="ulist">
2210 <ul>
2211 <li>
2212 <p><code>application/json</code></p>
2213 </li>
2214 </ul>
2215 </div>
2216 </div>
2217 <div class="sect3">
2218 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.25.4. Produces</a></h4>
2219 <div class="ulist">
2220 <ul>
2221 <li>
2222 <p><code>application/json</code></p>
2223 </li>
2224 </ul>
2225 </div>
2226 </div>
2227 </div>
2228 <div class="sect2">
2229 <h3 id="_route83"><a class="anchor" href="#_route83"></a><a class="link" href="#_route83">2.26. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
2230 <div class="sect3">
2231 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a><a class="link" href="#_parameters_20">2.26.1. Parameters</a></h4>
2232 <table class="tableblock frame-all grid-all stretch">
2233 <colgroup>
2234 <col style="width: 22.2222%;">
2235 <col style="width: 33.3333%;">
2236 <col style="width: 44.4445%;">
2237 </colgroup>
2238 <thead>
2239 <tr>
2240 <th class="tableblock halign-left valign-middle">Type</th>
2241 <th class="tableblock halign-left valign-middle">Name</th>
2242 <th class="tableblock halign-left valign-middle">Schema</th>
2243 </tr>
2244 </thead>
2245 <tbody>
2246 <tr>
2247 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2249 <em>required</em></p></td>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2251 </tr>
2252 <tr>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2255 <em>required</em></p></td>
2256 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2257 </tr>
2258 </tbody>
2259 </table>
2260 </div>
2261 <div class="sect3">
2262 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2263 <table class="tableblock frame-all grid-all stretch">
2264 <colgroup>
2265 <col style="width: 10%;">
2266 <col style="width: 70%;">
2267 <col style="width: 20%;">
2268 </colgroup>
2269 <thead>
2270 <tr>
2271 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2272 <th class="tableblock halign-left valign-middle">Description</th>
2273 <th class="tableblock halign-left valign-middle">Schema</th>
2274 </tr>
2275 </thead>
2276 <tbody>
2277 <tr>
2278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2279 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2280 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2281 </tr>
2282 </tbody>
2283 </table>
2284 </div>
2285 <div class="sect3">
2286 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.26.3. Consumes</a></h4>
2287 <div class="ulist">
2288 <ul>
2289 <li>
2290 <p><code>application/json</code></p>
2291 </li>
2292 </ul>
2293 </div>
2294 </div>
2295 <div class="sect3">
2296 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.26.4. Produces</a></h4>
2297 <div class="ulist">
2298 <ul>
2299 <li>
2300 <p><code>application/json</code></p>
2301 </li>
2302 </ul>
2303 </div>
2304 </div>
2305 </div>
2306 <div class="sect2">
2307 <h3 id="_route82"><a class="anchor" href="#_route82"></a><a class="link" href="#_route82">2.27. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
2308 <div class="sect3">
2309 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a><a class="link" href="#_parameters_21">2.27.1. Parameters</a></h4>
2310 <table class="tableblock frame-all grid-all stretch">
2311 <colgroup>
2312 <col style="width: 22.2222%;">
2313 <col style="width: 33.3333%;">
2314 <col style="width: 44.4445%;">
2315 </colgroup>
2316 <thead>
2317 <tr>
2318 <th class="tableblock halign-left valign-middle">Type</th>
2319 <th class="tableblock halign-left valign-middle">Name</th>
2320 <th class="tableblock halign-left valign-middle">Schema</th>
2321 </tr>
2322 </thead>
2323 <tbody>
2324 <tr>
2325 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2327 <em>required</em></p></td>
2328 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2329 </tr>
2330 <tr>
2331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2333 <em>required</em></p></td>
2334 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2335 </tr>
2336 </tbody>
2337 </table>
2338 </div>
2339 <div class="sect3">
2340 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.2. Responses</a></h4>
2341 <table class="tableblock frame-all grid-all stretch">
2342 <colgroup>
2343 <col style="width: 10%;">
2344 <col style="width: 70%;">
2345 <col style="width: 20%;">
2346 </colgroup>
2347 <thead>
2348 <tr>
2349 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2350 <th class="tableblock halign-left valign-middle">Description</th>
2351 <th class="tableblock halign-left valign-middle">Schema</th>
2352 </tr>
2353 </thead>
2354 <tbody>
2355 <tr>
2356 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2357 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2358 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2359 </tr>
2360 </tbody>
2361 </table>
2362 </div>
2363 <div class="sect3">
2364 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.27.3. Consumes</a></h4>
2365 <div class="ulist">
2366 <ul>
2367 <li>
2368 <p><code>application/json</code></p>
2369 </li>
2370 </ul>
2371 </div>
2372 </div>
2373 <div class="sect3">
2374 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.27.4. Produces</a></h4>
2375 <div class="ulist">
2376 <ul>
2377 <li>
2378 <p><code>application/json</code></p>
2379 </li>
2380 </ul>
2381 </div>
2382 </div>
2383 </div>
2384 <div class="sect2">
2385 <h3 id="_route79"><a class="anchor" href="#_route79"></a><a class="link" href="#_route79">2.28. GET /v2/loop/{loopName}</a></h3>
2386 <div class="sect3">
2387 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a><a class="link" href="#_parameters_22">2.28.1. Parameters</a></h4>
2388 <table class="tableblock frame-all grid-all stretch">
2389 <colgroup>
2390 <col style="width: 22.2222%;">
2391 <col style="width: 33.3333%;">
2392 <col style="width: 44.4445%;">
2393 </colgroup>
2394 <thead>
2395 <tr>
2396 <th class="tableblock halign-left valign-middle">Type</th>
2397 <th class="tableblock halign-left valign-middle">Name</th>
2398 <th class="tableblock halign-left valign-middle">Schema</th>
2399 </tr>
2400 </thead>
2401 <tbody>
2402 <tr>
2403 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2404 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2405 <em>required</em></p></td>
2406 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2407 </tr>
2408 </tbody>
2409 </table>
2410 </div>
2411 <div class="sect3">
2412 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.2. Responses</a></h4>
2413 <table class="tableblock frame-all grid-all stretch">
2414 <colgroup>
2415 <col style="width: 10%;">
2416 <col style="width: 70%;">
2417 <col style="width: 20%;">
2418 </colgroup>
2419 <thead>
2420 <tr>
2421 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2422 <th class="tableblock halign-left valign-middle">Description</th>
2423 <th class="tableblock halign-left valign-middle">Schema</th>
2424 </tr>
2425 </thead>
2426 <tbody>
2427 <tr>
2428 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2429 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2430 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2431 </tr>
2432 </tbody>
2433 </table>
2434 </div>
2435 <div class="sect3">
2436 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.28.3. Produces</a></h4>
2437 <div class="ulist">
2438 <ul>
2439 <li>
2440 <p><code>application/json</code></p>
2441 </li>
2442 </ul>
2443 </div>
2444 </div>
2445 </div>
2446 <div class="sect2">
2447 <h3 id="_route106"><a class="anchor" href="#_route106"></a><a class="link" href="#_route106">2.29. POST /v2/policyToscaModels</a></h3>
2448 <div class="sect3">
2449 <h4 id="_parameters_23"><a class="anchor" href="#_parameters_23"></a><a class="link" href="#_parameters_23">2.29.1. Parameters</a></h4>
2450 <table class="tableblock frame-all grid-all stretch">
2451 <colgroup>
2452 <col style="width: 22.2222%;">
2453 <col style="width: 33.3333%;">
2454 <col style="width: 44.4445%;">
2455 </colgroup>
2456 <thead>
2457 <tr>
2458 <th class="tableblock halign-left valign-middle">Type</th>
2459 <th class="tableblock halign-left valign-middle">Name</th>
2460 <th class="tableblock halign-left valign-middle">Schema</th>
2461 </tr>
2462 </thead>
2463 <tbody>
2464 <tr>
2465 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2466 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2467 <em>required</em></p></td>
2468 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2469 </tr>
2470 </tbody>
2471 </table>
2472 </div>
2473 <div class="sect3">
2474 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.2. Responses</a></h4>
2475 <table class="tableblock frame-all grid-all stretch">
2476 <colgroup>
2477 <col style="width: 10%;">
2478 <col style="width: 70%;">
2479 <col style="width: 20%;">
2480 </colgroup>
2481 <thead>
2482 <tr>
2483 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2484 <th class="tableblock halign-left valign-middle">Description</th>
2485 <th class="tableblock halign-left valign-middle">Schema</th>
2486 </tr>
2487 </thead>
2488 <tbody>
2489 <tr>
2490 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2491 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2492 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2493 </tr>
2494 </tbody>
2495 </table>
2496 </div>
2497 <div class="sect3">
2498 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a><a class="link" href="#_consumes_7">2.29.3. Consumes</a></h4>
2499 <div class="ulist">
2500 <ul>
2501 <li>
2502 <p><code>plain/text</code></p>
2503 </li>
2504 </ul>
2505 </div>
2506 </div>
2507 <div class="sect3">
2508 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.29.4. Produces</a></h4>
2509 <div class="ulist">
2510 <ul>
2511 <li>
2512 <p><code>application/json</code></p>
2513 </li>
2514 </ul>
2515 </div>
2516 </div>
2517 </div>
2518 <div class="sect2">
2519 <h3 id="_route105"><a class="anchor" href="#_route105"></a><a class="link" href="#_route105">2.30. GET /v2/policyToscaModels</a></h3>
2520 <div class="sect3">
2521 <h4 id="_responses_30"><a class="anchor" href="#_responses_30"></a><a class="link" href="#_responses_30">2.30.1. Responses</a></h4>
2522 <table class="tableblock frame-all grid-all stretch">
2523 <colgroup>
2524 <col style="width: 10%;">
2525 <col style="width: 70%;">
2526 <col style="width: 20%;">
2527 </colgroup>
2528 <thead>
2529 <tr>
2530 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2531 <th class="tableblock halign-left valign-middle">Description</th>
2532 <th class="tableblock halign-left valign-middle">Schema</th>
2533 </tr>
2534 </thead>
2535 <tbody>
2536 <tr>
2537 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2538 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2539 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2540 </tr>
2541 </tbody>
2542 </table>
2543 </div>
2544 <div class="sect3">
2545 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.30.2. Produces</a></h4>
2546 <div class="ulist">
2547 <ul>
2548 <li>
2549 <p><code>application/json</code></p>
2550 </li>
2551 </ul>
2552 </div>
2553 </div>
2554 </div>
2555 <div class="sect2">
2556 <h3 id="_v2_policytoscamodels_yaml_policymodeltype_policymodelversion_get"><a class="anchor" href="#_v2_policytoscamodels_yaml_policymodeltype_policymodelversion_get"></a><a class="link" href="#_v2_policytoscamodels_yaml_policymodeltype_policymodelversion_get">2.31. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}</a></h3>
2557 <div class="sect3">
2558 <h4 id="_parameters_24"><a class="anchor" href="#_parameters_24"></a><a class="link" href="#_parameters_24">2.31.1. Parameters</a></h4>
2559 <table class="tableblock frame-all grid-all stretch">
2560 <colgroup>
2561 <col style="width: 22.2222%;">
2562 <col style="width: 33.3333%;">
2563 <col style="width: 44.4445%;">
2564 </colgroup>
2565 <thead>
2566 <tr>
2567 <th class="tableblock halign-left valign-middle">Type</th>
2568 <th class="tableblock halign-left valign-middle">Name</th>
2569 <th class="tableblock halign-left valign-middle">Schema</th>
2570 </tr>
2571 </thead>
2572 <tbody>
2573 <tr>
2574 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2575 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2576 <em>required</em></p></td>
2577 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2578 </tr>
2579 <tr>
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>policyModelVersion</strong><br>
2582 <em>required</em></p></td>
2583 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2584 </tr>
2585 </tbody>
2586 </table>
2587 </div>
2588 <div class="sect3">
2589 <h4 id="_responses_31"><a class="anchor" href="#_responses_31"></a><a class="link" href="#_responses_31">2.31.2. Responses</a></h4>
2590 <table class="tableblock frame-all grid-all stretch">
2591 <colgroup>
2592 <col style="width: 10%;">
2593 <col style="width: 70%;">
2594 <col style="width: 20%;">
2595 </colgroup>
2596 <thead>
2597 <tr>
2598 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2599 <th class="tableblock halign-left valign-middle">Description</th>
2600 <th class="tableblock halign-left valign-middle">Schema</th>
2601 </tr>
2602 </thead>
2603 <tbody>
2604 <tr>
2605 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2606 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2607 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2608 </tr>
2609 </tbody>
2610 </table>
2611 </div>
2612 <div class="sect3">
2613 <h4 id="_produces_30"><a class="anchor" href="#_produces_30"></a><a class="link" href="#_produces_30">2.31.3. Produces</a></h4>
2614 <div class="ulist">
2615 <ul>
2616 <li>
2617 <p><code>application/json</code></p>
2618 </li>
2619 </ul>
2620 </div>
2621 </div>
2622 </div>
2623 <div class="sect2">
2624 <h3 id="_v2_policytoscamodels_policymodeltype_policymodelversion_get"><a class="anchor" href="#_v2_policytoscamodels_policymodeltype_policymodelversion_get"></a><a class="link" href="#_v2_policytoscamodels_policymodeltype_policymodelversion_get">2.32. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a></h3>
2625 <div class="sect3">
2626 <h4 id="_parameters_25"><a class="anchor" href="#_parameters_25"></a><a class="link" href="#_parameters_25">2.32.1. Parameters</a></h4>
2627 <table class="tableblock frame-all grid-all stretch">
2628 <colgroup>
2629 <col style="width: 22.2222%;">
2630 <col style="width: 33.3333%;">
2631 <col style="width: 44.4445%;">
2632 </colgroup>
2633 <thead>
2634 <tr>
2635 <th class="tableblock halign-left valign-middle">Type</th>
2636 <th class="tableblock halign-left valign-middle">Name</th>
2637 <th class="tableblock halign-left valign-middle">Schema</th>
2638 </tr>
2639 </thead>
2640 <tbody>
2641 <tr>
2642 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2643 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2644 <em>required</em></p></td>
2645 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2646 </tr>
2647 <tr>
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>policyModelVersion</strong><br>
2650 <em>required</em></p></td>
2651 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2652 </tr>
2653 </tbody>
2654 </table>
2655 </div>
2656 <div class="sect3">
2657 <h4 id="_responses_32"><a class="anchor" href="#_responses_32"></a><a class="link" href="#_responses_32">2.32.2. Responses</a></h4>
2658 <table class="tableblock frame-all grid-all stretch">
2659 <colgroup>
2660 <col style="width: 10%;">
2661 <col style="width: 70%;">
2662 <col style="width: 20%;">
2663 </colgroup>
2664 <thead>
2665 <tr>
2666 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2667 <th class="tableblock halign-left valign-middle">Description</th>
2668 <th class="tableblock halign-left valign-middle">Schema</th>
2669 </tr>
2670 </thead>
2671 <tbody>
2672 <tr>
2673 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2674 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2675 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2676 </tr>
2677 </tbody>
2678 </table>
2679 </div>
2680 <div class="sect3">
2681 <h4 id="_produces_31"><a class="anchor" href="#_produces_31"></a><a class="link" href="#_produces_31">2.32.3. Produces</a></h4>
2682 <div class="ulist">
2683 <ul>
2684 <li>
2685 <p><code>application/json</code></p>
2686 </li>
2687 </ul>
2688 </div>
2689 </div>
2690 </div>
2691 <div class="sect2">
2692 <h3 id="_route107"><a class="anchor" href="#_route107"></a><a class="link" href="#_route107">2.33. PUT /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a></h3>
2693 <div class="sect3">
2694 <h4 id="_parameters_26"><a class="anchor" href="#_parameters_26"></a><a class="link" href="#_parameters_26">2.33.1. Parameters</a></h4>
2695 <table class="tableblock frame-all grid-all stretch">
2696 <colgroup>
2697 <col style="width: 22.2222%;">
2698 <col style="width: 33.3333%;">
2699 <col style="width: 44.4445%;">
2700 </colgroup>
2701 <thead>
2702 <tr>
2703 <th class="tableblock halign-left valign-middle">Type</th>
2704 <th class="tableblock halign-left valign-middle">Name</th>
2705 <th class="tableblock halign-left valign-middle">Schema</th>
2706 </tr>
2707 </thead>
2708 <tbody>
2709 <tr>
2710 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2711 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2712 <em>required</em></p></td>
2713 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2714 </tr>
2715 <tr>
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>policyModelVersion</strong><br>
2718 <em>required</em></p></td>
2719 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2720 </tr>
2721 <tr>
2722 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2724 <em>required</em></p></td>
2725 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2726 </tr>
2727 </tbody>
2728 </table>
2729 </div>
2730 <div class="sect3">
2731 <h4 id="_responses_33"><a class="anchor" href="#_responses_33"></a><a class="link" href="#_responses_33">2.33.2. Responses</a></h4>
2732 <table class="tableblock frame-all grid-all stretch">
2733 <colgroup>
2734 <col style="width: 10%;">
2735 <col style="width: 70%;">
2736 <col style="width: 20%;">
2737 </colgroup>
2738 <thead>
2739 <tr>
2740 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2741 <th class="tableblock halign-left valign-middle">Description</th>
2742 <th class="tableblock halign-left valign-middle">Schema</th>
2743 </tr>
2744 </thead>
2745 <tbody>
2746 <tr>
2747 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2748 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2749 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2750 </tr>
2751 </tbody>
2752 </table>
2753 </div>
2754 <div class="sect3">
2755 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a><a class="link" href="#_consumes_8">2.33.3. Consumes</a></h4>
2756 <div class="ulist">
2757 <ul>
2758 <li>
2759 <p><code>plain/text</code></p>
2760 </li>
2761 </ul>
2762 </div>
2763 </div>
2764 <div class="sect3">
2765 <h4 id="_produces_32"><a class="anchor" href="#_produces_32"></a><a class="link" href="#_produces_32">2.33.4. Produces</a></h4>
2766 <div class="ulist">
2767 <ul>
2768 <li>
2769 <p><code>application/json</code></p>
2770 </li>
2771 </ul>
2772 </div>
2773 </div>
2774 </div>
2775 <div class="sect2">
2776 <h3 id="_route111"><a class="anchor" href="#_route111"></a><a class="link" href="#_route111">2.34. GET /v2/templates</a></h3>
2777 <div class="sect3">
2778 <h4 id="_responses_34"><a class="anchor" href="#_responses_34"></a><a class="link" href="#_responses_34">2.34.1. Responses</a></h4>
2779 <table class="tableblock frame-all grid-all stretch">
2780 <colgroup>
2781 <col style="width: 10%;">
2782 <col style="width: 70%;">
2783 <col style="width: 20%;">
2784 </colgroup>
2785 <thead>
2786 <tr>
2787 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2788 <th class="tableblock halign-left valign-middle">Description</th>
2789 <th class="tableblock halign-left valign-middle">Schema</th>
2790 </tr>
2791 </thead>
2792 <tbody>
2793 <tr>
2794 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2795 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2796 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2797 </tr>
2798 </tbody>
2799 </table>
2800 </div>
2801 <div class="sect3">
2802 <h4 id="_produces_33"><a class="anchor" href="#_produces_33"></a><a class="link" href="#_produces_33">2.34.2. Produces</a></h4>
2803 <div class="ulist">
2804 <ul>
2805 <li>
2806 <p><code>application/json</code></p>
2807 </li>
2808 </ul>
2809 </div>
2810 </div>
2811 </div>
2812 <div class="sect2">
2813 <h3 id="_v2_templates_names_get"><a class="anchor" href="#_v2_templates_names_get"></a><a class="link" href="#_v2_templates_names_get">2.35. GET /v2/templates/names</a></h3>
2814 <div class="sect3">
2815 <h4 id="_responses_35"><a class="anchor" href="#_responses_35"></a><a class="link" href="#_responses_35">2.35.1. Responses</a></h4>
2816 <table class="tableblock frame-all grid-all stretch">
2817 <colgroup>
2818 <col style="width: 10%;">
2819 <col style="width: 70%;">
2820 <col style="width: 20%;">
2821 </colgroup>
2822 <thead>
2823 <tr>
2824 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2825 <th class="tableblock halign-left valign-middle">Description</th>
2826 <th class="tableblock halign-left valign-middle">Schema</th>
2827 </tr>
2828 </thead>
2829 <tbody>
2830 <tr>
2831 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2832 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2833 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
2834 </tr>
2835 </tbody>
2836 </table>
2837 </div>
2838 <div class="sect3">
2839 <h4 id="_produces_34"><a class="anchor" href="#_produces_34"></a><a class="link" href="#_produces_34">2.35.2. Produces</a></h4>
2840 <div class="ulist">
2841 <ul>
2842 <li>
2843 <p><code>application/json</code></p>
2844 </li>
2845 </ul>
2846 </div>
2847 </div>
2848 </div>
2849 <div class="sect2">
2850 <h3 id="_v2_templates_templatename_get"><a class="anchor" href="#_v2_templates_templatename_get"></a><a class="link" href="#_v2_templates_templatename_get">2.36. GET /v2/templates/{templateName}</a></h3>
2851 <div class="sect3">
2852 <h4 id="_parameters_27"><a class="anchor" href="#_parameters_27"></a><a class="link" href="#_parameters_27">2.36.1. Parameters</a></h4>
2853 <table class="tableblock frame-all grid-all stretch">
2854 <colgroup>
2855 <col style="width: 22.2222%;">
2856 <col style="width: 33.3333%;">
2857 <col style="width: 44.4445%;">
2858 </colgroup>
2859 <thead>
2860 <tr>
2861 <th class="tableblock halign-left valign-middle">Type</th>
2862 <th class="tableblock halign-left valign-middle">Name</th>
2863 <th class="tableblock halign-left valign-middle">Schema</th>
2864 </tr>
2865 </thead>
2866 <tbody>
2867 <tr>
2868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2869 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2870 <em>required</em></p></td>
2871 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2872 </tr>
2873 </tbody>
2874 </table>
2875 </div>
2876 <div class="sect3">
2877 <h4 id="_responses_36"><a class="anchor" href="#_responses_36"></a><a class="link" href="#_responses_36">2.36.2. Responses</a></h4>
2878 <table class="tableblock frame-all grid-all stretch">
2879 <colgroup>
2880 <col style="width: 10%;">
2881 <col style="width: 70%;">
2882 <col style="width: 20%;">
2883 </colgroup>
2884 <thead>
2885 <tr>
2886 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2887 <th class="tableblock halign-left valign-middle">Description</th>
2888 <th class="tableblock halign-left valign-middle">Schema</th>
2889 </tr>
2890 </thead>
2891 <tbody>
2892 <tr>
2893 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2894 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2895 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2896 </tr>
2897 </tbody>
2898 </table>
2899 </div>
2900 <div class="sect3">
2901 <h4 id="_produces_35"><a class="anchor" href="#_produces_35"></a><a class="link" href="#_produces_35">2.36.3. Produces</a></h4>
2902 <div class="ulist">
2903 <ul>
2904 <li>
2905 <p><code>application/json</code></p>
2906 </li>
2907 </ul>
2908 </div>
2909 </div>
2910 </div>
2911 <div class="sect2">
2912 <h3 id="_v2_templates_templatename_svgrepresentation_get"><a class="anchor" href="#_v2_templates_templatename_svgrepresentation_get"></a><a class="link" href="#_v2_templates_templatename_svgrepresentation_get">2.37. GET /v2/templates/{templateName}/svgRepresentation</a></h3>
2913 <div class="sect3">
2914 <h4 id="_parameters_28"><a class="anchor" href="#_parameters_28"></a><a class="link" href="#_parameters_28">2.37.1. Parameters</a></h4>
2915 <table class="tableblock frame-all grid-all stretch">
2916 <colgroup>
2917 <col style="width: 22.2222%;">
2918 <col style="width: 33.3333%;">
2919 <col style="width: 44.4445%;">
2920 </colgroup>
2921 <thead>
2922 <tr>
2923 <th class="tableblock halign-left valign-middle">Type</th>
2924 <th class="tableblock halign-left valign-middle">Name</th>
2925 <th class="tableblock halign-left valign-middle">Schema</th>
2926 </tr>
2927 </thead>
2928 <tbody>
2929 <tr>
2930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2931 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2932 <em>required</em></p></td>
2933 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2934 </tr>
2935 </tbody>
2936 </table>
2937 </div>
2938 <div class="sect3">
2939 <h4 id="_responses_37"><a class="anchor" href="#_responses_37"></a><a class="link" href="#_responses_37">2.37.2. Responses</a></h4>
2940 <table class="tableblock frame-all grid-all stretch">
2941 <colgroup>
2942 <col style="width: 10%;">
2943 <col style="width: 70%;">
2944 <col style="width: 20%;">
2945 </colgroup>
2946 <thead>
2947 <tr>
2948 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2949 <th class="tableblock halign-left valign-middle">Description</th>
2950 <th class="tableblock halign-left valign-middle">Schema</th>
2951 </tr>
2952 </thead>
2953 <tbody>
2954 <tr>
2955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2956 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2957 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2958 </tr>
2959 </tbody>
2960 </table>
2961 </div>
2962 <div class="sect3">
2963 <h4 id="_produces_36"><a class="anchor" href="#_produces_36"></a><a class="link" href="#_produces_36">2.37.3. Produces</a></h4>
2964 <div class="ulist">
2965 <ul>
2966 <li>
2967 <p><code>application/xml</code></p>
2968 </li>
2969 </ul>
2970 </div>
2971 </div>
2972 </div>
2973 </div>
2974 </div>
2975 <div class="sect1">
2976 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
2977 <div class="sectionbody">
2978 <div class="sect2">
2979 <h3 id="_clampinformation"><a class="anchor" href="#_clampinformation"></a><a class="link" href="#_clampinformation">3.1. ClampInformation</a></h3>
2980 <table class="tableblock frame-all grid-all stretch">
2981 <colgroup>
2982 <col style="width: 42.8571%;">
2983 <col style="width: 57.1429%;">
2984 </colgroup>
2985 <thead>
2986 <tr>
2987 <th class="tableblock halign-left valign-middle">Name</th>
2988 <th class="tableblock halign-left valign-middle">Schema</th>
2989 </tr>
2990 </thead>
2991 <tbody>
2992 <tr>
2993 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allPermissions</strong><br>
2994 <em>optional</em></p></td>
2995 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
2996 </tr>
2997 <tr>
2998 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
2999 <em>optional</em></p></td>
3000 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3001 </tr>
3002 <tr>
3003 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
3004 <em>optional</em></p></td>
3005 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3006 </tr>
3007 </tbody>
3008 </table>
3009 </div>
3010 <div class="sect2">
3011 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a><a class="link" href="#_cldshealthcheck">3.2. CldsHealthCheck</a></h3>
3012 <table class="tableblock frame-all grid-all stretch">
3013 <colgroup>
3014 <col style="width: 42.8571%;">
3015 <col style="width: 57.1429%;">
3016 </colgroup>
3017 <thead>
3018 <tr>
3019 <th class="tableblock halign-left valign-middle">Name</th>
3020 <th class="tableblock halign-left valign-middle">Schema</th>
3021 </tr>
3022 </thead>
3023 <tbody>
3024 <tr>
3025 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3026 <em>optional</em></p></td>
3027 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3028 </tr>
3029 <tr>
3030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
3031 <em>optional</em></p></td>
3032 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3033 </tr>
3034 <tr>
3035 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
3036 <em>optional</em></p></td>
3037 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3038 </tr>
3039 </tbody>
3040 </table>
3041 </div>
3042 <div class="sect2">
3043 <h3 id="_dictionary"><a class="anchor" href="#_dictionary"></a><a class="link" href="#_dictionary">3.3. Dictionary</a></h3>
3044 <table class="tableblock frame-all grid-all stretch">
3045 <colgroup>
3046 <col style="width: 42.8571%;">
3047 <col style="width: 57.1429%;">
3048 </colgroup>
3049 <thead>
3050 <tr>
3051 <th class="tableblock halign-left valign-middle">Name</th>
3052 <th class="tableblock halign-left valign-middle">Schema</th>
3053 </tr>
3054 </thead>
3055 <tbody>
3056 <tr>
3057 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3058 <em>optional</em></p></td>
3059 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3060 </tr>
3061 <tr>
3062 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3063 <em>optional</em></p></td>
3064 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3065 </tr>
3066 <tr>
3067 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryElements</strong><br>
3068 <em>optional</em></p></td>
3069 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_dictionaryelement">DictionaryElement</a> &gt; array</p></td>
3070 </tr>
3071 <tr>
3072 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3073 <em>optional</em></p></td>
3074 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3075 </tr>
3076 <tr>
3077 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>secondLevelDictionary</strong><br>
3078 <em>optional</em></p></td>
3079 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3080 </tr>
3081 <tr>
3082 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionaryType</strong><br>
3083 <em>optional</em></p></td>
3084 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3085 </tr>
3086 <tr>
3087 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3088 <em>optional</em></p></td>
3089 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3090 </tr>
3091 <tr>
3092 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3093 <em>optional</em></p></td>
3094 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3095 </tr>
3096 </tbody>
3097 </table>
3098 </div>
3099 <div class="sect2">
3100 <h3 id="_dictionaryelement"><a class="anchor" href="#_dictionaryelement"></a><a class="link" href="#_dictionaryelement">3.4. DictionaryElement</a></h3>
3101 <table class="tableblock frame-all grid-all stretch">
3102 <colgroup>
3103 <col style="width: 42.8571%;">
3104 <col style="width: 57.1429%;">
3105 </colgroup>
3106 <thead>
3107 <tr>
3108 <th class="tableblock halign-left valign-middle">Name</th>
3109 <th class="tableblock halign-left valign-middle">Schema</th>
3110 </tr>
3111 </thead>
3112 <tbody>
3113 <tr>
3114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3115 <em>optional</em></p></td>
3116 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3117 </tr>
3118 <tr>
3119 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3120 <em>optional</em></p></td>
3121 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3122 </tr>
3123 <tr>
3124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3125 <em>optional</em></p></td>
3126 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3127 </tr>
3128 <tr>
3129 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3130 <em>optional</em></p></td>
3131 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3132 </tr>
3133 <tr>
3134 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
3135 <em>optional</em></p></td>
3136 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3137 </tr>
3138 <tr>
3139 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionary</strong><br>
3140 <em>optional</em></p></td>
3141 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3142 </tr>
3143 <tr>
3144 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
3145 <em>optional</em></p></td>
3146 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3147 </tr>
3148 <tr>
3149 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3150 <em>optional</em></p></td>
3151 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3152 </tr>
3153 <tr>
3154 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3155 <em>optional</em></p></td>
3156 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3157 </tr>
3158 <tr>
3159 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByDictionaries</strong><br>
3160 <em>optional</em></p></td>
3161 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_dictionary">Dictionary</a> &gt; array</p></td>
3162 </tr>
3163 </tbody>
3164 </table>
3165 </div>
3166 <div class="sect2">
3167 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.5. ExternalComponent</a></h3>
3168 <table class="tableblock frame-all grid-all stretch">
3169 <colgroup>
3170 <col style="width: 42.8571%;">
3171 <col style="width: 57.1429%;">
3172 </colgroup>
3173 <thead>
3174 <tr>
3175 <th class="tableblock halign-left valign-middle">Name</th>
3176 <th class="tableblock halign-left valign-middle">Schema</th>
3177 </tr>
3178 </thead>
3179 <tbody>
3180 <tr>
3181 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
3182 <em>optional</em></p></td>
3183 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3184 </tr>
3185 <tr>
3186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
3187 <em>optional</em></p></td>
3188 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
3189 </tr>
3190 </tbody>
3191 </table>
3192 </div>
3193 <div class="sect2">
3194 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.6. ExternalComponentState</a></h3>
3195 <table class="tableblock frame-all grid-all stretch">
3196 <colgroup>
3197 <col style="width: 42.8571%;">
3198 <col style="width: 57.1429%;">
3199 </colgroup>
3200 <thead>
3201 <tr>
3202 <th class="tableblock halign-left valign-middle">Name</th>
3203 <th class="tableblock halign-left valign-middle">Schema</th>
3204 </tr>
3205 </thead>
3206 <tbody>
3207 <tr>
3208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3209 <em>optional</em></p></td>
3210 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3211 </tr>
3212 <tr>
3213 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
3214 <em>optional</em></p></td>
3215 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3216 </tr>
3217 <tr>
3218 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
3219 <em>optional</em></p></td>
3220 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3221 </tr>
3222 </tbody>
3223 </table>
3224 </div>
3225 <div class="sect2">
3226 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.7. JsonArray</a></h3>
3227 <table class="tableblock frame-all grid-all stretch">
3228 <colgroup>
3229 <col style="width: 42.8571%;">
3230 <col style="width: 57.1429%;">
3231 </colgroup>
3232 <thead>
3233 <tr>
3234 <th class="tableblock halign-left valign-middle">Name</th>
3235 <th class="tableblock halign-left valign-middle">Schema</th>
3236 </tr>
3237 </thead>
3238 <tbody>
3239 <tr>
3240 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3241 <em>optional</em></p></td>
3242 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3243 </tr>
3244 <tr>
3245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3246 <em>optional</em></p></td>
3247 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3248 </tr>
3249 <tr>
3250 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3251 <em>optional</em></p></td>
3252 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3253 </tr>
3254 <tr>
3255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3256 <em>optional</em></p></td>
3257 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3258 </tr>
3259 <tr>
3260 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3261 <em>optional</em></p></td>
3262 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3263 </tr>
3264 <tr>
3265 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3266 <em>optional</em></p></td>
3267 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3268 </tr>
3269 <tr>
3270 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3271 <em>optional</em></p></td>
3272 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3273 </tr>
3274 <tr>
3275 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3276 <em>optional</em></p></td>
3277 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3278 </tr>
3279 <tr>
3280 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3281 <em>optional</em></p></td>
3282 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3283 </tr>
3284 <tr>
3285 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3286 <em>optional</em></p></td>
3287 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3288 </tr>
3289 <tr>
3290 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3291 <em>optional</em></p></td>
3292 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3293 </tr>
3294 <tr>
3295 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3296 <em>optional</em></p></td>
3297 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3298 </tr>
3299 <tr>
3300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3301 <em>optional</em></p></td>
3302 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3303 </tr>
3304 <tr>
3305 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3306 <em>optional</em></p></td>
3307 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3308 </tr>
3309 <tr>
3310 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3311 <em>optional</em></p></td>
3312 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3313 </tr>
3314 <tr>
3315 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3316 <em>optional</em></p></td>
3317 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3318 </tr>
3319 <tr>
3320 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3321 <em>optional</em></p></td>
3322 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3323 </tr>
3324 <tr>
3325 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3326 <em>optional</em></p></td>
3327 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3328 </tr>
3329 <tr>
3330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3331 <em>optional</em></p></td>
3332 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3333 </tr>
3334 <tr>
3335 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3336 <em>optional</em></p></td>
3337 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3338 </tr>
3339 </tbody>
3340 </table>
3341 </div>
3342 <div class="sect2">
3343 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.8. JsonNull</a></h3>
3344 <table class="tableblock frame-all grid-all stretch">
3345 <colgroup>
3346 <col style="width: 42.8571%;">
3347 <col style="width: 57.1429%;">
3348 </colgroup>
3349 <thead>
3350 <tr>
3351 <th class="tableblock halign-left valign-middle">Name</th>
3352 <th class="tableblock halign-left valign-middle">Schema</th>
3353 </tr>
3354 </thead>
3355 <tbody>
3356 <tr>
3357 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3358 <em>optional</em></p></td>
3359 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3360 </tr>
3361 <tr>
3362 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3363 <em>optional</em></p></td>
3364 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3365 </tr>
3366 <tr>
3367 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3368 <em>optional</em></p></td>
3369 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3370 </tr>
3371 <tr>
3372 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3373 <em>optional</em></p></td>
3374 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3375 </tr>
3376 <tr>
3377 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3378 <em>optional</em></p></td>
3379 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3380 </tr>
3381 <tr>
3382 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3383 <em>optional</em></p></td>
3384 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3385 </tr>
3386 <tr>
3387 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3388 <em>optional</em></p></td>
3389 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3390 </tr>
3391 <tr>
3392 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3393 <em>optional</em></p></td>
3394 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3395 </tr>
3396 <tr>
3397 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3398 <em>optional</em></p></td>
3399 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3400 </tr>
3401 <tr>
3402 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3403 <em>optional</em></p></td>
3404 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3405 </tr>
3406 <tr>
3407 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3408 <em>optional</em></p></td>
3409 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3410 </tr>
3411 <tr>
3412 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3413 <em>optional</em></p></td>
3414 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3415 </tr>
3416 <tr>
3417 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3418 <em>optional</em></p></td>
3419 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3420 </tr>
3421 <tr>
3422 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3423 <em>optional</em></p></td>
3424 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3425 </tr>
3426 <tr>
3427 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3428 <em>optional</em></p></td>
3429 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3430 </tr>
3431 <tr>
3432 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3433 <em>optional</em></p></td>
3434 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3435 </tr>
3436 <tr>
3437 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3438 <em>optional</em></p></td>
3439 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3440 </tr>
3441 <tr>
3442 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3443 <em>optional</em></p></td>
3444 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3445 </tr>
3446 <tr>
3447 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3448 <em>optional</em></p></td>
3449 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3450 </tr>
3451 <tr>
3452 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3453 <em>optional</em></p></td>
3454 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3455 </tr>
3456 </tbody>
3457 </table>
3458 </div>
3459 <div class="sect2">
3460 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.9. JsonObject</a></h3>
3461 <table class="tableblock frame-all grid-all stretch">
3462 <colgroup>
3463 <col style="width: 42.8571%;">
3464 <col style="width: 57.1429%;">
3465 </colgroup>
3466 <thead>
3467 <tr>
3468 <th class="tableblock halign-left valign-middle">Name</th>
3469 <th class="tableblock halign-left valign-middle">Schema</th>
3470 </tr>
3471 </thead>
3472 <tbody>
3473 <tr>
3474 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3475 <em>optional</em></p></td>
3476 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3477 </tr>
3478 <tr>
3479 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3480 <em>optional</em></p></td>
3481 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3482 </tr>
3483 <tr>
3484 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3485 <em>optional</em></p></td>
3486 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3487 </tr>
3488 <tr>
3489 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3490 <em>optional</em></p></td>
3491 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3492 </tr>
3493 <tr>
3494 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3495 <em>optional</em></p></td>
3496 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3497 </tr>
3498 <tr>
3499 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3500 <em>optional</em></p></td>
3501 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3502 </tr>
3503 <tr>
3504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3505 <em>optional</em></p></td>
3506 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3507 </tr>
3508 <tr>
3509 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3510 <em>optional</em></p></td>
3511 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3512 </tr>
3513 <tr>
3514 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3515 <em>optional</em></p></td>
3516 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3517 </tr>
3518 <tr>
3519 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3520 <em>optional</em></p></td>
3521 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3522 </tr>
3523 <tr>
3524 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3525 <em>optional</em></p></td>
3526 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3527 </tr>
3528 <tr>
3529 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3530 <em>optional</em></p></td>
3531 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3532 </tr>
3533 <tr>
3534 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3535 <em>optional</em></p></td>
3536 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3537 </tr>
3538 <tr>
3539 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3540 <em>optional</em></p></td>
3541 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3542 </tr>
3543 <tr>
3544 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3545 <em>optional</em></p></td>
3546 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3547 </tr>
3548 <tr>
3549 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3550 <em>optional</em></p></td>
3551 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3552 </tr>
3553 <tr>
3554 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3555 <em>optional</em></p></td>
3556 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3557 </tr>
3558 <tr>
3559 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3560 <em>optional</em></p></td>
3561 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3562 </tr>
3563 <tr>
3564 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3565 <em>optional</em></p></td>
3566 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3567 </tr>
3568 <tr>
3569 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3570 <em>optional</em></p></td>
3571 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3572 </tr>
3573 </tbody>
3574 </table>
3575 </div>
3576 <div class="sect2">
3577 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.10. JsonPrimitive</a></h3>
3578 <table class="tableblock frame-all grid-all stretch">
3579 <colgroup>
3580 <col style="width: 42.8571%;">
3581 <col style="width: 57.1429%;">
3582 </colgroup>
3583 <thead>
3584 <tr>
3585 <th class="tableblock halign-left valign-middle">Name</th>
3586 <th class="tableblock halign-left valign-middle">Schema</th>
3587 </tr>
3588 </thead>
3589 <tbody>
3590 <tr>
3591 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3592 <em>optional</em></p></td>
3593 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3594 </tr>
3595 <tr>
3596 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3597 <em>optional</em></p></td>
3598 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3599 </tr>
3600 <tr>
3601 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3602 <em>optional</em></p></td>
3603 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3604 </tr>
3605 <tr>
3606 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3607 <em>optional</em></p></td>
3608 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3609 </tr>
3610 <tr>
3611 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3612 <em>optional</em></p></td>
3613 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3614 </tr>
3615 <tr>
3616 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3617 <em>optional</em></p></td>
3618 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3619 </tr>
3620 <tr>
3621 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3622 <em>optional</em></p></td>
3623 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3624 </tr>
3625 <tr>
3626 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3627 <em>optional</em></p></td>
3628 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3629 </tr>
3630 <tr>
3631 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3632 <em>optional</em></p></td>
3633 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3634 </tr>
3635 <tr>
3636 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3637 <em>optional</em></p></td>
3638 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3639 </tr>
3640 <tr>
3641 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3642 <em>optional</em></p></td>
3643 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3644 </tr>
3645 <tr>
3646 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3647 <em>optional</em></p></td>
3648 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3649 </tr>
3650 <tr>
3651 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3652 <em>optional</em></p></td>
3653 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3654 </tr>
3655 <tr>
3656 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3657 <em>optional</em></p></td>
3658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3659 </tr>
3660 <tr>
3661 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3662 <em>optional</em></p></td>
3663 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3664 </tr>
3665 <tr>
3666 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3667 <em>optional</em></p></td>
3668 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3669 </tr>
3670 <tr>
3671 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
3672 <em>optional</em></p></td>
3673 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3674 </tr>
3675 <tr>
3676 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3677 <em>optional</em></p></td>
3678 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3679 </tr>
3680 <tr>
3681 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3682 <em>optional</em></p></td>
3683 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3684 </tr>
3685 <tr>
3686 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3687 <em>optional</em></p></td>
3688 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3689 </tr>
3690 <tr>
3691 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3692 <em>optional</em></p></td>
3693 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3694 </tr>
3695 <tr>
3696 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
3697 <em>optional</em></p></td>
3698 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3699 </tr>
3700 <tr>
3701 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
3702 <em>optional</em></p></td>
3703 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3704 </tr>
3705 </tbody>
3706 </table>
3707 </div>
3708 <div class="sect2">
3709 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.11. Loop</a></h3>
3710 <table class="tableblock frame-all grid-all stretch">
3711 <colgroup>
3712 <col style="width: 42.8571%;">
3713 <col style="width: 57.1429%;">
3714 </colgroup>
3715 <thead>
3716 <tr>
3717 <th class="tableblock halign-left valign-middle">Name</th>
3718 <th class="tableblock halign-left valign-middle">Schema</th>
3719 </tr>
3720 </thead>
3721 <tbody>
3722 <tr>
3723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
3724 <em>optional</em></p></td>
3725 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string, <a href="#_externalcomponent">ExternalComponent</a> &gt; map</p></td>
3726 </tr>
3727 <tr>
3728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3729 <em>optional</em></p></td>
3730 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3731 </tr>
3732 <tr>
3733 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3734 <em>optional</em></p></td>
3735 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3736 </tr>
3737 <tr>
3738 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
3739 <em>optional</em></p></td>
3740 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3741 </tr>
3742 <tr>
3743 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
3744 <em>optional</em></p></td>
3745 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3746 </tr>
3747 <tr>
3748 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
3749 <em>optional</em></p></td>
3750 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3751 </tr>
3752 <tr>
3753 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
3754 <em>optional</em></p></td>
3755 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
3756 </tr>
3757 <tr>
3758 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
3759 <em>optional</em></p></td>
3760 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looplog">LoopLog</a> &gt; array</p></td>
3761 </tr>
3762 <tr>
3763 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
3764 <em>optional</em></p></td>
3765 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3766 </tr>
3767 <tr>
3768 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
3769 <em>optional</em></p></td>
3770 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_microservicepolicy">MicroServicePolicy</a> &gt; array</p></td>
3771 </tr>
3772 <tr>
3773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3774 <em>optional</em></p></td>
3775 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3776 </tr>
3777 <tr>
3778 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3779 <em>optional</em></p></td>
3780 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3781 </tr>
3782 <tr>
3783 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
3784 <em>optional</em></p></td>
3785 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_operationalpolicy">OperationalPolicy</a> &gt; array</p></td>
3786 </tr>
3787 <tr>
3788 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3789 <em>optional</em></p></td>
3790 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3791 </tr>
3792 <tr>
3793 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3794 <em>optional</em></p></td>
3795 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3796 </tr>
3797 <tr>
3798 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3799 <em>optional</em></p></td>
3800 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3801 </tr>
3802 </tbody>
3803 </table>
3804 </div>
3805 <div class="sect2">
3806 <h3 id="_loopelementmodel"><a class="anchor" href="#_loopelementmodel"></a><a class="link" href="#_loopelementmodel">3.12. LoopElementModel</a></h3>
3807 <table class="tableblock frame-all grid-all stretch">
3808 <colgroup>
3809 <col style="width: 42.8571%;">
3810 <col style="width: 57.1429%;">
3811 </colgroup>
3812 <thead>
3813 <tr>
3814 <th class="tableblock halign-left valign-middle">Name</th>
3815 <th class="tableblock halign-left valign-middle">Schema</th>
3816 </tr>
3817 </thead>
3818 <tbody>
3819 <tr>
3820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3821 <em>optional</em></p></td>
3822 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3823 </tr>
3824 <tr>
3825 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3826 <em>optional</em></p></td>
3827 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3828 </tr>
3829 <tr>
3830 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3831 <em>optional</em></p></td>
3832 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3833 </tr>
3834 <tr>
3835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3836 <em>optional</em></p></td>
3837 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3838 </tr>
3839 <tr>
3840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementType</strong><br>
3841 <em>optional</em></p></td>
3842 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3843 </tr>
3844 <tr>
3845 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3846 <em>optional</em></p></td>
3847 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3848 </tr>
3849 <tr>
3850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModels</strong><br>
3851 <em>optional</em></p></td>
3852 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_policymodel">PolicyModel</a> &gt; array</p></td>
3853 </tr>
3854 <tr>
3855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
3856 <em>optional</em></p></td>
3857 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3858 </tr>
3859 <tr>
3860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3861 <em>optional</em></p></td>
3862 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3863 </tr>
3864 <tr>
3865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3866 <em>optional</em></p></td>
3867 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3868 </tr>
3869 <tr>
3870 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoopTemplates</strong><br>
3871 <em>optional</em></p></td>
3872 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
3873 </tr>
3874 </tbody>
3875 </table>
3876 </div>
3877 <div class="sect2">
3878 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.13. LoopLog</a></h3>
3879 <table class="tableblock frame-all grid-all stretch">
3880 <colgroup>
3881 <col style="width: 42.8571%;">
3882 <col style="width: 57.1429%;">
3883 </colgroup>
3884 <thead>
3885 <tr>
3886 <th class="tableblock halign-left valign-middle">Name</th>
3887 <th class="tableblock halign-left valign-middle">Schema</th>
3888 </tr>
3889 </thead>
3890 <tbody>
3891 <tr>
3892 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3893 <em>optional</em></p></td>
3894 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3895 </tr>
3896 <tr>
3897 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
3898 <em>optional</em></p></td>
3899 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3900 </tr>
3901 <tr>
3902 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
3903 <em>optional</em></p></td>
3904 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3905 </tr>
3906 <tr>
3907 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
3908 <em>optional</em></p></td>
3909 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
3910 </tr>
3911 <tr>
3912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
3913 <em>optional</em></p></td>
3914 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3915 </tr>
3916 <tr>
3917 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
3918 <em>optional</em></p></td>
3919 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3920 </tr>
3921 </tbody>
3922 </table>
3923 </div>
3924 <div class="sect2">
3925 <h3 id="_looptemplate"><a class="anchor" href="#_looptemplate"></a><a class="link" href="#_looptemplate">3.14. LoopTemplate</a></h3>
3926 <table class="tableblock frame-all grid-all stretch">
3927 <colgroup>
3928 <col style="width: 42.8571%;">
3929 <col style="width: 57.1429%;">
3930 </colgroup>
3931 <thead>
3932 <tr>
3933 <th class="tableblock halign-left valign-middle">Name</th>
3934 <th class="tableblock halign-left valign-middle">Schema</th>
3935 </tr>
3936 </thead>
3937 <tbody>
3938 <tr>
3939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allowedLoopType</strong><br>
3940 <em>optional</em></p></td>
3941 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (OPEN, CLOSED, HYBRID)</p></td>
3942 </tr>
3943 <tr>
3944 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3945 <em>optional</em></p></td>
3946 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3947 </tr>
3948 <tr>
3949 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3950 <em>optional</em></p></td>
3951 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3952 </tr>
3953 <tr>
3954 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3955 <em>optional</em></p></td>
3956 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3957 </tr>
3958 <tr>
3959 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3960 <em>optional</em></p></td>
3961 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3962 </tr>
3963 <tr>
3964 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModelsUsed</strong><br>
3965 <em>optional</em></p></td>
3966 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
3967 </tr>
3968 <tr>
3969 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>maximumInstancesAllowed</strong><br>
3970 <em>optional</em></p></td>
3971 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3972 </tr>
3973 <tr>
3974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3975 <em>optional</em></p></td>
3976 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3977 </tr>
3978 <tr>
3979 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3980 <em>optional</em></p></td>
3981 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3982 </tr>
3983 <tr>
3984 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3985 <em>optional</em></p></td>
3986 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3987 </tr>
3988 <tr>
3989 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>uniqueBlueprint</strong><br>
3990 <em>optional</em></p></td>
3991 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3992 </tr>
3993 <tr>
3994 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3995 <em>optional</em></p></td>
3996 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3997 </tr>
3998 <tr>
3999 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4000 <em>optional</em></p></td>
4001 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4002 </tr>
4003 </tbody>
4004 </table>
4005 </div>
4006 <div class="sect2">
4007 <h3 id="_looptemplateloopelementmodel"><a class="anchor" href="#_looptemplateloopelementmodel"></a><a class="link" href="#_looptemplateloopelementmodel">3.15. LoopTemplateLoopElementModel</a></h3>
4008 <table class="tableblock frame-all grid-all stretch">
4009 <colgroup>
4010 <col style="width: 42.8571%;">
4011 <col style="width: 57.1429%;">
4012 </colgroup>
4013 <thead>
4014 <tr>
4015 <th class="tableblock halign-left valign-middle">Name</th>
4016 <th class="tableblock halign-left valign-middle">Schema</th>
4017 </tr>
4018 </thead>
4019 <tbody>
4020 <tr>
4021 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>flowOrder</strong><br>
4022 <em>optional</em></p></td>
4023 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4024 </tr>
4025 <tr>
4026 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
4027 <em>optional</em></p></td>
4028 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
4029 </tr>
4030 <tr>
4031 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
4032 <em>optional</em></p></td>
4033 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
4034 </tr>
4035 </tbody>
4036 </table>
4037 </div>
4038 <div class="sect2">
4039 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.16. MicroServicePolicy</a></h3>
4040 <table class="tableblock frame-all grid-all stretch">
4041 <colgroup>
4042 <col style="width: 42.8571%;">
4043 <col style="width: 57.1429%;">
4044 </colgroup>
4045 <thead>
4046 <tr>
4047 <th class="tableblock halign-left valign-middle">Name</th>
4048 <th class="tableblock halign-left valign-middle">Schema</th>
4049 </tr>
4050 </thead>
4051 <tbody>
4052 <tr>
4053 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
4054 <em>optional</em></p></td>
4055 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4056 </tr>
4057 <tr>
4058 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>context</strong><br>
4059 <em>optional</em></p></td>
4060 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4061 </tr>
4062 <tr>
4063 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4064 <em>optional</em></p></td>
4065 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4066 </tr>
4067 <tr>
4068 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4069 <em>optional</em></p></td>
4070 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4071 </tr>
4072 <tr>
4073 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
4074 <em>optional</em></p></td>
4075 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4076 </tr>
4077 <tr>
4078 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
4079 <em>optional</em></p></td>
4080 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4081 </tr>
4082 <tr>
4083 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
4084 <em>optional</em></p></td>
4085 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4086 </tr>
4087 <tr>
4088 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deviceTypeScope</strong><br>
4089 <em>optional</em></p></td>
4090 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4091 </tr>
4092 <tr>
4093 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
4094 <em>optional</em></p></td>
4095 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4096 </tr>
4097 <tr>
4098 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
4099 <em>optional</em></p></td>
4100 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
4101 </tr>
4102 <tr>
4103 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4104 <em>optional</em></p></td>
4105 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4106 </tr>
4107 <tr>
4108 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
4109 <em>optional</em></p></td>
4110 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4111 </tr>
4112 <tr>
4113 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
4114 <em>optional</em></p></td>
4115 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4116 </tr>
4117 <tr>
4118 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
4119 <em>optional</em></p></td>
4120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
4121 </tr>
4122 <tr>
4123 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
4124 <em>optional</em></p></td>
4125 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4126 </tr>
4127 <tr>
4128 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4129 <em>optional</em></p></td>
4130 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4131 </tr>
4132 <tr>
4133 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4134 <em>optional</em></p></td>
4135 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4136 </tr>
4137 <tr>
4138 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
4139 <em>optional</em></p></td>
4140 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loop">Loop</a> &gt; array</p></td>
4141 </tr>
4142 </tbody>
4143 </table>
4144 </div>
4145 <div class="sect2">
4146 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.17. Number</a></h3>
4147 <div class="paragraph">
4148 <p><em>Type</em> : object</p>
4149 </div>
4150 </div>
4151 <div class="sect2">
4152 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.18. OperationalPolicy</a></h3>
4153 <table class="tableblock frame-all grid-all stretch">
4154 <colgroup>
4155 <col style="width: 42.8571%;">
4156 <col style="width: 57.1429%;">
4157 </colgroup>
4158 <thead>
4159 <tr>
4160 <th class="tableblock halign-left valign-middle">Name</th>
4161 <th class="tableblock halign-left valign-middle">Schema</th>
4162 </tr>
4163 </thead>
4164 <tbody>
4165 <tr>
4166 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
4167 <em>optional</em></p></td>
4168 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4169 </tr>
4170 <tr>
4171 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4172 <em>optional</em></p></td>
4173 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4174 </tr>
4175 <tr>
4176 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4177 <em>optional</em></p></td>
4178 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4179 </tr>
4180 <tr>
4181 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
4182 <em>optional</em></p></td>
4183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4184 </tr>
4185 <tr>
4186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>legacy</strong><br>
4187 <em>optional</em></p></td>
4188 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4189 </tr>
4190 <tr>
4191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
4192 <em>optional</em></p></td>
4193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
4194 </tr>
4195 <tr>
4196 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
4197 <em>optional</em></p></td>
4198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
4199 </tr>
4200 <tr>
4201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4202 <em>optional</em></p></td>
4203 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4204 </tr>
4205 <tr>
4206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
4207 <em>optional</em></p></td>
4208 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4209 </tr>
4210 <tr>
4211 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
4212 <em>optional</em></p></td>
4213 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4214 </tr>
4215 <tr>
4216 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
4217 <em>optional</em></p></td>
4218 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
4219 </tr>
4220 <tr>
4221 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4222 <em>optional</em></p></td>
4223 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4224 </tr>
4225 <tr>
4226 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4227 <em>optional</em></p></td>
4228 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4229 </tr>
4230 </tbody>
4231 </table>
4232 </div>
4233 <div class="sect2">
4234 <h3 id="_policymodel"><a class="anchor" href="#_policymodel"></a><a class="link" href="#_policymodel">3.19. PolicyModel</a></h3>
4235 <table class="tableblock frame-all grid-all stretch">
4236 <colgroup>
4237 <col style="width: 42.8571%;">
4238 <col style="width: 57.1429%;">
4239 </colgroup>
4240 <thead>
4241 <tr>
4242 <th class="tableblock halign-left valign-middle">Name</th>
4243 <th class="tableblock halign-left valign-middle">Schema</th>
4244 </tr>
4245 </thead>
4246 <tbody>
4247 <tr>
4248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4249 <em>optional</em></p></td>
4250 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4251 </tr>
4252 <tr>
4253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4254 <em>optional</em></p></td>
4255 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4256 </tr>
4257 <tr>
4258 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyAcronym</strong><br>
4259 <em>optional</em></p></td>
4260 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4261 </tr>
4262 <tr>
4263 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelTosca</strong><br>
4264 <em>optional</em></p></td>
4265 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4266 </tr>
4267 <tr>
4268 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
4269 <em>optional</em></p></td>
4270 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4271 </tr>
4272 <tr>
4273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyPdpGroup</strong><br>
4274 <em>optional</em></p></td>
4275 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4276 </tr>
4277 <tr>
4278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4279 <em>optional</em></p></td>
4280 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4281 </tr>
4282 <tr>
4283 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4284 <em>optional</em></p></td>
4285 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4286 </tr>
4287 <tr>
4288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByElementModels</strong><br>
4289 <em>optional</em></p></td>
4290 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loopelementmodel">LoopElementModel</a> &gt; array</p></td>
4291 </tr>
4292 <tr>
4293 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
4294 <em>optional</em></p></td>
4295 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4296 </tr>
4297 </tbody>
4298 </table>
4299 </div>
4300 <div class="sect2">
4301 <h3 id="_service"><a class="anchor" href="#_service"></a><a class="link" href="#_service">3.20. Service</a></h3>
4302 <table class="tableblock frame-all grid-all stretch">
4303 <colgroup>
4304 <col style="width: 42.8571%;">
4305 <col style="width: 57.1429%;">
4306 </colgroup>
4307 <thead>
4308 <tr>
4309 <th class="tableblock halign-left valign-middle">Name</th>
4310 <th class="tableblock halign-left valign-middle">Schema</th>
4311 </tr>
4312 </thead>
4313 <tbody>
4314 <tr>
4315 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4316 <em>optional</em></p></td>
4317 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4318 </tr>
4319 <tr>
4320 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceDetails</strong><br>
4321 <em>optional</em></p></td>
4322 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4323 </tr>
4324 <tr>
4325 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceDetails</strong><br>
4326 <em>optional</em></p></td>
4327 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4328 </tr>
4329 <tr>
4330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUuid</strong><br>
4331 <em>optional</em></p></td>
4332 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4333 </tr>
4334 <tr>
4335 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
4336 <em>optional</em></p></td>
4337 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4338 </tr>
4339 </tbody>
4340 </table>
4341 </div>
4342 </div>
4343 </div>
4344 </div>
4345 <div id="footer">
4346 <div id="footer-text">
4347 Last updated 2020-02-12 02:20:53 PST
4348 </div>
4349 </div>
4350 </body>
4351 </html>