docs/clamp/clamp/swagger/swagger.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="UTF-8">
   5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <meta name="generator" content="Asciidoctor 1.5.7.1">
   8 <title>Clamp Rest API</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  10 <style>
  11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12 /* Uncomment @import statement below to use as custom stylesheet */
  13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15 audio,canvas,video{display:inline-block}
  16 audio:not([controls]){display:none;height:0}
  17 script{display:none!important}
  18 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  19 a{background:transparent}
  20 a:focus{outline:thin dotted}
  21 a:active,a:hover{outline:0}
  22 h1{font-size:2em;margin:.67em 0}
  23 abbr[title]{border-bottom:1px dotted}
  24 b,strong{font-weight:bold}
  25 dfn{font-style:italic}
  26 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  27 mark{background:#ff0;color:#000}
  28 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  29 pre{white-space:pre-wrap}
  30 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  31 small{font-size:80%}
  32 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  33 sup{top:-.5em}
  34 sub{bottom:-.25em}
  35 img{border:0}
  36 svg:not(:root){overflow:hidden}
  37 figure{margin:0}
  38 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  39 legend{border:0;padding:0}
  40 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  41 button,input{line-height:normal}
  42 button,select{text-transform:none}
  43 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  44 button[disabled],html input[disabled]{cursor:default}
  45 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  46 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  47 textarea{overflow:auto;vertical-align:top}
  48 table{border-collapse:collapse;border-spacing:0}
  49 *,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  50 html,body{font-size:100%}
  51 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  52 a:hover{cursor:pointer}
  53 img,object,embed{max-width:100%;height:auto}
  54 object,embed{height:100%}
  55 img{-ms-interpolation-mode:bicubic}
  56 .left{float:left!important}
  57 .right{float:right!important}
  58 .text-left{text-align:left!important}
  59 .text-right{text-align:right!important}
  60 .text-center{text-align:center!important}
  61 .text-justify{text-align:justify!important}
  62 .hide{display:none}
  63 img,object,svg{display:inline-block;vertical-align:middle}
  64 textarea{height:auto;min-height:50px}
  65 select{width:100%}
  66 .center{margin-left:auto;margin-right:auto}
  67 .stretch{width:100%}
  68 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  69 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  70 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  71 a:hover,a:focus{color:#1d4b8f}
  72 a img{border:none}
  73 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  74 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  75 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  76 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  77 h1{font-size:2.125em}
  78 h2{font-size:1.6875em}
  79 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  80 h4,h5{font-size:1.125em}
  81 h6{font-size:1em}
  82 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  83 em,i{font-style:italic;line-height:inherit}
  84 strong,b{font-weight:bold;line-height:inherit}
  85 small{font-size:60%;line-height:inherit}
  86 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  87 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  88 ul,ol{margin-left:1.5em}
  89 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  90 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  91 ul.square{list-style-type:square}
  92 ul.circle{list-style-type:circle}
  93 ul.disc{list-style-type:disc}
  94 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  95 dl dt{margin-bottom:.3125em;font-weight:bold}
  96 dl dd{margin-bottom:1.25em}
  97 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
  98 abbr{text-transform:none}
  99 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
 100 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
 101 blockquote cite::before{content:"\2014 \0020"}
 102 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
 103 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 104 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 105 h1{font-size:2.75em}
 106 h2{font-size:2.3125em}
 107 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 108 h4{font-size:1.4375em}}
 109 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
 110 table thead,table tfoot{background:#f7f8f7}
 111 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 112 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 113 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
 114 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
 115 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 116 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 117 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
 118 .clearfix::after,.float-group::after{clear:both}
 119 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
 120 *:not(pre)>code.nobreak{word-wrap:normal}
 121 *:not(pre)>code.nowrap{white-space:nowrap}
 122 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
 123 em em{font-style:normal}
 124 strong strong{font-weight:400}
 125 .keyseq{color:rgba(51,51,51,.8)}
 126 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 127 .keyseq kbd:first-child{margin-left:0}
 128 .keyseq kbd:last-child{margin-right:0}
 129 .menuseq,.menuref{color:#000}
 130 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 131 .menuseq{word-spacing:-.02em}
 132 .menuseq b.caret{font-size:1.25em;line-height:.8}
 133 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 134 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
 135 b.button::before{content:"[";padding:0 3px 0 2px}
 136 b.button::after{content:"]";padding:0 2px 0 3px}
 137 p a>code:hover{color:rgba(0,0,0,.9)}
 138 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 139 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
 140 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
 141 #content{margin-top:1.25em}
 142 #content::before{content:none}
 143 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 144 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
 145 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
 146 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
 147 #header .details span:first-child{margin-left:-.125em}
 148 #header .details span.email a{color:rgba(0,0,0,.85)}
 149 #header .details br{display:none}
 150 #header .details br+span::before{content:"\00a0\2013\00a0"}
 151 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 152 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
 153 #header #revnumber{text-transform:capitalize}
 154 #header #revnumber::after{content:"\00a0"}
 155 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 156 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
 157 #toc>ul{margin-left:.125em}
 158 #toc ul.sectlevel0>li>a{font-style:italic}
 159 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 160 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 161 #toc li{line-height:1.3334;margin-top:.3334em}
 162 #toc a{text-decoration:none}
 163 #toc a:active{text-decoration:underline}
 164 #toctitle{color:#7a2518;font-size:1.2em}
 165 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
 166 body.toc2{padding-left:15em;padding-right:0}
 167 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 168 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 169 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 170 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 171 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 172 body.toc2.toc-right{padding-left:0;padding-right:15em}
 173 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
 174 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 175 #toc.toc2{width:20em}
 176 #toc.toc2 #toctitle{font-size:1.375em}
 177 #toc.toc2>ul{font-size:.95em}
 178 #toc.toc2 ul ul{padding-left:1.25em}
 179 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 180 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 181 #content #toc>:first-child{margin-top:0}
 182 #content #toc>:last-child{margin-bottom:0}
 183 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
 184 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
 185 #content{margin-bottom:.625em}
 186 .sect1{padding-bottom:.625em}
 187 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
 188 .sect1{padding-bottom:1.25em}}
 189 .sect1:last-child{padding-bottom:0}
 190 .sect1+.sect1{border-top:1px solid #efefed}
 191 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 192 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 193 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 194 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 195 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 196 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 197 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 198 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
 199 .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
 200 table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
 201 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 202 .admonitionblock>table td.icon{text-align:center;width:80px}
 203 .admonitionblock>table td.icon img{max-width:none}
 204 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 205 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
 206 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 207 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
 208 .exampleblock>.content>:first-child{margin-top:0}
 209 .exampleblock>.content>:last-child{margin-bottom:0}
 210 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 211 .sidebarblock>:first-child{margin-top:0}
 212 .sidebarblock>:last-child{margin-bottom:0}
 213 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 214 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 215 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
 216 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
 217 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
 218 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
 219 @media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
 220 @media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
 221 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
 222 .listingblock pre.highlightjs{padding:0}
 223 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
 224 .listingblock pre.prettyprint{border-width:0}
 225 .listingblock>.content{position:relative}
 226 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
 227 .listingblock:hover code[data-lang]::before{display:block}
 228 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999}
 229 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
 230 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 231 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
 232 table.pyhltable td.code{padding-left:.75em;padding-right:0}
 233 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
 234 pre.pygments .lineno{display:inline-block;margin-right:.25em}
 235 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
 236 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 237 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
 238 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 239 .quoteblock blockquote{margin:0;padding:0;border:0}
 240 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 241 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 242 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
 243 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
 244 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
 245 .quoteblock .quoteblock blockquote::before{display:none}
 246 .verseblock{margin:0 1em 1.25em}
 247 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 248 .verseblock pre strong{font-weight:400}
 249 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 250 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 251 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 252 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 253 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
 254 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
 255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{word-spacing:0;line-height:1.6}
 256 .quoteblock.abstract blockquote::before,.quoteblock.abstract p::before{display:none}
 257 table.tableblock{max-width:100%;border-collapse:separate}
 258 p.tableblock:last-child{margin-bottom:0}
 259 td.tableblock>.content{margin-bottom:-1.25em}
 260 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 261 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
 262 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
 263 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
 264 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
 265 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
 266 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
 267 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
 268 table.frame-all{border-width:1px}
 269 table.frame-sides{border-width:0 1px}
 270 table.frame-topbot,table.frame-ends{border-width:1px 0}
 271 table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7}
 272 table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none}
 273 th.halign-left,td.halign-left{text-align:left}
 274 th.halign-right,td.halign-right{text-align:right}
 275 th.halign-center,td.halign-center{text-align:center}
 276 th.valign-top,td.valign-top{vertical-align:top}
 277 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 278 th.valign-middle,td.valign-middle{vertical-align:middle}
 279 table thead th,table tfoot th{font-weight:bold}
 280 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
 281 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 282 p.tableblock>code:only-child{background:none;padding:0}
 283 p.tableblock{font-size:1em}
 284 td>div.verse{white-space:pre}
 285 ol{margin-left:1.75em}
 286 ul li ol{margin-left:1.5em}
 287 dl dd{margin-left:1.125em}
 288 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 289 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 290 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 291 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 292 ul.unstyled,ol.unstyled{margin-left:0}
 293 ul.checklist{margin-left:.625em}
 294 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 295 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
 296 ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
 297 ul.inline>li{margin-left:1.25em}
 298 .unstyled dl dt{font-weight:400;font-style:normal}
 299 ol.arabic{list-style-type:decimal}
 300 ol.decimal{list-style-type:decimal-leading-zero}
 301 ol.loweralpha{list-style-type:lower-alpha}
 302 ol.upperalpha{list-style-type:upper-alpha}
 303 ol.lowerroman{list-style-type:lower-roman}
 304 ol.upperroman{list-style-type:upper-roman}
 305 ol.lowergreek{list-style-type:lower-greek}
 306 .hdlist>table,.colist>table{border:0;background:none}
 307 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 308 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 309 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 310 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 311 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
 312 .colist td:not([class]):first-child img{max-width:none}
 313 .colist td:not([class]):last-child{padding:.25em 0}
 314 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
 315 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
 316 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
 317 .imageblock>.title{margin-bottom:0}
 318 .imageblock.thumb,.imageblock.th{border-width:6px}
 319 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 320 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 321 .image.left{margin-right:.625em}
 322 .image.right{margin-left:.625em}
 323 a.image{text-decoration:none;display:inline-block}
 324 a.image object{pointer-events:none}
 325 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 326 sup.footnote a,sup.footnoteref a{text-decoration:none}
 327 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 328 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 329 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 330 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
 331 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
 332 #footnotes .footnote:last-of-type{margin-bottom:0}
 333 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 334 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
 335 .gist .file-data>table td.line-data{width:99%}
 336 div.unbreakable{page-break-inside:avoid}
 337 .big{font-size:larger}
 338 .small{font-size:smaller}
 339 .underline{text-decoration:underline}
 340 .overline{text-decoration:overline}
 341 .line-through{text-decoration:line-through}
 342 .aqua{color:#00bfbf}
 343 .aqua-background{background-color:#00fafa}
 344 .black{color:#000}
 345 .black-background{background-color:#000}
 346 .blue{color:#0000bf}
 347 .blue-background{background-color:#0000fa}
 348 .fuchsia{color:#bf00bf}
 349 .fuchsia-background{background-color:#fa00fa}
 350 .gray{color:#606060}
 351 .gray-background{background-color:#7d7d7d}
 352 .green{color:#006000}
 353 .green-background{background-color:#007d00}
 354 .lime{color:#00bf00}
 355 .lime-background{background-color:#00fa00}
 356 .maroon{color:#600000}
 357 .maroon-background{background-color:#7d0000}
 358 .navy{color:#000060}
 359 .navy-background{background-color:#00007d}
 360 .olive{color:#606000}
 361 .olive-background{background-color:#7d7d00}
 362 .purple{color:#600060}
 363 .purple-background{background-color:#7d007d}
 364 .red{color:#bf0000}
 365 .red-background{background-color:#fa0000}
 366 .silver{color:#909090}
 367 .silver-background{background-color:#bcbcbc}
 368 .teal{color:#006060}
 369 .teal-background{background-color:#007d7d}
 370 .white{color:#bfbfbf}
 371 .white-background{background-color:#fafafa}
 372 .yellow{color:#bfbf00}
 373 .yellow-background{background-color:#fafa00}
 374 span.icon>.fa{cursor:default}
 375 a span.icon>.fa{cursor:inherit}
 376 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 377 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
 378 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 379 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
 380 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
 381 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
 382 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 383 .conum[data-value] *{color:#fff!important}
 384 .conum[data-value]+b{display:none}
 385 .conum[data-value]::after{content:attr(data-value)}
 386 pre .conum[data-value]{position:relative;top:-.125em}
 387 b.conum *{color:inherit!important}
 388 .conum:not([data-value]):empty{display:none}
 389 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 390 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
 391 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 392 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
 393 p{margin-bottom:1.25rem}
 394 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 395 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 396 .print-only{display:none!important}
 397 @page{margin:1.25cm .75cm}
 398 @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
 399 html{font-size:80%}
 400 a{color:inherit!important;text-decoration:underline!important}
 401 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 402 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 403 abbr[title]::after{content:" (" attr(title) ")"}
 404 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 405 thead{display:table-header-group}
 406 svg{max-width:100%}
 407 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 408 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 409 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 410 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
 411 body.book #header{text-align:center}
 412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
 413 body.book #header .details{border:0!important;display:block;padding:0!important}
 414 body.book #header .details span:first-child{margin-left:0!important}
 415 body.book #header .details br{display:block}
 416 body.book #header .details br+span::before{content:none!important}
 417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 419 .listingblock code[data-lang]::before{display:block}
 420 #footer{padding:0 .9375em}
 421 .hide-on-print{display:none!important}
 422 .print-only{display:block!important}
 423 .hide-for-print{display:none!important}
 424 .show-for-print{display:inherit!important}}
 425 @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
 426 .sect1{padding:0!important}
 427 .sect1+.sect1{border:0}
 428 #footer{background:none}
 429 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
 430 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
 431 </style>
 432 </head>
 433 <body class="book toc2 toc-left">
 434 <div id="header">
 435 <h1>Clamp Rest API</h1>
 436 <div id="toc" class="toc2">
 437 <div id="toctitle">Table of Contents</div>
 438 <ul class="sectlevel1">
 439 <li><a href="#_overview">1. Overview</a>
 440 <ul class="sectlevel2">
 441 <li><a href="#_version_information">1.1. Version information</a></li>
 442 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
 443 </ul>
 444 </li>
 445 <li><a href="#_paths">2. Paths</a>
 446 <ul class="sectlevel2">
 447 <li><a href="#_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>
 451 </ul>
 452 </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>
 457 </ul>
 458 </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>
 463 </ul>
 464 </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>
 469 </ul>
 470 </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>
 477 </ul>
 478 </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>
 483 </ul>
 484 </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>
 490 </ul>
 491 </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>
 498 </ul>
 499 </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>
 505 </ul>
 506 </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>
 512 </ul>
 513 </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>
 519 </ul>
 520 </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>
 527 </ul>
 528 </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>
 533 </ul>
 534 </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>
 540 </ul>
 541 </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>
 546 </ul>
 547 </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>
 553 </ul>
 554 </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>
 560 </ul>
 561 </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>
 567 </ul>
 568 </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>
 574 </ul>
 575 </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>
 581 </ul>
 582 </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>
 588 </ul>
 589 </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>
 595 </ul>
 596 </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>
 602 </ul>
 603 </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>
 610 </ul>
 611 </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>
 618 </ul>
 619 </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>
 626 </ul>
 627 </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>
 633 </ul>
 634 </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>
 639 </ul>
 640 </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>
 646 </ul>
 647 </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>
 653 </ul>
 654 </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>
 661 </ul>
 662 </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>
 667 </ul>
 668 </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>
 673 </ul>
 674 </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>
 680 </ul>
 681 </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>
 687 </ul>
 688 </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>
 693 </ul>
 694 </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>
 699 </ul>
 700 </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>
 706 </ul>
 707 </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>
 714 </ul>
 715 </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>
 722 </ul>
 723 </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>
 730 </ul>
 731 </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>
 738 </ul>
 739 </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>
 744 </ul>
 745 </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>
 750 </ul>
 751 </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>
 756 </ul>
 757 </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>
 762 </ul>
 763 </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>
 768 </ul>
 769 </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>
 774 </ul>
 775 </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>
 780 </ul>
 781 </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>
 788 </ul>
 789 </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>
 796 </ul>
 797 </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>
 804 </ul>
 805 </li>
 806 </ul>
 807 </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>
 831 </ul>
 832 </li>
 833 </ul>
 834 </div>
 835 </div>
 836 <div id="content">
 837 <div class="sect1">
 838 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
 839 <div class="sectionbody">
 840 <div class="sect2">
 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>
 844 </div>
 845 </div>
 846 <div class="sect2">
 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>
 852 </div>
 853 </div>
 854 </div>
 855 </div>
 856 <div class="sect1">
 857 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
 858 <div class="sectionbody">
 859 <div class="sect2">
 860 <h3 id="_verb363"><a class="anchor" href="#_verb363"></a><a class="link" href="#_verb363">2.1. GET /v1/healthcheck</a></h3>
 861 <div class="sect3">
 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">
 864 <colgroup>
 865 <col style="width: 10%;">
 866 <col style="width: 70%;">
 867 <col style="width: 20%;">
 868 </colgroup>
 869 <thead>
 870 <tr>
 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>
 874 </tr>
 875 </thead>
 876 <tbody>
 877 <tr>
 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>
 881 </tr>
 882 </tbody>
 883 </table>
 884 </div>
 885 <div class="sect3">
 886 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
 887 <div class="ulist">
 888 <ul>
 889 <li>
 890 <p><code>application/json</code></p>
 891 </li>
 892 </ul>
 893 </div>
 894 </div>
 895 </div>
 896 <div class="sect2">
 897 <h3 id="_verb364"><a class="anchor" href="#_verb364"></a><a class="link" href="#_verb364">2.2. GET /v1/user/getUser</a></h3>
 898 <div class="sect3">
 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">
 901 <colgroup>
 902 <col style="width: 33.3333%;">
 903 <col style="width: 66.6667%;">
 904 </colgroup>
 905 <thead>
 906 <tr>
 907 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 908 <th class="tableblock halign-left valign-middle">Schema</th>
 909 </tr>
 910 </thead>
 911 <tbody>
 912 <tr>
 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>
 915 </tr>
 916 </tbody>
 917 </table>
 918 </div>
 919 <div class="sect3">
 920 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
 921 <div class="ulist">
 922 <ul>
 923 <li>
 924 <p><code>text/plain</code></p>
 925 </li>
 926 </ul>
 927 </div>
 928 </div>
 929 </div>
 930 <div class="sect2">
 931 <h3 id="_verb362"><a class="anchor" href="#_verb362"></a><a class="link" href="#_verb362">2.3. GET /v2/clampInformation</a></h3>
 932 <div class="sect3">
 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">
 935 <colgroup>
 936 <col style="width: 10%;">
 937 <col style="width: 70%;">
 938 <col style="width: 20%;">
 939 </colgroup>
 940 <thead>
 941 <tr>
 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>
 945 </tr>
 946 </thead>
 947 <tbody>
 948 <tr>
 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>
 952 </tr>
 953 </tbody>
 954 </table>
 955 </div>
 956 <div class="sect3">
 957 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
 958 <div class="ulist">
 959 <ul>
 960 <li>
 961 <p><code>application/json</code></p>
 962 </li>
 963 </ul>
 964 </div>
 965 </div>
 966 </div>
 967 <div class="sect2">
 968 <h3 id="_verb333"><a class="anchor" href="#_verb333"></a><a class="link" href="#_verb333">2.4. GET /v2/dictionary</a></h3>
 969 <div class="sect3">
 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">
 972 <colgroup>
 973 <col style="width: 10%;">
 974 <col style="width: 70%;">
 975 <col style="width: 20%;">
 976 </colgroup>
 977 <thead>
 978 <tr>
 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>
 982 </tr>
 983 </thead>
 984 <tbody>
 985 <tr>
 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>
 989 </tr>
 990 </tbody>
 991 </table>
 992 </div>
 993 <div class="sect3">
 994 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.2. Produces</a></h4>
 995 <div class="ulist">
 996 <ul>
 997 <li>
 998 <p><code>application/json</code></p>
 999 </li>
1000 </ul>
1001 </div>
1002 </div>
1003 </div>
1004 <div class="sect2">
1005 <h3 id="_verb336"><a class="anchor" href="#_verb336"></a><a class="link" href="#_verb336">2.5. PUT /v2/dictionary</a></h3>
1006 <div class="sect3">
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">
1009 <colgroup>
1010 <col style="width: 22.2222%;">
1011 <col style="width: 33.3333%;">
1012 <col style="width: 44.4445%;">
1013 </colgroup>
1014 <thead>
1015 <tr>
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>
1019 </tr>
1020 </thead>
1021 <tbody>
1022 <tr>
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>
1027 </tr>
1028 </tbody>
1029 </table>
1030 </div>
1031 <div class="sect3">
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">
1034 <colgroup>
1035 <col style="width: 10%;">
1036 <col style="width: 70%;">
1037 <col style="width: 20%;">
1038 </colgroup>
1039 <thead>
1040 <tr>
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>
1044 </tr>
1045 </thead>
1046 <tbody>
1047 <tr>
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>
1051 </tr>
1052 </tbody>
1053 </table>
1054 </div>
1055 <div class="sect3">
1056 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.5.3. Consumes</a></h4>
1057 <div class="ulist">
1058 <ul>
1059 <li>
1060 <p><code>application/json</code></p>
1061 </li>
1062 </ul>
1063 </div>
1064 </div>
1065 <div class="sect3">
1066 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
1067 <div class="ulist">
1068 <ul>
1069 <li>
1070 <p><code>application/json</code></p>
1071 </li>
1072 </ul>
1073 </div>
1074 </div>
1075 </div>
1076 <div class="sect2">
1077 <h3 id="_verb334"><a class="anchor" href="#_verb334"></a><a class="link" href="#_verb334">2.6. GET /v2/dictionary/secondary/names</a></h3>
1078 <div class="sect3">
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">
1081 <colgroup>
1082 <col style="width: 10%;">
1083 <col style="width: 70%;">
1084 <col style="width: 20%;">
1085 </colgroup>
1086 <thead>
1087 <tr>
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>
1091 </tr>
1092 </thead>
1093 <tbody>
1094 <tr>
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">&lt; string &gt; array</p></td>
1098 </tr>
1099 </tbody>
1100 </table>
1101 </div>
1102 <div class="sect3">
1103 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
1104 <div class="ulist">
1105 <ul>
1106 <li>
1107 <p><code>application/json</code></p>
1108 </li>
1109 </ul>
1110 </div>
1111 </div>
1112 </div>
1113 <div class="sect2">
1114 <h3 id="_verb335"><a class="anchor" href="#_verb335"></a><a class="link" href="#_verb335">2.7. GET /v2/dictionary/{dictionaryName}</a></h3>
1115 <div class="sect3">
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">
1118 <colgroup>
1119 <col style="width: 22.2222%;">
1120 <col style="width: 33.3333%;">
1121 <col style="width: 44.4445%;">
1122 </colgroup>
1123 <thead>
1124 <tr>
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>
1128 </tr>
1129 </thead>
1130 <tbody>
1131 <tr>
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>
1136 </tr>
1137 </tbody>
1138 </table>
1139 </div>
1140 <div class="sect3">
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">
1143 <colgroup>
1144 <col style="width: 10%;">
1145 <col style="width: 70%;">
1146 <col style="width: 20%;">
1147 </colgroup>
1148 <thead>
1149 <tr>
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>
1153 </tr>
1154 </thead>
1155 <tbody>
1156 <tr>
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>
1160 </tr>
1161 </tbody>
1162 </table>
1163 </div>
1164 <div class="sect3">
1165 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1166 <div class="ulist">
1167 <ul>
1168 <li>
1169 <p><code>application/json</code></p>
1170 </li>
1171 </ul>
1172 </div>
1173 </div>
1174 </div>
1175 <div class="sect2">
1176 <h3 id="_verb337"><a class="anchor" href="#_verb337"></a><a class="link" href="#_verb337">2.8. PUT /v2/dictionary/{name}</a></h3>
1177 <div class="sect3">
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">
1180 <colgroup>
1181 <col style="width: 22.2222%;">
1182 <col style="width: 33.3333%;">
1183 <col style="width: 44.4445%;">
1184 </colgroup>
1185 <thead>
1186 <tr>
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>
1190 </tr>
1191 </thead>
1192 <tbody>
1193 <tr>
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>
1198 </tr>
1199 <tr>
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>
1204 </tr>
1205 </tbody>
1206 </table>
1207 </div>
1208 <div class="sect3">
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">
1211 <colgroup>
1212 <col style="width: 10%;">
1213 <col style="width: 70%;">
1214 <col style="width: 20%;">
1215 </colgroup>
1216 <thead>
1217 <tr>
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>
1221 </tr>
1222 </thead>
1223 <tbody>
1224 <tr>
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>
1228 </tr>
1229 </tbody>
1230 </table>
1231 </div>
1232 <div class="sect3">
1233 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.8.3. Consumes</a></h4>
1234 <div class="ulist">
1235 <ul>
1236 <li>
1237 <p><code>application/json</code></p>
1238 </li>
1239 </ul>
1240 </div>
1241 </div>
1242 <div class="sect3">
1243 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.4. Produces</a></h4>
1244 <div class="ulist">
1245 <ul>
1246 <li>
1247 <p><code>application/json</code></p>
1248 </li>
1249 </ul>
1250 </div>
1251 </div>
1252 </div>
1253 <div class="sect2">
1254 <h3 id="_verb338"><a class="anchor" href="#_verb338"></a><a class="link" href="#_verb338">2.9. DELETE /v2/dictionary/{name}</a></h3>
1255 <div class="sect3">
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">
1258 <colgroup>
1259 <col style="width: 22.2222%;">
1260 <col style="width: 33.3333%;">
1261 <col style="width: 44.4445%;">
1262 </colgroup>
1263 <thead>
1264 <tr>
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>
1268 </tr>
1269 </thead>
1270 <tbody>
1271 <tr>
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>
1276 </tr>
1277 </tbody>
1278 </table>
1279 </div>
1280 <div class="sect3">
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">
1283 <colgroup>
1284 <col style="width: 33.3333%;">
1285 <col style="width: 66.6667%;">
1286 </colgroup>
1287 <thead>
1288 <tr>
1289 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1290 <th class="tableblock halign-left valign-middle">Schema</th>
1291 </tr>
1292 </thead>
1293 <tbody>
1294 <tr>
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>
1297 </tr>
1298 </tbody>
1299 </table>
1300 </div>
1301 <div class="sect3">
1302 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1303 <div class="ulist">
1304 <ul>
1305 <li>
1306 <p><code>application/json</code></p>
1307 </li>
1308 </ul>
1309 </div>
1310 </div>
1311 </div>
1312 <div class="sect2">
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>
1314 <div class="sect3">
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">
1317 <colgroup>
1318 <col style="width: 22.2222%;">
1319 <col style="width: 33.3333%;">
1320 <col style="width: 44.4445%;">
1321 </colgroup>
1322 <thead>
1323 <tr>
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>
1327 </tr>
1328 </thead>
1329 <tbody>
1330 <tr>
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>
1335 </tr>
1336 <tr>
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>
1341 </tr>
1342 </tbody>
1343 </table>
1344 </div>
1345 <div class="sect3">
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">
1348 <colgroup>
1349 <col style="width: 33.3333%;">
1350 <col style="width: 66.6667%;">
1351 </colgroup>
1352 <thead>
1353 <tr>
1354 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1355 <th class="tableblock halign-left valign-middle">Schema</th>
1356 </tr>
1357 </thead>
1358 <tbody>
1359 <tr>
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>
1362 </tr>
1363 </tbody>
1364 </table>
1365 </div>
1366 <div class="sect3">
1367 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.3. Produces</a></h4>
1368 <div class="ulist">
1369 <ul>
1370 <li>
1371 <p><code>application/json</code></p>
1372 </li>
1373 </ul>
1374 </div>
1375 </div>
1376 </div>
1377 <div class="sect2">
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>
1379 <div class="sect3">
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">
1382 <colgroup>
1383 <col style="width: 22.2222%;">
1384 <col style="width: 33.3333%;">
1385 <col style="width: 44.4445%;">
1386 </colgroup>
1387 <thead>
1388 <tr>
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>
1392 </tr>
1393 </thead>
1394 <tbody>
1395 <tr>
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>
1400 </tr>
1401 <tr>
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>
1406 </tr>
1407 <tr>
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>
1412 </tr>
1413 </tbody>
1414 </table>
1415 </div>
1416 <div class="sect3">
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">
1419 <colgroup>
1420 <col style="width: 10%;">
1421 <col style="width: 70%;">
1422 <col style="width: 20%;">
1423 </colgroup>
1424 <thead>
1425 <tr>
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>
1429 </tr>
1430 </thead>
1431 <tbody>
1432 <tr>
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>
1436 </tr>
1437 </tbody>
1438 </table>
1439 </div>
1440 <div class="sect3">
1441 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.3. Produces</a></h4>
1442 <div class="ulist">
1443 <ul>
1444 <li>
1445 <p><code>application/json</code></p>
1446 </li>
1447 </ul>
1448 </div>
1449 </div>
1450 </div>
1451 <div class="sect2">
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>
1453 <div class="sect3">
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">
1456 <colgroup>
1457 <col style="width: 22.2222%;">
1458 <col style="width: 33.3333%;">
1459 <col style="width: 44.4445%;">
1460 </colgroup>
1461 <thead>
1462 <tr>
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>
1466 </tr>
1467 </thead>
1468 <tbody>
1469 <tr>
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>
1474 </tr>
1475 <tr>
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>
1480 </tr>
1481 </tbody>
1482 </table>
1483 </div>
1484 <div class="sect3">
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">
1487 <colgroup>
1488 <col style="width: 10%;">
1489 <col style="width: 70%;">
1490 <col style="width: 20%;">
1491 </colgroup>
1492 <thead>
1493 <tr>
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>
1497 </tr>
1498 </thead>
1499 <tbody>
1500 <tr>
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>
1504 </tr>
1505 </tbody>
1506 </table>
1507 </div>
1508 <div class="sect3">
1509 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.12.3. Consumes</a></h4>
1510 <div class="ulist">
1511 <ul>
1512 <li>
1513 <p><code>application/json</code></p>
1514 </li>
1515 </ul>
1516 </div>
1517 </div>
1518 <div class="sect3">
1519 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.4. Produces</a></h4>
1520 <div class="ulist">
1521 <ul>
1522 <li>
1523 <p><code>application/json</code></p>
1524 </li>
1525 </ul>
1526 </div>
1527 </div>
1528 </div>
1529 <div class="sect2">
1530 <h3 id="_verb325"><a class="anchor" href="#_verb325"></a><a class="link" href="#_verb325">2.13. PUT /v2/loop/delete/{loopName}</a></h3>
1531 <div class="sect3">
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">
1534 <colgroup>
1535 <col style="width: 22.2222%;">
1536 <col style="width: 33.3333%;">
1537 <col style="width: 44.4445%;">
1538 </colgroup>
1539 <thead>
1540 <tr>
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>
1544 </tr>
1545 </thead>
1546 <tbody>
1547 <tr>
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>
1552 </tr>
1553 </tbody>
1554 </table>
1555 </div>
1556 <div class="sect3">
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">
1559 <colgroup>
1560 <col style="width: 33.3333%;">
1561 <col style="width: 66.6667%;">
1562 </colgroup>
1563 <thead>
1564 <tr>
1565 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1566 <th class="tableblock halign-left valign-middle">Schema</th>
1567 </tr>
1568 </thead>
1569 <tbody>
1570 <tr>
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>
1573 </tr>
1574 </tbody>
1575 </table>
1576 </div>
1577 </div>
1578 <div class="sect2">
1579 <h3 id="_verb318"><a class="anchor" href="#_verb318"></a><a class="link" href="#_verb318">2.14. PUT /v2/loop/deploy/{loopName}</a></h3>
1580 <div class="sect3">
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">
1583 <colgroup>
1584 <col style="width: 22.2222%;">
1585 <col style="width: 33.3333%;">
1586 <col style="width: 44.4445%;">
1587 </colgroup>
1588 <thead>
1589 <tr>
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>
1593 </tr>
1594 </thead>
1595 <tbody>
1596 <tr>
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>
1601 </tr>
1602 </tbody>
1603 </table>
1604 </div>
1605 <div class="sect3">
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">
1608 <colgroup>
1609 <col style="width: 10%;">
1610 <col style="width: 70%;">
1611 <col style="width: 20%;">
1612 </colgroup>
1613 <thead>
1614 <tr>
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>
1618 </tr>
1619 </thead>
1620 <tbody>
1621 <tr>
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>
1625 </tr>
1626 </tbody>
1627 </table>
1628 </div>
1629 <div class="sect3">
1630 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.3. Produces</a></h4>
1631 <div class="ulist">
1632 <ul>
1633 <li>
1634 <p><code>application/json</code></p>
1635 </li>
1636 </ul>
1637 </div>
1638 </div>
1639 </div>
1640 <div class="sect2">
1641 <h3 id="_verb313"><a class="anchor" href="#_verb313"></a><a class="link" href="#_verb313">2.15. GET /v2/loop/getAllNames</a></h3>
1642 <div class="sect3">
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">
1645 <colgroup>
1646 <col style="width: 10%;">
1647 <col style="width: 70%;">
1648 <col style="width: 20%;">
1649 </colgroup>
1650 <thead>
1651 <tr>
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>
1655 </tr>
1656 </thead>
1657 <tbody>
1658 <tr>
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">&lt; string &gt; array</p></td>
1662 </tr>
1663 </tbody>
1664 </table>
1665 </div>
1666 <div class="sect3">
1667 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.2. Produces</a></h4>
1668 <div class="ulist">
1669 <ul>
1670 <li>
1671 <p><code>application/json</code></p>
1672 </li>
1673 </ul>
1674 </div>
1675 </div>
1676 </div>
1677 <div class="sect2">
1678 <h3 id="_verb326"><a class="anchor" href="#_verb326"></a><a class="link" href="#_verb326">2.16. GET /v2/loop/getstatus/{loopName}</a></h3>
1679 <div class="sect3">
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">
1682 <colgroup>
1683 <col style="width: 22.2222%;">
1684 <col style="width: 33.3333%;">
1685 <col style="width: 44.4445%;">
1686 </colgroup>
1687 <thead>
1688 <tr>
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>
1692 </tr>
1693 </thead>
1694 <tbody>
1695 <tr>
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>
1700 </tr>
1701 </tbody>
1702 </table>
1703 </div>
1704 <div class="sect3">
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">
1707 <colgroup>
1708 <col style="width: 10%;">
1709 <col style="width: 70%;">
1710 <col style="width: 20%;">
1711 </colgroup>
1712 <thead>
1713 <tr>
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>
1717 </tr>
1718 </thead>
1719 <tbody>
1720 <tr>
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>
1724 </tr>
1725 </tbody>
1726 </table>
1727 </div>
1728 <div class="sect3">
1729 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1730 <div class="ulist">
1731 <ul>
1732 <li>
1733 <p><code>application/json</code></p>
1734 </li>
1735 </ul>
1736 </div>
1737 </div>
1738 </div>
1739 <div class="sect2">
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>
1741 <div class="sect3">
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">
1744 <colgroup>
1745 <col style="width: 22.2222%;">
1746 <col style="width: 33.3333%;">
1747 <col style="width: 44.4445%;">
1748 </colgroup>
1749 <thead>
1750 <tr>
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>
1754 </tr>
1755 </thead>
1756 <tbody>
1757 <tr>
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>
1762 </tr>
1763 <tr>
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>
1768 </tr>
1769 </tbody>
1770 </table>
1771 </div>
1772 <div class="sect3">
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">
1775 <colgroup>
1776 <col style="width: 10%;">
1777 <col style="width: 70%;">
1778 <col style="width: 20%;">
1779 </colgroup>
1780 <thead>
1781 <tr>
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>
1785 </tr>
1786 </thead>
1787 <tbody>
1788 <tr>
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>
1792 </tr>
1793 </tbody>
1794 </table>
1795 </div>
1796 <div class="sect3">
1797 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.17.3. Produces</a></h4>
1798 <div class="ulist">
1799 <ul>
1800 <li>
1801 <p><code>application/json</code></p>
1802 </li>
1803 </ul>
1804 </div>
1805 </div>
1806 </div>
1807 <div class="sect2">
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>
1809 <div class="sect3">
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">
1812 <colgroup>
1813 <col style="width: 22.2222%;">
1814 <col style="width: 33.3333%;">
1815 <col style="width: 44.4445%;">
1816 </colgroup>
1817 <thead>
1818 <tr>
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>
1822 </tr>
1823 </thead>
1824 <tbody>
1825 <tr>
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>
1830 </tr>
1831 <tr>
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>
1836 </tr>
1837 </tbody>
1838 </table>
1839 </div>
1840 <div class="sect3">
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">
1843 <colgroup>
1844 <col style="width: 10%;">
1845 <col style="width: 70%;">
1846 <col style="width: 20%;">
1847 </colgroup>
1848 <thead>
1849 <tr>
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>
1853 </tr>
1854 </thead>
1855 <tbody>
1856 <tr>
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>
1860 </tr>
1861 </tbody>
1862 </table>
1863 </div>
1864 <div class="sect3">
1865 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.18.3. Produces</a></h4>
1866 <div class="ulist">
1867 <ul>
1868 <li>
1869 <p><code>application/json</code></p>
1870 </li>
1871 </ul>
1872 </div>
1873 </div>
1874 </div>
1875 <div class="sect2">
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>
1877 <div class="sect3">
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">
1880 <colgroup>
1881 <col style="width: 22.2222%;">
1882 <col style="width: 33.3333%;">
1883 <col style="width: 44.4445%;">
1884 </colgroup>
1885 <thead>
1886 <tr>
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>
1890 </tr>
1891 </thead>
1892 <tbody>
1893 <tr>
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>
1898 </tr>
1899 <tr>
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>
1904 </tr>
1905 <tr>
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>
1910 </tr>
1911 <tr>
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>
1916 </tr>
1917 </tbody>
1918 </table>
1919 </div>
1920 <div class="sect3">
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">
1923 <colgroup>
1924 <col style="width: 10%;">
1925 <col style="width: 70%;">
1926 <col style="width: 20%;">
1927 </colgroup>
1928 <thead>
1929 <tr>
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>
1933 </tr>
1934 </thead>
1935 <tbody>
1936 <tr>
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>
1940 </tr>
1941 </tbody>
1942 </table>
1943 </div>
1944 <div class="sect3">
1945 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.19.3. Produces</a></h4>
1946 <div class="ulist">
1947 <ul>
1948 <li>
1949 <p><code>application/json</code></p>
1950 </li>
1951 </ul>
1952 </div>
1953 </div>
1954 </div>
1955 <div class="sect2">
1956 <h3 id="_verb323"><a class="anchor" href="#_verb323"></a><a class="link" href="#_verb323">2.20. PUT /v2/loop/restart/{loopName}</a></h3>
1957 <div class="sect3">
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">
1960 <colgroup>
1961 <col style="width: 22.2222%;">
1962 <col style="width: 33.3333%;">
1963 <col style="width: 44.4445%;">
1964 </colgroup>
1965 <thead>
1966 <tr>
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>
1970 </tr>
1971 </thead>
1972 <tbody>
1973 <tr>
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>
1978 </tr>
1979 </tbody>
1980 </table>
1981 </div>
1982 <div class="sect3">
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">
1985 <colgroup>
1986 <col style="width: 10%;">
1987 <col style="width: 70%;">
1988 <col style="width: 20%;">
1989 </colgroup>
1990 <thead>
1991 <tr>
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>
1995 </tr>
1996 </thead>
1997 <tbody>
1998 <tr>
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>
2002 </tr>
2003 </tbody>
2004 </table>
2005 </div>
2006 <div class="sect3">
2007 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.20.3. Produces</a></h4>
2008 <div class="ulist">
2009 <ul>
2010 <li>
2011 <p><code>application/json</code></p>
2012 </li>
2013 </ul>
2014 </div>
2015 </div>
2016 </div>
2017 <div class="sect2">
2018 <h3 id="_verb322"><a class="anchor" href="#_verb322"></a><a class="link" href="#_verb322">2.21. PUT /v2/loop/stop/{loopName}</a></h3>
2019 <div class="sect3">
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">
2022 <colgroup>
2023 <col style="width: 22.2222%;">
2024 <col style="width: 33.3333%;">
2025 <col style="width: 44.4445%;">
2026 </colgroup>
2027 <thead>
2028 <tr>
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>
2032 </tr>
2033 </thead>
2034 <tbody>
2035 <tr>
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>
2040 </tr>
2041 </tbody>
2042 </table>
2043 </div>
2044 <div class="sect3">
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">
2047 <colgroup>
2048 <col style="width: 10%;">
2049 <col style="width: 70%;">
2050 <col style="width: 20%;">
2051 </colgroup>
2052 <thead>
2053 <tr>
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>
2057 </tr>
2058 </thead>
2059 <tbody>
2060 <tr>
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>
2064 </tr>
2065 </tbody>
2066 </table>
2067 </div>
2068 <div class="sect3">
2069 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.21.3. Produces</a></h4>
2070 <div class="ulist">
2071 <ul>
2072 <li>
2073 <p><code>application/json</code></p>
2074 </li>
2075 </ul>
2076 </div>
2077 </div>
2078 </div>
2079 <div class="sect2">
2080 <h3 id="_verb324"><a class="anchor" href="#_verb324"></a><a class="link" href="#_verb324">2.22. PUT /v2/loop/submit/{loopName}</a></h3>
2081 <div class="sect3">
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">
2084 <colgroup>
2085 <col style="width: 22.2222%;">
2086 <col style="width: 33.3333%;">
2087 <col style="width: 44.4445%;">
2088 </colgroup>
2089 <thead>
2090 <tr>
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>
2094 </tr>
2095 </thead>
2096 <tbody>
2097 <tr>
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>
2102 </tr>
2103 </tbody>
2104 </table>
2105 </div>
2106 <div class="sect3">
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">
2109 <colgroup>
2110 <col style="width: 10%;">
2111 <col style="width: 70%;">
2112 <col style="width: 20%;">
2113 </colgroup>
2114 <thead>
2115 <tr>
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>
2119 </tr>
2120 </thead>
2121 <tbody>
2122 <tr>
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>
2126 </tr>
2127 </tbody>
2128 </table>
2129 </div>
2130 <div class="sect3">
2131 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.22.3. Produces</a></h4>
2132 <div class="ulist">
2133 <ul>
2134 <li>
2135 <p><code>application/json</code></p>
2136 </li>
2137 </ul>
2138 </div>
2139 </div>
2140 </div>
2141 <div class="sect2">
2142 <h3 id="_verb321"><a class="anchor" href="#_verb321"></a><a class="link" href="#_verb321">2.23. PUT /v2/loop/undeploy/{loopName}</a></h3>
2143 <div class="sect3">
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">
2146 <colgroup>
2147 <col style="width: 22.2222%;">
2148 <col style="width: 33.3333%;">
2149 <col style="width: 44.4445%;">
2150 </colgroup>
2151 <thead>
2152 <tr>
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>
2156 </tr>
2157 </thead>
2158 <tbody>
2159 <tr>
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>
2164 </tr>
2165 </tbody>
2166 </table>
2167 </div>
2168 <div class="sect3">
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">
2171 <colgroup>
2172 <col style="width: 10%;">
2173 <col style="width: 70%;">
2174 <col style="width: 20%;">
2175 </colgroup>
2176 <thead>
2177 <tr>
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>
2181 </tr>
2182 </thead>
2183 <tbody>
2184 <tr>
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>
2188 </tr>
2189 </tbody>
2190 </table>
2191 </div>
2192 <div class="sect3">
2193 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.23.3. Produces</a></h4>
2194 <div class="ulist">
2195 <ul>
2196 <li>
2197 <p><code>application/json</code></p>
2198 </li>
2199 </ul>
2200 </div>
2201 </div>
2202 </div>
2203 <div class="sect2">
2204 <h3 id="_verb315"><a class="anchor" href="#_verb315"></a><a class="link" href="#_verb315">2.24. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
2205 <div class="sect3">
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">
2208 <colgroup>
2209 <col style="width: 22.2222%;">
2210 <col style="width: 33.3333%;">
2211 <col style="width: 44.4445%;">
2212 </colgroup>
2213 <thead>
2214 <tr>
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>
2218 </tr>
2219 </thead>
2220 <tbody>
2221 <tr>
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>
2226 </tr>
2227 <tr>
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>
2232 </tr>
2233 </tbody>
2234 </table>
2235 </div>
2236 <div class="sect3">
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">
2239 <colgroup>
2240 <col style="width: 10%;">
2241 <col style="width: 70%;">
2242 <col style="width: 20%;">
2243 </colgroup>
2244 <thead>
2245 <tr>
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>
2249 </tr>
2250 </thead>
2251 <tbody>
2252 <tr>
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>
2256 </tr>
2257 </tbody>
2258 </table>
2259 </div>
2260 <div class="sect3">
2261 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.24.3. Consumes</a></h4>
2262 <div class="ulist">
2263 <ul>
2264 <li>
2265 <p><code>application/json</code></p>
2266 </li>
2267 </ul>
2268 </div>
2269 </div>
2270 <div class="sect3">
2271 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.24.4. Produces</a></h4>
2272 <div class="ulist">
2273 <ul>
2274 <li>
2275 <p><code>application/json</code></p>
2276 </li>
2277 </ul>
2278 </div>
2279 </div>
2280 </div>
2281 <div class="sect2">
2282 <h3 id="_verb317"><a class="anchor" href="#_verb317"></a><a class="link" href="#_verb317">2.25. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
2283 <div class="sect3">
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">
2286 <colgroup>
2287 <col style="width: 22.2222%;">
2288 <col style="width: 33.3333%;">
2289 <col style="width: 44.4445%;">
2290 </colgroup>
2291 <thead>
2292 <tr>
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>
2296 </tr>
2297 </thead>
2298 <tbody>
2299 <tr>
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>
2304 </tr>
2305 <tr>
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>
2310 </tr>
2311 </tbody>
2312 </table>
2313 </div>
2314 <div class="sect3">
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">
2317 <colgroup>
2318 <col style="width: 10%;">
2319 <col style="width: 70%;">
2320 <col style="width: 20%;">
2321 </colgroup>
2322 <thead>
2323 <tr>
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>
2327 </tr>
2328 </thead>
2329 <tbody>
2330 <tr>
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>
2334 </tr>
2335 </tbody>
2336 </table>
2337 </div>
2338 <div class="sect3">
2339 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.25.3. Consumes</a></h4>
2340 <div class="ulist">
2341 <ul>
2342 <li>
2343 <p><code>application/json</code></p>
2344 </li>
2345 </ul>
2346 </div>
2347 </div>
2348 <div class="sect3">
2349 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.25.4. Produces</a></h4>
2350 <div class="ulist">
2351 <ul>
2352 <li>
2353 <p><code>application/json</code></p>
2354 </li>
2355 </ul>
2356 </div>
2357 </div>
2358 </div>
2359 <div class="sect2">
2360 <h3 id="_verb316"><a class="anchor" href="#_verb316"></a><a class="link" href="#_verb316">2.26. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
2361 <div class="sect3">
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">
2364 <colgroup>
2365 <col style="width: 22.2222%;">
2366 <col style="width: 33.3333%;">
2367 <col style="width: 44.4445%;">
2368 </colgroup>
2369 <thead>
2370 <tr>
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>
2374 </tr>
2375 </thead>
2376 <tbody>
2377 <tr>
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>
2382 </tr>
2383 <tr>
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>
2388 </tr>
2389 </tbody>
2390 </table>
2391 </div>
2392 <div class="sect3">
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">
2395 <colgroup>
2396 <col style="width: 10%;">
2397 <col style="width: 70%;">
2398 <col style="width: 20%;">
2399 </colgroup>
2400 <thead>
2401 <tr>
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>
2405 </tr>
2406 </thead>
2407 <tbody>
2408 <tr>
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>
2412 </tr>
2413 </tbody>
2414 </table>
2415 </div>
2416 <div class="sect3">
2417 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.26.3. Consumes</a></h4>
2418 <div class="ulist">
2419 <ul>
2420 <li>
2421 <p><code>application/json</code></p>
2422 </li>
2423 </ul>
2424 </div>
2425 </div>
2426 <div class="sect3">
2427 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.26.4. Produces</a></h4>
2428 <div class="ulist">
2429 <ul>
2430 <li>
2431 <p><code>application/json</code></p>
2432 </li>
2433 </ul>
2434 </div>
2435 </div>
2436 </div>
2437 <div class="sect2">
2438 <h3 id="_verb314"><a class="anchor" href="#_verb314"></a><a class="link" href="#_verb314">2.27. GET /v2/loop/{loopName}</a></h3>
2439 <div class="sect3">
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">
2442 <colgroup>
2443 <col style="width: 22.2222%;">
2444 <col style="width: 33.3333%;">
2445 <col style="width: 44.4445%;">
2446 </colgroup>
2447 <thead>
2448 <tr>
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>
2452 </tr>
2453 </thead>
2454 <tbody>
2455 <tr>
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>
2460 </tr>
2461 </tbody>
2462 </table>
2463 </div>
2464 <div class="sect3">
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">
2467 <colgroup>
2468 <col style="width: 10%;">
2469 <col style="width: 70%;">
2470 <col style="width: 20%;">
2471 </colgroup>
2472 <thead>
2473 <tr>
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>
2477 </tr>
2478 </thead>
2479 <tbody>
2480 <tr>
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>
2484 </tr>
2485 </tbody>
2486 </table>
2487 </div>
2488 <div class="sect3">
2489 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.27.3. Produces</a></h4>
2490 <div class="ulist">
2491 <ul>
2492 <li>
2493 <p><code>application/json</code></p>
2494 </li>
2495 </ul>
2496 </div>
2497 </div>
2498 </div>
2499 <div class="sect2">
2500 <h3 id="_verb343"><a class="anchor" href="#_verb343"></a><a class="link" href="#_verb343">2.28. GET /v2/policies</a></h3>
2501 <div class="sect3">
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">
2504 <colgroup>
2505 <col style="width: 10%;">
2506 <col style="width: 70%;">
2507 <col style="width: 20%;">
2508 </colgroup>
2509 <thead>
2510 <tr>
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>
2514 </tr>
2515 </thead>
2516 <tbody>
2517 <tr>
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>
2521 </tr>
2522 </tbody>
2523 </table>
2524 </div>
2525 <div class="sect3">
2526 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.28.2. Produces</a></h4>
2527 <div class="ulist">
2528 <ul>
2529 <li>
2530 <p><code>application/json</code></p>
2531 </li>
2532 </ul>
2533 </div>
2534 </div>
2535 </div>
2536 <div class="sect2">
2537 <h3 id="_verb346"><a class="anchor" href="#_verb346"></a><a class="link" href="#_verb346">2.29. PUT /v2/policies/pdpDeployment</a></h3>
2538 <div class="sect3">
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">
2541 <colgroup>
2542 <col style="width: 22.2222%;">
2543 <col style="width: 33.3333%;">
2544 <col style="width: 44.4445%;">
2545 </colgroup>
2546 <thead>
2547 <tr>
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>
2551 </tr>
2552 </thead>
2553 <tbody>
2554 <tr>
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>
2559 </tr>
2560 </tbody>
2561 </table>
2562 </div>
2563 <div class="sect3">
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">
2566 <colgroup>
2567 <col style="width: 33.3333%;">
2568 <col style="width: 66.6667%;">
2569 </colgroup>
2570 <thead>
2571 <tr>
2572 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2573 <th class="tableblock halign-left valign-middle">Schema</th>
2574 </tr>
2575 </thead>
2576 <tbody>
2577 <tr>
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>
2580 </tr>
2581 </tbody>
2582 </table>
2583 </div>
2584 <div class="sect3">
2585 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a><a class="link" href="#_consumes_7">2.29.3. Consumes</a></h4>
2586 <div class="ulist">
2587 <ul>
2588 <li>
2589 <p><code>application/json</code></p>
2590 </li>
2591 </ul>
2592 </div>
2593 </div>
2594 </div>
2595 <div class="sect2">
2596 <h3 id="_verb347"><a class="anchor" href="#_verb347"></a><a class="link" href="#_verb347">2.30. POST /v2/policies/policytype</a></h3>
2597 <div class="sect3">
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">
2600 <colgroup>
2601 <col style="width: 22.2222%;">
2602 <col style="width: 33.3333%;">
2603 <col style="width: 44.4445%;">
2604 </colgroup>
2605 <thead>
2606 <tr>
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>
2610 </tr>
2611 </thead>
2612 <tbody>
2613 <tr>
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>
2618 </tr>
2619 </tbody>
2620 </table>
2621 </div>
2622 <div class="sect3">
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">
2625 <colgroup>
2626 <col style="width: 33.3333%;">
2627 <col style="width: 66.6667%;">
2628 </colgroup>
2629 <thead>
2630 <tr>
2631 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2632 <th class="tableblock halign-left valign-middle">Schema</th>
2633 </tr>
2634 </thead>
2635 <tbody>
2636 <tr>
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>
2639 </tr>
2640 </tbody>
2641 </table>
2642 </div>
2643 <div class="sect3">
2644 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a><a class="link" href="#_consumes_8">2.30.3. Consumes</a></h4>
2645 <div class="ulist">
2646 <ul>
2647 <li>
2648 <p><code>plain/text</code></p>
2649 </li>
2650 </ul>
2651 </div>
2652 </div>
2653 </div>
2654 <div class="sect2">
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>
2656 <div class="sect3">
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">
2659 <colgroup>
2660 <col style="width: 22.2222%;">
2661 <col style="width: 33.3333%;">
2662 <col style="width: 44.4445%;">
2663 </colgroup>
2664 <thead>
2665 <tr>
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>
2669 </tr>
2670 </thead>
2671 <tbody>
2672 <tr>
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>
2677 </tr>
2678 <tr>
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>
2683 </tr>
2684 <tr>
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>
2689 </tr>
2690 <tr>
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>
2695 </tr>
2696 <tr>
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>
2701 </tr>
2702 </tbody>
2703 </table>
2704 </div>
2705 <div class="sect3">
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">
2708 <colgroup>
2709 <col style="width: 10%;">
2710 <col style="width: 70%;">
2711 <col style="width: 20%;">
2712 </colgroup>
2713 <thead>
2714 <tr>
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>
2718 </tr>
2719 </thead>
2720 <tbody>
2721 <tr>
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>
2725 </tr>
2726 </tbody>
2727 </table>
2728 </div>
2729 <div class="sect3">
2730 <h4 id="_consumes_9"><a class="anchor" href="#_consumes_9"></a><a class="link" href="#_consumes_9">2.31.3. Consumes</a></h4>
2731 <div class="ulist">
2732 <ul>
2733 <li>
2734 <p><code>application/json</code></p>
2735 </li>
2736 </ul>
2737 </div>
2738 </div>
2739 <div class="sect3">
2740 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.31.4. Produces</a></h4>
2741 <div class="ulist">
2742 <ul>
2743 <li>
2744 <p><code>application/json</code></p>
2745 </li>
2746 </ul>
2747 </div>
2748 </div>
2749 </div>
2750 <div class="sect2">
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>
2752 <div class="sect3">
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">
2755 <colgroup>
2756 <col style="width: 22.2222%;">
2757 <col style="width: 33.3333%;">
2758 <col style="width: 44.4445%;">
2759 </colgroup>
2760 <thead>
2761 <tr>
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>
2765 </tr>
2766 </thead>
2767 <tbody>
2768 <tr>
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>
2773 </tr>
2774 <tr>
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>
2779 </tr>
2780 <tr>
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>
2785 </tr>
2786 <tr>
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>
2791 </tr>
2792 </tbody>
2793 </table>
2794 </div>
2795 <div class="sect3">
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">
2798 <colgroup>
2799 <col style="width: 33.3333%;">
2800 <col style="width: 66.6667%;">
2801 </colgroup>
2802 <thead>
2803 <tr>
2804 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2805 <th class="tableblock halign-left valign-middle">Schema</th>
2806 </tr>
2807 </thead>
2808 <tbody>
2809 <tr>
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>
2812 </tr>
2813 </tbody>
2814 </table>
2815 </div>
2816 </div>
2817 <div class="sect2">
2818 <h3 id="_verb340"><a class="anchor" href="#_verb340"></a><a class="link" href="#_verb340">2.33. GET /v2/policyToscaModels</a></h3>
2819 <div class="sect3">
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">
2822 <colgroup>
2823 <col style="width: 10%;">
2824 <col style="width: 70%;">
2825 <col style="width: 20%;">
2826 </colgroup>
2827 <thead>
2828 <tr>
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>
2832 </tr>
2833 </thead>
2834 <tbody>
2835 <tr>
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>
2839 </tr>
2840 </tbody>
2841 </table>
2842 </div>
2843 <div class="sect3">
2844 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.33.2. Produces</a></h4>
2845 <div class="ulist">
2846 <ul>
2847 <li>
2848 <p><code>application/json</code></p>
2849 </li>
2850 </ul>
2851 </div>
2852 </div>
2853 </div>
2854 <div class="sect2">
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>
2856 <div class="sect3">
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">
2859 <colgroup>
2860 <col style="width: 22.2222%;">
2861 <col style="width: 33.3333%;">
2862 <col style="width: 44.4445%;">
2863 </colgroup>
2864 <thead>
2865 <tr>
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>
2869 </tr>
2870 </thead>
2871 <tbody>
2872 <tr>
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>
2877 </tr>
2878 <tr>
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>
2883 </tr>
2884 </tbody>
2885 </table>
2886 </div>
2887 <div class="sect3">
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">
2890 <colgroup>
2891 <col style="width: 10%;">
2892 <col style="width: 70%;">
2893 <col style="width: 20%;">
2894 </colgroup>
2895 <thead>
2896 <tr>
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>
2900 </tr>
2901 </thead>
2902 <tbody>
2903 <tr>
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>
2907 </tr>
2908 </tbody>
2909 </table>
2910 </div>
2911 <div class="sect3">
2912 <h4 id="_produces_30"><a class="anchor" href="#_produces_30"></a><a class="link" href="#_produces_30">2.34.3. Produces</a></h4>
2913 <div class="ulist">
2914 <ul>
2915 <li>
2916 <p><code>application/json</code></p>
2917 </li>
2918 </ul>
2919 </div>
2920 </div>
2921 </div>
2922 <div class="sect2">
2923 <h3 id="_verb341"><a class="anchor" href="#_verb341"></a><a class="link" href="#_verb341">2.35. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}</a></h3>
2924 <div class="sect3">
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">
2927 <colgroup>
2928 <col style="width: 22.2222%;">
2929 <col style="width: 33.3333%;">
2930 <col style="width: 44.4445%;">
2931 </colgroup>
2932 <thead>
2933 <tr>
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>
2937 </tr>
2938 </thead>
2939 <tbody>
2940 <tr>
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>
2945 </tr>
2946 <tr>
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>
2951 </tr>
2952 </tbody>
2953 </table>
2954 </div>
2955 <div class="sect3">
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">
2958 <colgroup>
2959 <col style="width: 10%;">
2960 <col style="width: 70%;">
2961 <col style="width: 20%;">
2962 </colgroup>
2963 <thead>
2964 <tr>
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>
2968 </tr>
2969 </thead>
2970 <tbody>
2971 <tr>
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>
2975 </tr>
2976 </tbody>
2977 </table>
2978 </div>
2979 <div class="sect3">
2980 <h4 id="_produces_31"><a class="anchor" href="#_produces_31"></a><a class="link" href="#_produces_31">2.35.3. Produces</a></h4>
2981 <div class="ulist">
2982 <ul>
2983 <li>
2984 <p><code>application/json</code></p>
2985 </li>
2986 </ul>
2987 </div>
2988 </div>
2989 </div>
2990 <div class="sect2">
2991 <h3 id="_verb330"><a class="anchor" href="#_verb330"></a><a class="link" href="#_verb330">2.36. GET /v2/templates</a></h3>
2992 <div class="sect3">
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">
2995 <colgroup>
2996 <col style="width: 10%;">
2997 <col style="width: 70%;">
2998 <col style="width: 20%;">
2999 </colgroup>
3000 <thead>
3001 <tr>
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>
3005 </tr>
3006 </thead>
3007 <tbody>
3008 <tr>
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>
3012 </tr>
3013 </tbody>
3014 </table>
3015 </div>
3016 <div class="sect3">
3017 <h4 id="_produces_32"><a class="anchor" href="#_produces_32"></a><a class="link" href="#_produces_32">2.36.2. Produces</a></h4>
3018 <div class="ulist">
3019 <ul>
3020 <li>
3021 <p><code>application/json</code></p>
3022 </li>
3023 </ul>
3024 </div>
3025 </div>
3026 </div>
3027 <div class="sect2">
3028 <h3 id="_verb332"><a class="anchor" href="#_verb332"></a><a class="link" href="#_verb332">2.37. GET /v2/templates/names</a></h3>
3029 <div class="sect3">
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">
3032 <colgroup>
3033 <col style="width: 10%;">
3034 <col style="width: 70%;">
3035 <col style="width: 20%;">
3036 </colgroup>
3037 <thead>
3038 <tr>
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>
3042 </tr>
3043 </thead>
3044 <tbody>
3045 <tr>
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">&lt; string &gt; array</p></td>
3049 </tr>
3050 </tbody>
3051 </table>
3052 </div>
3053 <div class="sect3">
3054 <h4 id="_produces_33"><a class="anchor" href="#_produces_33"></a><a class="link" href="#_produces_33">2.37.2. Produces</a></h4>
3055 <div class="ulist">
3056 <ul>
3057 <li>
3058 <p><code>application/json</code></p>
3059 </li>
3060 </ul>
3061 </div>
3062 </div>
3063 </div>
3064 <div class="sect2">
3065 <h3 id="_verb331"><a class="anchor" href="#_verb331"></a><a class="link" href="#_verb331">2.38. GET /v2/templates/{templateName}</a></h3>
3066 <div class="sect3">
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">
3069 <colgroup>
3070 <col style="width: 22.2222%;">
3071 <col style="width: 33.3333%;">
3072 <col style="width: 44.4445%;">
3073 </colgroup>
3074 <thead>
3075 <tr>
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>
3079 </tr>
3080 </thead>
3081 <tbody>
3082 <tr>
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>
3087 </tr>
3088 </tbody>
3089 </table>
3090 </div>
3091 <div class="sect3">
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">
3094 <colgroup>
3095 <col style="width: 10%;">
3096 <col style="width: 70%;">
3097 <col style="width: 20%;">
3098 </colgroup>
3099 <thead>
3100 <tr>
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>
3104 </tr>
3105 </thead>
3106 <tbody>
3107 <tr>
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>
3111 </tr>
3112 </tbody>
3113 </table>
3114 </div>
3115 <div class="sect3">
3116 <h4 id="_produces_34"><a class="anchor" href="#_produces_34"></a><a class="link" href="#_produces_34">2.38.3. Produces</a></h4>
3117 <div class="ulist">
3118 <ul>
3119 <li>
3120 <p><code>application/json</code></p>
3121 </li>
3122 </ul>
3123 </div>
3124 </div>
3125 </div>
3126 <div class="sect2">
3127 <h3 id="_verb349"><a class="anchor" href="#_verb349"></a><a class="link" href="#_verb349">2.39. POST /v2/toscaControlLoop/commissionToscaTemplate</a></h3>
3128 <div class="sect3">
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">
3131 <colgroup>
3132 <col style="width: 22.2222%;">
3133 <col style="width: 33.3333%;">
3134 <col style="width: 44.4445%;">
3135 </colgroup>
3136 <thead>
3137 <tr>
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>
3141 </tr>
3142 </thead>
3143 <tbody>
3144 <tr>
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>
3149 </tr>
3150 </tbody>
3151 </table>
3152 </div>
3153 <div class="sect3">
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">
3156 <colgroup>
3157 <col style="width: 10%;">
3158 <col style="width: 70%;">
3159 <col style="width: 20%;">
3160 </colgroup>
3161 <thead>
3162 <tr>
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>
3166 </tr>
3167 </thead>
3168 <tbody>
3169 <tr>
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>
3173 </tr>
3174 </tbody>
3175 </table>
3176 </div>
3177 <div class="sect3">
3178 <h4 id="_consumes_10"><a class="anchor" href="#_consumes_10"></a><a class="link" href="#_consumes_10">2.39.3. Consumes</a></h4>
3179 <div class="ulist">
3180 <ul>
3181 <li>
3182 <p><code>plain/text</code></p>
3183 </li>
3184 </ul>
3185 </div>
3186 </div>
3187 <div class="sect3">
3188 <h4 id="_produces_35"><a class="anchor" href="#_produces_35"></a><a class="link" href="#_produces_35">2.39.4. Produces</a></h4>
3189 <div class="ulist">
3190 <ul>
3191 <li>
3192 <p><code>application/json</code></p>
3193 </li>
3194 </ul>
3195 </div>
3196 </div>
3197 </div>
3198 <div class="sect2">
3199 <h3 id="_verb350"><a class="anchor" href="#_verb350"></a><a class="link" href="#_verb350">2.40. DELETE /v2/toscaControlLoop/decommissionToscaTemplate</a></h3>
3200 <div class="sect3">
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">
3203 <colgroup>
3204 <col style="width: 22.2222%;">
3205 <col style="width: 33.3333%;">
3206 <col style="width: 44.4445%;">
3207 </colgroup>
3208 <thead>
3209 <tr>
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>
3213 </tr>
3214 </thead>
3215 <tbody>
3216 <tr>
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>
3221 </tr>
3222 </tbody>
3223 </table>
3224 </div>
3225 <div class="sect3">
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">
3228 <colgroup>
3229 <col style="width: 10%;">
3230 <col style="width: 70%;">
3231 <col style="width: 20%;">
3232 </colgroup>
3233 <thead>
3234 <tr>
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>
3238 </tr>
3239 </thead>
3240 <tbody>
3241 <tr>
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>
3245 </tr>
3246 </tbody>
3247 </table>
3248 </div>
3249 <div class="sect3">
3250 <h4 id="_consumes_11"><a class="anchor" href="#_consumes_11"></a><a class="link" href="#_consumes_11">2.40.3. Consumes</a></h4>
3251 <div class="ulist">
3252 <ul>
3253 <li>
3254 <p><code>plain/text</code></p>
3255 </li>
3256 </ul>
3257 </div>
3258 </div>
3259 <div class="sect3">
3260 <h4 id="_produces_36"><a class="anchor" href="#_produces_36"></a><a class="link" href="#_produces_36">2.40.4. Produces</a></h4>
3261 <div class="ulist">
3262 <ul>
3263 <li>
3264 <p><code>application/json</code></p>
3265 </li>
3266 </ul>
3267 </div>
3268 </div>
3269 </div>
3270 <div class="sect2">
3271 <h3 id="_verb358"><a class="anchor" href="#_verb358"></a><a class="link" href="#_verb358">2.41. DELETE /v2/toscaControlLoop/deleteToscaInstanceProperties</a></h3>
3272 <div class="sect3">
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">
3275 <colgroup>
3276 <col style="width: 22.2222%;">
3277 <col style="width: 33.3333%;">
3278 <col style="width: 44.4445%;">
3279 </colgroup>
3280 <thead>
3281 <tr>
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>
3285 </tr>
3286 </thead>
3287 <tbody>
3288 <tr>
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>
3293 </tr>
3294 </tbody>
3295 </table>
3296 </div>
3297 <div class="sect3">
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">
3300 <colgroup>
3301 <col style="width: 10%;">
3302 <col style="width: 70%;">
3303 <col style="width: 20%;">
3304 </colgroup>
3305 <thead>
3306 <tr>
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>
3310 </tr>
3311 </thead>
3312 <tbody>
3313 <tr>
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>
3317 </tr>
3318 </tbody>
3319 </table>
3320 </div>
3321 <div class="sect3">
3322 <h4 id="_consumes_12"><a class="anchor" href="#_consumes_12"></a><a class="link" href="#_consumes_12">2.41.3. Consumes</a></h4>
3323 <div class="ulist">
3324 <ul>
3325 <li>
3326 <p><code>plain/text</code></p>
3327 </li>
3328 </ul>
3329 </div>
3330 </div>
3331 <div class="sect3">
3332 <h4 id="_produces_37"><a class="anchor" href="#_produces_37"></a><a class="link" href="#_produces_37">2.41.4. Produces</a></h4>
3333 <div class="ulist">
3334 <ul>
3335 <li>
3336 <p><code>application/json</code></p>
3337 </li>
3338 </ul>
3339 </div>
3340 </div>
3341 </div>
3342 <div class="sect2">
3343 <h3 id="_verb351"><a class="anchor" href="#_verb351"></a><a class="link" href="#_verb351">2.42. DELETE /v2/toscaControlLoop/deleteToscaInstantiation</a></h3>
3344 <div class="sect3">
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">
3347 <colgroup>
3348 <col style="width: 22.2222%;">
3349 <col style="width: 33.3333%;">
3350 <col style="width: 44.4445%;">
3351 </colgroup>
3352 <thead>
3353 <tr>
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>
3357 </tr>
3358 </thead>
3359 <tbody>
3360 <tr>
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>
3365 </tr>
3366 </tbody>
3367 </table>
3368 </div>
3369 <div class="sect3">
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">
3372 <colgroup>
3373 <col style="width: 10%;">
3374 <col style="width: 70%;">
3375 <col style="width: 20%;">
3376 </colgroup>
3377 <thead>
3378 <tr>
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>
3382 </tr>
3383 </thead>
3384 <tbody>
3385 <tr>
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>
3389 </tr>
3390 </tbody>
3391 </table>
3392 </div>
3393 <div class="sect3">
3394 <h4 id="_consumes_13"><a class="anchor" href="#_consumes_13"></a><a class="link" href="#_consumes_13">2.42.3. Consumes</a></h4>
3395 <div class="ulist">
3396 <ul>
3397 <li>
3398 <p><code>plain/text</code></p>
3399 </li>
3400 </ul>
3401 </div>
3402 </div>
3403 <div class="sect3">
3404 <h4 id="_produces_38"><a class="anchor" href="#_produces_38"></a><a class="link" href="#_produces_38">2.42.4. Produces</a></h4>
3405 <div class="ulist">
3406 <ul>
3407 <li>
3408 <p><code>application/json</code></p>
3409 </li>
3410 </ul>
3411 </div>
3412 </div>
3413 </div>
3414 <div class="sect2">
3415 <h3 id="_verb359"><a class="anchor" href="#_verb359"></a><a class="link" href="#_verb359">2.43. GET /v2/toscaControlLoop/getCommonOrInstanceProperties</a></h3>
3416 <div class="sect3">
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">
3419 <colgroup>
3420 <col style="width: 10%;">
3421 <col style="width: 70%;">
3422 <col style="width: 20%;">
3423 </colgroup>
3424 <thead>
3425 <tr>
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>
3429 </tr>
3430 </thead>
3431 <tbody>
3432 <tr>
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>
3436 </tr>
3437 </tbody>
3438 </table>
3439 </div>
3440 <div class="sect3">
3441 <h4 id="_produces_39"><a class="anchor" href="#_produces_39"></a><a class="link" href="#_produces_39">2.43.2. Produces</a></h4>
3442 <div class="ulist">
3443 <ul>
3444 <li>
3445 <p><code>application/json</code></p>
3446 </li>
3447 </ul>
3448 </div>
3449 </div>
3450 </div>
3451 <div class="sect2">
3452 <h3 id="_verb356"><a class="anchor" href="#_verb356"></a><a class="link" href="#_verb356">2.44. GET /v2/toscaControlLoop/getControlLoopDefinitions</a></h3>
3453 <div class="sect3">
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">
3456 <colgroup>
3457 <col style="width: 10%;">
3458 <col style="width: 70%;">
3459 <col style="width: 20%;">
3460 </colgroup>
3461 <thead>
3462 <tr>
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>
3466 </tr>
3467 </thead>
3468 <tbody>
3469 <tr>
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>
3473 </tr>
3474 </tbody>
3475 </table>
3476 </div>
3477 <div class="sect3">
3478 <h4 id="_produces_40"><a class="anchor" href="#_produces_40"></a><a class="link" href="#_produces_40">2.44.2. Produces</a></h4>
3479 <div class="ulist">
3480 <ul>
3481 <li>
3482 <p><code>application/json</code></p>
3483 </li>
3484 </ul>
3485 </div>
3486 </div>
3487 </div>
3488 <div class="sect2">
3489 <h3 id="_verb355"><a class="anchor" href="#_verb355"></a><a class="link" href="#_verb355">2.45. GET /v2/toscaControlLoop/getElementDefinitions</a></h3>
3490 <div class="sect3">
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">
3493 <colgroup>
3494 <col style="width: 10%;">
3495 <col style="width: 70%;">
3496 <col style="width: 20%;">
3497 </colgroup>
3498 <thead>
3499 <tr>
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>
3503 </tr>
3504 </thead>
3505 <tbody>
3506 <tr>
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>
3510 </tr>
3511 </tbody>
3512 </table>
3513 </div>
3514 <div class="sect3">
3515 <h4 id="_produces_41"><a class="anchor" href="#_produces_41"></a><a class="link" href="#_produces_41">2.45.2. Produces</a></h4>
3516 <div class="ulist">
3517 <ul>
3518 <li>
3519 <p><code>application/json</code></p>
3520 </li>
3521 </ul>
3522 </div>
3523 </div>
3524 </div>
3525 <div class="sect2">
3526 <h3 id="_verb353"><a class="anchor" href="#_verb353"></a><a class="link" href="#_verb353">2.46. GET /v2/toscaControlLoop/getInstantiationOrderState</a></h3>
3527 <div class="sect3">
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">
3530 <colgroup>
3531 <col style="width: 10%;">
3532 <col style="width: 70%;">
3533 <col style="width: 20%;">
3534 </colgroup>
3535 <thead>
3536 <tr>
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>
3540 </tr>
3541 </thead>
3542 <tbody>
3543 <tr>
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>
3547 </tr>
3548 </tbody>
3549 </table>
3550 </div>
3551 <div class="sect3">
3552 <h4 id="_produces_42"><a class="anchor" href="#_produces_42"></a><a class="link" href="#_produces_42">2.46.2. Produces</a></h4>
3553 <div class="ulist">
3554 <ul>
3555 <li>
3556 <p><code>application/json</code></p>
3557 </li>
3558 </ul>
3559 </div>
3560 </div>
3561 </div>
3562 <div class="sect2">
3563 <h3 id="_verb354"><a class="anchor" href="#_verb354"></a><a class="link" href="#_verb354">2.47. GET /v2/toscaControlLoop/getJsonSchema</a></h3>
3564 <div class="sect3">
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">
3567 <colgroup>
3568 <col style="width: 10%;">
3569 <col style="width: 70%;">
3570 <col style="width: 20%;">
3571 </colgroup>
3572 <thead>
3573 <tr>
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>
3577 </tr>
3578 </thead>
3579 <tbody>
3580 <tr>
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>
3584 </tr>
3585 </tbody>
3586 </table>
3587 </div>
3588 <div class="sect3">
3589 <h4 id="_produces_43"><a class="anchor" href="#_produces_43"></a><a class="link" href="#_produces_43">2.47.2. Produces</a></h4>
3590 <div class="ulist">
3591 <ul>
3592 <li>
3593 <p><code>application/json</code></p>
3594 </li>
3595 </ul>
3596 </div>
3597 </div>
3598 </div>
3599 <div class="sect2">
3600 <h3 id="_verb352"><a class="anchor" href="#_verb352"></a><a class="link" href="#_verb352">2.48. GET /v2/toscaControlLoop/getToscaInstantiation</a></h3>
3601 <div class="sect3">
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">
3604 <colgroup>
3605 <col style="width: 10%;">
3606 <col style="width: 70%;">
3607 <col style="width: 20%;">
3608 </colgroup>
3609 <thead>
3610 <tr>
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>
3614 </tr>
3615 </thead>
3616 <tbody>
3617 <tr>
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>
3621 </tr>
3622 </tbody>
3623 </table>
3624 </div>
3625 <div class="sect3">
3626 <h4 id="_produces_44"><a class="anchor" href="#_produces_44"></a><a class="link" href="#_produces_44">2.48.2. Produces</a></h4>
3627 <div class="ulist">
3628 <ul>
3629 <li>
3630 <p><code>application/json</code></p>
3631 </li>
3632 </ul>
3633 </div>
3634 </div>
3635 </div>
3636 <div class="sect2">
3637 <h3 id="_verb348"><a class="anchor" href="#_verb348"></a><a class="link" href="#_verb348">2.49. GET /v2/toscaControlLoop/getToscaTemplate</a></h3>
3638 <div class="sect3">
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">
3641 <colgroup>
3642 <col style="width: 10%;">
3643 <col style="width: 70%;">
3644 <col style="width: 20%;">
3645 </colgroup>
3646 <thead>
3647 <tr>
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>
3651 </tr>
3652 </thead>
3653 <tbody>
3654 <tr>
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>
3658 </tr>
3659 </tbody>
3660 </table>
3661 </div>
3662 <div class="sect3">
3663 <h4 id="_produces_45"><a class="anchor" href="#_produces_45"></a><a class="link" href="#_produces_45">2.49.2. Produces</a></h4>
3664 <div class="ulist">
3665 <ul>
3666 <li>
3667 <p><code>application/json</code></p>
3668 </li>
3669 </ul>
3670 </div>
3671 </div>
3672 </div>
3673 <div class="sect2">
3674 <h3 id="_verb357"><a class="anchor" href="#_verb357"></a><a class="link" href="#_verb357">2.50. POST /v2/toscaControlLoop/postToscaInstanceProperties</a></h3>
3675 <div class="sect3">
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">
3678 <colgroup>
3679 <col style="width: 22.2222%;">
3680 <col style="width: 33.3333%;">
3681 <col style="width: 44.4445%;">
3682 </colgroup>
3683 <thead>
3684 <tr>
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>
3688 </tr>
3689 </thead>
3690 <tbody>
3691 <tr>
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>
3696 </tr>
3697 </tbody>
3698 </table>
3699 </div>
3700 <div class="sect3">
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">
3703 <colgroup>
3704 <col style="width: 10%;">
3705 <col style="width: 70%;">
3706 <col style="width: 20%;">
3707 </colgroup>
3708 <thead>
3709 <tr>
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>
3713 </tr>
3714 </thead>
3715 <tbody>
3716 <tr>
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>
3720 </tr>
3721 </tbody>
3722 </table>
3723 </div>
3724 <div class="sect3">
3725 <h4 id="_consumes_14"><a class="anchor" href="#_consumes_14"></a><a class="link" href="#_consumes_14">2.50.3. Consumes</a></h4>
3726 <div class="ulist">
3727 <ul>
3728 <li>
3729 <p><code>plain/text</code></p>
3730 </li>
3731 </ul>
3732 </div>
3733 </div>
3734 <div class="sect3">
3735 <h4 id="_produces_46"><a class="anchor" href="#_produces_46"></a><a class="link" href="#_produces_46">2.50.4. Produces</a></h4>
3736 <div class="ulist">
3737 <ul>
3738 <li>
3739 <p><code>application/json</code></p>
3740 </li>
3741 </ul>
3742 </div>
3743 </div>
3744 </div>
3745 <div class="sect2">
3746 <h3 id="_verb360"><a class="anchor" href="#_verb360"></a><a class="link" href="#_verb360">2.51. POST /v2/toscaControlLoop/postToscaInstantiation</a></h3>
3747 <div class="sect3">
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">
3750 <colgroup>
3751 <col style="width: 22.2222%;">
3752 <col style="width: 33.3333%;">
3753 <col style="width: 44.4445%;">
3754 </colgroup>
3755 <thead>
3756 <tr>
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>
3760 </tr>
3761 </thead>
3762 <tbody>
3763 <tr>
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>
3768 </tr>
3769 </tbody>
3770 </table>
3771 </div>
3772 <div class="sect3">
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">
3775 <colgroup>
3776 <col style="width: 10%;">
3777 <col style="width: 70%;">
3778 <col style="width: 20%;">
3779 </colgroup>
3780 <thead>
3781 <tr>
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>
3785 </tr>
3786 </thead>
3787 <tbody>
3788 <tr>
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>
3792 </tr>
3793 </tbody>
3794 </table>
3795 </div>
3796 <div class="sect3">
3797 <h4 id="_consumes_15"><a class="anchor" href="#_consumes_15"></a><a class="link" href="#_consumes_15">2.51.3. Consumes</a></h4>
3798 <div class="ulist">
3799 <ul>
3800 <li>
3801 <p><code>plain/text</code></p>
3802 </li>
3803 </ul>
3804 </div>
3805 </div>
3806 <div class="sect3">
3807 <h4 id="_produces_47"><a class="anchor" href="#_produces_47"></a><a class="link" href="#_produces_47">2.51.4. Produces</a></h4>
3808 <div class="ulist">
3809 <ul>
3810 <li>
3811 <p><code>application/json</code></p>
3812 </li>
3813 </ul>
3814 </div>
3815 </div>
3816 </div>
3817 <div class="sect2">
3818 <h3 id="_verb361"><a class="anchor" href="#_verb361"></a><a class="link" href="#_verb361">2.52. PUT /v2/toscaControlLoop/putToscaInstantiationStateChange</a></h3>
3819 <div class="sect3">
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">
3822 <colgroup>
3823 <col style="width: 22.2222%;">
3824 <col style="width: 33.3333%;">
3825 <col style="width: 44.4445%;">
3826 </colgroup>
3827 <thead>
3828 <tr>
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>
3832 </tr>
3833 </thead>
3834 <tbody>
3835 <tr>
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>
3840 </tr>
3841 </tbody>
3842 </table>
3843 </div>
3844 <div class="sect3">
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">
3847 <colgroup>
3848 <col style="width: 10%;">
3849 <col style="width: 70%;">
3850 <col style="width: 20%;">
3851 </colgroup>
3852 <thead>
3853 <tr>
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>
3857 </tr>
3858 </thead>
3859 <tbody>
3860 <tr>
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>
3864 </tr>
3865 </tbody>
3866 </table>
3867 </div>
3868 <div class="sect3">
3869 <h4 id="_consumes_16"><a class="anchor" href="#_consumes_16"></a><a class="link" href="#_consumes_16">2.52.3. Consumes</a></h4>
3870 <div class="ulist">
3871 <ul>
3872 <li>
3873 <p><code>plain/text</code></p>
3874 </li>
3875 </ul>
3876 </div>
3877 </div>
3878 <div class="sect3">
3879 <h4 id="_produces_48"><a class="anchor" href="#_produces_48"></a><a class="link" href="#_produces_48">2.52.4. Produces</a></h4>
3880 <div class="ulist">
3881 <ul>
3882 <li>
3883 <p><code>application/json</code></p>
3884 </li>
3885 </ul>
3886 </div>
3887 </div>
3888 </div>
3889 </div>
3890 </div>
3891 <div class="sect1">
3892 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
3893 <div class="sectionbody">
3894 <div class="sect2">
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">
3897 <colgroup>
3898 <col style="width: 42.8571%;">
3899 <col style="width: 57.1429%;">
3900 </colgroup>
3901 <thead>
3902 <tr>
3903 <th class="tableblock halign-left valign-middle">Name</th>
3904 <th class="tableblock halign-left valign-middle">Schema</th>
3905 </tr>
3906 </thead>
3907 <tbody>
3908 <tr>
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">&lt; string &gt; array</p></td>
3912 </tr>
3913 <tr>
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>
3917 </tr>
3918 <tr>
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>
3922 </tr>
3923 </tbody>
3924 </table>
3925 </div>
3926 <div class="sect2">
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">
3929 <colgroup>
3930 <col style="width: 42.8571%;">
3931 <col style="width: 57.1429%;">
3932 </colgroup>
3933 <thead>
3934 <tr>
3935 <th class="tableblock halign-left valign-middle">Name</th>
3936 <th class="tableblock halign-left valign-middle">Schema</th>
3937 </tr>
3938 </thead>
3939 <tbody>
3940 <tr>
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>
3944 </tr>
3945 <tr>
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>
3949 </tr>
3950 <tr>
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>
3954 </tr>
3955 </tbody>
3956 </table>
3957 </div>
3958 <div class="sect2">
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">
3961 <colgroup>
3962 <col style="width: 42.8571%;">
3963 <col style="width: 57.1429%;">
3964 </colgroup>
3965 <thead>
3966 <tr>
3967 <th class="tableblock halign-left valign-middle">Name</th>
3968 <th class="tableblock halign-left valign-middle">Schema</th>
3969 </tr>
3970 </thead>
3971 <tbody>
3972 <tr>
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>
3976 </tr>
3977 <tr>
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>
3981 </tr>
3982 <tr>
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">&lt; <a href="#_dictionaryelement">DictionaryElement</a> &gt; array</p></td>
3986 </tr>
3987 <tr>
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>
3991 </tr>
3992 <tr>
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>
3996 </tr>
3997 <tr>
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>
4001 </tr>
4002 <tr>
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>
4006 </tr>
4007 <tr>
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>
4011 </tr>
4012 </tbody>
4013 </table>
4014 </div>
4015 <div class="sect2">
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">
4018 <colgroup>
4019 <col style="width: 42.8571%;">
4020 <col style="width: 57.1429%;">
4021 </colgroup>
4022 <thead>
4023 <tr>
4024 <th class="tableblock halign-left valign-middle">Name</th>
4025 <th class="tableblock halign-left valign-middle">Schema</th>
4026 </tr>
4027 </thead>
4028 <tbody>
4029 <tr>
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>
4033 </tr>
4034 <tr>
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>
4038 </tr>
4039 <tr>
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>
4043 </tr>
4044 <tr>
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>
4048 </tr>
4049 <tr>
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>
4053 </tr>
4054 <tr>
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>
4058 </tr>
4059 <tr>
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>
4063 </tr>
4064 <tr>
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>
4068 </tr>
4069 <tr>
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>
4073 </tr>
4074 <tr>
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">&lt; <a href="#_dictionary">Dictionary</a> &gt; array</p></td>
4078 </tr>
4079 </tbody>
4080 </table>
4081 </div>
4082 <div class="sect2">
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">
4085 <colgroup>
4086 <col style="width: 42.8571%;">
4087 <col style="width: 57.1429%;">
4088 </colgroup>
4089 <thead>
4090 <tr>
4091 <th class="tableblock halign-left valign-middle">Name</th>
4092 <th class="tableblock halign-left valign-middle">Schema</th>
4093 </tr>
4094 </thead>
4095 <tbody>
4096 <tr>
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>
4100 </tr>
4101 <tr>
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>
4105 </tr>
4106 </tbody>
4107 </table>
4108 </div>
4109 <div class="sect2">
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">
4112 <colgroup>
4113 <col style="width: 42.8571%;">
4114 <col style="width: 57.1429%;">
4115 </colgroup>
4116 <thead>
4117 <tr>
4118 <th class="tableblock halign-left valign-middle">Name</th>
4119 <th class="tableblock halign-left valign-middle">Schema</th>
4120 </tr>
4121 </thead>
4122 <tbody>
4123 <tr>
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>
4127 </tr>
4128 <tr>
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>
4132 </tr>
4133 <tr>
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>
4137 </tr>
4138 </tbody>
4139 </table>
4140 </div>
4141 <div class="sect2">
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">
4144 <colgroup>
4145 <col style="width: 42.8571%;">
4146 <col style="width: 57.1429%;">
4147 </colgroup>
4148 <thead>
4149 <tr>
4150 <th class="tableblock halign-left valign-middle">Name</th>
4151 <th class="tableblock halign-left valign-middle">Schema</th>
4152 </tr>
4153 </thead>
4154 <tbody>
4155 <tr>
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>
4159 </tr>
4160 <tr>
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>
4164 </tr>
4165 <tr>
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>
4169 </tr>
4170 <tr>
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>
4174 </tr>
4175 <tr>
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>
4179 </tr>
4180 <tr>
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>
4184 </tr>
4185 <tr>
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>
4189 </tr>
4190 <tr>
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>
4194 </tr>
4195 <tr>
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>
4199 </tr>
4200 <tr>
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>
4204 </tr>
4205 <tr>
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>
4209 </tr>
4210 <tr>
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>
4214 </tr>
4215 <tr>
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>
4219 </tr>
4220 <tr>
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>
4224 </tr>
4225 <tr>
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>
4229 </tr>
4230 <tr>
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>
4234 </tr>
4235 <tr>
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>
4239 </tr>
4240 <tr>
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>
4244 </tr>
4245 <tr>
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>
4249 </tr>
4250 <tr>
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>
4254 </tr>
4255 </tbody>
4256 </table>
4257 </div>
4258 <div class="sect2">
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">
4261 <colgroup>
4262 <col style="width: 42.8571%;">
4263 <col style="width: 57.1429%;">
4264 </colgroup>
4265 <thead>
4266 <tr>
4267 <th class="tableblock halign-left valign-middle">Name</th>
4268 <th class="tableblock halign-left valign-middle">Schema</th>
4269 </tr>
4270 </thead>
4271 <tbody>
4272 <tr>
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>
4276 </tr>
4277 <tr>
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>
4281 </tr>
4282 <tr>
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>
4286 </tr>
4287 <tr>
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>
4291 </tr>
4292 <tr>
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>
4296 </tr>
4297 <tr>
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>
4301 </tr>
4302 <tr>
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>
4306 </tr>
4307 <tr>
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>
4311 </tr>
4312 <tr>
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>
4316 </tr>
4317 <tr>
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>
4321 </tr>
4322 <tr>
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>
4326 </tr>
4327 <tr>
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>
4331 </tr>
4332 <tr>
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>
4336 </tr>
4337 <tr>
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>
4341 </tr>
4342 <tr>
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>
4346 </tr>
4347 <tr>
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>
4351 </tr>
4352 <tr>
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>
4356 </tr>
4357 <tr>
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>
4361 </tr>
4362 <tr>
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>
4366 </tr>
4367 <tr>
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>
4371 </tr>
4372 </tbody>
4373 </table>
4374 </div>
4375 <div class="sect2">
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">
4378 <colgroup>
4379 <col style="width: 42.8571%;">
4380 <col style="width: 57.1429%;">
4381 </colgroup>
4382 <thead>
4383 <tr>
4384 <th class="tableblock halign-left valign-middle">Name</th>
4385 <th class="tableblock halign-left valign-middle">Schema</th>
4386 </tr>
4387 </thead>
4388 <tbody>
4389 <tr>
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>
4393 </tr>
4394 <tr>
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>
4398 </tr>
4399 <tr>
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>
4403 </tr>
4404 <tr>
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>
4408 </tr>
4409 <tr>
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>
4413 </tr>
4414 <tr>
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>
4418 </tr>
4419 <tr>
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>
4423 </tr>
4424 <tr>
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>
4428 </tr>
4429 <tr>
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>
4433 </tr>
4434 <tr>
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>
4438 </tr>
4439 <tr>
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>
4443 </tr>
4444 <tr>
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>
4448 </tr>
4449 <tr>
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>
4453 </tr>
4454 <tr>
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>
4458 </tr>
4459 <tr>
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>
4463 </tr>
4464 <tr>
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>
4468 </tr>
4469 <tr>
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>
4473 </tr>
4474 <tr>
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>
4478 </tr>
4479 <tr>
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>
4483 </tr>
4484 <tr>
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>
4488 </tr>
4489 </tbody>
4490 </table>
4491 </div>
4492 <div class="sect2">
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">
4495 <colgroup>
4496 <col style="width: 42.8571%;">
4497 <col style="width: 57.1429%;">
4498 </colgroup>
4499 <thead>
4500 <tr>
4501 <th class="tableblock halign-left valign-middle">Name</th>
4502 <th class="tableblock halign-left valign-middle">Schema</th>
4503 </tr>
4504 </thead>
4505 <tbody>
4506 <tr>
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>
4510 </tr>
4511 <tr>
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>
4515 </tr>
4516 <tr>
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>
4520 </tr>
4521 <tr>
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>
4525 </tr>
4526 <tr>
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>
4530 </tr>
4531 <tr>
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>
4535 </tr>
4536 <tr>
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>
4540 </tr>
4541 <tr>
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>
4545 </tr>
4546 <tr>
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>
4550 </tr>
4551 <tr>
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>
4555 </tr>
4556 <tr>
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>
4560 </tr>
4561 <tr>
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>
4565 </tr>
4566 <tr>
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>
4570 </tr>
4571 <tr>
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>
4575 </tr>
4576 <tr>
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>
4580 </tr>
4581 <tr>
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>
4585 </tr>
4586 <tr>
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>
4590 </tr>
4591 <tr>
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>
4595 </tr>
4596 <tr>
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>
4600 </tr>
4601 <tr>
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>
4605 </tr>
4606 </tbody>
4607 </table>
4608 </div>
4609 <div class="sect2">
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">
4612 <colgroup>
4613 <col style="width: 42.8571%;">
4614 <col style="width: 57.1429%;">
4615 </colgroup>
4616 <thead>
4617 <tr>
4618 <th class="tableblock halign-left valign-middle">Name</th>
4619 <th class="tableblock halign-left valign-middle">Schema</th>
4620 </tr>
4621 </thead>
4622 <tbody>
4623 <tr>
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>
4627 </tr>
4628 <tr>
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>
4632 </tr>
4633 <tr>
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>
4637 </tr>
4638 <tr>
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>
4642 </tr>
4643 <tr>
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>
4647 </tr>
4648 <tr>
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>
4652 </tr>
4653 <tr>
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>
4657 </tr>
4658 <tr>
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>
4662 </tr>
4663 <tr>
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>
4667 </tr>
4668 <tr>
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>
4672 </tr>
4673 <tr>
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>
4677 </tr>
4678 <tr>
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>
4682 </tr>
4683 <tr>
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>
4687 </tr>
4688 <tr>
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>
4692 </tr>
4693 <tr>
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>
4697 </tr>
4698 <tr>
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>
4702 </tr>
4703 <tr>
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>
4707 </tr>
4708 <tr>
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>
4712 </tr>
4713 <tr>
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>
4717 </tr>
4718 <tr>
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>
4722 </tr>
4723 <tr>
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>
4727 </tr>
4728 <tr>
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>
4732 </tr>
4733 <tr>
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>
4737 </tr>
4738 </tbody>
4739 </table>
4740 </div>
4741 <div class="sect2">
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">
4744 <colgroup>
4745 <col style="width: 42.8571%;">
4746 <col style="width: 57.1429%;">
4747 </colgroup>
4748 <thead>
4749 <tr>
4750 <th class="tableblock halign-left valign-middle">Name</th>
4751 <th class="tableblock halign-left valign-middle">Schema</th>
4752 </tr>
4753 </thead>
4754 <tbody>
4755 <tr>
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">&lt; string, <a href="#_externalcomponent">ExternalComponent</a> &gt; map</p></td>
4759 </tr>
4760 <tr>
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>
4764 </tr>
4765 <tr>
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>
4769 </tr>
4770 <tr>
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>
4774 </tr>
4775 <tr>
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>
4779 </tr>
4780 <tr>
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>
4784 </tr>
4785 <tr>
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>
4789 </tr>
4790 <tr>
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">&lt; <a href="#_looplog">LoopLog</a> &gt; array</p></td>
4794 </tr>
4795 <tr>
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>
4799 </tr>
4800 <tr>
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">&lt; <a href="#_microservicepolicy">MicroServicePolicy</a> &gt; array</p></td>
4804 </tr>
4805 <tr>
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>
4809 </tr>
4810 <tr>
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>
4814 </tr>
4815 <tr>
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">&lt; <a href="#_operationalpolicy">OperationalPolicy</a> &gt; array</p></td>
4819 </tr>
4820 <tr>
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>
4824 </tr>
4825 <tr>
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>
4829 </tr>
4830 </tbody>
4831 </table>
4832 </div>
4833 <div class="sect2">
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">
4836 <colgroup>
4837 <col style="width: 42.8571%;">
4838 <col style="width: 57.1429%;">
4839 </colgroup>
4840 <thead>
4841 <tr>
4842 <th class="tableblock halign-left valign-middle">Name</th>
4843 <th class="tableblock halign-left valign-middle">Schema</th>
4844 </tr>
4845 </thead>
4846 <tbody>
4847 <tr>
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>
4851 </tr>
4852 <tr>
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>
4856 </tr>
4857 <tr>
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>
4861 </tr>
4862 <tr>
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>
4866 </tr>
4867 <tr>
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>
4871 </tr>
4872 <tr>
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>
4876 </tr>
4877 <tr>
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">&lt; <a href="#_policymodel">PolicyModel</a> &gt; array</p></td>
4881 </tr>
4882 <tr>
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>
4886 </tr>
4887 <tr>
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>
4891 </tr>
4892 <tr>
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>
4896 </tr>
4897 <tr>
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">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
4901 </tr>
4902 </tbody>
4903 </table>
4904 </div>
4905 <div class="sect2">
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">
4908 <colgroup>
4909 <col style="width: 42.8571%;">
4910 <col style="width: 57.1429%;">
4911 </colgroup>
4912 <thead>
4913 <tr>
4914 <th class="tableblock halign-left valign-middle">Name</th>
4915 <th class="tableblock halign-left valign-middle">Schema</th>
4916 </tr>
4917 </thead>
4918 <tbody>
4919 <tr>
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>
4923 </tr>
4924 <tr>
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>
4928 </tr>
4929 <tr>
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>
4933 </tr>
4934 <tr>
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>
4938 </tr>
4939 <tr>
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>
4943 </tr>
4944 <tr>
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>
4948 </tr>
4949 </tbody>
4950 </table>
4951 </div>
4952 <div class="sect2">
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">
4955 <colgroup>
4956 <col style="width: 42.8571%;">
4957 <col style="width: 57.1429%;">
4958 </colgroup>
4959 <thead>
4960 <tr>
4961 <th class="tableblock halign-left valign-middle">Name</th>
4962 <th class="tableblock halign-left valign-middle">Schema</th>
4963 </tr>
4964 </thead>
4965 <tbody>
4966 <tr>
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>
4970 </tr>
4971 <tr>
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>
4975 </tr>
4976 <tr>
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>
4980 </tr>
4981 <tr>
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>
4985 </tr>
4986 <tr>
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>
4990 </tr>
4991 <tr>
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">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
4995 </tr>
4996 <tr>
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>
5000 </tr>
5001 <tr>
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>
5005 </tr>
5006 <tr>
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>
5010 </tr>
5011 <tr>
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>
5015 </tr>
5016 <tr>
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>
5020 </tr>
5021 <tr>
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>
5025 </tr>
5026 </tbody>
5027 </table>
5028 </div>
5029 <div class="sect2">
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">
5032 <colgroup>
5033 <col style="width: 42.8571%;">
5034 <col style="width: 57.1429%;">
5035 </colgroup>
5036 <thead>
5037 <tr>
5038 <th class="tableblock halign-left valign-middle">Name</th>
5039 <th class="tableblock halign-left valign-middle">Schema</th>
5040 </tr>
5041 </thead>
5042 <tbody>
5043 <tr>
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>
5047 </tr>
5048 <tr>
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>
5052 </tr>
5053 <tr>
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>
5057 </tr>
5058 </tbody>
5059 </table>
5060 </div>
5061 <div class="sect2">
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">
5064 <colgroup>
5065 <col style="width: 42.8571%;">
5066 <col style="width: 57.1429%;">
5067 </colgroup>
5068 <thead>
5069 <tr>
5070 <th class="tableblock halign-left valign-middle">Name</th>
5071 <th class="tableblock halign-left valign-middle">Schema</th>
5072 </tr>
5073 </thead>
5074 <tbody>
5075 <tr>
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>
5079 </tr>
5080 <tr>
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>
5084 </tr>
5085 <tr>
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>
5089 </tr>
5090 <tr>
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>
5094 </tr>
5095 <tr>
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>
5099 </tr>
5100 <tr>
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>
5104 </tr>
5105 <tr>
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>
5109 </tr>
5110 <tr>
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>
5114 </tr>
5115 <tr>
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>
5119 </tr>
5120 <tr>
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>
5124 </tr>
5125 <tr>
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>
5129 </tr>
5130 <tr>
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>
5134 </tr>
5135 <tr>
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>
5139 </tr>
5140 <tr>
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>
5144 </tr>
5145 <tr>
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>
5149 </tr>
5150 <tr>
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>
5154 </tr>
5155 <tr>
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>
5159 </tr>
5160 <tr>
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">&lt; <a href="#_loop">Loop</a> &gt; array</p></td>
5164 </tr>
5165 </tbody>
5166 </table>
5167 </div>
5168 <div class="sect2">
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>
5172 </div>
5173 </div>
5174 <div class="sect2">
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">
5177 <colgroup>
5178 <col style="width: 42.8571%;">
5179 <col style="width: 57.1429%;">
5180 </colgroup>
5181 <thead>
5182 <tr>
5183 <th class="tableblock halign-left valign-middle">Name</th>
5184 <th class="tableblock halign-left valign-middle">Schema</th>
5185 </tr>
5186 </thead>
5187 <tbody>
5188 <tr>
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>
5192 </tr>
5193 <tr>
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>
5197 </tr>
5198 <tr>
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>
5202 </tr>
5203 <tr>
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>
5207 </tr>
5208 <tr>
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>
5212 </tr>
5213 <tr>
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>
5217 </tr>
5218 <tr>
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>
5222 </tr>
5223 <tr>
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>
5227 </tr>
5228 <tr>
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>
5232 </tr>
5233 <tr>
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>
5237 </tr>
5238 <tr>
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>
5242 </tr>
5243 <tr>
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>
5247 </tr>
5248 </tbody>
5249 </table>
5250 </div>
5251 <div class="sect2">
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">
5254 <colgroup>
5255 <col style="width: 42.8571%;">
5256 <col style="width: 57.1429%;">
5257 </colgroup>
5258 <thead>
5259 <tr>
5260 <th class="tableblock halign-left valign-middle">Name</th>
5261 <th class="tableblock halign-left valign-middle">Schema</th>
5262 </tr>
5263 </thead>
5264 <tbody>
5265 <tr>
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>
5269 </tr>
5270 <tr>
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>
5274 </tr>
5275 <tr>
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>
5279 </tr>
5280 <tr>
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>
5284 </tr>
5285 <tr>
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>
5289 </tr>
5290 <tr>
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>
5294 </tr>
5295 <tr>
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>
5299 </tr>
5300 <tr>
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>
5304 </tr>
5305 <tr>
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">&lt; <a href="#_loopelementmodel">LoopElementModel</a> &gt; array</p></td>
5309 </tr>
5310 <tr>
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>
5314 </tr>
5315 </tbody>
5316 </table>
5317 </div>
5318 <div class="sect2">
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">
5321 <colgroup>
5322 <col style="width: 42.8571%;">
5323 <col style="width: 57.1429%;">
5324 </colgroup>
5325 <thead>
5326 <tr>
5327 <th class="tableblock halign-left valign-middle">Name</th>
5328 <th class="tableblock halign-left valign-middle">Schema</th>
5329 </tr>
5330 </thead>
5331 <tbody>
5332 <tr>
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>
5336 </tr>
5337 <tr>
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>
5341 </tr>
5342 <tr>
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>
5346 </tr>
5347 <tr>
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>
5351 </tr>
5352 <tr>
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>
5356 </tr>
5357 </tbody>
5358 </table>
5359 </div>
5360 </div>
5361 </div>
5362 </div>
5363 <div id="footer">
5364 <div id="footer-text">
5365 Last updated 2021-09-09 13:43:02 IST
5366 </div>
5367 </div>
5368 </body>
5369 </html>