69e9c7c15f6060aafe91fd53b458342f78d0c3ee
[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="#_route61">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="#_route62">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="#_route49">2.3. GET /v2/dictionary</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="#_route51">2.4. PUT /v2/dictionary</a>
466 <ul class="sectlevel3">
467 <li><a href="#_parameters">2.4.1. Parameters</a></li>
468 <li><a href="#_responses_4">2.4.2. Responses</a></li>
469 <li><a href="#_consumes">2.4.3. Consumes</a></li>
470 <li><a href="#_produces_4">2.4.4. Produces</a></li>
471 </ul>
472 </li>
473 <li><a href="#_v2_dictionary_secondary_names_get">2.5. GET /v2/dictionary/secondary/names</a>
474 <ul class="sectlevel3">
475 <li><a href="#_responses_5">2.5.1. Responses</a></li>
476 <li><a href="#_produces_5">2.5.2. Produces</a></li>
477 </ul>
478 </li>
479 <li><a href="#_v2_dictionary_dictionaryname_get">2.6. GET /v2/dictionary/{dictionaryName}</a>
480 <ul class="sectlevel3">
481 <li><a href="#_parameters_2">2.6.1. Parameters</a></li>
482 <li><a href="#_responses_6">2.6.2. Responses</a></li>
483 <li><a href="#_produces_6">2.6.3. Produces</a></li>
484 </ul>
485 </li>
486 <li><a href="#_v2_dictionary_name_put">2.7. PUT /v2/dictionary/{name}</a>
487 <ul class="sectlevel3">
488 <li><a href="#_parameters_3">2.7.1. Parameters</a></li>
489 <li><a href="#_responses_7">2.7.2. Responses</a></li>
490 <li><a href="#_consumes_2">2.7.3. Consumes</a></li>
491 <li><a href="#_produces_7">2.7.4. Produces</a></li>
492 </ul>
493 </li>
494 <li><a href="#_route53">2.8. DELETE /v2/dictionary/{name}</a>
495 <ul class="sectlevel3">
496 <li><a href="#_parameters_4">2.8.1. Parameters</a></li>
497 <li><a href="#_responses_8">2.8.2. Responses</a></li>
498 <li><a href="#_produces_8">2.8.3. Produces</a></li>
499 </ul>
500 </li>
501 <li><a href="#_v2_dictionary_name_elements_shortname_delete">2.9. DELETE /v2/dictionary/{name}/elements/{shortName}</a>
502 <ul class="sectlevel3">
503 <li><a href="#_parameters_5">2.9.1. Parameters</a></li>
504 <li><a href="#_responses_9">2.9.2. Responses</a></li>
505 <li><a href="#_produces_9">2.9.3. Produces</a></li>
506 </ul>
507 </li>
508 <li><a href="#_route45">2.10. PUT /v2/loop/delete/{loopName}</a>
509 <ul class="sectlevel3">
510 <li><a href="#_parameters_6">2.10.1. Parameters</a></li>
511 <li><a href="#_responses_10">2.10.2. Responses</a></li>
512 </ul>
513 </li>
514 <li><a href="#_route39">2.11. PUT /v2/loop/deploy/{loopName}</a>
515 <ul class="sectlevel3">
516 <li><a href="#_parameters_7">2.11.1. Parameters</a></li>
517 <li><a href="#_responses_11">2.11.2. Responses</a></li>
518 <li><a href="#_produces_10">2.11.3. Produces</a></li>
519 </ul>
520 </li>
521 <li><a href="#_route33">2.12. GET /v2/loop/getAllNames</a>
522 <ul class="sectlevel3">
523 <li><a href="#_responses_12">2.12.1. Responses</a></li>
524 <li><a href="#_produces_11">2.12.2. Produces</a></li>
525 </ul>
526 </li>
527 <li><a href="#_route46">2.13. GET /v2/loop/getstatus/{loopName}</a>
528 <ul class="sectlevel3">
529 <li><a href="#_parameters_8">2.13.1. Parameters</a></li>
530 <li><a href="#_responses_13">2.13.2. Responses</a></li>
531 <li><a href="#_produces_12">2.13.3. Produces</a></li>
532 </ul>
533 </li>
534 <li><a href="#_route40">2.14. PUT /v2/loop/refreshOpPolicyJsonSchema/{loopName}</a>
535 <ul class="sectlevel3">
536 <li><a href="#_parameters_9">2.14.1. Parameters</a></li>
537 <li><a href="#_responses_14">2.14.2. Responses</a></li>
538 <li><a href="#_produces_13">2.14.3. Produces</a></li>
539 </ul>
540 </li>
541 <li><a href="#_route43">2.15. PUT /v2/loop/restart/{loopName}</a>
542 <ul class="sectlevel3">
543 <li><a href="#_parameters_10">2.15.1. Parameters</a></li>
544 <li><a href="#_responses_15">2.15.2. Responses</a></li>
545 <li><a href="#_produces_14">2.15.3. Produces</a></li>
546 </ul>
547 </li>
548 <li><a href="#_route42">2.16. PUT /v2/loop/stop/{loopName}</a>
549 <ul class="sectlevel3">
550 <li><a href="#_parameters_11">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="#_route44">2.17. PUT /v2/loop/submit/{loopName}</a>
556 <ul class="sectlevel3">
557 <li><a href="#_parameters_12">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="#_route35">2.18. GET /v2/loop/svgRepresentation/{loopName}</a>
563 <ul class="sectlevel3">
564 <li><a href="#_parameters_13">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="#_route41">2.19. PUT /v2/loop/undeploy/{loopName}</a>
570 <ul class="sectlevel3">
571 <li><a href="#_parameters_14">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="#_route36">2.20. POST /v2/loop/updateGlobalProperties/{loopName}</a>
577 <ul class="sectlevel3">
578 <li><a href="#_parameters_15">2.20.1. Parameters</a></li>
579 <li><a href="#_responses_20">2.20.2. Responses</a></li>
580 <li><a href="#_consumes_3">2.20.3. Consumes</a></li>
581 <li><a href="#_produces_19">2.20.4. Produces</a></li>
582 </ul>
583 </li>
584 <li><a href="#_route38">2.21. POST /v2/loop/updateMicroservicePolicy/{loopName}</a>
585 <ul class="sectlevel3">
586 <li><a href="#_parameters_16">2.21.1. Parameters</a></li>
587 <li><a href="#_responses_21">2.21.2. Responses</a></li>
588 <li><a href="#_consumes_4">2.21.3. Consumes</a></li>
589 <li><a href="#_produces_20">2.21.4. Produces</a></li>
590 </ul>
591 </li>
592 <li><a href="#_route37">2.22. POST /v2/loop/updateOperationalPolicies/{loopName}</a>
593 <ul class="sectlevel3">
594 <li><a href="#_parameters_17">2.22.1. Parameters</a></li>
595 <li><a href="#_responses_22">2.22.2. Responses</a></li>
596 <li><a href="#_consumes_5">2.22.3. Consumes</a></li>
597 <li><a href="#_produces_21">2.22.4. Produces</a></li>
598 </ul>
599 </li>
600 <li><a href="#_route34">2.23. GET /v2/loop/{loopName}</a>
601 <ul class="sectlevel3">
602 <li><a href="#_parameters_18">2.23.1. Parameters</a></li>
603 <li><a href="#_responses_23">2.23.2. Responses</a></li>
604 <li><a href="#_produces_22">2.23.3. Produces</a></li>
605 </ul>
606 </li>
607 <li><a href="#_route56">2.24. GET /v2/policyToscaModels</a>
608 <ul class="sectlevel3">
609 <li><a href="#_responses_24">2.24.1. Responses</a></li>
610 <li><a href="#_produces_23">2.24.2. Produces</a></li>
611 </ul>
612 </li>
613 <li><a href="#_v2_policytoscamodels_yaml_policymodeltype_get">2.25. GET /v2/policyToscaModels/yaml/{policyModelType}</a>
614 <ul class="sectlevel3">
615 <li><a href="#_parameters_19">2.25.1. Parameters</a></li>
616 <li><a href="#_responses_25">2.25.2. Responses</a></li>
617 <li><a href="#_produces_24">2.25.3. Produces</a></li>
618 </ul>
619 </li>
620 <li><a href="#_v2_policytoscamodels_policymodeltype_get">2.26. GET /v2/policyToscaModels/{policyModelType}</a>
621 <ul class="sectlevel3">
622 <li><a href="#_parameters_20">2.26.1. Parameters</a></li>
623 <li><a href="#_responses_26">2.26.2. Responses</a></li>
624 <li><a href="#_produces_25">2.26.3. Produces</a></li>
625 </ul>
626 </li>
627 <li><a href="#_route57">2.27. PUT /v2/policyToscaModels/{policyModelType}</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="#_route60">2.28. GET /v2/templates</a>
636 <ul class="sectlevel3">
637 <li><a href="#_responses_28">2.28.1. Responses</a></li>
638 <li><a href="#_produces_27">2.28.2. Produces</a></li>
639 </ul>
640 </li>
641 <li><a href="#_v2_templates_names_get">2.29. GET /v2/templates/names</a>
642 <ul class="sectlevel3">
643 <li><a href="#_responses_29">2.29.1. Responses</a></li>
644 <li><a href="#_produces_28">2.29.2. Produces</a></li>
645 </ul>
646 </li>
647 <li><a href="#_v2_templates_templatename_get">2.30. GET /v2/templates/{templateName}</a>
648 <ul class="sectlevel3">
649 <li><a href="#_parameters_22">2.30.1. Parameters</a></li>
650 <li><a href="#_responses_30">2.30.2. Responses</a></li>
651 <li><a href="#_produces_29">2.30.3. Produces</a></li>
652 </ul>
653 </li>
654 </ul>
655 </li>
656 <li><a href="#_definitions">3. Definitions</a>
657 <ul class="sectlevel2">
658 <li><a href="#_cldshealthcheck">3.1. CldsHealthCheck</a></li>
659 <li><a href="#_dictionary">3.2. Dictionary</a></li>
660 <li><a href="#_dictionaryelement">3.3. DictionaryElement</a></li>
661 <li><a href="#_externalcomponent">3.4. ExternalComponent</a></li>
662 <li><a href="#_externalcomponentstate">3.5. ExternalComponentState</a></li>
663 <li><a href="#_jsonarray">3.6. JsonArray</a></li>
664 <li><a href="#_jsonnull">3.7. JsonNull</a></li>
665 <li><a href="#_jsonobject">3.8. JsonObject</a></li>
666 <li><a href="#_jsonprimitive">3.9. JsonPrimitive</a></li>
667 <li><a href="#_loop">3.10. Loop</a></li>
668 <li><a href="#_loopelementmodel">3.11. LoopElementModel</a></li>
669 <li><a href="#_looplog">3.12. LoopLog</a></li>
670 <li><a href="#_looptemplate">3.13. LoopTemplate</a></li>
671 <li><a href="#_looptemplateloopelementmodel">3.14. LoopTemplateLoopElementModel</a></li>
672 <li><a href="#_microservicepolicy">3.15. MicroServicePolicy</a></li>
673 <li><a href="#_number">3.16. Number</a></li>
674 <li><a href="#_operationalpolicy">3.17. OperationalPolicy</a></li>
675 <li><a href="#_policymodel">3.18. PolicyModel</a></li>
676 <li><a href="#_service">3.19. Service</a></li>
677 </ul>
678 </li>
679 </ul>
680 </div>
681 </div>
682 <div id="content">
683 <div class="sect1">
684 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
685 <div class="sectionbody">
686 <div class="sect2">
687 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
688 <div class="paragraph">
689 <p><em>Version</em> : 5.0.0-SNAPSHOT</p>
690 </div>
691 </div>
692 <div class="sect2">
693 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
694 <div class="paragraph">
695 <p><em>Host</em> : localhost:39237<br>
696 <em>BasePath</em> : /restservices/clds/<br>
697 <em>Schemes</em> : HTTP</p>
698 </div>
699 </div>
700 </div>
701 </div>
702 <div class="sect1">
703 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
704 <div class="sectionbody">
705 <div class="sect2">
706 <h3 id="_route61"><a class="anchor" href="#_route61"></a><a class="link" href="#_route61">2.1. GET /v1/healthcheck</a></h3>
707 <div class="sect3">
708 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.1. Responses</a></h4>
709 <table class="tableblock frame-all grid-all stretch">
710 <colgroup>
711 <col style="width: 10%;">
712 <col style="width: 70%;">
713 <col style="width: 20%;">
714 </colgroup>
715 <thead>
716 <tr>
717 <th class="tableblock halign-left valign-middle">HTTP Code</th>
718 <th class="tableblock halign-left valign-middle">Description</th>
719 <th class="tableblock halign-left valign-middle">Schema</th>
720 </tr>
721 </thead>
722 <tbody>
723 <tr>
724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
725 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
727 </tr>
728 </tbody>
729 </table>
730 </div>
731 <div class="sect3">
732 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
733 <div class="ulist">
734 <ul>
735 <li>
736 <p><code>application/json</code></p>
737 </li>
738 </ul>
739 </div>
740 </div>
741 </div>
742 <div class="sect2">
743 <h3 id="_route62"><a class="anchor" href="#_route62"></a><a class="link" href="#_route62">2.2. GET /v1/user/getUser</a></h3>
744 <div class="sect3">
745 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
746 <table class="tableblock frame-all grid-all stretch">
747 <colgroup>
748 <col style="width: 33.3333%;">
749 <col style="width: 66.6667%;">
750 </colgroup>
751 <thead>
752 <tr>
753 <th class="tableblock halign-left valign-middle">HTTP Code</th>
754 <th class="tableblock halign-left valign-middle">Schema</th>
755 </tr>
756 </thead>
757 <tbody>
758 <tr>
759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
760 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
761 </tr>
762 </tbody>
763 </table>
764 </div>
765 <div class="sect3">
766 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
767 <div class="ulist">
768 <ul>
769 <li>
770 <p><code>text/plain</code></p>
771 </li>
772 </ul>
773 </div>
774 </div>
775 </div>
776 <div class="sect2">
777 <h3 id="_route49"><a class="anchor" href="#_route49"></a><a class="link" href="#_route49">2.3. GET /v2/dictionary</a></h3>
778 <div class="sect3">
779 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
780 <table class="tableblock frame-all grid-all stretch">
781 <colgroup>
782 <col style="width: 10%;">
783 <col style="width: 70%;">
784 <col style="width: 20%;">
785 </colgroup>
786 <thead>
787 <tr>
788 <th class="tableblock halign-left valign-middle">HTTP Code</th>
789 <th class="tableblock halign-left valign-middle">Description</th>
790 <th class="tableblock halign-left valign-middle">Schema</th>
791 </tr>
792 </thead>
793 <tbody>
794 <tr>
795 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
796 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
797 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
798 </tr>
799 </tbody>
800 </table>
801 </div>
802 <div class="sect3">
803 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
804 <div class="ulist">
805 <ul>
806 <li>
807 <p><code>application/json</code></p>
808 </li>
809 </ul>
810 </div>
811 </div>
812 </div>
813 <div class="sect2">
814 <h3 id="_route51"><a class="anchor" href="#_route51"></a><a class="link" href="#_route51">2.4. PUT /v2/dictionary</a></h3>
815 <div class="sect3">
816 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.4.1. Parameters</a></h4>
817 <table class="tableblock frame-all grid-all stretch">
818 <colgroup>
819 <col style="width: 22.2222%;">
820 <col style="width: 33.3333%;">
821 <col style="width: 44.4445%;">
822 </colgroup>
823 <thead>
824 <tr>
825 <th class="tableblock halign-left valign-middle">Type</th>
826 <th class="tableblock halign-left valign-middle">Name</th>
827 <th class="tableblock halign-left valign-middle">Schema</th>
828 </tr>
829 </thead>
830 <tbody>
831 <tr>
832 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
833 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
834 <em>required</em></p></td>
835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
836 </tr>
837 </tbody>
838 </table>
839 </div>
840 <div class="sect3">
841 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.2. Responses</a></h4>
842 <table class="tableblock frame-all grid-all stretch">
843 <colgroup>
844 <col style="width: 10%;">
845 <col style="width: 70%;">
846 <col style="width: 20%;">
847 </colgroup>
848 <thead>
849 <tr>
850 <th class="tableblock halign-left valign-middle">HTTP Code</th>
851 <th class="tableblock halign-left valign-middle">Description</th>
852 <th class="tableblock halign-left valign-middle">Schema</th>
853 </tr>
854 </thead>
855 <tbody>
856 <tr>
857 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
858 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
859 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
860 </tr>
861 </tbody>
862 </table>
863 </div>
864 <div class="sect3">
865 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.4.3. Consumes</a></h4>
866 <div class="ulist">
867 <ul>
868 <li>
869 <p><code>application/json</code></p>
870 </li>
871 </ul>
872 </div>
873 </div>
874 <div class="sect3">
875 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.4. Produces</a></h4>
876 <div class="ulist">
877 <ul>
878 <li>
879 <p><code>application/json</code></p>
880 </li>
881 </ul>
882 </div>
883 </div>
884 </div>
885 <div class="sect2">
886 <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.5. GET /v2/dictionary/secondary/names</a></h3>
887 <div class="sect3">
888 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.1. Responses</a></h4>
889 <table class="tableblock frame-all grid-all stretch">
890 <colgroup>
891 <col style="width: 10%;">
892 <col style="width: 70%;">
893 <col style="width: 20%;">
894 </colgroup>
895 <thead>
896 <tr>
897 <th class="tableblock halign-left valign-middle">HTTP Code</th>
898 <th class="tableblock halign-left valign-middle">Description</th>
899 <th class="tableblock halign-left valign-middle">Schema</th>
900 </tr>
901 </thead>
902 <tbody>
903 <tr>
904 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
905 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
906 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
907 </tr>
908 </tbody>
909 </table>
910 </div>
911 <div class="sect3">
912 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.2. Produces</a></h4>
913 <div class="ulist">
914 <ul>
915 <li>
916 <p><code>application/json</code></p>
917 </li>
918 </ul>
919 </div>
920 </div>
921 </div>
922 <div class="sect2">
923 <h3 id="_v2_dictionary_dictionaryname_get"><a class="anchor" href="#_v2_dictionary_dictionaryname_get"></a><a class="link" href="#_v2_dictionary_dictionaryname_get">2.6. GET /v2/dictionary/{dictionaryName}</a></h3>
924 <div class="sect3">
925 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.6.1. Parameters</a></h4>
926 <table class="tableblock frame-all grid-all stretch">
927 <colgroup>
928 <col style="width: 22.2222%;">
929 <col style="width: 33.3333%;">
930 <col style="width: 44.4445%;">
931 </colgroup>
932 <thead>
933 <tr>
934 <th class="tableblock halign-left valign-middle">Type</th>
935 <th class="tableblock halign-left valign-middle">Name</th>
936 <th class="tableblock halign-left valign-middle">Schema</th>
937 </tr>
938 </thead>
939 <tbody>
940 <tr>
941 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
943 <em>required</em></p></td>
944 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
945 </tr>
946 </tbody>
947 </table>
948 </div>
949 <div class="sect3">
950 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.2. Responses</a></h4>
951 <table class="tableblock frame-all grid-all stretch">
952 <colgroup>
953 <col style="width: 10%;">
954 <col style="width: 70%;">
955 <col style="width: 20%;">
956 </colgroup>
957 <thead>
958 <tr>
959 <th class="tableblock halign-left valign-middle">HTTP Code</th>
960 <th class="tableblock halign-left valign-middle">Description</th>
961 <th class="tableblock halign-left valign-middle">Schema</th>
962 </tr>
963 </thead>
964 <tbody>
965 <tr>
966 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
967 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
968 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
969 </tr>
970 </tbody>
971 </table>
972 </div>
973 <div class="sect3">
974 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.3. Produces</a></h4>
975 <div class="ulist">
976 <ul>
977 <li>
978 <p><code>application/json</code></p>
979 </li>
980 </ul>
981 </div>
982 </div>
983 </div>
984 <div class="sect2">
985 <h3 id="_v2_dictionary_name_put"><a class="anchor" href="#_v2_dictionary_name_put"></a><a class="link" href="#_v2_dictionary_name_put">2.7. PUT /v2/dictionary/{name}</a></h3>
986 <div class="sect3">
987 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.7.1. Parameters</a></h4>
988 <table class="tableblock frame-all grid-all stretch">
989 <colgroup>
990 <col style="width: 22.2222%;">
991 <col style="width: 33.3333%;">
992 <col style="width: 44.4445%;">
993 </colgroup>
994 <thead>
995 <tr>
996 <th class="tableblock halign-left valign-middle">Type</th>
997 <th class="tableblock halign-left valign-middle">Name</th>
998 <th class="tableblock halign-left valign-middle">Schema</th>
999 </tr>
1000 </thead>
1001 <tbody>
1002 <tr>
1003 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1004 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1005 <em>required</em></p></td>
1006 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1007 </tr>
1008 <tr>
1009 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1011 <em>required</em></p></td>
1012 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1013 </tr>
1014 </tbody>
1015 </table>
1016 </div>
1017 <div class="sect3">
1018 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
1019 <table class="tableblock frame-all grid-all stretch">
1020 <colgroup>
1021 <col style="width: 10%;">
1022 <col style="width: 70%;">
1023 <col style="width: 20%;">
1024 </colgroup>
1025 <thead>
1026 <tr>
1027 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1028 <th class="tableblock halign-left valign-middle">Description</th>
1029 <th class="tableblock halign-left valign-middle">Schema</th>
1030 </tr>
1031 </thead>
1032 <tbody>
1033 <tr>
1034 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1035 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1036 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1037 </tr>
1038 </tbody>
1039 </table>
1040 </div>
1041 <div class="sect3">
1042 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.7.3. Consumes</a></h4>
1043 <div class="ulist">
1044 <ul>
1045 <li>
1046 <p><code>application/json</code></p>
1047 </li>
1048 </ul>
1049 </div>
1050 </div>
1051 <div class="sect3">
1052 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.4. Produces</a></h4>
1053 <div class="ulist">
1054 <ul>
1055 <li>
1056 <p><code>application/json</code></p>
1057 </li>
1058 </ul>
1059 </div>
1060 </div>
1061 </div>
1062 <div class="sect2">
1063 <h3 id="_route53"><a class="anchor" href="#_route53"></a><a class="link" href="#_route53">2.8. DELETE /v2/dictionary/{name}</a></h3>
1064 <div class="sect3">
1065 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.8.1. Parameters</a></h4>
1066 <table class="tableblock frame-all grid-all stretch">
1067 <colgroup>
1068 <col style="width: 22.2222%;">
1069 <col style="width: 33.3333%;">
1070 <col style="width: 44.4445%;">
1071 </colgroup>
1072 <thead>
1073 <tr>
1074 <th class="tableblock halign-left valign-middle">Type</th>
1075 <th class="tableblock halign-left valign-middle">Name</th>
1076 <th class="tableblock halign-left valign-middle">Schema</th>
1077 </tr>
1078 </thead>
1079 <tbody>
1080 <tr>
1081 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1082 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1083 <em>required</em></p></td>
1084 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1085 </tr>
1086 </tbody>
1087 </table>
1088 </div>
1089 <div class="sect3">
1090 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1091 <table class="tableblock frame-all grid-all stretch">
1092 <colgroup>
1093 <col style="width: 33.3333%;">
1094 <col style="width: 66.6667%;">
1095 </colgroup>
1096 <thead>
1097 <tr>
1098 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1099 <th class="tableblock halign-left valign-middle">Schema</th>
1100 </tr>
1101 </thead>
1102 <tbody>
1103 <tr>
1104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1105 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1106 </tr>
1107 </tbody>
1108 </table>
1109 </div>
1110 <div class="sect3">
1111 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.3. Produces</a></h4>
1112 <div class="ulist">
1113 <ul>
1114 <li>
1115 <p><code>application/json</code></p>
1116 </li>
1117 </ul>
1118 </div>
1119 </div>
1120 </div>
1121 <div class="sect2">
1122 <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.9. DELETE /v2/dictionary/{name}/elements/{shortName}</a></h3>
1123 <div class="sect3">
1124 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.9.1. Parameters</a></h4>
1125 <table class="tableblock frame-all grid-all stretch">
1126 <colgroup>
1127 <col style="width: 22.2222%;">
1128 <col style="width: 33.3333%;">
1129 <col style="width: 44.4445%;">
1130 </colgroup>
1131 <thead>
1132 <tr>
1133 <th class="tableblock halign-left valign-middle">Type</th>
1134 <th class="tableblock halign-left valign-middle">Name</th>
1135 <th class="tableblock halign-left valign-middle">Schema</th>
1136 </tr>
1137 </thead>
1138 <tbody>
1139 <tr>
1140 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1141 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1142 <em>required</em></p></td>
1143 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1144 </tr>
1145 <tr>
1146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1147 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
1148 <em>required</em></p></td>
1149 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1150 </tr>
1151 </tbody>
1152 </table>
1153 </div>
1154 <div class="sect3">
1155 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1156 <table class="tableblock frame-all grid-all stretch">
1157 <colgroup>
1158 <col style="width: 33.3333%;">
1159 <col style="width: 66.6667%;">
1160 </colgroup>
1161 <thead>
1162 <tr>
1163 <th class="tableblock halign-left valign-middle">HTTP Code</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>200</strong></p></td>
1170 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1171 </tr>
1172 </tbody>
1173 </table>
1174 </div>
1175 <div class="sect3">
1176 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1177 <div class="ulist">
1178 <ul>
1179 <li>
1180 <p><code>application/json</code></p>
1181 </li>
1182 </ul>
1183 </div>
1184 </div>
1185 </div>
1186 <div class="sect2">
1187 <h3 id="_route45"><a class="anchor" href="#_route45"></a><a class="link" href="#_route45">2.10. PUT /v2/loop/delete/{loopName}</a></h3>
1188 <div class="sect3">
1189 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.10.1. Parameters</a></h4>
1190 <table class="tableblock frame-all grid-all stretch">
1191 <colgroup>
1192 <col style="width: 22.2222%;">
1193 <col style="width: 33.3333%;">
1194 <col style="width: 44.4445%;">
1195 </colgroup>
1196 <thead>
1197 <tr>
1198 <th class="tableblock halign-left valign-middle">Type</th>
1199 <th class="tableblock halign-left valign-middle">Name</th>
1200 <th class="tableblock halign-left valign-middle">Schema</th>
1201 </tr>
1202 </thead>
1203 <tbody>
1204 <tr>
1205 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1207 <em>required</em></p></td>
1208 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1209 </tr>
1210 </tbody>
1211 </table>
1212 </div>
1213 <div class="sect3">
1214 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1215 <table class="tableblock frame-all grid-all stretch">
1216 <colgroup>
1217 <col style="width: 33.3333%;">
1218 <col style="width: 66.6667%;">
1219 </colgroup>
1220 <thead>
1221 <tr>
1222 <th class="tableblock halign-left valign-middle">HTTP Code</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>200</strong></p></td>
1229 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1230 </tr>
1231 </tbody>
1232 </table>
1233 </div>
1234 </div>
1235 <div class="sect2">
1236 <h3 id="_route39"><a class="anchor" href="#_route39"></a><a class="link" href="#_route39">2.11. PUT /v2/loop/deploy/{loopName}</a></h3>
1237 <div class="sect3">
1238 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.11.1. Parameters</a></h4>
1239 <table class="tableblock frame-all grid-all stretch">
1240 <colgroup>
1241 <col style="width: 22.2222%;">
1242 <col style="width: 33.3333%;">
1243 <col style="width: 44.4445%;">
1244 </colgroup>
1245 <thead>
1246 <tr>
1247 <th class="tableblock halign-left valign-middle">Type</th>
1248 <th class="tableblock halign-left valign-middle">Name</th>
1249 <th class="tableblock halign-left valign-middle">Schema</th>
1250 </tr>
1251 </thead>
1252 <tbody>
1253 <tr>
1254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1256 <em>required</em></p></td>
1257 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1258 </tr>
1259 </tbody>
1260 </table>
1261 </div>
1262 <div class="sect3">
1263 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.2. Responses</a></h4>
1264 <table class="tableblock frame-all grid-all stretch">
1265 <colgroup>
1266 <col style="width: 10%;">
1267 <col style="width: 70%;">
1268 <col style="width: 20%;">
1269 </colgroup>
1270 <thead>
1271 <tr>
1272 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1273 <th class="tableblock halign-left valign-middle">Description</th>
1274 <th class="tableblock halign-left valign-middle">Schema</th>
1275 </tr>
1276 </thead>
1277 <tbody>
1278 <tr>
1279 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1280 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1281 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1282 </tr>
1283 </tbody>
1284 </table>
1285 </div>
1286 <div class="sect3">
1287 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.11.3. Produces</a></h4>
1288 <div class="ulist">
1289 <ul>
1290 <li>
1291 <p><code>application/json</code></p>
1292 </li>
1293 </ul>
1294 </div>
1295 </div>
1296 </div>
1297 <div class="sect2">
1298 <h3 id="_route33"><a class="anchor" href="#_route33"></a><a class="link" href="#_route33">2.12. GET /v2/loop/getAllNames</a></h3>
1299 <div class="sect3">
1300 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.1. Responses</a></h4>
1301 <table class="tableblock frame-all grid-all stretch">
1302 <colgroup>
1303 <col style="width: 10%;">
1304 <col style="width: 70%;">
1305 <col style="width: 20%;">
1306 </colgroup>
1307 <thead>
1308 <tr>
1309 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1310 <th class="tableblock halign-left valign-middle">Description</th>
1311 <th class="tableblock halign-left valign-middle">Schema</th>
1312 </tr>
1313 </thead>
1314 <tbody>
1315 <tr>
1316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1317 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1318 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
1319 </tr>
1320 </tbody>
1321 </table>
1322 </div>
1323 <div class="sect3">
1324 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.12.2. Produces</a></h4>
1325 <div class="ulist">
1326 <ul>
1327 <li>
1328 <p><code>application/json</code></p>
1329 </li>
1330 </ul>
1331 </div>
1332 </div>
1333 </div>
1334 <div class="sect2">
1335 <h3 id="_route46"><a class="anchor" href="#_route46"></a><a class="link" href="#_route46">2.13. GET /v2/loop/getstatus/{loopName}</a></h3>
1336 <div class="sect3">
1337 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.13.1. Parameters</a></h4>
1338 <table class="tableblock frame-all grid-all stretch">
1339 <colgroup>
1340 <col style="width: 22.2222%;">
1341 <col style="width: 33.3333%;">
1342 <col style="width: 44.4445%;">
1343 </colgroup>
1344 <thead>
1345 <tr>
1346 <th class="tableblock halign-left valign-middle">Type</th>
1347 <th class="tableblock halign-left valign-middle">Name</th>
1348 <th class="tableblock halign-left valign-middle">Schema</th>
1349 </tr>
1350 </thead>
1351 <tbody>
1352 <tr>
1353 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1354 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1355 <em>required</em></p></td>
1356 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1357 </tr>
1358 </tbody>
1359 </table>
1360 </div>
1361 <div class="sect3">
1362 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.2. Responses</a></h4>
1363 <table class="tableblock frame-all grid-all stretch">
1364 <colgroup>
1365 <col style="width: 10%;">
1366 <col style="width: 70%;">
1367 <col style="width: 20%;">
1368 </colgroup>
1369 <thead>
1370 <tr>
1371 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1372 <th class="tableblock halign-left valign-middle">Description</th>
1373 <th class="tableblock halign-left valign-middle">Schema</th>
1374 </tr>
1375 </thead>
1376 <tbody>
1377 <tr>
1378 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1379 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1380 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1381 </tr>
1382 </tbody>
1383 </table>
1384 </div>
1385 <div class="sect3">
1386 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.13.3. Produces</a></h4>
1387 <div class="ulist">
1388 <ul>
1389 <li>
1390 <p><code>application/json</code></p>
1391 </li>
1392 </ul>
1393 </div>
1394 </div>
1395 </div>
1396 <div class="sect2">
1397 <h3 id="_route40"><a class="anchor" href="#_route40"></a><a class="link" href="#_route40">2.14. PUT /v2/loop/refreshOpPolicyJsonSchema/{loopName}</a></h3>
1398 <div class="sect3">
1399 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.14.1. Parameters</a></h4>
1400 <table class="tableblock frame-all grid-all stretch">
1401 <colgroup>
1402 <col style="width: 22.2222%;">
1403 <col style="width: 33.3333%;">
1404 <col style="width: 44.4445%;">
1405 </colgroup>
1406 <thead>
1407 <tr>
1408 <th class="tableblock halign-left valign-middle">Type</th>
1409 <th class="tableblock halign-left valign-middle">Name</th>
1410 <th class="tableblock halign-left valign-middle">Schema</th>
1411 </tr>
1412 </thead>
1413 <tbody>
1414 <tr>
1415 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1416 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1417 <em>required</em></p></td>
1418 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1419 </tr>
1420 </tbody>
1421 </table>
1422 </div>
1423 <div class="sect3">
1424 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1425 <table class="tableblock frame-all grid-all stretch">
1426 <colgroup>
1427 <col style="width: 10%;">
1428 <col style="width: 70%;">
1429 <col style="width: 20%;">
1430 </colgroup>
1431 <thead>
1432 <tr>
1433 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1434 <th class="tableblock halign-left valign-middle">Description</th>
1435 <th class="tableblock halign-left valign-middle">Schema</th>
1436 </tr>
1437 </thead>
1438 <tbody>
1439 <tr>
1440 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1441 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1442 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1443 </tr>
1444 </tbody>
1445 </table>
1446 </div>
1447 <div class="sect3">
1448 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.3. Produces</a></h4>
1449 <div class="ulist">
1450 <ul>
1451 <li>
1452 <p><code>application/json</code></p>
1453 </li>
1454 </ul>
1455 </div>
1456 </div>
1457 </div>
1458 <div class="sect2">
1459 <h3 id="_route43"><a class="anchor" href="#_route43"></a><a class="link" href="#_route43">2.15. PUT /v2/loop/restart/{loopName}</a></h3>
1460 <div class="sect3">
1461 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.15.1. Parameters</a></h4>
1462 <table class="tableblock frame-all grid-all stretch">
1463 <colgroup>
1464 <col style="width: 22.2222%;">
1465 <col style="width: 33.3333%;">
1466 <col style="width: 44.4445%;">
1467 </colgroup>
1468 <thead>
1469 <tr>
1470 <th class="tableblock halign-left valign-middle">Type</th>
1471 <th class="tableblock halign-left valign-middle">Name</th>
1472 <th class="tableblock halign-left valign-middle">Schema</th>
1473 </tr>
1474 </thead>
1475 <tbody>
1476 <tr>
1477 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1478 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1479 <em>required</em></p></td>
1480 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1481 </tr>
1482 </tbody>
1483 </table>
1484 </div>
1485 <div class="sect3">
1486 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.2. Responses</a></h4>
1487 <table class="tableblock frame-all grid-all stretch">
1488 <colgroup>
1489 <col style="width: 10%;">
1490 <col style="width: 70%;">
1491 <col style="width: 20%;">
1492 </colgroup>
1493 <thead>
1494 <tr>
1495 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1496 <th class="tableblock halign-left valign-middle">Description</th>
1497 <th class="tableblock halign-left valign-middle">Schema</th>
1498 </tr>
1499 </thead>
1500 <tbody>
1501 <tr>
1502 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1503 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1505 </tr>
1506 </tbody>
1507 </table>
1508 </div>
1509 <div class="sect3">
1510 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.3. Produces</a></h4>
1511 <div class="ulist">
1512 <ul>
1513 <li>
1514 <p><code>application/json</code></p>
1515 </li>
1516 </ul>
1517 </div>
1518 </div>
1519 </div>
1520 <div class="sect2">
1521 <h3 id="_route42"><a class="anchor" href="#_route42"></a><a class="link" href="#_route42">2.16. PUT /v2/loop/stop/{loopName}</a></h3>
1522 <div class="sect3">
1523 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.16.1. Parameters</a></h4>
1524 <table class="tableblock frame-all grid-all stretch">
1525 <colgroup>
1526 <col style="width: 22.2222%;">
1527 <col style="width: 33.3333%;">
1528 <col style="width: 44.4445%;">
1529 </colgroup>
1530 <thead>
1531 <tr>
1532 <th class="tableblock halign-left valign-middle">Type</th>
1533 <th class="tableblock halign-left valign-middle">Name</th>
1534 <th class="tableblock halign-left valign-middle">Schema</th>
1535 </tr>
1536 </thead>
1537 <tbody>
1538 <tr>
1539 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1541 <em>required</em></p></td>
1542 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1543 </tr>
1544 </tbody>
1545 </table>
1546 </div>
1547 <div class="sect3">
1548 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1549 <table class="tableblock frame-all grid-all stretch">
1550 <colgroup>
1551 <col style="width: 10%;">
1552 <col style="width: 70%;">
1553 <col style="width: 20%;">
1554 </colgroup>
1555 <thead>
1556 <tr>
1557 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1558 <th class="tableblock halign-left valign-middle">Description</th>
1559 <th class="tableblock halign-left valign-middle">Schema</th>
1560 </tr>
1561 </thead>
1562 <tbody>
1563 <tr>
1564 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1565 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1566 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1567 </tr>
1568 </tbody>
1569 </table>
1570 </div>
1571 <div class="sect3">
1572 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1573 <div class="ulist">
1574 <ul>
1575 <li>
1576 <p><code>application/json</code></p>
1577 </li>
1578 </ul>
1579 </div>
1580 </div>
1581 </div>
1582 <div class="sect2">
1583 <h3 id="_route44"><a class="anchor" href="#_route44"></a><a class="link" href="#_route44">2.17. PUT /v2/loop/submit/{loopName}</a></h3>
1584 <div class="sect3">
1585 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.17.1. Parameters</a></h4>
1586 <table class="tableblock frame-all grid-all stretch">
1587 <colgroup>
1588 <col style="width: 22.2222%;">
1589 <col style="width: 33.3333%;">
1590 <col style="width: 44.4445%;">
1591 </colgroup>
1592 <thead>
1593 <tr>
1594 <th class="tableblock halign-left valign-middle">Type</th>
1595 <th class="tableblock halign-left valign-middle">Name</th>
1596 <th class="tableblock halign-left valign-middle">Schema</th>
1597 </tr>
1598 </thead>
1599 <tbody>
1600 <tr>
1601 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1603 <em>required</em></p></td>
1604 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1605 </tr>
1606 </tbody>
1607 </table>
1608 </div>
1609 <div class="sect3">
1610 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1611 <table class="tableblock frame-all grid-all stretch">
1612 <colgroup>
1613 <col style="width: 10%;">
1614 <col style="width: 70%;">
1615 <col style="width: 20%;">
1616 </colgroup>
1617 <thead>
1618 <tr>
1619 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1620 <th class="tableblock halign-left valign-middle">Description</th>
1621 <th class="tableblock halign-left valign-middle">Schema</th>
1622 </tr>
1623 </thead>
1624 <tbody>
1625 <tr>
1626 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1627 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1628 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1629 </tr>
1630 </tbody>
1631 </table>
1632 </div>
1633 <div class="sect3">
1634 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.17.3. Produces</a></h4>
1635 <div class="ulist">
1636 <ul>
1637 <li>
1638 <p><code>application/json</code></p>
1639 </li>
1640 </ul>
1641 </div>
1642 </div>
1643 </div>
1644 <div class="sect2">
1645 <h3 id="_route35"><a class="anchor" href="#_route35"></a><a class="link" href="#_route35">2.18. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
1646 <div class="sect3">
1647 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.18.1. Parameters</a></h4>
1648 <table class="tableblock frame-all grid-all stretch">
1649 <colgroup>
1650 <col style="width: 22.2222%;">
1651 <col style="width: 33.3333%;">
1652 <col style="width: 44.4445%;">
1653 </colgroup>
1654 <thead>
1655 <tr>
1656 <th class="tableblock halign-left valign-middle">Type</th>
1657 <th class="tableblock halign-left valign-middle">Name</th>
1658 <th class="tableblock halign-left valign-middle">Schema</th>
1659 </tr>
1660 </thead>
1661 <tbody>
1662 <tr>
1663 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1665 <em>required</em></p></td>
1666 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1667 </tr>
1668 </tbody>
1669 </table>
1670 </div>
1671 <div class="sect3">
1672 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.2. Responses</a></h4>
1673 <table class="tableblock frame-all grid-all stretch">
1674 <colgroup>
1675 <col style="width: 10%;">
1676 <col style="width: 70%;">
1677 <col style="width: 20%;">
1678 </colgroup>
1679 <thead>
1680 <tr>
1681 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1682 <th class="tableblock halign-left valign-middle">Description</th>
1683 <th class="tableblock halign-left valign-middle">Schema</th>
1684 </tr>
1685 </thead>
1686 <tbody>
1687 <tr>
1688 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1689 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1690 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1691 </tr>
1692 </tbody>
1693 </table>
1694 </div>
1695 <div class="sect3">
1696 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.18.3. Produces</a></h4>
1697 <div class="ulist">
1698 <ul>
1699 <li>
1700 <p><code>application/xml</code></p>
1701 </li>
1702 </ul>
1703 </div>
1704 </div>
1705 </div>
1706 <div class="sect2">
1707 <h3 id="_route41"><a class="anchor" href="#_route41"></a><a class="link" href="#_route41">2.19. PUT /v2/loop/undeploy/{loopName}</a></h3>
1708 <div class="sect3">
1709 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.19.1. Parameters</a></h4>
1710 <table class="tableblock frame-all grid-all stretch">
1711 <colgroup>
1712 <col style="width: 22.2222%;">
1713 <col style="width: 33.3333%;">
1714 <col style="width: 44.4445%;">
1715 </colgroup>
1716 <thead>
1717 <tr>
1718 <th class="tableblock halign-left valign-middle">Type</th>
1719 <th class="tableblock halign-left valign-middle">Name</th>
1720 <th class="tableblock halign-left valign-middle">Schema</th>
1721 </tr>
1722 </thead>
1723 <tbody>
1724 <tr>
1725 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1727 <em>required</em></p></td>
1728 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1729 </tr>
1730 </tbody>
1731 </table>
1732 </div>
1733 <div class="sect3">
1734 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1735 <table class="tableblock frame-all grid-all stretch">
1736 <colgroup>
1737 <col style="width: 10%;">
1738 <col style="width: 70%;">
1739 <col style="width: 20%;">
1740 </colgroup>
1741 <thead>
1742 <tr>
1743 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1744 <th class="tableblock halign-left valign-middle">Description</th>
1745 <th class="tableblock halign-left valign-middle">Schema</th>
1746 </tr>
1747 </thead>
1748 <tbody>
1749 <tr>
1750 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1751 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1752 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1753 </tr>
1754 </tbody>
1755 </table>
1756 </div>
1757 <div class="sect3">
1758 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.19.3. Produces</a></h4>
1759 <div class="ulist">
1760 <ul>
1761 <li>
1762 <p><code>application/json</code></p>
1763 </li>
1764 </ul>
1765 </div>
1766 </div>
1767 </div>
1768 <div class="sect2">
1769 <h3 id="_route36"><a class="anchor" href="#_route36"></a><a class="link" href="#_route36">2.20. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
1770 <div class="sect3">
1771 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.20.1. Parameters</a></h4>
1772 <table class="tableblock frame-all grid-all stretch">
1773 <colgroup>
1774 <col style="width: 22.2222%;">
1775 <col style="width: 33.3333%;">
1776 <col style="width: 44.4445%;">
1777 </colgroup>
1778 <thead>
1779 <tr>
1780 <th class="tableblock halign-left valign-middle">Type</th>
1781 <th class="tableblock halign-left valign-middle">Name</th>
1782 <th class="tableblock halign-left valign-middle">Schema</th>
1783 </tr>
1784 </thead>
1785 <tbody>
1786 <tr>
1787 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1788 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1789 <em>required</em></p></td>
1790 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1791 </tr>
1792 <tr>
1793 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1794 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1795 <em>required</em></p></td>
1796 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1797 </tr>
1798 </tbody>
1799 </table>
1800 </div>
1801 <div class="sect3">
1802 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.2. Responses</a></h4>
1803 <table class="tableblock frame-all grid-all stretch">
1804 <colgroup>
1805 <col style="width: 10%;">
1806 <col style="width: 70%;">
1807 <col style="width: 20%;">
1808 </colgroup>
1809 <thead>
1810 <tr>
1811 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1812 <th class="tableblock halign-left valign-middle">Description</th>
1813 <th class="tableblock halign-left valign-middle">Schema</th>
1814 </tr>
1815 </thead>
1816 <tbody>
1817 <tr>
1818 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1819 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1821 </tr>
1822 </tbody>
1823 </table>
1824 </div>
1825 <div class="sect3">
1826 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.20.3. Consumes</a></h4>
1827 <div class="ulist">
1828 <ul>
1829 <li>
1830 <p><code>application/json</code></p>
1831 </li>
1832 </ul>
1833 </div>
1834 </div>
1835 <div class="sect3">
1836 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.20.4. Produces</a></h4>
1837 <div class="ulist">
1838 <ul>
1839 <li>
1840 <p><code>application/json</code></p>
1841 </li>
1842 </ul>
1843 </div>
1844 </div>
1845 </div>
1846 <div class="sect2">
1847 <h3 id="_route38"><a class="anchor" href="#_route38"></a><a class="link" href="#_route38">2.21. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
1848 <div class="sect3">
1849 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.21.1. Parameters</a></h4>
1850 <table class="tableblock frame-all grid-all stretch">
1851 <colgroup>
1852 <col style="width: 22.2222%;">
1853 <col style="width: 33.3333%;">
1854 <col style="width: 44.4445%;">
1855 </colgroup>
1856 <thead>
1857 <tr>
1858 <th class="tableblock halign-left valign-middle">Type</th>
1859 <th class="tableblock halign-left valign-middle">Name</th>
1860 <th class="tableblock halign-left valign-middle">Schema</th>
1861 </tr>
1862 </thead>
1863 <tbody>
1864 <tr>
1865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1866 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1867 <em>required</em></p></td>
1868 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1869 </tr>
1870 <tr>
1871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1872 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1873 <em>required</em></p></td>
1874 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1875 </tr>
1876 </tbody>
1877 </table>
1878 </div>
1879 <div class="sect3">
1880 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
1881 <table class="tableblock frame-all grid-all stretch">
1882 <colgroup>
1883 <col style="width: 10%;">
1884 <col style="width: 70%;">
1885 <col style="width: 20%;">
1886 </colgroup>
1887 <thead>
1888 <tr>
1889 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1890 <th class="tableblock halign-left valign-middle">Description</th>
1891 <th class="tableblock halign-left valign-middle">Schema</th>
1892 </tr>
1893 </thead>
1894 <tbody>
1895 <tr>
1896 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1897 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1899 </tr>
1900 </tbody>
1901 </table>
1902 </div>
1903 <div class="sect3">
1904 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.21.3. Consumes</a></h4>
1905 <div class="ulist">
1906 <ul>
1907 <li>
1908 <p><code>application/json</code></p>
1909 </li>
1910 </ul>
1911 </div>
1912 </div>
1913 <div class="sect3">
1914 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.21.4. Produces</a></h4>
1915 <div class="ulist">
1916 <ul>
1917 <li>
1918 <p><code>application/json</code></p>
1919 </li>
1920 </ul>
1921 </div>
1922 </div>
1923 </div>
1924 <div class="sect2">
1925 <h3 id="_route37"><a class="anchor" href="#_route37"></a><a class="link" href="#_route37">2.22. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
1926 <div class="sect3">
1927 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.22.1. Parameters</a></h4>
1928 <table class="tableblock frame-all grid-all stretch">
1929 <colgroup>
1930 <col style="width: 22.2222%;">
1931 <col style="width: 33.3333%;">
1932 <col style="width: 44.4445%;">
1933 </colgroup>
1934 <thead>
1935 <tr>
1936 <th class="tableblock halign-left valign-middle">Type</th>
1937 <th class="tableblock halign-left valign-middle">Name</th>
1938 <th class="tableblock halign-left valign-middle">Schema</th>
1939 </tr>
1940 </thead>
1941 <tbody>
1942 <tr>
1943 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1944 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1945 <em>required</em></p></td>
1946 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1947 </tr>
1948 <tr>
1949 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1950 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1951 <em>required</em></p></td>
1952 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1953 </tr>
1954 </tbody>
1955 </table>
1956 </div>
1957 <div class="sect3">
1958 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.2. Responses</a></h4>
1959 <table class="tableblock frame-all grid-all stretch">
1960 <colgroup>
1961 <col style="width: 10%;">
1962 <col style="width: 70%;">
1963 <col style="width: 20%;">
1964 </colgroup>
1965 <thead>
1966 <tr>
1967 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1968 <th class="tableblock halign-left valign-middle">Description</th>
1969 <th class="tableblock halign-left valign-middle">Schema</th>
1970 </tr>
1971 </thead>
1972 <tbody>
1973 <tr>
1974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1975 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1976 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1977 </tr>
1978 </tbody>
1979 </table>
1980 </div>
1981 <div class="sect3">
1982 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.22.3. Consumes</a></h4>
1983 <div class="ulist">
1984 <ul>
1985 <li>
1986 <p><code>application/json</code></p>
1987 </li>
1988 </ul>
1989 </div>
1990 </div>
1991 <div class="sect3">
1992 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.22.4. Produces</a></h4>
1993 <div class="ulist">
1994 <ul>
1995 <li>
1996 <p><code>application/json</code></p>
1997 </li>
1998 </ul>
1999 </div>
2000 </div>
2001 </div>
2002 <div class="sect2">
2003 <h3 id="_route34"><a class="anchor" href="#_route34"></a><a class="link" href="#_route34">2.23. GET /v2/loop/{loopName}</a></h3>
2004 <div class="sect3">
2005 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.23.1. Parameters</a></h4>
2006 <table class="tableblock frame-all grid-all stretch">
2007 <colgroup>
2008 <col style="width: 22.2222%;">
2009 <col style="width: 33.3333%;">
2010 <col style="width: 44.4445%;">
2011 </colgroup>
2012 <thead>
2013 <tr>
2014 <th class="tableblock halign-left valign-middle">Type</th>
2015 <th class="tableblock halign-left valign-middle">Name</th>
2016 <th class="tableblock halign-left valign-middle">Schema</th>
2017 </tr>
2018 </thead>
2019 <tbody>
2020 <tr>
2021 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2022 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2023 <em>required</em></p></td>
2024 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2025 </tr>
2026 </tbody>
2027 </table>
2028 </div>
2029 <div class="sect3">
2030 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.2. Responses</a></h4>
2031 <table class="tableblock frame-all grid-all stretch">
2032 <colgroup>
2033 <col style="width: 10%;">
2034 <col style="width: 70%;">
2035 <col style="width: 20%;">
2036 </colgroup>
2037 <thead>
2038 <tr>
2039 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2040 <th class="tableblock halign-left valign-middle">Description</th>
2041 <th class="tableblock halign-left valign-middle">Schema</th>
2042 </tr>
2043 </thead>
2044 <tbody>
2045 <tr>
2046 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2047 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2048 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2049 </tr>
2050 </tbody>
2051 </table>
2052 </div>
2053 <div class="sect3">
2054 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.23.3. Produces</a></h4>
2055 <div class="ulist">
2056 <ul>
2057 <li>
2058 <p><code>application/json</code></p>
2059 </li>
2060 </ul>
2061 </div>
2062 </div>
2063 </div>
2064 <div class="sect2">
2065 <h3 id="_route56"><a class="anchor" href="#_route56"></a><a class="link" href="#_route56">2.24. GET /v2/policyToscaModels</a></h3>
2066 <div class="sect3">
2067 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.1. Responses</a></h4>
2068 <table class="tableblock frame-all grid-all stretch">
2069 <colgroup>
2070 <col style="width: 10%;">
2071 <col style="width: 70%;">
2072 <col style="width: 20%;">
2073 </colgroup>
2074 <thead>
2075 <tr>
2076 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2077 <th class="tableblock halign-left valign-middle">Description</th>
2078 <th class="tableblock halign-left valign-middle">Schema</th>
2079 </tr>
2080 </thead>
2081 <tbody>
2082 <tr>
2083 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2084 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2085 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2086 </tr>
2087 </tbody>
2088 </table>
2089 </div>
2090 <div class="sect3">
2091 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.24.2. Produces</a></h4>
2092 <div class="ulist">
2093 <ul>
2094 <li>
2095 <p><code>application/json</code></p>
2096 </li>
2097 </ul>
2098 </div>
2099 </div>
2100 </div>
2101 <div class="sect2">
2102 <h3 id="_v2_policytoscamodels_yaml_policymodeltype_get"><a class="anchor" href="#_v2_policytoscamodels_yaml_policymodeltype_get"></a><a class="link" href="#_v2_policytoscamodels_yaml_policymodeltype_get">2.25. GET /v2/policyToscaModels/yaml/{policyModelType}</a></h3>
2103 <div class="sect3">
2104 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.25.1. Parameters</a></h4>
2105 <table class="tableblock frame-all grid-all stretch">
2106 <colgroup>
2107 <col style="width: 22.2222%;">
2108 <col style="width: 33.3333%;">
2109 <col style="width: 44.4445%;">
2110 </colgroup>
2111 <thead>
2112 <tr>
2113 <th class="tableblock halign-left valign-middle">Type</th>
2114 <th class="tableblock halign-left valign-middle">Name</th>
2115 <th class="tableblock halign-left valign-middle">Schema</th>
2116 </tr>
2117 </thead>
2118 <tbody>
2119 <tr>
2120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2121 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2122 <em>required</em></p></td>
2123 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2124 </tr>
2125 </tbody>
2126 </table>
2127 </div>
2128 <div class="sect3">
2129 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.2. Responses</a></h4>
2130 <table class="tableblock frame-all grid-all stretch">
2131 <colgroup>
2132 <col style="width: 10%;">
2133 <col style="width: 70%;">
2134 <col style="width: 20%;">
2135 </colgroup>
2136 <thead>
2137 <tr>
2138 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2139 <th class="tableblock halign-left valign-middle">Description</th>
2140 <th class="tableblock halign-left valign-middle">Schema</th>
2141 </tr>
2142 </thead>
2143 <tbody>
2144 <tr>
2145 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2146 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2147 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2148 </tr>
2149 </tbody>
2150 </table>
2151 </div>
2152 <div class="sect3">
2153 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.25.3. Produces</a></h4>
2154 <div class="ulist">
2155 <ul>
2156 <li>
2157 <p><code>application/json</code></p>
2158 </li>
2159 </ul>
2160 </div>
2161 </div>
2162 </div>
2163 <div class="sect2">
2164 <h3 id="_v2_policytoscamodels_policymodeltype_get"><a class="anchor" href="#_v2_policytoscamodels_policymodeltype_get"></a><a class="link" href="#_v2_policytoscamodels_policymodeltype_get">2.26. GET /v2/policyToscaModels/{policyModelType}</a></h3>
2165 <div class="sect3">
2166 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a><a class="link" href="#_parameters_20">2.26.1. Parameters</a></h4>
2167 <table class="tableblock frame-all grid-all stretch">
2168 <colgroup>
2169 <col style="width: 22.2222%;">
2170 <col style="width: 33.3333%;">
2171 <col style="width: 44.4445%;">
2172 </colgroup>
2173 <thead>
2174 <tr>
2175 <th class="tableblock halign-left valign-middle">Type</th>
2176 <th class="tableblock halign-left valign-middle">Name</th>
2177 <th class="tableblock halign-left valign-middle">Schema</th>
2178 </tr>
2179 </thead>
2180 <tbody>
2181 <tr>
2182 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2184 <em>required</em></p></td>
2185 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2186 </tr>
2187 </tbody>
2188 </table>
2189 </div>
2190 <div class="sect3">
2191 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2192 <table class="tableblock frame-all grid-all stretch">
2193 <colgroup>
2194 <col style="width: 10%;">
2195 <col style="width: 70%;">
2196 <col style="width: 20%;">
2197 </colgroup>
2198 <thead>
2199 <tr>
2200 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2201 <th class="tableblock halign-left valign-middle">Description</th>
2202 <th class="tableblock halign-left valign-middle">Schema</th>
2203 </tr>
2204 </thead>
2205 <tbody>
2206 <tr>
2207 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2208 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2210 </tr>
2211 </tbody>
2212 </table>
2213 </div>
2214 <div class="sect3">
2215 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.26.3. Produces</a></h4>
2216 <div class="ulist">
2217 <ul>
2218 <li>
2219 <p><code>application/json</code></p>
2220 </li>
2221 </ul>
2222 </div>
2223 </div>
2224 </div>
2225 <div class="sect2">
2226 <h3 id="_route57"><a class="anchor" href="#_route57"></a><a class="link" href="#_route57">2.27. PUT /v2/policyToscaModels/{policyModelType}</a></h3>
2227 <div class="sect3">
2228 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a><a class="link" href="#_parameters_21">2.27.1. Parameters</a></h4>
2229 <table class="tableblock frame-all grid-all stretch">
2230 <colgroup>
2231 <col style="width: 22.2222%;">
2232 <col style="width: 33.3333%;">
2233 <col style="width: 44.4445%;">
2234 </colgroup>
2235 <thead>
2236 <tr>
2237 <th class="tableblock halign-left valign-middle">Type</th>
2238 <th class="tableblock halign-left valign-middle">Name</th>
2239 <th class="tableblock halign-left valign-middle">Schema</th>
2240 </tr>
2241 </thead>
2242 <tbody>
2243 <tr>
2244 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2246 <em>required</em></p></td>
2247 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2248 </tr>
2249 <tr>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2252 <em>required</em></p></td>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2254 </tr>
2255 </tbody>
2256 </table>
2257 </div>
2258 <div class="sect3">
2259 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.2. Responses</a></h4>
2260 <table class="tableblock frame-all grid-all stretch">
2261 <colgroup>
2262 <col style="width: 10%;">
2263 <col style="width: 70%;">
2264 <col style="width: 20%;">
2265 </colgroup>
2266 <thead>
2267 <tr>
2268 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2269 <th class="tableblock halign-left valign-middle">Description</th>
2270 <th class="tableblock halign-left valign-middle">Schema</th>
2271 </tr>
2272 </thead>
2273 <tbody>
2274 <tr>
2275 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2276 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2277 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2278 </tr>
2279 </tbody>
2280 </table>
2281 </div>
2282 <div class="sect3">
2283 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.27.3. Consumes</a></h4>
2284 <div class="ulist">
2285 <ul>
2286 <li>
2287 <p><code>plain/text</code></p>
2288 </li>
2289 </ul>
2290 </div>
2291 </div>
2292 <div class="sect3">
2293 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.27.4. Produces</a></h4>
2294 <div class="ulist">
2295 <ul>
2296 <li>
2297 <p><code>application/json</code></p>
2298 </li>
2299 </ul>
2300 </div>
2301 </div>
2302 </div>
2303 <div class="sect2">
2304 <h3 id="_route60"><a class="anchor" href="#_route60"></a><a class="link" href="#_route60">2.28. GET /v2/templates</a></h3>
2305 <div class="sect3">
2306 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.1. Responses</a></h4>
2307 <table class="tableblock frame-all grid-all stretch">
2308 <colgroup>
2309 <col style="width: 10%;">
2310 <col style="width: 70%;">
2311 <col style="width: 20%;">
2312 </colgroup>
2313 <thead>
2314 <tr>
2315 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2316 <th class="tableblock halign-left valign-middle">Description</th>
2317 <th class="tableblock halign-left valign-middle">Schema</th>
2318 </tr>
2319 </thead>
2320 <tbody>
2321 <tr>
2322 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2323 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2324 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2325 </tr>
2326 </tbody>
2327 </table>
2328 </div>
2329 <div class="sect3">
2330 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.28.2. Produces</a></h4>
2331 <div class="ulist">
2332 <ul>
2333 <li>
2334 <p><code>application/json</code></p>
2335 </li>
2336 </ul>
2337 </div>
2338 </div>
2339 </div>
2340 <div class="sect2">
2341 <h3 id="_v2_templates_names_get"><a class="anchor" href="#_v2_templates_names_get"></a><a class="link" href="#_v2_templates_names_get">2.29. GET /v2/templates/names</a></h3>
2342 <div class="sect3">
2343 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.1. Responses</a></h4>
2344 <table class="tableblock frame-all grid-all stretch">
2345 <colgroup>
2346 <col style="width: 10%;">
2347 <col style="width: 70%;">
2348 <col style="width: 20%;">
2349 </colgroup>
2350 <thead>
2351 <tr>
2352 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2353 <th class="tableblock halign-left valign-middle">Description</th>
2354 <th class="tableblock halign-left valign-middle">Schema</th>
2355 </tr>
2356 </thead>
2357 <tbody>
2358 <tr>
2359 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2360 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2361 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
2362 </tr>
2363 </tbody>
2364 </table>
2365 </div>
2366 <div class="sect3">
2367 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.29.2. Produces</a></h4>
2368 <div class="ulist">
2369 <ul>
2370 <li>
2371 <p><code>application/json</code></p>
2372 </li>
2373 </ul>
2374 </div>
2375 </div>
2376 </div>
2377 <div class="sect2">
2378 <h3 id="_v2_templates_templatename_get"><a class="anchor" href="#_v2_templates_templatename_get"></a><a class="link" href="#_v2_templates_templatename_get">2.30. GET /v2/templates/{templateName}</a></h3>
2379 <div class="sect3">
2380 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a><a class="link" href="#_parameters_22">2.30.1. Parameters</a></h4>
2381 <table class="tableblock frame-all grid-all stretch">
2382 <colgroup>
2383 <col style="width: 22.2222%;">
2384 <col style="width: 33.3333%;">
2385 <col style="width: 44.4445%;">
2386 </colgroup>
2387 <thead>
2388 <tr>
2389 <th class="tableblock halign-left valign-middle">Type</th>
2390 <th class="tableblock halign-left valign-middle">Name</th>
2391 <th class="tableblock halign-left valign-middle">Schema</th>
2392 </tr>
2393 </thead>
2394 <tbody>
2395 <tr>
2396 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2397 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2398 <em>required</em></p></td>
2399 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2400 </tr>
2401 </tbody>
2402 </table>
2403 </div>
2404 <div class="sect3">
2405 <h4 id="_responses_30"><a class="anchor" href="#_responses_30"></a><a class="link" href="#_responses_30">2.30.2. Responses</a></h4>
2406 <table class="tableblock frame-all grid-all stretch">
2407 <colgroup>
2408 <col style="width: 10%;">
2409 <col style="width: 70%;">
2410 <col style="width: 20%;">
2411 </colgroup>
2412 <thead>
2413 <tr>
2414 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2415 <th class="tableblock halign-left valign-middle">Description</th>
2416 <th class="tableblock halign-left valign-middle">Schema</th>
2417 </tr>
2418 </thead>
2419 <tbody>
2420 <tr>
2421 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2422 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2423 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2424 </tr>
2425 </tbody>
2426 </table>
2427 </div>
2428 <div class="sect3">
2429 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.30.3. Produces</a></h4>
2430 <div class="ulist">
2431 <ul>
2432 <li>
2433 <p><code>application/json</code></p>
2434 </li>
2435 </ul>
2436 </div>
2437 </div>
2438 </div>
2439 </div>
2440 </div>
2441 <div class="sect1">
2442 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
2443 <div class="sectionbody">
2444 <div class="sect2">
2445 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a><a class="link" href="#_cldshealthcheck">3.1. CldsHealthCheck</a></h3>
2446 <table class="tableblock frame-all grid-all stretch">
2447 <colgroup>
2448 <col style="width: 42.8571%;">
2449 <col style="width: 57.1429%;">
2450 </colgroup>
2451 <thead>
2452 <tr>
2453 <th class="tableblock halign-left valign-middle">Name</th>
2454 <th class="tableblock halign-left valign-middle">Schema</th>
2455 </tr>
2456 </thead>
2457 <tbody>
2458 <tr>
2459 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2460 <em>optional</em></p></td>
2461 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2462 </tr>
2463 <tr>
2464 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
2465 <em>optional</em></p></td>
2466 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2467 </tr>
2468 <tr>
2469 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
2470 <em>optional</em></p></td>
2471 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2472 </tr>
2473 </tbody>
2474 </table>
2475 </div>
2476 <div class="sect2">
2477 <h3 id="_dictionary"><a class="anchor" href="#_dictionary"></a><a class="link" href="#_dictionary">3.2. Dictionary</a></h3>
2478 <table class="tableblock frame-all grid-all stretch">
2479 <colgroup>
2480 <col style="width: 42.8571%;">
2481 <col style="width: 57.1429%;">
2482 </colgroup>
2483 <thead>
2484 <tr>
2485 <th class="tableblock halign-left valign-middle">Name</th>
2486 <th class="tableblock halign-left valign-middle">Schema</th>
2487 </tr>
2488 </thead>
2489 <tbody>
2490 <tr>
2491 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
2492 <em>optional</em></p></td>
2493 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2494 </tr>
2495 <tr>
2496 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
2497 <em>optional</em></p></td>
2498 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2499 </tr>
2500 <tr>
2501 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryElements</strong><br>
2502 <em>optional</em></p></td>
2503 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_dictionaryelement">DictionaryElement</a> &gt; array</p></td>
2504 </tr>
2505 <tr>
2506 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2507 <em>optional</em></p></td>
2508 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2509 </tr>
2510 <tr>
2511 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>secondLevelDictionary</strong><br>
2512 <em>optional</em></p></td>
2513 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2514 </tr>
2515 <tr>
2516 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionaryType</strong><br>
2517 <em>optional</em></p></td>
2518 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2519 </tr>
2520 <tr>
2521 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
2522 <em>optional</em></p></td>
2523 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2524 </tr>
2525 <tr>
2526 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
2527 <em>optional</em></p></td>
2528 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2529 </tr>
2530 </tbody>
2531 </table>
2532 </div>
2533 <div class="sect2">
2534 <h3 id="_dictionaryelement"><a class="anchor" href="#_dictionaryelement"></a><a class="link" href="#_dictionaryelement">3.3. DictionaryElement</a></h3>
2535 <table class="tableblock frame-all grid-all stretch">
2536 <colgroup>
2537 <col style="width: 42.8571%;">
2538 <col style="width: 57.1429%;">
2539 </colgroup>
2540 <thead>
2541 <tr>
2542 <th class="tableblock halign-left valign-middle">Name</th>
2543 <th class="tableblock halign-left valign-middle">Schema</th>
2544 </tr>
2545 </thead>
2546 <tbody>
2547 <tr>
2548 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
2549 <em>optional</em></p></td>
2550 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2551 </tr>
2552 <tr>
2553 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
2554 <em>optional</em></p></td>
2555 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2556 </tr>
2557 <tr>
2558 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2559 <em>optional</em></p></td>
2560 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2561 </tr>
2562 <tr>
2563 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2564 <em>optional</em></p></td>
2565 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2566 </tr>
2567 <tr>
2568 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
2569 <em>optional</em></p></td>
2570 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2571 </tr>
2572 <tr>
2573 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionary</strong><br>
2574 <em>optional</em></p></td>
2575 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2576 </tr>
2577 <tr>
2578 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
2579 <em>optional</em></p></td>
2580 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2581 </tr>
2582 <tr>
2583 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
2584 <em>optional</em></p></td>
2585 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2586 </tr>
2587 <tr>
2588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
2589 <em>optional</em></p></td>
2590 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2591 </tr>
2592 <tr>
2593 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByDictionaries</strong><br>
2594 <em>optional</em></p></td>
2595 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_dictionary">Dictionary</a> &gt; array</p></td>
2596 </tr>
2597 </tbody>
2598 </table>
2599 </div>
2600 <div class="sect2">
2601 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.4. ExternalComponent</a></h3>
2602 <table class="tableblock frame-all grid-all stretch">
2603 <colgroup>
2604 <col style="width: 42.8571%;">
2605 <col style="width: 57.1429%;">
2606 </colgroup>
2607 <thead>
2608 <tr>
2609 <th class="tableblock halign-left valign-middle">Name</th>
2610 <th class="tableblock halign-left valign-middle">Schema</th>
2611 </tr>
2612 </thead>
2613 <tbody>
2614 <tr>
2615 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
2616 <em>optional</em></p></td>
2617 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2618 </tr>
2619 <tr>
2620 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
2621 <em>optional</em></p></td>
2622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
2623 </tr>
2624 </tbody>
2625 </table>
2626 </div>
2627 <div class="sect2">
2628 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.5. ExternalComponentState</a></h3>
2629 <table class="tableblock frame-all grid-all stretch">
2630 <colgroup>
2631 <col style="width: 42.8571%;">
2632 <col style="width: 57.1429%;">
2633 </colgroup>
2634 <thead>
2635 <tr>
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>description</strong><br>
2643 <em>optional</em></p></td>
2644 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2645 </tr>
2646 <tr>
2647 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
2648 <em>optional</em></p></td>
2649 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2650 </tr>
2651 <tr>
2652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
2653 <em>optional</em></p></td>
2654 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2655 </tr>
2656 </tbody>
2657 </table>
2658 </div>
2659 <div class="sect2">
2660 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.6. JsonArray</a></h3>
2661 <table class="tableblock frame-all grid-all stretch">
2662 <colgroup>
2663 <col style="width: 42.8571%;">
2664 <col style="width: 57.1429%;">
2665 </colgroup>
2666 <thead>
2667 <tr>
2668 <th class="tableblock halign-left valign-middle">Name</th>
2669 <th class="tableblock halign-left valign-middle">Schema</th>
2670 </tr>
2671 </thead>
2672 <tbody>
2673 <tr>
2674 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2675 <em>optional</em></p></td>
2676 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2677 </tr>
2678 <tr>
2679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2680 <em>optional</em></p></td>
2681 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2682 </tr>
2683 <tr>
2684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2685 <em>optional</em></p></td>
2686 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2687 </tr>
2688 <tr>
2689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2690 <em>optional</em></p></td>
2691 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2692 </tr>
2693 <tr>
2694 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2695 <em>optional</em></p></td>
2696 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2697 </tr>
2698 <tr>
2699 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2700 <em>optional</em></p></td>
2701 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2702 </tr>
2703 <tr>
2704 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2705 <em>optional</em></p></td>
2706 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2707 </tr>
2708 <tr>
2709 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2710 <em>optional</em></p></td>
2711 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2712 </tr>
2713 <tr>
2714 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2715 <em>optional</em></p></td>
2716 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2717 </tr>
2718 <tr>
2719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2720 <em>optional</em></p></td>
2721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2722 </tr>
2723 <tr>
2724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2725 <em>optional</em></p></td>
2726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2727 </tr>
2728 <tr>
2729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2730 <em>optional</em></p></td>
2731 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2732 </tr>
2733 <tr>
2734 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2735 <em>optional</em></p></td>
2736 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2737 </tr>
2738 <tr>
2739 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2740 <em>optional</em></p></td>
2741 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2742 </tr>
2743 <tr>
2744 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2745 <em>optional</em></p></td>
2746 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2747 </tr>
2748 <tr>
2749 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2750 <em>optional</em></p></td>
2751 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2752 </tr>
2753 <tr>
2754 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2755 <em>optional</em></p></td>
2756 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2757 </tr>
2758 <tr>
2759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2760 <em>optional</em></p></td>
2761 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2762 </tr>
2763 <tr>
2764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2765 <em>optional</em></p></td>
2766 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2767 </tr>
2768 <tr>
2769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2770 <em>optional</em></p></td>
2771 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2772 </tr>
2773 </tbody>
2774 </table>
2775 </div>
2776 <div class="sect2">
2777 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.7. JsonNull</a></h3>
2778 <table class="tableblock frame-all grid-all stretch">
2779 <colgroup>
2780 <col style="width: 42.8571%;">
2781 <col style="width: 57.1429%;">
2782 </colgroup>
2783 <thead>
2784 <tr>
2785 <th class="tableblock halign-left valign-middle">Name</th>
2786 <th class="tableblock halign-left valign-middle">Schema</th>
2787 </tr>
2788 </thead>
2789 <tbody>
2790 <tr>
2791 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2792 <em>optional</em></p></td>
2793 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2794 </tr>
2795 <tr>
2796 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2797 <em>optional</em></p></td>
2798 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2799 </tr>
2800 <tr>
2801 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2802 <em>optional</em></p></td>
2803 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2804 </tr>
2805 <tr>
2806 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2807 <em>optional</em></p></td>
2808 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2809 </tr>
2810 <tr>
2811 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2812 <em>optional</em></p></td>
2813 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2814 </tr>
2815 <tr>
2816 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2817 <em>optional</em></p></td>
2818 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2819 </tr>
2820 <tr>
2821 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2822 <em>optional</em></p></td>
2823 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2824 </tr>
2825 <tr>
2826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2827 <em>optional</em></p></td>
2828 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2829 </tr>
2830 <tr>
2831 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2832 <em>optional</em></p></td>
2833 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2834 </tr>
2835 <tr>
2836 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2837 <em>optional</em></p></td>
2838 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2839 </tr>
2840 <tr>
2841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2842 <em>optional</em></p></td>
2843 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2844 </tr>
2845 <tr>
2846 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2847 <em>optional</em></p></td>
2848 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2849 </tr>
2850 <tr>
2851 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2852 <em>optional</em></p></td>
2853 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2854 </tr>
2855 <tr>
2856 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2857 <em>optional</em></p></td>
2858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2859 </tr>
2860 <tr>
2861 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2862 <em>optional</em></p></td>
2863 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2864 </tr>
2865 <tr>
2866 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2867 <em>optional</em></p></td>
2868 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2869 </tr>
2870 <tr>
2871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2872 <em>optional</em></p></td>
2873 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2874 </tr>
2875 <tr>
2876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2877 <em>optional</em></p></td>
2878 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2879 </tr>
2880 <tr>
2881 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2882 <em>optional</em></p></td>
2883 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2884 </tr>
2885 <tr>
2886 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2887 <em>optional</em></p></td>
2888 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2889 </tr>
2890 </tbody>
2891 </table>
2892 </div>
2893 <div class="sect2">
2894 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.8. JsonObject</a></h3>
2895 <table class="tableblock frame-all grid-all stretch">
2896 <colgroup>
2897 <col style="width: 42.8571%;">
2898 <col style="width: 57.1429%;">
2899 </colgroup>
2900 <thead>
2901 <tr>
2902 <th class="tableblock halign-left valign-middle">Name</th>
2903 <th class="tableblock halign-left valign-middle">Schema</th>
2904 </tr>
2905 </thead>
2906 <tbody>
2907 <tr>
2908 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2909 <em>optional</em></p></td>
2910 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2911 </tr>
2912 <tr>
2913 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2914 <em>optional</em></p></td>
2915 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2916 </tr>
2917 <tr>
2918 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2919 <em>optional</em></p></td>
2920 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2921 </tr>
2922 <tr>
2923 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2924 <em>optional</em></p></td>
2925 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2926 </tr>
2927 <tr>
2928 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2929 <em>optional</em></p></td>
2930 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2931 </tr>
2932 <tr>
2933 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2934 <em>optional</em></p></td>
2935 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2936 </tr>
2937 <tr>
2938 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2939 <em>optional</em></p></td>
2940 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2941 </tr>
2942 <tr>
2943 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2944 <em>optional</em></p></td>
2945 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2946 </tr>
2947 <tr>
2948 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2949 <em>optional</em></p></td>
2950 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2951 </tr>
2952 <tr>
2953 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2954 <em>optional</em></p></td>
2955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2956 </tr>
2957 <tr>
2958 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2959 <em>optional</em></p></td>
2960 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2961 </tr>
2962 <tr>
2963 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2964 <em>optional</em></p></td>
2965 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2966 </tr>
2967 <tr>
2968 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2969 <em>optional</em></p></td>
2970 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2971 </tr>
2972 <tr>
2973 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2974 <em>optional</em></p></td>
2975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2976 </tr>
2977 <tr>
2978 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2979 <em>optional</em></p></td>
2980 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2981 </tr>
2982 <tr>
2983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2984 <em>optional</em></p></td>
2985 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2986 </tr>
2987 <tr>
2988 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2989 <em>optional</em></p></td>
2990 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2991 </tr>
2992 <tr>
2993 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2994 <em>optional</em></p></td>
2995 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2996 </tr>
2997 <tr>
2998 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2999 <em>optional</em></p></td>
3000 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3001 </tr>
3002 <tr>
3003 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3004 <em>optional</em></p></td>
3005 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3006 </tr>
3007 </tbody>
3008 </table>
3009 </div>
3010 <div class="sect2">
3011 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.9. JsonPrimitive</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>asBigDecimal</strong><br>
3026 <em>optional</em></p></td>
3027 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3028 </tr>
3029 <tr>
3030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3031 <em>optional</em></p></td>
3032 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3033 </tr>
3034 <tr>
3035 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3036 <em>optional</em></p></td>
3037 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3038 </tr>
3039 <tr>
3040 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3041 <em>optional</em></p></td>
3042 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3043 </tr>
3044 <tr>
3045 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3046 <em>optional</em></p></td>
3047 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3048 </tr>
3049 <tr>
3050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3051 <em>optional</em></p></td>
3052 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3053 </tr>
3054 <tr>
3055 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3056 <em>optional</em></p></td>
3057 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3058 </tr>
3059 <tr>
3060 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3061 <em>optional</em></p></td>
3062 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3063 </tr>
3064 <tr>
3065 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3066 <em>optional</em></p></td>
3067 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3068 </tr>
3069 <tr>
3070 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3071 <em>optional</em></p></td>
3072 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3073 </tr>
3074 <tr>
3075 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3076 <em>optional</em></p></td>
3077 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3078 </tr>
3079 <tr>
3080 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3081 <em>optional</em></p></td>
3082 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3083 </tr>
3084 <tr>
3085 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3086 <em>optional</em></p></td>
3087 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3088 </tr>
3089 <tr>
3090 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3091 <em>optional</em></p></td>
3092 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3093 </tr>
3094 <tr>
3095 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3096 <em>optional</em></p></td>
3097 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3098 </tr>
3099 <tr>
3100 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3101 <em>optional</em></p></td>
3102 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3103 </tr>
3104 <tr>
3105 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
3106 <em>optional</em></p></td>
3107 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3108 </tr>
3109 <tr>
3110 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3111 <em>optional</em></p></td>
3112 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3113 </tr>
3114 <tr>
3115 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3116 <em>optional</em></p></td>
3117 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3118 </tr>
3119 <tr>
3120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3121 <em>optional</em></p></td>
3122 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3123 </tr>
3124 <tr>
3125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3126 <em>optional</em></p></td>
3127 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3128 </tr>
3129 <tr>
3130 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
3131 <em>optional</em></p></td>
3132 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3133 </tr>
3134 <tr>
3135 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
3136 <em>optional</em></p></td>
3137 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3138 </tr>
3139 </tbody>
3140 </table>
3141 </div>
3142 <div class="sect2">
3143 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.10. Loop</a></h3>
3144 <table class="tableblock frame-all grid-all stretch">
3145 <colgroup>
3146 <col style="width: 42.8571%;">
3147 <col style="width: 57.1429%;">
3148 </colgroup>
3149 <thead>
3150 <tr>
3151 <th class="tableblock halign-left valign-middle">Name</th>
3152 <th class="tableblock halign-left valign-middle">Schema</th>
3153 </tr>
3154 </thead>
3155 <tbody>
3156 <tr>
3157 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
3158 <em>optional</em></p></td>
3159 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string, <a href="#_externalcomponent">ExternalComponent</a> &gt; map</p></td>
3160 </tr>
3161 <tr>
3162 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3163 <em>optional</em></p></td>
3164 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3165 </tr>
3166 <tr>
3167 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3168 <em>optional</em></p></td>
3169 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3170 </tr>
3171 <tr>
3172 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
3173 <em>optional</em></p></td>
3174 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3175 </tr>
3176 <tr>
3177 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
3178 <em>optional</em></p></td>
3179 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3180 </tr>
3181 <tr>
3182 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
3183 <em>optional</em></p></td>
3184 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3185 </tr>
3186 <tr>
3187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
3188 <em>optional</em></p></td>
3189 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
3190 </tr>
3191 <tr>
3192 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
3193 <em>optional</em></p></td>
3194 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looplog">LoopLog</a> &gt; array</p></td>
3195 </tr>
3196 <tr>
3197 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
3198 <em>optional</em></p></td>
3199 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3200 </tr>
3201 <tr>
3202 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
3203 <em>optional</em></p></td>
3204 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_microservicepolicy">MicroServicePolicy</a> &gt; array</p></td>
3205 </tr>
3206 <tr>
3207 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3208 <em>optional</em></p></td>
3209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3210 </tr>
3211 <tr>
3212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3213 <em>optional</em></p></td>
3214 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3215 </tr>
3216 <tr>
3217 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
3218 <em>optional</em></p></td>
3219 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_operationalpolicy">OperationalPolicy</a> &gt; array</p></td>
3220 </tr>
3221 <tr>
3222 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3223 <em>optional</em></p></td>
3224 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3225 </tr>
3226 <tr>
3227 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3228 <em>optional</em></p></td>
3229 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3230 </tr>
3231 <tr>
3232 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3233 <em>optional</em></p></td>
3234 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3235 </tr>
3236 </tbody>
3237 </table>
3238 </div>
3239 <div class="sect2">
3240 <h3 id="_loopelementmodel"><a class="anchor" href="#_loopelementmodel"></a><a class="link" href="#_loopelementmodel">3.11. LoopElementModel</a></h3>
3241 <table class="tableblock frame-all grid-all stretch">
3242 <colgroup>
3243 <col style="width: 42.8571%;">
3244 <col style="width: 57.1429%;">
3245 </colgroup>
3246 <thead>
3247 <tr>
3248 <th class="tableblock halign-left valign-middle">Name</th>
3249 <th class="tableblock halign-left valign-middle">Schema</th>
3250 </tr>
3251 </thead>
3252 <tbody>
3253 <tr>
3254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3255 <em>optional</em></p></td>
3256 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3257 </tr>
3258 <tr>
3259 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3260 <em>optional</em></p></td>
3261 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3262 </tr>
3263 <tr>
3264 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3265 <em>optional</em></p></td>
3266 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3267 </tr>
3268 <tr>
3269 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3270 <em>optional</em></p></td>
3271 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3272 </tr>
3273 <tr>
3274 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementType</strong><br>
3275 <em>optional</em></p></td>
3276 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3277 </tr>
3278 <tr>
3279 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3280 <em>optional</em></p></td>
3281 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3282 </tr>
3283 <tr>
3284 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModels</strong><br>
3285 <em>optional</em></p></td>
3286 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_policymodel">PolicyModel</a> &gt; array</p></td>
3287 </tr>
3288 <tr>
3289 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
3290 <em>optional</em></p></td>
3291 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3292 </tr>
3293 <tr>
3294 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3295 <em>optional</em></p></td>
3296 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3297 </tr>
3298 <tr>
3299 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3300 <em>optional</em></p></td>
3301 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3302 </tr>
3303 <tr>
3304 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoopTemplates</strong><br>
3305 <em>optional</em></p></td>
3306 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
3307 </tr>
3308 </tbody>
3309 </table>
3310 </div>
3311 <div class="sect2">
3312 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.12. LoopLog</a></h3>
3313 <table class="tableblock frame-all grid-all stretch">
3314 <colgroup>
3315 <col style="width: 42.8571%;">
3316 <col style="width: 57.1429%;">
3317 </colgroup>
3318 <thead>
3319 <tr>
3320 <th class="tableblock halign-left valign-middle">Name</th>
3321 <th class="tableblock halign-left valign-middle">Schema</th>
3322 </tr>
3323 </thead>
3324 <tbody>
3325 <tr>
3326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3327 <em>optional</em></p></td>
3328 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3329 </tr>
3330 <tr>
3331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
3332 <em>optional</em></p></td>
3333 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3334 </tr>
3335 <tr>
3336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
3337 <em>optional</em></p></td>
3338 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3339 </tr>
3340 <tr>
3341 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
3342 <em>optional</em></p></td>
3343 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
3344 </tr>
3345 <tr>
3346 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
3347 <em>optional</em></p></td>
3348 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3349 </tr>
3350 <tr>
3351 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
3352 <em>optional</em></p></td>
3353 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3354 </tr>
3355 </tbody>
3356 </table>
3357 </div>
3358 <div class="sect2">
3359 <h3 id="_looptemplate"><a class="anchor" href="#_looptemplate"></a><a class="link" href="#_looptemplate">3.13. LoopTemplate</a></h3>
3360 <table class="tableblock frame-all grid-all stretch">
3361 <colgroup>
3362 <col style="width: 42.8571%;">
3363 <col style="width: 57.1429%;">
3364 </colgroup>
3365 <thead>
3366 <tr>
3367 <th class="tableblock halign-left valign-middle">Name</th>
3368 <th class="tableblock halign-left valign-middle">Schema</th>
3369 </tr>
3370 </thead>
3371 <tbody>
3372 <tr>
3373 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allowedLoopType</strong><br>
3374 <em>optional</em></p></td>
3375 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (OPEN, CLOSED, HYBRID)</p></td>
3376 </tr>
3377 <tr>
3378 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3379 <em>optional</em></p></td>
3380 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3381 </tr>
3382 <tr>
3383 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3384 <em>optional</em></p></td>
3385 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3386 </tr>
3387 <tr>
3388 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3389 <em>optional</em></p></td>
3390 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3391 </tr>
3392 <tr>
3393 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3394 <em>optional</em></p></td>
3395 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3396 </tr>
3397 <tr>
3398 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModelsUsed</strong><br>
3399 <em>optional</em></p></td>
3400 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
3401 </tr>
3402 <tr>
3403 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>maximumInstancesAllowed</strong><br>
3404 <em>optional</em></p></td>
3405 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3406 </tr>
3407 <tr>
3408 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3409 <em>optional</em></p></td>
3410 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3411 </tr>
3412 <tr>
3413 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3414 <em>optional</em></p></td>
3415 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3416 </tr>
3417 <tr>
3418 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3419 <em>optional</em></p></td>
3420 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3421 </tr>
3422 <tr>
3423 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>uniqueBlueprint</strong><br>
3424 <em>optional</em></p></td>
3425 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3426 </tr>
3427 <tr>
3428 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3429 <em>optional</em></p></td>
3430 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3431 </tr>
3432 <tr>
3433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3434 <em>optional</em></p></td>
3435 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3436 </tr>
3437 </tbody>
3438 </table>
3439 </div>
3440 <div class="sect2">
3441 <h3 id="_looptemplateloopelementmodel"><a class="anchor" href="#_looptemplateloopelementmodel"></a><a class="link" href="#_looptemplateloopelementmodel">3.14. LoopTemplateLoopElementModel</a></h3>
3442 <table class="tableblock frame-all grid-all stretch">
3443 <colgroup>
3444 <col style="width: 42.8571%;">
3445 <col style="width: 57.1429%;">
3446 </colgroup>
3447 <thead>
3448 <tr>
3449 <th class="tableblock halign-left valign-middle">Name</th>
3450 <th class="tableblock halign-left valign-middle">Schema</th>
3451 </tr>
3452 </thead>
3453 <tbody>
3454 <tr>
3455 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>flowOrder</strong><br>
3456 <em>optional</em></p></td>
3457 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3458 </tr>
3459 <tr>
3460 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
3461 <em>optional</em></p></td>
3462 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
3463 </tr>
3464 <tr>
3465 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
3466 <em>optional</em></p></td>
3467 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3468 </tr>
3469 </tbody>
3470 </table>
3471 </div>
3472 <div class="sect2">
3473 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.15. MicroServicePolicy</a></h3>
3474 <table class="tableblock frame-all grid-all stretch">
3475 <colgroup>
3476 <col style="width: 42.8571%;">
3477 <col style="width: 57.1429%;">
3478 </colgroup>
3479 <thead>
3480 <tr>
3481 <th class="tableblock halign-left valign-middle">Name</th>
3482 <th class="tableblock halign-left valign-middle">Schema</th>
3483 </tr>
3484 </thead>
3485 <tbody>
3486 <tr>
3487 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
3488 <em>optional</em></p></td>
3489 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3490 </tr>
3491 <tr>
3492 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>context</strong><br>
3493 <em>optional</em></p></td>
3494 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3495 </tr>
3496 <tr>
3497 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3498 <em>optional</em></p></td>
3499 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3500 </tr>
3501 <tr>
3502 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3503 <em>optional</em></p></td>
3504 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3505 </tr>
3506 <tr>
3507 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3508 <em>optional</em></p></td>
3509 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3510 </tr>
3511 <tr>
3512 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
3513 <em>optional</em></p></td>
3514 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3515 </tr>
3516 <tr>
3517 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
3518 <em>optional</em></p></td>
3519 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3520 </tr>
3521 <tr>
3522 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deviceTypeScope</strong><br>
3523 <em>optional</em></p></td>
3524 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3525 </tr>
3526 <tr>
3527 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
3528 <em>optional</em></p></td>
3529 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3530 </tr>
3531 <tr>
3532 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
3533 <em>optional</em></p></td>
3534 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
3535 </tr>
3536 <tr>
3537 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3538 <em>optional</em></p></td>
3539 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3540 </tr>
3541 <tr>
3542 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
3543 <em>optional</em></p></td>
3544 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3545 </tr>
3546 <tr>
3547 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
3548 <em>optional</em></p></td>
3549 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3550 </tr>
3551 <tr>
3552 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
3553 <em>optional</em></p></td>
3554 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
3555 </tr>
3556 <tr>
3557 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
3558 <em>optional</em></p></td>
3559 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3560 </tr>
3561 <tr>
3562 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3563 <em>optional</em></p></td>
3564 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3565 </tr>
3566 <tr>
3567 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3568 <em>optional</em></p></td>
3569 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3570 </tr>
3571 <tr>
3572 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
3573 <em>optional</em></p></td>
3574 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loop">Loop</a> &gt; array</p></td>
3575 </tr>
3576 </tbody>
3577 </table>
3578 </div>
3579 <div class="sect2">
3580 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.16. Number</a></h3>
3581 <div class="paragraph">
3582 <p><em>Type</em> : object</p>
3583 </div>
3584 </div>
3585 <div class="sect2">
3586 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.17. OperationalPolicy</a></h3>
3587 <table class="tableblock frame-all grid-all stretch">
3588 <colgroup>
3589 <col style="width: 42.8571%;">
3590 <col style="width: 57.1429%;">
3591 </colgroup>
3592 <thead>
3593 <tr>
3594 <th class="tableblock halign-left valign-middle">Name</th>
3595 <th class="tableblock halign-left valign-middle">Schema</th>
3596 </tr>
3597 </thead>
3598 <tbody>
3599 <tr>
3600 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
3601 <em>optional</em></p></td>
3602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3603 </tr>
3604 <tr>
3605 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3606 <em>optional</em></p></td>
3607 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3608 </tr>
3609 <tr>
3610 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3611 <em>optional</em></p></td>
3612 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3613 </tr>
3614 <tr>
3615 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
3616 <em>optional</em></p></td>
3617 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3618 </tr>
3619 <tr>
3620 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>legacy</strong><br>
3621 <em>optional</em></p></td>
3622 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3623 </tr>
3624 <tr>
3625 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
3626 <em>optional</em></p></td>
3627 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3628 </tr>
3629 <tr>
3630 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
3631 <em>optional</em></p></td>
3632 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
3633 </tr>
3634 <tr>
3635 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3636 <em>optional</em></p></td>
3637 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3638 </tr>
3639 <tr>
3640 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
3641 <em>optional</em></p></td>
3642 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3643 </tr>
3644 <tr>
3645 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
3646 <em>optional</em></p></td>
3647 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3648 </tr>
3649 <tr>
3650 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
3651 <em>optional</em></p></td>
3652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
3653 </tr>
3654 <tr>
3655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3656 <em>optional</em></p></td>
3657 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3658 </tr>
3659 <tr>
3660 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3661 <em>optional</em></p></td>
3662 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3663 </tr>
3664 </tbody>
3665 </table>
3666 </div>
3667 <div class="sect2">
3668 <h3 id="_policymodel"><a class="anchor" href="#_policymodel"></a><a class="link" href="#_policymodel">3.18. PolicyModel</a></h3>
3669 <table class="tableblock frame-all grid-all stretch">
3670 <colgroup>
3671 <col style="width: 42.8571%;">
3672 <col style="width: 57.1429%;">
3673 </colgroup>
3674 <thead>
3675 <tr>
3676 <th class="tableblock halign-left valign-middle">Name</th>
3677 <th class="tableblock halign-left valign-middle">Schema</th>
3678 </tr>
3679 </thead>
3680 <tbody>
3681 <tr>
3682 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3683 <em>optional</em></p></td>
3684 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3685 </tr>
3686 <tr>
3687 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3688 <em>optional</em></p></td>
3689 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3690 </tr>
3691 <tr>
3692 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyAcronym</strong><br>
3693 <em>optional</em></p></td>
3694 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3695 </tr>
3696 <tr>
3697 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelTosca</strong><br>
3698 <em>optional</em></p></td>
3699 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3700 </tr>
3701 <tr>
3702 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
3703 <em>optional</em></p></td>
3704 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3705 </tr>
3706 <tr>
3707 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyPdpGroup</strong><br>
3708 <em>optional</em></p></td>
3709 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3710 </tr>
3711 <tr>
3712 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3713 <em>optional</em></p></td>
3714 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3715 </tr>
3716 <tr>
3717 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3718 <em>optional</em></p></td>
3719 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3720 </tr>
3721 <tr>
3722 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByElementModels</strong><br>
3723 <em>optional</em></p></td>
3724 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loopelementmodel">LoopElementModel</a> &gt; array</p></td>
3725 </tr>
3726 <tr>
3727 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
3728 <em>optional</em></p></td>
3729 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3730 </tr>
3731 </tbody>
3732 </table>
3733 </div>
3734 <div class="sect2">
3735 <h3 id="_service"><a class="anchor" href="#_service"></a><a class="link" href="#_service">3.19. Service</a></h3>
3736 <table class="tableblock frame-all grid-all stretch">
3737 <colgroup>
3738 <col style="width: 42.8571%;">
3739 <col style="width: 57.1429%;">
3740 </colgroup>
3741 <thead>
3742 <tr>
3743 <th class="tableblock halign-left valign-middle">Name</th>
3744 <th class="tableblock halign-left valign-middle">Schema</th>
3745 </tr>
3746 </thead>
3747 <tbody>
3748 <tr>
3749 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3750 <em>optional</em></p></td>
3751 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3752 </tr>
3753 <tr>
3754 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceDetails</strong><br>
3755 <em>optional</em></p></td>
3756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3757 </tr>
3758 <tr>
3759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceDetails</strong><br>
3760 <em>optional</em></p></td>
3761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3762 </tr>
3763 <tr>
3764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUuid</strong><br>
3765 <em>optional</em></p></td>
3766 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3767 </tr>
3768 <tr>
3769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
3770 <em>optional</em></p></td>
3771 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3772 </tr>
3773 </tbody>
3774 </table>
3775 </div>
3776 </div>
3777 </div>
3778 </div>
3779 <div id="footer">
3780 <div id="footer-text">
3781 Last updated 2020-02-12 02:20:53 PST
3782 </div>
3783 </div>
3784 </body>
3785 </html>