5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
7 <meta name="generator" content="Asciidoctor 1.5.7.1">
8 <title>Clamp Rest API</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
12 /* Uncomment @import statement below to use as custom stylesheet */
13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
15 audio,canvas,video{display:inline-block}
16 audio:not([controls]){display:none;height:0}
17 script{display:none!important}
18 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
19 a{background:transparent}
20 a:focus{outline:thin dotted}
21 a:active,a:hover{outline:0}
22 h1{font-size:2em;margin:.67em 0}
23 abbr[title]{border-bottom:1px dotted}
24 b,strong{font-weight:bold}
25 dfn{font-style:italic}
26 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
27 mark{background:#ff0;color:#000}
28 code,kbd,pre,samp{font-family:monospace;font-size:1em}
29 pre{white-space:pre-wrap}
30 q{quotes:"\201C" "\201D" "\2018" "\2019"}
32 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
36 svg:not(:root){overflow:hidden}
38 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
39 legend{border:0;padding:0}
40 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
41 button,input{line-height:normal}
42 button,select{text-transform:none}
43 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
44 button[disabled],html input[disabled]{cursor:default}
45 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
46 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
47 textarea{overflow:auto;vertical-align:top}
48 table{border-collapse:collapse;border-spacing:0}
49 *,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
50 html,body{font-size:100%}
51 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
52 a:hover{cursor:pointer}
53 img,object,embed{max-width:100%;height:auto}
54 object,embed{height:100%}
55 img{-ms-interpolation-mode:bicubic}
56 .left{float:left!important}
57 .right{float:right!important}
58 .text-left{text-align:left!important}
59 .text-right{text-align:right!important}
60 .text-center{text-align:center!important}
61 .text-justify{text-align:justify!important}
63 img,object,svg{display:inline-block;vertical-align:middle}
64 textarea{height:auto;min-height:50px}
66 .center{margin-left:auto;margin-right:auto}
68 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
69 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
70 a{color:#2156a5;text-decoration:underline;line-height:inherit}
71 a:hover,a:focus{color:#1d4b8f}
73 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
74 p aside{font-size:.875em;line-height:1.35;font-style:italic}
75 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
76 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
78 h2{font-size:1.6875em}
79 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
80 h4,h5{font-size:1.125em}
82 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
83 em,i{font-style:italic;line-height:inherit}
84 strong,b{font-weight:bold;line-height:inherit}
85 small{font-size:60%;line-height:inherit}
86 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
87 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
88 ul,ol{margin-left:1.5em}
89 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
90 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
91 ul.square{list-style-type:square}
92 ul.circle{list-style-type:circle}
93 ul.disc{list-style-type:disc}
94 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
95 dl dt{margin-bottom:.3125em;font-weight:bold}
96 dl dd{margin-bottom:1.25em}
97 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
98 abbr{text-transform:none}
99 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
100 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
101 blockquote cite::before{content:"\2014 \0020"}
102 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
103 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
104 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
106 h2{font-size:2.3125em}
107 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
108 h4{font-size:1.4375em}}
109 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
110 table thead,table tfoot{background:#f7f8f7}
111 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
112 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
113 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
114 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
115 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
116 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
117 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
118 .clearfix::after,.float-group::after{clear:both}
119 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
120 *:not(pre)>code.nobreak{word-wrap:normal}
121 *:not(pre)>code.nowrap{white-space:nowrap}
122 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
123 em em{font-style:normal}
124 strong strong{font-weight:400}
125 .keyseq{color:rgba(51,51,51,.8)}
126 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
127 .keyseq kbd:first-child{margin-left:0}
128 .keyseq kbd:last-child{margin-right:0}
129 .menuseq,.menuref{color:#000}
130 .menuseq b:not(.caret),.menuref{font-weight:inherit}
131 .menuseq{word-spacing:-.02em}
132 .menuseq b.caret{font-size:1.25em;line-height:.8}
133 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
134 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
135 b.button::before{content:"[";padding:0 3px 0 2px}
136 b.button::after{content:"]";padding:0 2px 0 3px}
137 p a>code:hover{color:rgba(0,0,0,.9)}
138 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
139 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
140 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
141 #content{margin-top:1.25em}
142 #content::before{content:none}
143 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
144 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
145 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
146 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
147 #header .details span:first-child{margin-left:-.125em}
148 #header .details span.email a{color:rgba(0,0,0,.85)}
149 #header .details br{display:none}
150 #header .details br+span::before{content:"\00a0\2013\00a0"}
151 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
152 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
153 #header #revnumber{text-transform:capitalize}
154 #header #revnumber::after{content:"\00a0"}
155 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
156 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
157 #toc>ul{margin-left:.125em}
158 #toc ul.sectlevel0>li>a{font-style:italic}
159 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
160 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
161 #toc li{line-height:1.3334;margin-top:.3334em}
162 #toc a{text-decoration:none}
163 #toc a:active{text-decoration:underline}
164 #toctitle{color:#7a2518;font-size:1.2em}
165 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
166 body.toc2{padding-left:15em;padding-right:0}
167 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
168 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
169 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
170 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
171 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
172 body.toc2.toc-right{padding-left:0;padding-right:15em}
173 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
174 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
175 #toc.toc2{width:20em}
176 #toc.toc2 #toctitle{font-size:1.375em}
177 #toc.toc2>ul{font-size:.95em}
178 #toc.toc2 ul ul{padding-left:1.25em}
179 body.toc2.toc-right{padding-left:0;padding-right:20em}}
180 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
181 #content #toc>:first-child{margin-top:0}
182 #content #toc>:last-child{margin-bottom:0}
183 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
184 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
185 #content{margin-bottom:.625em}
186 .sect1{padding-bottom:.625em}
187 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
188 .sect1{padding-bottom:1.25em}}
189 .sect1:last-child{padding-bottom:0}
190 .sect1+.sect1{border-top:1px solid #efefed}
191 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
192 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
193 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
194 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
195 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
196 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
197 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
198 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
199 .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
200 table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
201 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
202 .admonitionblock>table td.icon{text-align:center;width:80px}
203 .admonitionblock>table td.icon img{max-width:none}
204 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
205 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
206 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
207 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
208 .exampleblock>.content>:first-child{margin-top:0}
209 .exampleblock>.content>:last-child{margin-bottom:0}
210 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
211 .sidebarblock>:first-child{margin-top:0}
212 .sidebarblock>:last-child{margin-bottom:0}
213 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
216 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
217 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
218 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
219 @media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
220 @media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
221 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
222 .listingblock pre.highlightjs{padding:0}
223 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
224 .listingblock pre.prettyprint{border-width:0}
225 .listingblock>.content{position:relative}
226 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
227 .listingblock:hover code[data-lang]::before{display:block}
228 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999}
229 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
230 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
231 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
232 table.pyhltable td.code{padding-left:.75em;padding-right:0}
233 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
234 pre.pygments .lineno{display:inline-block;margin-right:.25em}
235 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
236 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
237 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
238 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
239 .quoteblock blockquote{margin:0;padding:0;border:0}
240 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
241 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
242 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
243 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
244 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
245 .quoteblock .quoteblock blockquote::before{display:none}
246 .verseblock{margin:0 1em 1.25em}
247 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248 .verseblock pre strong{font-weight:400}
249 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251 .quoteblock .attribution br,.verseblock .attribution br{display:none}
252 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
254 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{word-spacing:0;line-height:1.6}
256 .quoteblock.abstract blockquote::before,.quoteblock.abstract p::before{display:none}
257 table.tableblock{max-width:100%;border-collapse:separate}
258 p.tableblock:last-child{margin-bottom:0}
259 td.tableblock>.content{margin-bottom:-1.25em}
260 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
261 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
262 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
263 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
264 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
265 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
266 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
267 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
268 table.frame-all{border-width:1px}
269 table.frame-sides{border-width:0 1px}
270 table.frame-topbot,table.frame-ends{border-width:1px 0}
271 table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7}
272 table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none}
273 th.halign-left,td.halign-left{text-align:left}
274 th.halign-right,td.halign-right{text-align:right}
275 th.halign-center,td.halign-center{text-align:center}
276 th.valign-top,td.valign-top{vertical-align:top}
277 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
278 th.valign-middle,td.valign-middle{vertical-align:middle}
279 table thead th,table tfoot th{font-weight:bold}
280 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
281 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
282 p.tableblock>code:only-child{background:none;padding:0}
283 p.tableblock{font-size:1em}
284 td>div.verse{white-space:pre}
285 ol{margin-left:1.75em}
286 ul li ol{margin-left:1.5em}
287 dl dd{margin-left:1.125em}
288 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
289 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
290 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
291 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
292 ul.unstyled,ol.unstyled{margin-left:0}
293 ul.checklist{margin-left:.625em}
294 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
295 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
296 ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
297 ul.inline>li{margin-left:1.25em}
298 .unstyled dl dt{font-weight:400;font-style:normal}
299 ol.arabic{list-style-type:decimal}
300 ol.decimal{list-style-type:decimal-leading-zero}
301 ol.loweralpha{list-style-type:lower-alpha}
302 ol.upperalpha{list-style-type:upper-alpha}
303 ol.lowerroman{list-style-type:lower-roman}
304 ol.upperroman{list-style-type:upper-roman}
305 ol.lowergreek{list-style-type:lower-greek}
306 .hdlist>table,.colist>table{border:0;background:none}
307 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
308 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
309 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
310 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
311 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
312 .colist td:not([class]):first-child img{max-width:none}
313 .colist td:not([class]):last-child{padding:.25em 0}
314 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
315 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
316 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
317 .imageblock>.title{margin-bottom:0}
318 .imageblock.thumb,.imageblock.th{border-width:6px}
319 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
320 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
321 .image.left{margin-right:.625em}
322 .image.right{margin-left:.625em}
323 a.image{text-decoration:none;display:inline-block}
324 a.image object{pointer-events:none}
325 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
326 sup.footnote a,sup.footnoteref a{text-decoration:none}
327 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
328 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
329 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
330 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
331 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
332 #footnotes .footnote:last-of-type{margin-bottom:0}
333 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
334 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
335 .gist .file-data>table td.line-data{width:99%}
336 div.unbreakable{page-break-inside:avoid}
337 .big{font-size:larger}
338 .small{font-size:smaller}
339 .underline{text-decoration:underline}
340 .overline{text-decoration:overline}
341 .line-through{text-decoration:line-through}
343 .aqua-background{background-color:#00fafa}
345 .black-background{background-color:#000}
347 .blue-background{background-color:#0000fa}
348 .fuchsia{color:#bf00bf}
349 .fuchsia-background{background-color:#fa00fa}
351 .gray-background{background-color:#7d7d7d}
352 .green{color:#006000}
353 .green-background{background-color:#007d00}
355 .lime-background{background-color:#00fa00}
356 .maroon{color:#600000}
357 .maroon-background{background-color:#7d0000}
359 .navy-background{background-color:#00007d}
360 .olive{color:#606000}
361 .olive-background{background-color:#7d7d00}
362 .purple{color:#600060}
363 .purple-background{background-color:#7d007d}
365 .red-background{background-color:#fa0000}
366 .silver{color:#909090}
367 .silver-background{background-color:#bcbcbc}
369 .teal-background{background-color:#007d7d}
370 .white{color:#bfbfbf}
371 .white-background{background-color:#fafafa}
372 .yellow{color:#bfbf00}
373 .yellow-background{background-color:#fafa00}
374 span.icon>.fa{cursor:default}
375 a span.icon>.fa{cursor:inherit}
376 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
377 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
378 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
379 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
380 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
381 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
382 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
383 .conum[data-value] *{color:#fff!important}
384 .conum[data-value]+b{display:none}
385 .conum[data-value]::after{content:attr(data-value)}
386 pre .conum[data-value]{position:relative;top:-.125em}
387 b.conum *{color:inherit!important}
388 .conum:not([data-value]):empty{display:none}
389 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
390 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
391 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
392 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
393 p{margin-bottom:1.25rem}
394 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
395 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
396 .print-only{display:none!important}
397 @page{margin:1.25cm .75cm}
398 @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
400 a{color:inherit!important;text-decoration:underline!important}
401 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
402 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
403 abbr[title]::after{content:" (" attr(title) ")"}
404 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
405 thead{display:table-header-group}
407 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
408 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
409 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
410 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
411 body.book #header{text-align:center}
412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
413 body.book #header .details{border:0!important;display:block;padding:0!important}
414 body.book #header .details span:first-child{margin-left:0!important}
415 body.book #header .details br{display:block}
416 body.book #header .details br+span::before{content:none!important}
417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
419 .listingblock code[data-lang]::before{display:block}
420 #footer{padding:0 .9375em}
421 .hide-on-print{display:none!important}
422 .print-only{display:block!important}
423 .hide-for-print{display:none!important}
424 .show-for-print{display:inherit!important}}
425 @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
426 .sect1{padding:0!important}
427 .sect1+.sect1{border:0}
428 #footer{background:none}
429 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
430 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
433 <body class="book toc2 toc-left">
435 <h1>Clamp Rest API</h1>
436 <div id="toc" class="toc2">
437 <div id="toctitle">Table of Contents</div>
438 <ul class="sectlevel1">
439 <li><a href="#_overview">1. Overview</a>
440 <ul class="sectlevel2">
441 <li><a href="#_version_information">1.1. Version information</a></li>
442 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
445 <li><a href="#_paths">2. Paths</a>
446 <ul class="sectlevel2">
447 <li><a href="#_verb363">2.1. GET /v1/healthcheck</a>
448 <ul class="sectlevel3">
449 <li><a href="#_responses">2.1.1. Responses</a></li>
450 <li><a href="#_produces">2.1.2. Produces</a></li>
453 <li><a href="#_verb364">2.2. GET /v1/user/getUser</a>
454 <ul class="sectlevel3">
455 <li><a href="#_responses_2">2.2.1. Responses</a></li>
456 <li><a href="#_produces_2">2.2.2. Produces</a></li>
459 <li><a href="#_verb362">2.3. GET /v2/clampInformation</a>
460 <ul class="sectlevel3">
461 <li><a href="#_responses_3">2.3.1. Responses</a></li>
462 <li><a href="#_produces_3">2.3.2. Produces</a></li>
465 <li><a href="#_verb333">2.4. GET /v2/dictionary</a>
466 <ul class="sectlevel3">
467 <li><a href="#_responses_4">2.4.1. Responses</a></li>
468 <li><a href="#_produces_4">2.4.2. Produces</a></li>
471 <li><a href="#_verb336">2.5. PUT /v2/dictionary</a>
472 <ul class="sectlevel3">
473 <li><a href="#_parameters">2.5.1. Parameters</a></li>
474 <li><a href="#_responses_5">2.5.2. Responses</a></li>
475 <li><a href="#_consumes">2.5.3. Consumes</a></li>
476 <li><a href="#_produces_5">2.5.4. Produces</a></li>
479 <li><a href="#_verb334">2.6. GET /v2/dictionary/secondary/names</a>
480 <ul class="sectlevel3">
481 <li><a href="#_responses_6">2.6.1. Responses</a></li>
482 <li><a href="#_produces_6">2.6.2. Produces</a></li>
485 <li><a href="#_verb335">2.7. GET /v2/dictionary/{dictionaryName}</a>
486 <ul class="sectlevel3">
487 <li><a href="#_parameters_2">2.7.1. Parameters</a></li>
488 <li><a href="#_responses_7">2.7.2. Responses</a></li>
489 <li><a href="#_produces_7">2.7.3. Produces</a></li>
492 <li><a href="#_verb337">2.8. PUT /v2/dictionary/{name}</a>
493 <ul class="sectlevel3">
494 <li><a href="#_parameters_3">2.8.1. Parameters</a></li>
495 <li><a href="#_responses_8">2.8.2. Responses</a></li>
496 <li><a href="#_consumes_2">2.8.3. Consumes</a></li>
497 <li><a href="#_produces_8">2.8.4. Produces</a></li>
500 <li><a href="#_verb338">2.9. DELETE /v2/dictionary/{name}</a>
501 <ul class="sectlevel3">
502 <li><a href="#_parameters_4">2.9.1. Parameters</a></li>
503 <li><a href="#_responses_9">2.9.2. Responses</a></li>
504 <li><a href="#_produces_9">2.9.3. Produces</a></li>
507 <li><a href="#_verb339">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a>
508 <ul class="sectlevel3">
509 <li><a href="#_parameters_5">2.10.1. Parameters</a></li>
510 <li><a href="#_responses_10">2.10.2. Responses</a></li>
511 <li><a href="#_produces_10">2.10.3. Produces</a></li>
514 <li><a href="#_verb327">2.11. PUT /v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}</a>
515 <ul class="sectlevel3">
516 <li><a href="#_parameters_6">2.11.1. Parameters</a></li>
517 <li><a href="#_responses_11">2.11.2. Responses</a></li>
518 <li><a href="#_produces_11">2.11.3. Produces</a></li>
521 <li><a href="#_verb329">2.12. POST /v2/loop/create/{loopName}?templateName={templateName}</a>
522 <ul class="sectlevel3">
523 <li><a href="#_parameters_7">2.12.1. Parameters</a></li>
524 <li><a href="#_responses_12">2.12.2. Responses</a></li>
525 <li><a href="#_consumes_3">2.12.3. Consumes</a></li>
526 <li><a href="#_produces_12">2.12.4. Produces</a></li>
529 <li><a href="#_verb325">2.13. PUT /v2/loop/delete/{loopName}</a>
530 <ul class="sectlevel3">
531 <li><a href="#_parameters_8">2.13.1. Parameters</a></li>
532 <li><a href="#_responses_13">2.13.2. Responses</a></li>
535 <li><a href="#_verb318">2.14. PUT /v2/loop/deploy/{loopName}</a>
536 <ul class="sectlevel3">
537 <li><a href="#_parameters_9">2.14.1. Parameters</a></li>
538 <li><a href="#_responses_14">2.14.2. Responses</a></li>
539 <li><a href="#_produces_13">2.14.3. Produces</a></li>
542 <li><a href="#_verb313">2.15. GET /v2/loop/getAllNames</a>
543 <ul class="sectlevel3">
544 <li><a href="#_responses_15">2.15.1. Responses</a></li>
545 <li><a href="#_produces_14">2.15.2. Produces</a></li>
548 <li><a href="#_verb326">2.16. GET /v2/loop/getstatus/{loopName}</a>
549 <ul class="sectlevel3">
550 <li><a href="#_parameters_10">2.16.1. Parameters</a></li>
551 <li><a href="#_responses_16">2.16.2. Responses</a></li>
552 <li><a href="#_produces_15">2.16.3. Produces</a></li>
555 <li><a href="#_verb319">2.17. PUT /v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}</a>
556 <ul class="sectlevel3">
557 <li><a href="#_parameters_11">2.17.1. Parameters</a></li>
558 <li><a href="#_responses_17">2.17.2. Responses</a></li>
559 <li><a href="#_produces_16">2.17.3. Produces</a></li>
562 <li><a href="#_verb320">2.18. PUT /v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}</a>
563 <ul class="sectlevel3">
564 <li><a href="#_parameters_12">2.18.1. Parameters</a></li>
565 <li><a href="#_responses_18">2.18.2. Responses</a></li>
566 <li><a href="#_produces_17">2.18.3. Produces</a></li>
569 <li><a href="#_verb328">2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}/{policyName}</a>
570 <ul class="sectlevel3">
571 <li><a href="#_parameters_13">2.19.1. Parameters</a></li>
572 <li><a href="#_responses_19">2.19.2. Responses</a></li>
573 <li><a href="#_produces_18">2.19.3. Produces</a></li>
576 <li><a href="#_verb323">2.20. PUT /v2/loop/restart/{loopName}</a>
577 <ul class="sectlevel3">
578 <li><a href="#_parameters_14">2.20.1. Parameters</a></li>
579 <li><a href="#_responses_20">2.20.2. Responses</a></li>
580 <li><a href="#_produces_19">2.20.3. Produces</a></li>
583 <li><a href="#_verb322">2.21. PUT /v2/loop/stop/{loopName}</a>
584 <ul class="sectlevel3">
585 <li><a href="#_parameters_15">2.21.1. Parameters</a></li>
586 <li><a href="#_responses_21">2.21.2. Responses</a></li>
587 <li><a href="#_produces_20">2.21.3. Produces</a></li>
590 <li><a href="#_verb324">2.22. PUT /v2/loop/submit/{loopName}</a>
591 <ul class="sectlevel3">
592 <li><a href="#_parameters_16">2.22.1. Parameters</a></li>
593 <li><a href="#_responses_22">2.22.2. Responses</a></li>
594 <li><a href="#_produces_21">2.22.3. Produces</a></li>
597 <li><a href="#_verb321">2.23. PUT /v2/loop/undeploy/{loopName}</a>
598 <ul class="sectlevel3">
599 <li><a href="#_parameters_17">2.23.1. Parameters</a></li>
600 <li><a href="#_responses_23">2.23.2. Responses</a></li>
601 <li><a href="#_produces_22">2.23.3. Produces</a></li>
604 <li><a href="#_verb315">2.24. POST /v2/loop/updateGlobalProperties/{loopName}</a>
605 <ul class="sectlevel3">
606 <li><a href="#_parameters_18">2.24.1. Parameters</a></li>
607 <li><a href="#_responses_24">2.24.2. Responses</a></li>
608 <li><a href="#_consumes_4">2.24.3. Consumes</a></li>
609 <li><a href="#_produces_23">2.24.4. Produces</a></li>
612 <li><a href="#_verb317">2.25. POST /v2/loop/updateMicroservicePolicy/{loopName}</a>
613 <ul class="sectlevel3">
614 <li><a href="#_parameters_19">2.25.1. Parameters</a></li>
615 <li><a href="#_responses_25">2.25.2. Responses</a></li>
616 <li><a href="#_consumes_5">2.25.3. Consumes</a></li>
617 <li><a href="#_produces_24">2.25.4. Produces</a></li>
620 <li><a href="#_verb316">2.26. POST /v2/loop/updateOperationalPolicies/{loopName}</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="#_consumes_6">2.26.3. Consumes</a></li>
625 <li><a href="#_produces_25">2.26.4. Produces</a></li>
628 <li><a href="#_verb314">2.27. GET /v2/loop/{loopName}</a>
629 <ul class="sectlevel3">
630 <li><a href="#_parameters_21">2.27.1. Parameters</a></li>
631 <li><a href="#_responses_27">2.27.2. Responses</a></li>
632 <li><a href="#_produces_26">2.27.3. Produces</a></li>
635 <li><a href="#_verb343">2.28. GET /v2/policies</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>
641 <li><a href="#_verb346">2.29. PUT /v2/policies/pdpDeployment</a>
642 <ul class="sectlevel3">
643 <li><a href="#_parameters_22">2.29.1. Parameters</a></li>
644 <li><a href="#_responses_29">2.29.2. Responses</a></li>
645 <li><a href="#_consumes_7">2.29.3. Consumes</a></li>
648 <li><a href="#_verb347">2.30. POST /v2/policies/policytype</a>
649 <ul class="sectlevel3">
650 <li><a href="#_parameters_23">2.30.1. Parameters</a></li>
651 <li><a href="#_responses_30">2.30.2. Responses</a></li>
652 <li><a href="#_consumes_8">2.30.3. Consumes</a></li>
655 <li><a href="#_verb344">2.31. POST /v2/policies/{policyModelType}/{policyModelVersion}/{policyName}/{policyVersion}</a>
656 <ul class="sectlevel3">
657 <li><a href="#_parameters_24">2.31.1. Parameters</a></li>
658 <li><a href="#_responses_31">2.31.2. Responses</a></li>
659 <li><a href="#_consumes_9">2.31.3. Consumes</a></li>
660 <li><a href="#_produces_28">2.31.4. Produces</a></li>
663 <li><a href="#_verb345">2.32. DELETE /v2/policies/{policyModelType}/{policyModelVersion}/{policyName}/{policyVersion}</a>
664 <ul class="sectlevel3">
665 <li><a href="#_parameters_25">2.32.1. Parameters</a></li>
666 <li><a href="#_responses_32">2.32.2. Responses</a></li>
669 <li><a href="#_verb340">2.33. GET /v2/policyToscaModels</a>
670 <ul class="sectlevel3">
671 <li><a href="#_responses_33">2.33.1. Responses</a></li>
672 <li><a href="#_produces_29">2.33.2. Produces</a></li>
675 <li><a href="#_verb342">2.34. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}</a>
676 <ul class="sectlevel3">
677 <li><a href="#_parameters_26">2.34.1. Parameters</a></li>
678 <li><a href="#_responses_34">2.34.2. Responses</a></li>
679 <li><a href="#_produces_30">2.34.3. Produces</a></li>
682 <li><a href="#_verb341">2.35. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a>
683 <ul class="sectlevel3">
684 <li><a href="#_parameters_27">2.35.1. Parameters</a></li>
685 <li><a href="#_responses_35">2.35.2. Responses</a></li>
686 <li><a href="#_produces_31">2.35.3. Produces</a></li>
689 <li><a href="#_verb330">2.36. GET /v2/templates</a>
690 <ul class="sectlevel3">
691 <li><a href="#_responses_36">2.36.1. Responses</a></li>
692 <li><a href="#_produces_32">2.36.2. Produces</a></li>
695 <li><a href="#_verb332">2.37. GET /v2/templates/names</a>
696 <ul class="sectlevel3">
697 <li><a href="#_responses_37">2.37.1. Responses</a></li>
698 <li><a href="#_produces_33">2.37.2. Produces</a></li>
701 <li><a href="#_verb331">2.38. GET /v2/templates/{templateName}</a>
702 <ul class="sectlevel3">
703 <li><a href="#_parameters_28">2.38.1. Parameters</a></li>
704 <li><a href="#_responses_38">2.38.2. Responses</a></li>
705 <li><a href="#_produces_34">2.38.3. Produces</a></li>
708 <li><a href="#_verb349">2.39. POST /v2/toscaControlLoop/commissionToscaTemplate</a>
709 <ul class="sectlevel3">
710 <li><a href="#_parameters_29">2.39.1. Parameters</a></li>
711 <li><a href="#_responses_39">2.39.2. Responses</a></li>
712 <li><a href="#_consumes_10">2.39.3. Consumes</a></li>
713 <li><a href="#_produces_35">2.39.4. Produces</a></li>
716 <li><a href="#_verb350">2.40. DELETE /v2/toscaControlLoop/decommissionToscaTemplate</a>
717 <ul class="sectlevel3">
718 <li><a href="#_parameters_30">2.40.1. Parameters</a></li>
719 <li><a href="#_responses_40">2.40.2. Responses</a></li>
720 <li><a href="#_consumes_11">2.40.3. Consumes</a></li>
721 <li><a href="#_produces_36">2.40.4. Produces</a></li>
724 <li><a href="#_verb358">2.41. DELETE /v2/toscaControlLoop/deleteToscaInstanceProperties</a>
725 <ul class="sectlevel3">
726 <li><a href="#_parameters_31">2.41.1. Parameters</a></li>
727 <li><a href="#_responses_41">2.41.2. Responses</a></li>
728 <li><a href="#_consumes_12">2.41.3. Consumes</a></li>
729 <li><a href="#_produces_37">2.41.4. Produces</a></li>
732 <li><a href="#_verb351">2.42. DELETE /v2/toscaControlLoop/deleteToscaInstantiation</a>
733 <ul class="sectlevel3">
734 <li><a href="#_parameters_32">2.42.1. Parameters</a></li>
735 <li><a href="#_responses_42">2.42.2. Responses</a></li>
736 <li><a href="#_consumes_13">2.42.3. Consumes</a></li>
737 <li><a href="#_produces_38">2.42.4. Produces</a></li>
740 <li><a href="#_verb359">2.43. GET /v2/toscaControlLoop/getCommonOrInstanceProperties</a>
741 <ul class="sectlevel3">
742 <li><a href="#_responses_43">2.43.1. Responses</a></li>
743 <li><a href="#_produces_39">2.43.2. Produces</a></li>
746 <li><a href="#_verb356">2.44. GET /v2/toscaControlLoop/getControlLoopDefinitions</a>
747 <ul class="sectlevel3">
748 <li><a href="#_responses_44">2.44.1. Responses</a></li>
749 <li><a href="#_produces_40">2.44.2. Produces</a></li>
752 <li><a href="#_verb355">2.45. GET /v2/toscaControlLoop/getElementDefinitions</a>
753 <ul class="sectlevel3">
754 <li><a href="#_responses_45">2.45.1. Responses</a></li>
755 <li><a href="#_produces_41">2.45.2. Produces</a></li>
758 <li><a href="#_verb353">2.46. GET /v2/toscaControlLoop/getInstantiationOrderState</a>
759 <ul class="sectlevel3">
760 <li><a href="#_responses_46">2.46.1. Responses</a></li>
761 <li><a href="#_produces_42">2.46.2. Produces</a></li>
764 <li><a href="#_verb354">2.47. GET /v2/toscaControlLoop/getJsonSchema</a>
765 <ul class="sectlevel3">
766 <li><a href="#_responses_47">2.47.1. Responses</a></li>
767 <li><a href="#_produces_43">2.47.2. Produces</a></li>
770 <li><a href="#_verb352">2.48. GET /v2/toscaControlLoop/getToscaInstantiation</a>
771 <ul class="sectlevel3">
772 <li><a href="#_responses_48">2.48.1. Responses</a></li>
773 <li><a href="#_produces_44">2.48.2. Produces</a></li>
776 <li><a href="#_verb348">2.49. GET /v2/toscaControlLoop/getToscaTemplate</a>
777 <ul class="sectlevel3">
778 <li><a href="#_responses_49">2.49.1. Responses</a></li>
779 <li><a href="#_produces_45">2.49.2. Produces</a></li>
782 <li><a href="#_verb357">2.50. POST /v2/toscaControlLoop/postToscaInstanceProperties</a>
783 <ul class="sectlevel3">
784 <li><a href="#_parameters_33">2.50.1. Parameters</a></li>
785 <li><a href="#_responses_50">2.50.2. Responses</a></li>
786 <li><a href="#_consumes_14">2.50.3. Consumes</a></li>
787 <li><a href="#_produces_46">2.50.4. Produces</a></li>
790 <li><a href="#_verb360">2.51. POST /v2/toscaControlLoop/postToscaInstantiation</a>
791 <ul class="sectlevel3">
792 <li><a href="#_parameters_34">2.51.1. Parameters</a></li>
793 <li><a href="#_responses_51">2.51.2. Responses</a></li>
794 <li><a href="#_consumes_15">2.51.3. Consumes</a></li>
795 <li><a href="#_produces_47">2.51.4. Produces</a></li>
798 <li><a href="#_verb361">2.52. PUT /v2/toscaControlLoop/putToscaInstantiationStateChange</a>
799 <ul class="sectlevel3">
800 <li><a href="#_parameters_35">2.52.1. Parameters</a></li>
801 <li><a href="#_responses_52">2.52.2. Responses</a></li>
802 <li><a href="#_consumes_16">2.52.3. Consumes</a></li>
803 <li><a href="#_produces_48">2.52.4. Produces</a></li>
808 <li><a href="#_definitions">3. Definitions</a>
809 <ul class="sectlevel2">
810 <li><a href="#_clampinformation">3.1. ClampInformation</a></li>
811 <li><a href="#_cldshealthcheck">3.2. CldsHealthCheck</a></li>
812 <li><a href="#_dictionary">3.3. Dictionary</a></li>
813 <li><a href="#_dictionaryelement">3.4. DictionaryElement</a></li>
814 <li><a href="#_externalcomponent">3.5. ExternalComponent</a></li>
815 <li><a href="#_externalcomponentstate">3.6. ExternalComponentState</a></li>
816 <li><a href="#_jsonarray">3.7. JsonArray</a></li>
817 <li><a href="#_jsonelement">3.8. JsonElement</a></li>
818 <li><a href="#_jsonnull">3.9. JsonNull</a></li>
819 <li><a href="#_jsonobject">3.10. JsonObject</a></li>
820 <li><a href="#_jsonprimitive">3.11. JsonPrimitive</a></li>
821 <li><a href="#_loop">3.12. Loop</a></li>
822 <li><a href="#_loopelementmodel">3.13. LoopElementModel</a></li>
823 <li><a href="#_looplog">3.14. LoopLog</a></li>
824 <li><a href="#_looptemplate">3.15. LoopTemplate</a></li>
825 <li><a href="#_looptemplateloopelementmodel">3.16. LoopTemplateLoopElementModel</a></li>
826 <li><a href="#_microservicepolicy">3.17. MicroServicePolicy</a></li>
827 <li><a href="#_number">3.18. Number</a></li>
828 <li><a href="#_operationalpolicy">3.19. OperationalPolicy</a></li>
829 <li><a href="#_policymodel">3.20. PolicyModel</a></li>
830 <li><a href="#_service">3.21. Service</a></li>
838 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
839 <div class="sectionbody">
841 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
842 <div class="paragraph">
843 <p><em>Version</em> : 6.1.3-SNAPSHOT</p>
847 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
848 <div class="paragraph">
849 <p><em>Host</em> : localhost:39221<br>
850 <em>BasePath</em> : /restservices/clds/<br>
851 <em>Schemes</em> : HTTP</p>
857 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
858 <div class="sectionbody">
860 <h3 id="_verb363"><a class="anchor" href="#_verb363"></a><a class="link" href="#_verb363">2.1. GET /v1/healthcheck</a></h3>
862 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.1. Responses</a></h4>
863 <table class="tableblock frame-all grid-all stretch">
865 <col style="width: 10%;">
866 <col style="width: 70%;">
867 <col style="width: 20%;">
871 <th class="tableblock halign-left valign-middle">HTTP Code</th>
872 <th class="tableblock halign-left valign-middle">Description</th>
873 <th class="tableblock halign-left valign-middle">Schema</th>
878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
879 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
880 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
886 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
890 <p><code>application/json</code></p>
897 <h3 id="_verb364"><a class="anchor" href="#_verb364"></a><a class="link" href="#_verb364">2.2. GET /v1/user/getUser</a></h3>
899 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
900 <table class="tableblock frame-all grid-all stretch">
902 <col style="width: 33.3333%;">
903 <col style="width: 66.6667%;">
907 <th class="tableblock halign-left valign-middle">HTTP Code</th>
908 <th class="tableblock halign-left valign-middle">Schema</th>
913 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
914 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
920 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
924 <p><code>text/plain</code></p>
931 <h3 id="_verb362"><a class="anchor" href="#_verb362"></a><a class="link" href="#_verb362">2.3. GET /v2/clampInformation</a></h3>
933 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
934 <table class="tableblock frame-all grid-all stretch">
936 <col style="width: 10%;">
937 <col style="width: 70%;">
938 <col style="width: 20%;">
942 <th class="tableblock halign-left valign-middle">HTTP Code</th>
943 <th class="tableblock halign-left valign-middle">Description</th>
944 <th class="tableblock halign-left valign-middle">Schema</th>
949 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
950 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
951 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_clampinformation">ClampInformation</a></p></td>
957 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
961 <p><code>application/json</code></p>
968 <h3 id="_verb333"><a class="anchor" href="#_verb333"></a><a class="link" href="#_verb333">2.4. GET /v2/dictionary</a></h3>
970 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.1. Responses</a></h4>
971 <table class="tableblock frame-all grid-all stretch">
973 <col style="width: 10%;">
974 <col style="width: 70%;">
975 <col style="width: 20%;">
979 <th class="tableblock halign-left valign-middle">HTTP Code</th>
980 <th class="tableblock halign-left valign-middle">Description</th>
981 <th class="tableblock halign-left valign-middle">Schema</th>
986 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
987 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
988 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
994 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.2. Produces</a></h4>
998 <p><code>application/json</code></p>
1005 <h3 id="_verb336"><a class="anchor" href="#_verb336"></a><a class="link" href="#_verb336">2.5. PUT /v2/dictionary</a></h3>
1007 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.5.1. Parameters</a></h4>
1008 <table class="tableblock frame-all grid-all stretch">
1010 <col style="width: 22.2222%;">
1011 <col style="width: 33.3333%;">
1012 <col style="width: 44.4445%;">
1016 <th class="tableblock halign-left valign-middle">Type</th>
1017 <th class="tableblock halign-left valign-middle">Name</th>
1018 <th class="tableblock halign-left valign-middle">Schema</th>
1023 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1024 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1025 <em>required</em></p></td>
1026 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1032 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
1033 <table class="tableblock frame-all grid-all stretch">
1035 <col style="width: 10%;">
1036 <col style="width: 70%;">
1037 <col style="width: 20%;">
1041 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1042 <th class="tableblock halign-left valign-middle">Description</th>
1043 <th class="tableblock halign-left valign-middle">Schema</th>
1048 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1049 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1056 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.5.3. Consumes</a></h4>
1060 <p><code>application/json</code></p>
1066 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
1070 <p><code>application/json</code></p>
1077 <h3 id="_verb334"><a class="anchor" href="#_verb334"></a><a class="link" href="#_verb334">2.6. GET /v2/dictionary/secondary/names</a></h3>
1079 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
1080 <table class="tableblock frame-all grid-all stretch">
1082 <col style="width: 10%;">
1083 <col style="width: 70%;">
1084 <col style="width: 20%;">
1088 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1089 <th class="tableblock halign-left valign-middle">Description</th>
1090 <th class="tableblock halign-left valign-middle">Schema</th>
1095 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1096 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1097 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
1103 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
1107 <p><code>application/json</code></p>
1114 <h3 id="_verb335"><a class="anchor" href="#_verb335"></a><a class="link" href="#_verb335">2.7. GET /v2/dictionary/{dictionaryName}</a></h3>
1116 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.7.1. Parameters</a></h4>
1117 <table class="tableblock frame-all grid-all stretch">
1119 <col style="width: 22.2222%;">
1120 <col style="width: 33.3333%;">
1121 <col style="width: 44.4445%;">
1125 <th class="tableblock halign-left valign-middle">Type</th>
1126 <th class="tableblock halign-left valign-middle">Name</th>
1127 <th class="tableblock halign-left valign-middle">Schema</th>
1132 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1133 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1134 <em>required</em></p></td>
1135 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1141 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
1142 <table class="tableblock frame-all grid-all stretch">
1144 <col style="width: 10%;">
1145 <col style="width: 70%;">
1146 <col style="width: 20%;">
1150 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1151 <th class="tableblock halign-left valign-middle">Description</th>
1152 <th class="tableblock halign-left valign-middle">Schema</th>
1157 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1158 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1159 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1165 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1169 <p><code>application/json</code></p>
1176 <h3 id="_verb337"><a class="anchor" href="#_verb337"></a><a class="link" href="#_verb337">2.8. PUT /v2/dictionary/{name}</a></h3>
1178 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.8.1. Parameters</a></h4>
1179 <table class="tableblock frame-all grid-all stretch">
1181 <col style="width: 22.2222%;">
1182 <col style="width: 33.3333%;">
1183 <col style="width: 44.4445%;">
1187 <th class="tableblock halign-left valign-middle">Type</th>
1188 <th class="tableblock halign-left valign-middle">Name</th>
1189 <th class="tableblock halign-left valign-middle">Schema</th>
1194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1195 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1196 <em>required</em></p></td>
1197 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1200 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1202 <em>required</em></p></td>
1203 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1209 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1210 <table class="tableblock frame-all grid-all stretch">
1212 <col style="width: 10%;">
1213 <col style="width: 70%;">
1214 <col style="width: 20%;">
1218 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1219 <th class="tableblock halign-left valign-middle">Description</th>
1220 <th class="tableblock halign-left valign-middle">Schema</th>
1225 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1226 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1227 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1233 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.8.3. Consumes</a></h4>
1237 <p><code>application/json</code></p>
1243 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.4. Produces</a></h4>
1247 <p><code>application/json</code></p>
1254 <h3 id="_verb338"><a class="anchor" href="#_verb338"></a><a class="link" href="#_verb338">2.9. DELETE /v2/dictionary/{name}</a></h3>
1256 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.9.1. Parameters</a></h4>
1257 <table class="tableblock frame-all grid-all stretch">
1259 <col style="width: 22.2222%;">
1260 <col style="width: 33.3333%;">
1261 <col style="width: 44.4445%;">
1265 <th class="tableblock halign-left valign-middle">Type</th>
1266 <th class="tableblock halign-left valign-middle">Name</th>
1267 <th class="tableblock halign-left valign-middle">Schema</th>
1272 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1274 <em>required</em></p></td>
1275 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1281 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1282 <table class="tableblock frame-all grid-all stretch">
1284 <col style="width: 33.3333%;">
1285 <col style="width: 66.6667%;">
1289 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1290 <th class="tableblock halign-left valign-middle">Schema</th>
1295 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1296 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1302 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1306 <p><code>application/json</code></p>
1313 <h3 id="_verb339"><a class="anchor" href="#_verb339"></a><a class="link" href="#_verb339">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a></h3>
1315 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.10.1. Parameters</a></h4>
1316 <table class="tableblock frame-all grid-all stretch">
1318 <col style="width: 22.2222%;">
1319 <col style="width: 33.3333%;">
1320 <col style="width: 44.4445%;">
1324 <th class="tableblock halign-left valign-middle">Type</th>
1325 <th class="tableblock halign-left valign-middle">Name</th>
1326 <th class="tableblock halign-left valign-middle">Schema</th>
1331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1333 <em>required</em></p></td>
1334 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1337 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
1339 <em>required</em></p></td>
1340 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1346 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1347 <table class="tableblock frame-all grid-all stretch">
1349 <col style="width: 33.3333%;">
1350 <col style="width: 66.6667%;">
1354 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1355 <th class="tableblock halign-left valign-middle">Schema</th>
1360 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1361 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1367 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.3. Produces</a></h4>
1371 <p><code>application/json</code></p>
1378 <h3 id="_verb327"><a class="anchor" href="#_verb327"></a><a class="link" href="#_verb327">2.11. PUT /v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}</a></h3>
1380 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.11.1. Parameters</a></h4>
1381 <table class="tableblock frame-all grid-all stretch">
1383 <col style="width: 22.2222%;">
1384 <col style="width: 33.3333%;">
1385 <col style="width: 44.4445%;">
1389 <th class="tableblock halign-left valign-middle">Type</th>
1390 <th class="tableblock halign-left valign-middle">Name</th>
1391 <th class="tableblock halign-left valign-middle">Schema</th>
1396 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1397 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1398 <em>required</em></p></td>
1399 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1402 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1403 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
1404 <em>required</em></p></td>
1405 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1408 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1409 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyVersion</strong><br>
1410 <em>required</em></p></td>
1411 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1417 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.2. Responses</a></h4>
1418 <table class="tableblock frame-all grid-all stretch">
1420 <col style="width: 10%;">
1421 <col style="width: 70%;">
1422 <col style="width: 20%;">
1426 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1427 <th class="tableblock halign-left valign-middle">Description</th>
1428 <th class="tableblock halign-left valign-middle">Schema</th>
1433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1434 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1435 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1441 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.3. Produces</a></h4>
1445 <p><code>application/json</code></p>
1452 <h3 id="_verb329"><a class="anchor" href="#_verb329"></a><a class="link" href="#_verb329">2.12. POST /v2/loop/create/{loopName}?templateName={templateName}</a></h3>
1454 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.12.1. Parameters</a></h4>
1455 <table class="tableblock frame-all grid-all stretch">
1457 <col style="width: 22.2222%;">
1458 <col style="width: 33.3333%;">
1459 <col style="width: 44.4445%;">
1463 <th class="tableblock halign-left valign-middle">Type</th>
1464 <th class="tableblock halign-left valign-middle">Name</th>
1465 <th class="tableblock halign-left valign-middle">Schema</th>
1470 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1471 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1472 <em>required</em></p></td>
1473 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1476 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1477 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1478 <em>required</em></p></td>
1479 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1485 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1486 <table class="tableblock frame-all grid-all stretch">
1488 <col style="width: 10%;">
1489 <col style="width: 70%;">
1490 <col style="width: 20%;">
1494 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1495 <th class="tableblock halign-left valign-middle">Description</th>
1496 <th class="tableblock halign-left valign-middle">Schema</th>
1501 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1502 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1503 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1509 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.12.3. Consumes</a></h4>
1513 <p><code>application/json</code></p>
1519 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.4. Produces</a></h4>
1523 <p><code>application/json</code></p>
1530 <h3 id="_verb325"><a class="anchor" href="#_verb325"></a><a class="link" href="#_verb325">2.13. PUT /v2/loop/delete/{loopName}</a></h3>
1532 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.13.1. Parameters</a></h4>
1533 <table class="tableblock frame-all grid-all stretch">
1535 <col style="width: 22.2222%;">
1536 <col style="width: 33.3333%;">
1537 <col style="width: 44.4445%;">
1541 <th class="tableblock halign-left valign-middle">Type</th>
1542 <th class="tableblock halign-left valign-middle">Name</th>
1543 <th class="tableblock halign-left valign-middle">Schema</th>
1548 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1549 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1550 <em>required</em></p></td>
1551 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1557 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.2. Responses</a></h4>
1558 <table class="tableblock frame-all grid-all stretch">
1560 <col style="width: 33.3333%;">
1561 <col style="width: 66.6667%;">
1565 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1566 <th class="tableblock halign-left valign-middle">Schema</th>
1571 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1572 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1579 <h3 id="_verb318"><a class="anchor" href="#_verb318"></a><a class="link" href="#_verb318">2.14. PUT /v2/loop/deploy/{loopName}</a></h3>
1581 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.14.1. Parameters</a></h4>
1582 <table class="tableblock frame-all grid-all stretch">
1584 <col style="width: 22.2222%;">
1585 <col style="width: 33.3333%;">
1586 <col style="width: 44.4445%;">
1590 <th class="tableblock halign-left valign-middle">Type</th>
1591 <th class="tableblock halign-left valign-middle">Name</th>
1592 <th class="tableblock halign-left valign-middle">Schema</th>
1597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1598 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1599 <em>required</em></p></td>
1600 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1606 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1607 <table class="tableblock frame-all grid-all stretch">
1609 <col style="width: 10%;">
1610 <col style="width: 70%;">
1611 <col style="width: 20%;">
1615 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1616 <th class="tableblock halign-left valign-middle">Description</th>
1617 <th class="tableblock halign-left valign-middle">Schema</th>
1622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1623 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1624 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1630 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.3. Produces</a></h4>
1634 <p><code>application/json</code></p>
1641 <h3 id="_verb313"><a class="anchor" href="#_verb313"></a><a class="link" href="#_verb313">2.15. GET /v2/loop/getAllNames</a></h3>
1643 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.1. Responses</a></h4>
1644 <table class="tableblock frame-all grid-all stretch">
1646 <col style="width: 10%;">
1647 <col style="width: 70%;">
1648 <col style="width: 20%;">
1652 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1653 <th class="tableblock halign-left valign-middle">Description</th>
1654 <th class="tableblock halign-left valign-middle">Schema</th>
1659 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1660 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1661 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
1667 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.2. Produces</a></h4>
1671 <p><code>application/json</code></p>
1678 <h3 id="_verb326"><a class="anchor" href="#_verb326"></a><a class="link" href="#_verb326">2.16. GET /v2/loop/getstatus/{loopName}</a></h3>
1680 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.16.1. Parameters</a></h4>
1681 <table class="tableblock frame-all grid-all stretch">
1683 <col style="width: 22.2222%;">
1684 <col style="width: 33.3333%;">
1685 <col style="width: 44.4445%;">
1689 <th class="tableblock halign-left valign-middle">Type</th>
1690 <th class="tableblock halign-left valign-middle">Name</th>
1691 <th class="tableblock halign-left valign-middle">Schema</th>
1696 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1697 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1698 <em>required</em></p></td>
1699 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1705 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1706 <table class="tableblock frame-all grid-all stretch">
1708 <col style="width: 10%;">
1709 <col style="width: 70%;">
1710 <col style="width: 20%;">
1714 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1715 <th class="tableblock halign-left valign-middle">Description</th>
1716 <th class="tableblock halign-left valign-middle">Schema</th>
1721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1722 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1729 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1733 <p><code>application/json</code></p>
1740 <h3 id="_verb319"><a class="anchor" href="#_verb319"></a><a class="link" href="#_verb319">2.17. PUT /v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}</a></h3>
1742 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.17.1. Parameters</a></h4>
1743 <table class="tableblock frame-all grid-all stretch">
1745 <col style="width: 22.2222%;">
1746 <col style="width: 33.3333%;">
1747 <col style="width: 44.4445%;">
1751 <th class="tableblock halign-left valign-middle">Type</th>
1752 <th class="tableblock halign-left valign-middle">Name</th>
1753 <th class="tableblock halign-left valign-middle">Schema</th>
1758 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1760 <em>required</em></p></td>
1761 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1765 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicyName</strong><br>
1766 <em>required</em></p></td>
1767 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1773 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1774 <table class="tableblock frame-all grid-all stretch">
1776 <col style="width: 10%;">
1777 <col style="width: 70%;">
1778 <col style="width: 20%;">
1782 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1783 <th class="tableblock halign-left valign-middle">Description</th>
1784 <th class="tableblock halign-left valign-middle">Schema</th>
1789 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1790 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1791 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1797 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.17.3. Produces</a></h4>
1801 <p><code>application/json</code></p>
1808 <h3 id="_verb320"><a class="anchor" href="#_verb320"></a><a class="link" href="#_verb320">2.18. PUT /v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}</a></h3>
1810 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.18.1. Parameters</a></h4>
1811 <table class="tableblock frame-all grid-all stretch">
1813 <col style="width: 22.2222%;">
1814 <col style="width: 33.3333%;">
1815 <col style="width: 44.4445%;">
1819 <th class="tableblock halign-left valign-middle">Type</th>
1820 <th class="tableblock halign-left valign-middle">Name</th>
1821 <th class="tableblock halign-left valign-middle">Schema</th>
1826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1827 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1828 <em>required</em></p></td>
1829 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1832 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1833 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicyName</strong><br>
1834 <em>required</em></p></td>
1835 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1841 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.2. Responses</a></h4>
1842 <table class="tableblock frame-all grid-all stretch">
1844 <col style="width: 10%;">
1845 <col style="width: 70%;">
1846 <col style="width: 20%;">
1850 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1851 <th class="tableblock halign-left valign-middle">Description</th>
1852 <th class="tableblock halign-left valign-middle">Schema</th>
1857 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1858 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1859 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1865 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.18.3. Produces</a></h4>
1869 <p><code>application/json</code></p>
1876 <h3 id="_verb328"><a class="anchor" href="#_verb328"></a><a class="link" href="#_verb328">2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}/{policyName}</a></h3>
1878 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.19.1. Parameters</a></h4>
1879 <table class="tableblock frame-all grid-all stretch">
1881 <col style="width: 22.2222%;">
1882 <col style="width: 33.3333%;">
1883 <col style="width: 44.4445%;">
1887 <th class="tableblock halign-left valign-middle">Type</th>
1888 <th class="tableblock halign-left valign-middle">Name</th>
1889 <th class="tableblock halign-left valign-middle">Schema</th>
1894 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1895 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1896 <em>required</em></p></td>
1897 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1900 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1901 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyName</strong><br>
1902 <em>required</em></p></td>
1903 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1906 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1907 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
1908 <em>required</em></p></td>
1909 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1913 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyVersion</strong><br>
1914 <em>required</em></p></td>
1915 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1921 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1922 <table class="tableblock frame-all grid-all stretch">
1924 <col style="width: 10%;">
1925 <col style="width: 70%;">
1926 <col style="width: 20%;">
1930 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1931 <th class="tableblock halign-left valign-middle">Description</th>
1932 <th class="tableblock halign-left valign-middle">Schema</th>
1937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1938 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1945 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.19.3. Produces</a></h4>
1949 <p><code>application/json</code></p>
1956 <h3 id="_verb323"><a class="anchor" href="#_verb323"></a><a class="link" href="#_verb323">2.20. PUT /v2/loop/restart/{loopName}</a></h3>
1958 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.20.1. Parameters</a></h4>
1959 <table class="tableblock frame-all grid-all stretch">
1961 <col style="width: 22.2222%;">
1962 <col style="width: 33.3333%;">
1963 <col style="width: 44.4445%;">
1967 <th class="tableblock halign-left valign-middle">Type</th>
1968 <th class="tableblock halign-left valign-middle">Name</th>
1969 <th class="tableblock halign-left valign-middle">Schema</th>
1974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1976 <em>required</em></p></td>
1977 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1983 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.2. Responses</a></h4>
1984 <table class="tableblock frame-all grid-all stretch">
1986 <col style="width: 10%;">
1987 <col style="width: 70%;">
1988 <col style="width: 20%;">
1992 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1993 <th class="tableblock halign-left valign-middle">Description</th>
1994 <th class="tableblock halign-left valign-middle">Schema</th>
1999 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2000 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2001 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2007 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.20.3. Produces</a></h4>
2011 <p><code>application/json</code></p>
2018 <h3 id="_verb322"><a class="anchor" href="#_verb322"></a><a class="link" href="#_verb322">2.21. PUT /v2/loop/stop/{loopName}</a></h3>
2020 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.21.1. Parameters</a></h4>
2021 <table class="tableblock frame-all grid-all stretch">
2023 <col style="width: 22.2222%;">
2024 <col style="width: 33.3333%;">
2025 <col style="width: 44.4445%;">
2029 <th class="tableblock halign-left valign-middle">Type</th>
2030 <th class="tableblock halign-left valign-middle">Name</th>
2031 <th class="tableblock halign-left valign-middle">Schema</th>
2036 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2037 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2038 <em>required</em></p></td>
2039 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2045 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
2046 <table class="tableblock frame-all grid-all stretch">
2048 <col style="width: 10%;">
2049 <col style="width: 70%;">
2050 <col style="width: 20%;">
2054 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2055 <th class="tableblock halign-left valign-middle">Description</th>
2056 <th class="tableblock halign-left valign-middle">Schema</th>
2061 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2062 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2063 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2069 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.21.3. Produces</a></h4>
2073 <p><code>application/json</code></p>
2080 <h3 id="_verb324"><a class="anchor" href="#_verb324"></a><a class="link" href="#_verb324">2.22. PUT /v2/loop/submit/{loopName}</a></h3>
2082 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.22.1. Parameters</a></h4>
2083 <table class="tableblock frame-all grid-all stretch">
2085 <col style="width: 22.2222%;">
2086 <col style="width: 33.3333%;">
2087 <col style="width: 44.4445%;">
2091 <th class="tableblock halign-left valign-middle">Type</th>
2092 <th class="tableblock halign-left valign-middle">Name</th>
2093 <th class="tableblock halign-left valign-middle">Schema</th>
2098 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2099 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2100 <em>required</em></p></td>
2101 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2107 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.2. Responses</a></h4>
2108 <table class="tableblock frame-all grid-all stretch">
2110 <col style="width: 10%;">
2111 <col style="width: 70%;">
2112 <col style="width: 20%;">
2116 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2117 <th class="tableblock halign-left valign-middle">Description</th>
2118 <th class="tableblock halign-left valign-middle">Schema</th>
2123 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2124 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2131 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.22.3. Produces</a></h4>
2135 <p><code>application/json</code></p>
2142 <h3 id="_verb321"><a class="anchor" href="#_verb321"></a><a class="link" href="#_verb321">2.23. PUT /v2/loop/undeploy/{loopName}</a></h3>
2144 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.23.1. Parameters</a></h4>
2145 <table class="tableblock frame-all grid-all stretch">
2147 <col style="width: 22.2222%;">
2148 <col style="width: 33.3333%;">
2149 <col style="width: 44.4445%;">
2153 <th class="tableblock halign-left valign-middle">Type</th>
2154 <th class="tableblock halign-left valign-middle">Name</th>
2155 <th class="tableblock halign-left valign-middle">Schema</th>
2160 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2162 <em>required</em></p></td>
2163 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2169 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.2. Responses</a></h4>
2170 <table class="tableblock frame-all grid-all stretch">
2172 <col style="width: 10%;">
2173 <col style="width: 70%;">
2174 <col style="width: 20%;">
2178 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2179 <th class="tableblock halign-left valign-middle">Description</th>
2180 <th class="tableblock halign-left valign-middle">Schema</th>
2185 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2186 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2193 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.23.3. Produces</a></h4>
2197 <p><code>application/json</code></p>
2204 <h3 id="_verb315"><a class="anchor" href="#_verb315"></a><a class="link" href="#_verb315">2.24. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
2206 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.24.1. Parameters</a></h4>
2207 <table class="tableblock frame-all grid-all stretch">
2209 <col style="width: 22.2222%;">
2210 <col style="width: 33.3333%;">
2211 <col style="width: 44.4445%;">
2215 <th class="tableblock halign-left valign-middle">Type</th>
2216 <th class="tableblock halign-left valign-middle">Name</th>
2217 <th class="tableblock halign-left valign-middle">Schema</th>
2222 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2223 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2224 <em>required</em></p></td>
2225 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2228 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2229 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2230 <em>required</em></p></td>
2231 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2237 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.2. Responses</a></h4>
2238 <table class="tableblock frame-all grid-all stretch">
2240 <col style="width: 10%;">
2241 <col style="width: 70%;">
2242 <col style="width: 20%;">
2246 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2247 <th class="tableblock halign-left valign-middle">Description</th>
2248 <th class="tableblock halign-left valign-middle">Schema</th>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2254 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2261 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.24.3. Consumes</a></h4>
2265 <p><code>application/json</code></p>
2271 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.24.4. Produces</a></h4>
2275 <p><code>application/json</code></p>
2282 <h3 id="_verb317"><a class="anchor" href="#_verb317"></a><a class="link" href="#_verb317">2.25. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
2284 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.25.1. Parameters</a></h4>
2285 <table class="tableblock frame-all grid-all stretch">
2287 <col style="width: 22.2222%;">
2288 <col style="width: 33.3333%;">
2289 <col style="width: 44.4445%;">
2293 <th class="tableblock halign-left valign-middle">Type</th>
2294 <th class="tableblock halign-left valign-middle">Name</th>
2295 <th class="tableblock halign-left valign-middle">Schema</th>
2300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2301 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2302 <em>required</em></p></td>
2303 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2307 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2308 <em>required</em></p></td>
2309 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2315 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.2. Responses</a></h4>
2316 <table class="tableblock frame-all grid-all stretch">
2318 <col style="width: 10%;">
2319 <col style="width: 70%;">
2320 <col style="width: 20%;">
2324 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2325 <th class="tableblock halign-left valign-middle">Description</th>
2326 <th class="tableblock halign-left valign-middle">Schema</th>
2331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2332 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
2339 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.25.3. Consumes</a></h4>
2343 <p><code>application/json</code></p>
2349 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.25.4. Produces</a></h4>
2353 <p><code>application/json</code></p>
2360 <h3 id="_verb316"><a class="anchor" href="#_verb316"></a><a class="link" href="#_verb316">2.26. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
2362 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a><a class="link" href="#_parameters_20">2.26.1. Parameters</a></h4>
2363 <table class="tableblock frame-all grid-all stretch">
2365 <col style="width: 22.2222%;">
2366 <col style="width: 33.3333%;">
2367 <col style="width: 44.4445%;">
2371 <th class="tableblock halign-left valign-middle">Type</th>
2372 <th class="tableblock halign-left valign-middle">Name</th>
2373 <th class="tableblock halign-left valign-middle">Schema</th>
2378 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2379 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2380 <em>required</em></p></td>
2381 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2384 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2385 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2386 <em>required</em></p></td>
2387 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2393 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2394 <table class="tableblock frame-all grid-all stretch">
2396 <col style="width: 10%;">
2397 <col style="width: 70%;">
2398 <col style="width: 20%;">
2402 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2403 <th class="tableblock halign-left valign-middle">Description</th>
2404 <th class="tableblock halign-left valign-middle">Schema</th>
2409 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2410 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2411 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2417 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.26.3. Consumes</a></h4>
2421 <p><code>application/json</code></p>
2427 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.26.4. Produces</a></h4>
2431 <p><code>application/json</code></p>
2438 <h3 id="_verb314"><a class="anchor" href="#_verb314"></a><a class="link" href="#_verb314">2.27. GET /v2/loop/{loopName}</a></h3>
2440 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a><a class="link" href="#_parameters_21">2.27.1. Parameters</a></h4>
2441 <table class="tableblock frame-all grid-all stretch">
2443 <col style="width: 22.2222%;">
2444 <col style="width: 33.3333%;">
2445 <col style="width: 44.4445%;">
2449 <th class="tableblock halign-left valign-middle">Type</th>
2450 <th class="tableblock halign-left valign-middle">Name</th>
2451 <th class="tableblock halign-left valign-middle">Schema</th>
2456 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2457 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2458 <em>required</em></p></td>
2459 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2465 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.2. Responses</a></h4>
2466 <table class="tableblock frame-all grid-all stretch">
2468 <col style="width: 10%;">
2469 <col style="width: 70%;">
2470 <col style="width: 20%;">
2474 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2475 <th class="tableblock halign-left valign-middle">Description</th>
2476 <th class="tableblock halign-left valign-middle">Schema</th>
2481 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2482 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2483 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2489 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.27.3. Produces</a></h4>
2493 <p><code>application/json</code></p>
2500 <h3 id="_verb343"><a class="anchor" href="#_verb343"></a><a class="link" href="#_verb343">2.28. GET /v2/policies</a></h3>
2502 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.1. Responses</a></h4>
2503 <table class="tableblock frame-all grid-all stretch">
2505 <col style="width: 10%;">
2506 <col style="width: 70%;">
2507 <col style="width: 20%;">
2511 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2512 <th class="tableblock halign-left valign-middle">Description</th>
2513 <th class="tableblock halign-left valign-middle">Schema</th>
2518 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2519 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2520 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2526 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.28.2. Produces</a></h4>
2530 <p><code>application/json</code></p>
2537 <h3 id="_verb346"><a class="anchor" href="#_verb346"></a><a class="link" href="#_verb346">2.29. PUT /v2/policies/pdpDeployment</a></h3>
2539 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a><a class="link" href="#_parameters_22">2.29.1. Parameters</a></h4>
2540 <table class="tableblock frame-all grid-all stretch">
2542 <col style="width: 22.2222%;">
2543 <col style="width: 33.3333%;">
2544 <col style="width: 44.4445%;">
2548 <th class="tableblock halign-left valign-middle">Type</th>
2549 <th class="tableblock halign-left valign-middle">Name</th>
2550 <th class="tableblock halign-left valign-middle">Schema</th>
2555 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2556 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2557 <em>required</em></p></td>
2558 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonelement">JsonElement</a></p></td>
2564 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.2. Responses</a></h4>
2565 <table class="tableblock frame-all grid-all stretch">
2567 <col style="width: 33.3333%;">
2568 <col style="width: 66.6667%;">
2572 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2573 <th class="tableblock halign-left valign-middle">Schema</th>
2578 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2579 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2585 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a><a class="link" href="#_consumes_7">2.29.3. Consumes</a></h4>
2589 <p><code>application/json</code></p>
2596 <h3 id="_verb347"><a class="anchor" href="#_verb347"></a><a class="link" href="#_verb347">2.30. POST /v2/policies/policytype</a></h3>
2598 <h4 id="_parameters_23"><a class="anchor" href="#_parameters_23"></a><a class="link" href="#_parameters_23">2.30.1. Parameters</a></h4>
2599 <table class="tableblock frame-all grid-all stretch">
2601 <col style="width: 22.2222%;">
2602 <col style="width: 33.3333%;">
2603 <col style="width: 44.4445%;">
2607 <th class="tableblock halign-left valign-middle">Type</th>
2608 <th class="tableblock halign-left valign-middle">Name</th>
2609 <th class="tableblock halign-left valign-middle">Schema</th>
2614 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2615 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2616 <em>required</em></p></td>
2617 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2623 <h4 id="_responses_30"><a class="anchor" href="#_responses_30"></a><a class="link" href="#_responses_30">2.30.2. Responses</a></h4>
2624 <table class="tableblock frame-all grid-all stretch">
2626 <col style="width: 33.3333%;">
2627 <col style="width: 66.6667%;">
2631 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2632 <th class="tableblock halign-left valign-middle">Schema</th>
2637 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2638 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2644 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a><a class="link" href="#_consumes_8">2.30.3. Consumes</a></h4>
2648 <p><code>plain/text</code></p>
2655 <h3 id="_verb344"><a class="anchor" href="#_verb344"></a><a class="link" href="#_verb344">2.31. POST /v2/policies/{policyModelType}/{policyModelVersion}/{policyName}/{policyVersion}</a></h3>
2657 <h4 id="_parameters_24"><a class="anchor" href="#_parameters_24"></a><a class="link" href="#_parameters_24">2.31.1. Parameters</a></h4>
2658 <table class="tableblock frame-all grid-all stretch">
2660 <col style="width: 22.2222%;">
2661 <col style="width: 33.3333%;">
2662 <col style="width: 44.4445%;">
2666 <th class="tableblock halign-left valign-middle">Type</th>
2667 <th class="tableblock halign-left valign-middle">Name</th>
2668 <th class="tableblock halign-left valign-middle">Schema</th>
2673 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2674 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2675 <em>required</em></p></td>
2676 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2680 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2681 <em>required</em></p></td>
2682 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2685 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2686 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyName</strong><br>
2687 <em>required</em></p></td>
2688 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2691 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2692 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyVersion</strong><br>
2693 <em>required</em></p></td>
2694 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2697 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2698 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2699 <em>required</em></p></td>
2700 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonelement">JsonElement</a></p></td>
2706 <h4 id="_responses_31"><a class="anchor" href="#_responses_31"></a><a class="link" href="#_responses_31">2.31.2. Responses</a></h4>
2707 <table class="tableblock frame-all grid-all stretch">
2709 <col style="width: 10%;">
2710 <col style="width: 70%;">
2711 <col style="width: 20%;">
2715 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2716 <th class="tableblock halign-left valign-middle">Description</th>
2717 <th class="tableblock halign-left valign-middle">Schema</th>
2722 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2723 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2730 <h4 id="_consumes_9"><a class="anchor" href="#_consumes_9"></a><a class="link" href="#_consumes_9">2.31.3. Consumes</a></h4>
2734 <p><code>application/json</code></p>
2740 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.31.4. Produces</a></h4>
2744 <p><code>application/json</code></p>
2751 <h3 id="_verb345"><a class="anchor" href="#_verb345"></a><a class="link" href="#_verb345">2.32. DELETE /v2/policies/{policyModelType}/{policyModelVersion}/{policyName}/{policyVersion}</a></h3>
2753 <h4 id="_parameters_25"><a class="anchor" href="#_parameters_25"></a><a class="link" href="#_parameters_25">2.32.1. Parameters</a></h4>
2754 <table class="tableblock frame-all grid-all stretch">
2756 <col style="width: 22.2222%;">
2757 <col style="width: 33.3333%;">
2758 <col style="width: 44.4445%;">
2762 <th class="tableblock halign-left valign-middle">Type</th>
2763 <th class="tableblock halign-left valign-middle">Name</th>
2764 <th class="tableblock halign-left valign-middle">Schema</th>
2769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2770 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2771 <em>required</em></p></td>
2772 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2775 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2776 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2777 <em>required</em></p></td>
2778 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2781 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2782 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyName</strong><br>
2783 <em>required</em></p></td>
2784 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2787 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2788 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyVersion</strong><br>
2789 <em>required</em></p></td>
2790 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2796 <h4 id="_responses_32"><a class="anchor" href="#_responses_32"></a><a class="link" href="#_responses_32">2.32.2. Responses</a></h4>
2797 <table class="tableblock frame-all grid-all stretch">
2799 <col style="width: 33.3333%;">
2800 <col style="width: 66.6667%;">
2804 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2805 <th class="tableblock halign-left valign-middle">Schema</th>
2810 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2811 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2818 <h3 id="_verb340"><a class="anchor" href="#_verb340"></a><a class="link" href="#_verb340">2.33. GET /v2/policyToscaModels</a></h3>
2820 <h4 id="_responses_33"><a class="anchor" href="#_responses_33"></a><a class="link" href="#_responses_33">2.33.1. Responses</a></h4>
2821 <table class="tableblock frame-all grid-all stretch">
2823 <col style="width: 10%;">
2824 <col style="width: 70%;">
2825 <col style="width: 20%;">
2829 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2830 <th class="tableblock halign-left valign-middle">Description</th>
2831 <th class="tableblock halign-left valign-middle">Schema</th>
2836 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2837 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2838 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2844 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.33.2. Produces</a></h4>
2848 <p><code>application/json</code></p>
2855 <h3 id="_verb342"><a class="anchor" href="#_verb342"></a><a class="link" href="#_verb342">2.34. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}</a></h3>
2857 <h4 id="_parameters_26"><a class="anchor" href="#_parameters_26"></a><a class="link" href="#_parameters_26">2.34.1. Parameters</a></h4>
2858 <table class="tableblock frame-all grid-all stretch">
2860 <col style="width: 22.2222%;">
2861 <col style="width: 33.3333%;">
2862 <col style="width: 44.4445%;">
2866 <th class="tableblock halign-left valign-middle">Type</th>
2867 <th class="tableblock halign-left valign-middle">Name</th>
2868 <th class="tableblock halign-left valign-middle">Schema</th>
2873 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2874 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2875 <em>required</em></p></td>
2876 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2879 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2880 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2881 <em>required</em></p></td>
2882 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2888 <h4 id="_responses_34"><a class="anchor" href="#_responses_34"></a><a class="link" href="#_responses_34">2.34.2. Responses</a></h4>
2889 <table class="tableblock frame-all grid-all stretch">
2891 <col style="width: 10%;">
2892 <col style="width: 70%;">
2893 <col style="width: 20%;">
2897 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2898 <th class="tableblock halign-left valign-middle">Description</th>
2899 <th class="tableblock halign-left valign-middle">Schema</th>
2904 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2905 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2906 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2912 <h4 id="_produces_30"><a class="anchor" href="#_produces_30"></a><a class="link" href="#_produces_30">2.34.3. Produces</a></h4>
2916 <p><code>application/json</code></p>
2923 <h3 id="_verb341"><a class="anchor" href="#_verb341"></a><a class="link" href="#_verb341">2.35. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a></h3>
2925 <h4 id="_parameters_27"><a class="anchor" href="#_parameters_27"></a><a class="link" href="#_parameters_27">2.35.1. Parameters</a></h4>
2926 <table class="tableblock frame-all grid-all stretch">
2928 <col style="width: 22.2222%;">
2929 <col style="width: 33.3333%;">
2930 <col style="width: 44.4445%;">
2934 <th class="tableblock halign-left valign-middle">Type</th>
2935 <th class="tableblock halign-left valign-middle">Name</th>
2936 <th class="tableblock halign-left valign-middle">Schema</th>
2941 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2943 <em>required</em></p></td>
2944 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2947 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2948 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelVersion</strong><br>
2949 <em>required</em></p></td>
2950 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2956 <h4 id="_responses_35"><a class="anchor" href="#_responses_35"></a><a class="link" href="#_responses_35">2.35.2. Responses</a></h4>
2957 <table class="tableblock frame-all grid-all stretch">
2959 <col style="width: 10%;">
2960 <col style="width: 70%;">
2961 <col style="width: 20%;">
2965 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2966 <th class="tableblock halign-left valign-middle">Description</th>
2967 <th class="tableblock halign-left valign-middle">Schema</th>
2972 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2973 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2980 <h4 id="_produces_31"><a class="anchor" href="#_produces_31"></a><a class="link" href="#_produces_31">2.35.3. Produces</a></h4>
2984 <p><code>application/json</code></p>
2991 <h3 id="_verb330"><a class="anchor" href="#_verb330"></a><a class="link" href="#_verb330">2.36. GET /v2/templates</a></h3>
2993 <h4 id="_responses_36"><a class="anchor" href="#_responses_36"></a><a class="link" href="#_responses_36">2.36.1. Responses</a></h4>
2994 <table class="tableblock frame-all grid-all stretch">
2996 <col style="width: 10%;">
2997 <col style="width: 70%;">
2998 <col style="width: 20%;">
3002 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3003 <th class="tableblock halign-left valign-middle">Description</th>
3004 <th class="tableblock halign-left valign-middle">Schema</th>
3009 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3010 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3011 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3017 <h4 id="_produces_32"><a class="anchor" href="#_produces_32"></a><a class="link" href="#_produces_32">2.36.2. Produces</a></h4>
3021 <p><code>application/json</code></p>
3028 <h3 id="_verb332"><a class="anchor" href="#_verb332"></a><a class="link" href="#_verb332">2.37. GET /v2/templates/names</a></h3>
3030 <h4 id="_responses_37"><a class="anchor" href="#_responses_37"></a><a class="link" href="#_responses_37">2.37.1. Responses</a></h4>
3031 <table class="tableblock frame-all grid-all stretch">
3033 <col style="width: 10%;">
3034 <col style="width: 70%;">
3035 <col style="width: 20%;">
3039 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3040 <th class="tableblock halign-left valign-middle">Description</th>
3041 <th class="tableblock halign-left valign-middle">Schema</th>
3046 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3047 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3048 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
3054 <h4 id="_produces_33"><a class="anchor" href="#_produces_33"></a><a class="link" href="#_produces_33">2.37.2. Produces</a></h4>
3058 <p><code>application/json</code></p>
3065 <h3 id="_verb331"><a class="anchor" href="#_verb331"></a><a class="link" href="#_verb331">2.38. GET /v2/templates/{templateName}</a></h3>
3067 <h4 id="_parameters_28"><a class="anchor" href="#_parameters_28"></a><a class="link" href="#_parameters_28">2.38.1. Parameters</a></h4>
3068 <table class="tableblock frame-all grid-all stretch">
3070 <col style="width: 22.2222%;">
3071 <col style="width: 33.3333%;">
3072 <col style="width: 44.4445%;">
3076 <th class="tableblock halign-left valign-middle">Type</th>
3077 <th class="tableblock halign-left valign-middle">Name</th>
3078 <th class="tableblock halign-left valign-middle">Schema</th>
3083 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
3084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
3085 <em>required</em></p></td>
3086 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3092 <h4 id="_responses_38"><a class="anchor" href="#_responses_38"></a><a class="link" href="#_responses_38">2.38.2. Responses</a></h4>
3093 <table class="tableblock frame-all grid-all stretch">
3095 <col style="width: 10%;">
3096 <col style="width: 70%;">
3097 <col style="width: 20%;">
3101 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3102 <th class="tableblock halign-left valign-middle">Description</th>
3103 <th class="tableblock halign-left valign-middle">Schema</th>
3108 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3109 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3110 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3116 <h4 id="_produces_34"><a class="anchor" href="#_produces_34"></a><a class="link" href="#_produces_34">2.38.3. Produces</a></h4>
3120 <p><code>application/json</code></p>
3127 <h3 id="_verb349"><a class="anchor" href="#_verb349"></a><a class="link" href="#_verb349">2.39. POST /v2/toscaControlLoop/commissionToscaTemplate</a></h3>
3129 <h4 id="_parameters_29"><a class="anchor" href="#_parameters_29"></a><a class="link" href="#_parameters_29">2.39.1. Parameters</a></h4>
3130 <table class="tableblock frame-all grid-all stretch">
3132 <col style="width: 22.2222%;">
3133 <col style="width: 33.3333%;">
3134 <col style="width: 44.4445%;">
3138 <th class="tableblock halign-left valign-middle">Type</th>
3139 <th class="tableblock halign-left valign-middle">Name</th>
3140 <th class="tableblock halign-left valign-middle">Schema</th>
3145 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3147 <em>required</em></p></td>
3148 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3154 <h4 id="_responses_39"><a class="anchor" href="#_responses_39"></a><a class="link" href="#_responses_39">2.39.2. Responses</a></h4>
3155 <table class="tableblock frame-all grid-all stretch">
3157 <col style="width: 10%;">
3158 <col style="width: 70%;">
3159 <col style="width: 20%;">
3163 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3164 <th class="tableblock halign-left valign-middle">Description</th>
3165 <th class="tableblock halign-left valign-middle">Schema</th>
3170 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3171 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3172 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3178 <h4 id="_consumes_10"><a class="anchor" href="#_consumes_10"></a><a class="link" href="#_consumes_10">2.39.3. Consumes</a></h4>
3182 <p><code>plain/text</code></p>
3188 <h4 id="_produces_35"><a class="anchor" href="#_produces_35"></a><a class="link" href="#_produces_35">2.39.4. Produces</a></h4>
3192 <p><code>application/json</code></p>
3199 <h3 id="_verb350"><a class="anchor" href="#_verb350"></a><a class="link" href="#_verb350">2.40. DELETE /v2/toscaControlLoop/decommissionToscaTemplate</a></h3>
3201 <h4 id="_parameters_30"><a class="anchor" href="#_parameters_30"></a><a class="link" href="#_parameters_30">2.40.1. Parameters</a></h4>
3202 <table class="tableblock frame-all grid-all stretch">
3204 <col style="width: 22.2222%;">
3205 <col style="width: 33.3333%;">
3206 <col style="width: 44.4445%;">
3210 <th class="tableblock halign-left valign-middle">Type</th>
3211 <th class="tableblock halign-left valign-middle">Name</th>
3212 <th class="tableblock halign-left valign-middle">Schema</th>
3217 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3218 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3219 <em>required</em></p></td>
3220 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3226 <h4 id="_responses_40"><a class="anchor" href="#_responses_40"></a><a class="link" href="#_responses_40">2.40.2. Responses</a></h4>
3227 <table class="tableblock frame-all grid-all stretch">
3229 <col style="width: 10%;">
3230 <col style="width: 70%;">
3231 <col style="width: 20%;">
3235 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3236 <th class="tableblock halign-left valign-middle">Description</th>
3237 <th class="tableblock halign-left valign-middle">Schema</th>
3242 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3243 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3244 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3250 <h4 id="_consumes_11"><a class="anchor" href="#_consumes_11"></a><a class="link" href="#_consumes_11">2.40.3. Consumes</a></h4>
3254 <p><code>plain/text</code></p>
3260 <h4 id="_produces_36"><a class="anchor" href="#_produces_36"></a><a class="link" href="#_produces_36">2.40.4. Produces</a></h4>
3264 <p><code>application/json</code></p>
3271 <h3 id="_verb358"><a class="anchor" href="#_verb358"></a><a class="link" href="#_verb358">2.41. DELETE /v2/toscaControlLoop/deleteToscaInstanceProperties</a></h3>
3273 <h4 id="_parameters_31"><a class="anchor" href="#_parameters_31"></a><a class="link" href="#_parameters_31">2.41.1. Parameters</a></h4>
3274 <table class="tableblock frame-all grid-all stretch">
3276 <col style="width: 22.2222%;">
3277 <col style="width: 33.3333%;">
3278 <col style="width: 44.4445%;">
3282 <th class="tableblock halign-left valign-middle">Type</th>
3283 <th class="tableblock halign-left valign-middle">Name</th>
3284 <th class="tableblock halign-left valign-middle">Schema</th>
3289 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3290 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3291 <em>required</em></p></td>
3292 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3298 <h4 id="_responses_41"><a class="anchor" href="#_responses_41"></a><a class="link" href="#_responses_41">2.41.2. Responses</a></h4>
3299 <table class="tableblock frame-all grid-all stretch">
3301 <col style="width: 10%;">
3302 <col style="width: 70%;">
3303 <col style="width: 20%;">
3307 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3308 <th class="tableblock halign-left valign-middle">Description</th>
3309 <th class="tableblock halign-left valign-middle">Schema</th>
3314 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3315 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3316 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3322 <h4 id="_consumes_12"><a class="anchor" href="#_consumes_12"></a><a class="link" href="#_consumes_12">2.41.3. Consumes</a></h4>
3326 <p><code>plain/text</code></p>
3332 <h4 id="_produces_37"><a class="anchor" href="#_produces_37"></a><a class="link" href="#_produces_37">2.41.4. Produces</a></h4>
3336 <p><code>application/json</code></p>
3343 <h3 id="_verb351"><a class="anchor" href="#_verb351"></a><a class="link" href="#_verb351">2.42. DELETE /v2/toscaControlLoop/deleteToscaInstantiation</a></h3>
3345 <h4 id="_parameters_32"><a class="anchor" href="#_parameters_32"></a><a class="link" href="#_parameters_32">2.42.1. Parameters</a></h4>
3346 <table class="tableblock frame-all grid-all stretch">
3348 <col style="width: 22.2222%;">
3349 <col style="width: 33.3333%;">
3350 <col style="width: 44.4445%;">
3354 <th class="tableblock halign-left valign-middle">Type</th>
3355 <th class="tableblock halign-left valign-middle">Name</th>
3356 <th class="tableblock halign-left valign-middle">Schema</th>
3361 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3362 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3363 <em>required</em></p></td>
3364 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3370 <h4 id="_responses_42"><a class="anchor" href="#_responses_42"></a><a class="link" href="#_responses_42">2.42.2. Responses</a></h4>
3371 <table class="tableblock frame-all grid-all stretch">
3373 <col style="width: 10%;">
3374 <col style="width: 70%;">
3375 <col style="width: 20%;">
3379 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3380 <th class="tableblock halign-left valign-middle">Description</th>
3381 <th class="tableblock halign-left valign-middle">Schema</th>
3386 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3387 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3388 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3394 <h4 id="_consumes_13"><a class="anchor" href="#_consumes_13"></a><a class="link" href="#_consumes_13">2.42.3. Consumes</a></h4>
3398 <p><code>plain/text</code></p>
3404 <h4 id="_produces_38"><a class="anchor" href="#_produces_38"></a><a class="link" href="#_produces_38">2.42.4. Produces</a></h4>
3408 <p><code>application/json</code></p>
3415 <h3 id="_verb359"><a class="anchor" href="#_verb359"></a><a class="link" href="#_verb359">2.43. GET /v2/toscaControlLoop/getCommonOrInstanceProperties</a></h3>
3417 <h4 id="_responses_43"><a class="anchor" href="#_responses_43"></a><a class="link" href="#_responses_43">2.43.1. Responses</a></h4>
3418 <table class="tableblock frame-all grid-all stretch">
3420 <col style="width: 10%;">
3421 <col style="width: 70%;">
3422 <col style="width: 20%;">
3426 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3427 <th class="tableblock halign-left valign-middle">Description</th>
3428 <th class="tableblock halign-left valign-middle">Schema</th>
3433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3434 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3435 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3441 <h4 id="_produces_39"><a class="anchor" href="#_produces_39"></a><a class="link" href="#_produces_39">2.43.2. Produces</a></h4>
3445 <p><code>application/json</code></p>
3452 <h3 id="_verb356"><a class="anchor" href="#_verb356"></a><a class="link" href="#_verb356">2.44. GET /v2/toscaControlLoop/getControlLoopDefinitions</a></h3>
3454 <h4 id="_responses_44"><a class="anchor" href="#_responses_44"></a><a class="link" href="#_responses_44">2.44.1. Responses</a></h4>
3455 <table class="tableblock frame-all grid-all stretch">
3457 <col style="width: 10%;">
3458 <col style="width: 70%;">
3459 <col style="width: 20%;">
3463 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3464 <th class="tableblock halign-left valign-middle">Description</th>
3465 <th class="tableblock halign-left valign-middle">Schema</th>
3470 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3471 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3472 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3478 <h4 id="_produces_40"><a class="anchor" href="#_produces_40"></a><a class="link" href="#_produces_40">2.44.2. Produces</a></h4>
3482 <p><code>application/json</code></p>
3489 <h3 id="_verb355"><a class="anchor" href="#_verb355"></a><a class="link" href="#_verb355">2.45. GET /v2/toscaControlLoop/getElementDefinitions</a></h3>
3491 <h4 id="_responses_45"><a class="anchor" href="#_responses_45"></a><a class="link" href="#_responses_45">2.45.1. Responses</a></h4>
3492 <table class="tableblock frame-all grid-all stretch">
3494 <col style="width: 10%;">
3495 <col style="width: 70%;">
3496 <col style="width: 20%;">
3500 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3501 <th class="tableblock halign-left valign-middle">Description</th>
3502 <th class="tableblock halign-left valign-middle">Schema</th>
3507 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3508 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3509 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3515 <h4 id="_produces_41"><a class="anchor" href="#_produces_41"></a><a class="link" href="#_produces_41">2.45.2. Produces</a></h4>
3519 <p><code>application/json</code></p>
3526 <h3 id="_verb353"><a class="anchor" href="#_verb353"></a><a class="link" href="#_verb353">2.46. GET /v2/toscaControlLoop/getInstantiationOrderState</a></h3>
3528 <h4 id="_responses_46"><a class="anchor" href="#_responses_46"></a><a class="link" href="#_responses_46">2.46.1. Responses</a></h4>
3529 <table class="tableblock frame-all grid-all stretch">
3531 <col style="width: 10%;">
3532 <col style="width: 70%;">
3533 <col style="width: 20%;">
3537 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3538 <th class="tableblock halign-left valign-middle">Description</th>
3539 <th class="tableblock halign-left valign-middle">Schema</th>
3544 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3545 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3546 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3552 <h4 id="_produces_42"><a class="anchor" href="#_produces_42"></a><a class="link" href="#_produces_42">2.46.2. Produces</a></h4>
3556 <p><code>application/json</code></p>
3563 <h3 id="_verb354"><a class="anchor" href="#_verb354"></a><a class="link" href="#_verb354">2.47. GET /v2/toscaControlLoop/getJsonSchema</a></h3>
3565 <h4 id="_responses_47"><a class="anchor" href="#_responses_47"></a><a class="link" href="#_responses_47">2.47.1. Responses</a></h4>
3566 <table class="tableblock frame-all grid-all stretch">
3568 <col style="width: 10%;">
3569 <col style="width: 70%;">
3570 <col style="width: 20%;">
3574 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3575 <th class="tableblock halign-left valign-middle">Description</th>
3576 <th class="tableblock halign-left valign-middle">Schema</th>
3581 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3582 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3583 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3589 <h4 id="_produces_43"><a class="anchor" href="#_produces_43"></a><a class="link" href="#_produces_43">2.47.2. Produces</a></h4>
3593 <p><code>application/json</code></p>
3600 <h3 id="_verb352"><a class="anchor" href="#_verb352"></a><a class="link" href="#_verb352">2.48. GET /v2/toscaControlLoop/getToscaInstantiation</a></h3>
3602 <h4 id="_responses_48"><a class="anchor" href="#_responses_48"></a><a class="link" href="#_responses_48">2.48.1. Responses</a></h4>
3603 <table class="tableblock frame-all grid-all stretch">
3605 <col style="width: 10%;">
3606 <col style="width: 70%;">
3607 <col style="width: 20%;">
3611 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3612 <th class="tableblock halign-left valign-middle">Description</th>
3613 <th class="tableblock halign-left valign-middle">Schema</th>
3618 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3619 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3620 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3626 <h4 id="_produces_44"><a class="anchor" href="#_produces_44"></a><a class="link" href="#_produces_44">2.48.2. Produces</a></h4>
3630 <p><code>application/json</code></p>
3637 <h3 id="_verb348"><a class="anchor" href="#_verb348"></a><a class="link" href="#_verb348">2.49. GET /v2/toscaControlLoop/getToscaTemplate</a></h3>
3639 <h4 id="_responses_49"><a class="anchor" href="#_responses_49"></a><a class="link" href="#_responses_49">2.49.1. Responses</a></h4>
3640 <table class="tableblock frame-all grid-all stretch">
3642 <col style="width: 10%;">
3643 <col style="width: 70%;">
3644 <col style="width: 20%;">
3648 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3649 <th class="tableblock halign-left valign-middle">Description</th>
3650 <th class="tableblock halign-left valign-middle">Schema</th>
3655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3656 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3657 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3663 <h4 id="_produces_45"><a class="anchor" href="#_produces_45"></a><a class="link" href="#_produces_45">2.49.2. Produces</a></h4>
3667 <p><code>application/json</code></p>
3674 <h3 id="_verb357"><a class="anchor" href="#_verb357"></a><a class="link" href="#_verb357">2.50. POST /v2/toscaControlLoop/postToscaInstanceProperties</a></h3>
3676 <h4 id="_parameters_33"><a class="anchor" href="#_parameters_33"></a><a class="link" href="#_parameters_33">2.50.1. Parameters</a></h4>
3677 <table class="tableblock frame-all grid-all stretch">
3679 <col style="width: 22.2222%;">
3680 <col style="width: 33.3333%;">
3681 <col style="width: 44.4445%;">
3685 <th class="tableblock halign-left valign-middle">Type</th>
3686 <th class="tableblock halign-left valign-middle">Name</th>
3687 <th class="tableblock halign-left valign-middle">Schema</th>
3692 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3693 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3694 <em>required</em></p></td>
3695 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3701 <h4 id="_responses_50"><a class="anchor" href="#_responses_50"></a><a class="link" href="#_responses_50">2.50.2. Responses</a></h4>
3702 <table class="tableblock frame-all grid-all stretch">
3704 <col style="width: 10%;">
3705 <col style="width: 70%;">
3706 <col style="width: 20%;">
3710 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3711 <th class="tableblock halign-left valign-middle">Description</th>
3712 <th class="tableblock halign-left valign-middle">Schema</th>
3717 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3718 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3719 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3725 <h4 id="_consumes_14"><a class="anchor" href="#_consumes_14"></a><a class="link" href="#_consumes_14">2.50.3. Consumes</a></h4>
3729 <p><code>plain/text</code></p>
3735 <h4 id="_produces_46"><a class="anchor" href="#_produces_46"></a><a class="link" href="#_produces_46">2.50.4. Produces</a></h4>
3739 <p><code>application/json</code></p>
3746 <h3 id="_verb360"><a class="anchor" href="#_verb360"></a><a class="link" href="#_verb360">2.51. POST /v2/toscaControlLoop/postToscaInstantiation</a></h3>
3748 <h4 id="_parameters_34"><a class="anchor" href="#_parameters_34"></a><a class="link" href="#_parameters_34">2.51.1. Parameters</a></h4>
3749 <table class="tableblock frame-all grid-all stretch">
3751 <col style="width: 22.2222%;">
3752 <col style="width: 33.3333%;">
3753 <col style="width: 44.4445%;">
3757 <th class="tableblock halign-left valign-middle">Type</th>
3758 <th class="tableblock halign-left valign-middle">Name</th>
3759 <th class="tableblock halign-left valign-middle">Schema</th>
3764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3765 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3766 <em>required</em></p></td>
3767 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3773 <h4 id="_responses_51"><a class="anchor" href="#_responses_51"></a><a class="link" href="#_responses_51">2.51.2. Responses</a></h4>
3774 <table class="tableblock frame-all grid-all stretch">
3776 <col style="width: 10%;">
3777 <col style="width: 70%;">
3778 <col style="width: 20%;">
3782 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3783 <th class="tableblock halign-left valign-middle">Description</th>
3784 <th class="tableblock halign-left valign-middle">Schema</th>
3789 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3790 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3791 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3797 <h4 id="_consumes_15"><a class="anchor" href="#_consumes_15"></a><a class="link" href="#_consumes_15">2.51.3. Consumes</a></h4>
3801 <p><code>plain/text</code></p>
3807 <h4 id="_produces_47"><a class="anchor" href="#_produces_47"></a><a class="link" href="#_produces_47">2.51.4. Produces</a></h4>
3811 <p><code>application/json</code></p>
3818 <h3 id="_verb361"><a class="anchor" href="#_verb361"></a><a class="link" href="#_verb361">2.52. PUT /v2/toscaControlLoop/putToscaInstantiationStateChange</a></h3>
3820 <h4 id="_parameters_35"><a class="anchor" href="#_parameters_35"></a><a class="link" href="#_parameters_35">2.52.1. Parameters</a></h4>
3821 <table class="tableblock frame-all grid-all stretch">
3823 <col style="width: 22.2222%;">
3824 <col style="width: 33.3333%;">
3825 <col style="width: 44.4445%;">
3829 <th class="tableblock halign-left valign-middle">Type</th>
3830 <th class="tableblock halign-left valign-middle">Name</th>
3831 <th class="tableblock halign-left valign-middle">Schema</th>
3836 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
3837 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
3838 <em>required</em></p></td>
3839 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3845 <h4 id="_responses_52"><a class="anchor" href="#_responses_52"></a><a class="link" href="#_responses_52">2.52.2. Responses</a></h4>
3846 <table class="tableblock frame-all grid-all stretch">
3848 <col style="width: 10%;">
3849 <col style="width: 70%;">
3850 <col style="width: 20%;">
3854 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3855 <th class="tableblock halign-left valign-middle">Description</th>
3856 <th class="tableblock halign-left valign-middle">Schema</th>
3861 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
3862 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
3863 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3869 <h4 id="_consumes_16"><a class="anchor" href="#_consumes_16"></a><a class="link" href="#_consumes_16">2.52.3. Consumes</a></h4>
3873 <p><code>plain/text</code></p>
3879 <h4 id="_produces_48"><a class="anchor" href="#_produces_48"></a><a class="link" href="#_produces_48">2.52.4. Produces</a></h4>
3883 <p><code>application/json</code></p>
3892 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
3893 <div class="sectionbody">
3895 <h3 id="_clampinformation"><a class="anchor" href="#_clampinformation"></a><a class="link" href="#_clampinformation">3.1. ClampInformation</a></h3>
3896 <table class="tableblock frame-all grid-all stretch">
3898 <col style="width: 42.8571%;">
3899 <col style="width: 57.1429%;">
3903 <th class="tableblock halign-left valign-middle">Name</th>
3904 <th class="tableblock halign-left valign-middle">Schema</th>
3909 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allPermissions</strong><br>
3910 <em>optional</em></p></td>
3911 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
3914 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
3915 <em>optional</em></p></td>
3916 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3919 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
3920 <em>optional</em></p></td>
3921 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3927 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a><a class="link" href="#_cldshealthcheck">3.2. CldsHealthCheck</a></h3>
3928 <table class="tableblock frame-all grid-all stretch">
3930 <col style="width: 42.8571%;">
3931 <col style="width: 57.1429%;">
3935 <th class="tableblock halign-left valign-middle">Name</th>
3936 <th class="tableblock halign-left valign-middle">Schema</th>
3941 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
3942 <em>optional</em></p></td>
3943 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3946 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
3947 <em>optional</em></p></td>
3948 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3951 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
3952 <em>optional</em></p></td>
3953 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3959 <h3 id="_dictionary"><a class="anchor" href="#_dictionary"></a><a class="link" href="#_dictionary">3.3. Dictionary</a></h3>
3960 <table class="tableblock frame-all grid-all stretch">
3962 <col style="width: 42.8571%;">
3963 <col style="width: 57.1429%;">
3967 <th class="tableblock halign-left valign-middle">Name</th>
3968 <th class="tableblock halign-left valign-middle">Schema</th>
3973 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3974 <em>optional</em></p></td>
3975 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3978 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3979 <em>optional</em></p></td>
3980 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryElements</strong><br>
3984 <em>optional</em></p></td>
3985 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_dictionaryelement">DictionaryElement</a> > array</p></td>
3988 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3989 <em>optional</em></p></td>
3990 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3993 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>secondLevelDictionary</strong><br>
3994 <em>optional</em></p></td>
3995 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3998 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionaryType</strong><br>
3999 <em>optional</em></p></td>
4000 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4003 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4004 <em>optional</em></p></td>
4005 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4008 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4009 <em>optional</em></p></td>
4010 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4016 <h3 id="_dictionaryelement"><a class="anchor" href="#_dictionaryelement"></a><a class="link" href="#_dictionaryelement">3.4. DictionaryElement</a></h3>
4017 <table class="tableblock frame-all grid-all stretch">
4019 <col style="width: 42.8571%;">
4020 <col style="width: 57.1429%;">
4024 <th class="tableblock halign-left valign-middle">Name</th>
4025 <th class="tableblock halign-left valign-middle">Schema</th>
4030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4031 <em>optional</em></p></td>
4032 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4035 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4036 <em>optional</em></p></td>
4037 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4040 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
4041 <em>optional</em></p></td>
4042 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4045 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4046 <em>optional</em></p></td>
4047 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
4051 <em>optional</em></p></td>
4052 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4055 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionary</strong><br>
4056 <em>optional</em></p></td>
4057 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4060 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
4061 <em>optional</em></p></td>
4062 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4065 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4066 <em>optional</em></p></td>
4067 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4070 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4071 <em>optional</em></p></td>
4072 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4075 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByDictionaries</strong><br>
4076 <em>optional</em></p></td>
4077 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_dictionary">Dictionary</a> > array</p></td>
4083 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.5. ExternalComponent</a></h3>
4084 <table class="tableblock frame-all grid-all stretch">
4086 <col style="width: 42.8571%;">
4087 <col style="width: 57.1429%;">
4091 <th class="tableblock halign-left valign-middle">Name</th>
4092 <th class="tableblock halign-left valign-middle">Schema</th>
4097 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
4098 <em>optional</em></p></td>
4099 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4102 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
4103 <em>optional</em></p></td>
4104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
4110 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.6. ExternalComponentState</a></h3>
4111 <table class="tableblock frame-all grid-all stretch">
4113 <col style="width: 42.8571%;">
4114 <col style="width: 57.1429%;">
4118 <th class="tableblock halign-left valign-middle">Name</th>
4119 <th class="tableblock halign-left valign-middle">Schema</th>
4124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
4125 <em>optional</em></p></td>
4126 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4129 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
4130 <em>optional</em></p></td>
4131 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4134 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
4135 <em>optional</em></p></td>
4136 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4142 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.7. JsonArray</a></h3>
4143 <table class="tableblock frame-all grid-all stretch">
4145 <col style="width: 42.8571%;">
4146 <col style="width: 57.1429%;">
4150 <th class="tableblock halign-left valign-middle">Name</th>
4151 <th class="tableblock halign-left valign-middle">Schema</th>
4156 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4157 <em>optional</em></p></td>
4158 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4162 <em>optional</em></p></td>
4163 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4166 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4167 <em>optional</em></p></td>
4168 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4171 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4172 <em>optional</em></p></td>
4173 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4176 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4177 <em>optional</em></p></td>
4178 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4181 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4182 <em>optional</em></p></td>
4183 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4187 <em>optional</em></p></td>
4188 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4192 <em>optional</em></p></td>
4193 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4196 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4197 <em>optional</em></p></td>
4198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4202 <em>optional</em></p></td>
4203 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4207 <em>optional</em></p></td>
4208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4211 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4212 <em>optional</em></p></td>
4213 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4216 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4217 <em>optional</em></p></td>
4218 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4221 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4222 <em>optional</em></p></td>
4223 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4226 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4227 <em>optional</em></p></td>
4228 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4231 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4232 <em>optional</em></p></td>
4233 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4236 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4237 <em>optional</em></p></td>
4238 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4241 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4242 <em>optional</em></p></td>
4243 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4246 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4247 <em>optional</em></p></td>
4248 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4252 <em>optional</em></p></td>
4253 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4259 <h3 id="_jsonelement"><a class="anchor" href="#_jsonelement"></a><a class="link" href="#_jsonelement">3.8. JsonElement</a></h3>
4260 <table class="tableblock frame-all grid-all stretch">
4262 <col style="width: 42.8571%;">
4263 <col style="width: 57.1429%;">
4267 <th class="tableblock halign-left valign-middle">Name</th>
4268 <th class="tableblock halign-left valign-middle">Schema</th>
4273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4274 <em>optional</em></p></td>
4275 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4279 <em>optional</em></p></td>
4280 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4283 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4284 <em>optional</em></p></td>
4285 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4289 <em>optional</em></p></td>
4290 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4293 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4294 <em>optional</em></p></td>
4295 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4298 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4299 <em>optional</em></p></td>
4300 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4303 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4304 <em>optional</em></p></td>
4305 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4308 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4309 <em>optional</em></p></td>
4310 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4313 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4314 <em>optional</em></p></td>
4315 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4318 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4319 <em>optional</em></p></td>
4320 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4323 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4324 <em>optional</em></p></td>
4325 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4329 <em>optional</em></p></td>
4330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4334 <em>optional</em></p></td>
4335 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4339 <em>optional</em></p></td>
4340 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4343 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4344 <em>optional</em></p></td>
4345 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4348 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4349 <em>optional</em></p></td>
4350 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4353 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4354 <em>optional</em></p></td>
4355 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4358 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4359 <em>optional</em></p></td>
4360 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4363 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4364 <em>optional</em></p></td>
4365 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4369 <em>optional</em></p></td>
4370 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4376 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.9. JsonNull</a></h3>
4377 <table class="tableblock frame-all grid-all stretch">
4379 <col style="width: 42.8571%;">
4380 <col style="width: 57.1429%;">
4384 <th class="tableblock halign-left valign-middle">Name</th>
4385 <th class="tableblock halign-left valign-middle">Schema</th>
4390 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4391 <em>optional</em></p></td>
4392 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4395 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4396 <em>optional</em></p></td>
4397 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4400 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4401 <em>optional</em></p></td>
4402 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4406 <em>optional</em></p></td>
4407 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4410 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4411 <em>optional</em></p></td>
4412 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4415 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4416 <em>optional</em></p></td>
4417 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4420 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4421 <em>optional</em></p></td>
4422 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4425 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4426 <em>optional</em></p></td>
4427 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4430 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4431 <em>optional</em></p></td>
4432 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4435 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4436 <em>optional</em></p></td>
4437 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4440 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4441 <em>optional</em></p></td>
4442 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4445 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4446 <em>optional</em></p></td>
4447 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4450 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4451 <em>optional</em></p></td>
4452 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4455 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4456 <em>optional</em></p></td>
4457 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4460 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4461 <em>optional</em></p></td>
4462 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4465 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4466 <em>optional</em></p></td>
4467 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4470 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4471 <em>optional</em></p></td>
4472 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4475 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4476 <em>optional</em></p></td>
4477 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4480 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4481 <em>optional</em></p></td>
4482 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4485 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4486 <em>optional</em></p></td>
4487 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4493 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.10. JsonObject</a></h3>
4494 <table class="tableblock frame-all grid-all stretch">
4496 <col style="width: 42.8571%;">
4497 <col style="width: 57.1429%;">
4501 <th class="tableblock halign-left valign-middle">Name</th>
4502 <th class="tableblock halign-left valign-middle">Schema</th>
4507 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4508 <em>optional</em></p></td>
4509 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4512 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4513 <em>optional</em></p></td>
4514 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4517 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4518 <em>optional</em></p></td>
4519 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4522 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4523 <em>optional</em></p></td>
4524 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4527 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4528 <em>optional</em></p></td>
4529 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4532 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4533 <em>optional</em></p></td>
4534 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4537 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4538 <em>optional</em></p></td>
4539 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4542 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4543 <em>optional</em></p></td>
4544 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4547 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4548 <em>optional</em></p></td>
4549 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4552 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4553 <em>optional</em></p></td>
4554 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4557 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4558 <em>optional</em></p></td>
4559 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4562 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4563 <em>optional</em></p></td>
4564 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4567 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4568 <em>optional</em></p></td>
4569 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4572 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4573 <em>optional</em></p></td>
4574 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4577 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4578 <em>optional</em></p></td>
4579 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4582 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4583 <em>optional</em></p></td>
4584 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4587 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4588 <em>optional</em></p></td>
4589 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4592 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4593 <em>optional</em></p></td>
4594 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4598 <em>optional</em></p></td>
4599 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4603 <em>optional</em></p></td>
4604 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4610 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.11. JsonPrimitive</a></h3>
4611 <table class="tableblock frame-all grid-all stretch">
4613 <col style="width: 42.8571%;">
4614 <col style="width: 57.1429%;">
4618 <th class="tableblock halign-left valign-middle">Name</th>
4619 <th class="tableblock halign-left valign-middle">Schema</th>
4624 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
4625 <em>optional</em></p></td>
4626 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
4629 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
4630 <em>optional</em></p></td>
4631 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
4634 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
4635 <em>optional</em></p></td>
4636 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4639 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
4640 <em>optional</em></p></td>
4641 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
4644 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
4645 <em>optional</em></p></td>
4646 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4649 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
4650 <em>optional</em></p></td>
4651 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
4654 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
4655 <em>optional</em></p></td>
4656 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
4659 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
4660 <em>optional</em></p></td>
4661 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
4665 <em>optional</em></p></td>
4666 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
4669 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
4670 <em>optional</em></p></td>
4671 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
4674 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
4675 <em>optional</em></p></td>
4676 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
4680 <em>optional</em></p></td>
4681 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
4684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
4685 <em>optional</em></p></td>
4686 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
4690 <em>optional</em></p></td>
4691 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
4694 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
4695 <em>optional</em></p></td>
4696 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
4699 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
4700 <em>optional</em></p></td>
4701 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4704 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
4705 <em>optional</em></p></td>
4706 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4709 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
4710 <em>optional</em></p></td>
4711 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4714 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
4715 <em>optional</em></p></td>
4716 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
4720 <em>optional</em></p></td>
4721 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
4725 <em>optional</em></p></td>
4726 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
4730 <em>optional</em></p></td>
4731 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4734 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
4735 <em>optional</em></p></td>
4736 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
4742 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.12. Loop</a></h3>
4743 <table class="tableblock frame-all grid-all stretch">
4745 <col style="width: 42.8571%;">
4746 <col style="width: 57.1429%;">
4750 <th class="tableblock halign-left valign-middle">Name</th>
4751 <th class="tableblock halign-left valign-middle">Schema</th>
4756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
4757 <em>optional</em></p></td>
4758 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string, <a href="#_externalcomponent">ExternalComponent</a> > map</p></td>
4761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4762 <em>optional</em></p></td>
4763 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4766 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4767 <em>optional</em></p></td>
4768 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4771 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
4772 <em>optional</em></p></td>
4773 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4776 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
4777 <em>optional</em></p></td>
4778 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4781 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
4782 <em>optional</em></p></td>
4783 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
4786 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
4787 <em>optional</em></p></td>
4788 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
4791 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
4792 <em>optional</em></p></td>
4793 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looplog">LoopLog</a> > array</p></td>
4796 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
4797 <em>optional</em></p></td>
4798 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
4801 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
4802 <em>optional</em></p></td>
4803 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_microservicepolicy">MicroServicePolicy</a> > array</p></td>
4806 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
4807 <em>optional</em></p></td>
4808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
4811 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4812 <em>optional</em></p></td>
4813 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4816 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
4817 <em>optional</em></p></td>
4818 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_operationalpolicy">OperationalPolicy</a> > array</p></td>
4821 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4822 <em>optional</em></p></td>
4823 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4827 <em>optional</em></p></td>
4828 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4834 <h3 id="_loopelementmodel"><a class="anchor" href="#_loopelementmodel"></a><a class="link" href="#_loopelementmodel">3.13. LoopElementModel</a></h3>
4835 <table class="tableblock frame-all grid-all stretch">
4837 <col style="width: 42.8571%;">
4838 <col style="width: 57.1429%;">
4842 <th class="tableblock halign-left valign-middle">Name</th>
4843 <th class="tableblock halign-left valign-middle">Schema</th>
4848 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
4849 <em>optional</em></p></td>
4850 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4853 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4854 <em>optional</em></p></td>
4855 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4859 <em>optional</em></p></td>
4860 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4863 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
4864 <em>optional</em></p></td>
4865 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementType</strong><br>
4869 <em>optional</em></p></td>
4870 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4873 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
4874 <em>optional</em></p></td>
4875 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModels</strong><br>
4879 <em>optional</em></p></td>
4880 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_policymodel">PolicyModel</a> > array</p></td>
4883 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
4884 <em>optional</em></p></td>
4885 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4888 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
4889 <em>optional</em></p></td>
4890 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4893 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
4894 <em>optional</em></p></td>
4895 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoopTemplates</strong><br>
4899 <em>optional</em></p></td>
4900 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> > array</p></td>
4906 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.14. LoopLog</a></h3>
4907 <table class="tableblock frame-all grid-all stretch">
4909 <col style="width: 42.8571%;">
4910 <col style="width: 57.1429%;">
4914 <th class="tableblock halign-left valign-middle">Name</th>
4915 <th class="tableblock halign-left valign-middle">Schema</th>
4920 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
4921 <em>optional</em></p></td>
4922 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4925 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
4926 <em>optional</em></p></td>
4927 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
4931 <em>optional</em></p></td>
4932 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4935 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
4936 <em>optional</em></p></td>
4937 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
4940 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
4941 <em>optional</em></p></td>
4942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
4945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
4946 <em>optional</em></p></td>
4947 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4953 <h3 id="_looptemplate"><a class="anchor" href="#_looptemplate"></a><a class="link" href="#_looptemplate">3.15. LoopTemplate</a></h3>
4954 <table class="tableblock frame-all grid-all stretch">
4956 <col style="width: 42.8571%;">
4957 <col style="width: 57.1429%;">
4961 <th class="tableblock halign-left valign-middle">Name</th>
4962 <th class="tableblock halign-left valign-middle">Schema</th>
4967 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allowedLoopType</strong><br>
4968 <em>optional</em></p></td>
4969 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (OPEN, CLOSED, HYBRID)</p></td>
4972 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
4973 <em>optional</em></p></td>
4974 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4977 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
4978 <em>optional</em></p></td>
4979 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4982 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
4983 <em>optional</em></p></td>
4984 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
4987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
4988 <em>optional</em></p></td>
4989 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
4992 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModelsUsed</strong><br>
4993 <em>optional</em></p></td>
4994 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> > array</p></td>
4997 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>maximumInstancesAllowed</strong><br>
4998 <em>optional</em></p></td>
4999 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
5002 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
5003 <em>optional</em></p></td>
5004 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
5007 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
5008 <em>optional</em></p></td>
5009 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5012 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>uniqueBlueprint</strong><br>
5013 <em>optional</em></p></td>
5014 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
5017 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
5018 <em>optional</em></p></td>
5019 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5022 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
5023 <em>optional</em></p></td>
5024 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5030 <h3 id="_looptemplateloopelementmodel"><a class="anchor" href="#_looptemplateloopelementmodel"></a><a class="link" href="#_looptemplateloopelementmodel">3.16. LoopTemplateLoopElementModel</a></h3>
5031 <table class="tableblock frame-all grid-all stretch">
5033 <col style="width: 42.8571%;">
5034 <col style="width: 57.1429%;">
5038 <th class="tableblock halign-left valign-middle">Name</th>
5039 <th class="tableblock halign-left valign-middle">Schema</th>
5044 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>flowOrder</strong><br>
5045 <em>optional</em></p></td>
5046 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
5049 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
5050 <em>optional</em></p></td>
5051 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
5054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
5055 <em>optional</em></p></td>
5056 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
5062 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.17. MicroServicePolicy</a></h3>
5063 <table class="tableblock frame-all grid-all stretch">
5065 <col style="width: 42.8571%;">
5066 <col style="width: 57.1429%;">
5070 <th class="tableblock halign-left valign-middle">Name</th>
5071 <th class="tableblock halign-left valign-middle">Schema</th>
5076 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
5077 <em>optional</em></p></td>
5078 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5081 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>context</strong><br>
5082 <em>optional</em></p></td>
5083 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5086 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
5087 <em>optional</em></p></td>
5088 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5091 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
5092 <em>optional</em></p></td>
5093 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5096 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
5097 <em>optional</em></p></td>
5098 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5101 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
5102 <em>optional</em></p></td>
5103 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5106 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
5107 <em>optional</em></p></td>
5108 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5111 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deviceTypeScope</strong><br>
5112 <em>optional</em></p></td>
5113 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5116 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
5117 <em>optional</em></p></td>
5118 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5121 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
5122 <em>optional</em></p></td>
5123 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
5126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
5127 <em>optional</em></p></td>
5128 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5131 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
5132 <em>optional</em></p></td>
5133 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5136 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
5137 <em>optional</em></p></td>
5138 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5141 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
5142 <em>optional</em></p></td>
5143 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
5146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
5147 <em>optional</em></p></td>
5148 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
5151 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
5152 <em>optional</em></p></td>
5153 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5156 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
5157 <em>optional</em></p></td>
5158 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
5162 <em>optional</em></p></td>
5163 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_loop">Loop</a> > array</p></td>
5169 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.18. Number</a></h3>
5170 <div class="paragraph">
5171 <p><em>Type</em> : object</p>
5175 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.19. OperationalPolicy</a></h3>
5176 <table class="tableblock frame-all grid-all stretch">
5178 <col style="width: 42.8571%;">
5179 <col style="width: 57.1429%;">
5183 <th class="tableblock halign-left valign-middle">Name</th>
5184 <th class="tableblock halign-left valign-middle">Schema</th>
5189 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
5190 <em>optional</em></p></td>
5191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
5195 <em>optional</em></p></td>
5196 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5199 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
5200 <em>optional</em></p></td>
5201 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5204 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
5205 <em>optional</em></p></td>
5206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
5210 <em>optional</em></p></td>
5211 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
5214 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
5215 <em>optional</em></p></td>
5216 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
5219 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
5220 <em>optional</em></p></td>
5221 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5224 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
5225 <em>optional</em></p></td>
5226 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5229 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpSubgroup</strong><br>
5230 <em>optional</em></p></td>
5231 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5234 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
5235 <em>optional</em></p></td>
5236 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
5239 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
5240 <em>optional</em></p></td>
5241 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5244 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
5245 <em>optional</em></p></td>
5246 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5252 <h3 id="_policymodel"><a class="anchor" href="#_policymodel"></a><a class="link" href="#_policymodel">3.20. PolicyModel</a></h3>
5253 <table class="tableblock frame-all grid-all stretch">
5255 <col style="width: 42.8571%;">
5256 <col style="width: 57.1429%;">
5260 <th class="tableblock halign-left valign-middle">Name</th>
5261 <th class="tableblock halign-left valign-middle">Schema</th>
5266 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
5267 <em>optional</em></p></td>
5268 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5271 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
5272 <em>optional</em></p></td>
5273 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5276 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyAcronym</strong><br>
5277 <em>optional</em></p></td>
5278 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5281 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelTosca</strong><br>
5282 <em>optional</em></p></td>
5283 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5286 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
5287 <em>optional</em></p></td>
5288 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5291 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyPdpGroup</strong><br>
5292 <em>optional</em></p></td>
5293 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5296 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
5297 <em>optional</em></p></td>
5298 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5301 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
5302 <em>optional</em></p></td>
5303 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
5306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByElementModels</strong><br>
5307 <em>optional</em></p></td>
5308 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_loopelementmodel">LoopElementModel</a> > array</p></td>
5311 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
5312 <em>optional</em></p></td>
5313 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5319 <h3 id="_service"><a class="anchor" href="#_service"></a><a class="link" href="#_service">3.21. Service</a></h3>
5320 <table class="tableblock frame-all grid-all stretch">
5322 <col style="width: 42.8571%;">
5323 <col style="width: 57.1429%;">
5327 <th class="tableblock halign-left valign-middle">Name</th>
5328 <th class="tableblock halign-left valign-middle">Schema</th>
5333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
5334 <em>optional</em></p></td>
5335 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceDetails</strong><br>
5339 <em>optional</em></p></td>
5340 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5343 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceDetails</strong><br>
5344 <em>optional</em></p></td>
5345 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
5348 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUuid</strong><br>
5349 <em>optional</em></p></td>
5350 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5353 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
5354 <em>optional</em></p></td>
5355 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
5364 <div id="footer-text">
5365 Last updated 2021-09-09 13:43:02 IST