src/main/resources/META-INF/resources/swagger.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="UTF-8">
   5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <meta name="generator" content="Asciidoctor 1.5.7.1">
   8 <title>Clamp Rest API</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  10 <style>
  11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12 /* Uncomment @import statement below to use as custom stylesheet */
  13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15 audio,canvas,video{display:inline-block}
  16 audio:not([controls]){display:none;height:0}
  17 script{display:none!important}
  18 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  19 a{background:transparent}
  20 a:focus{outline:thin dotted}
  21 a:active,a:hover{outline:0}
  22 h1{font-size:2em;margin:.67em 0}
  23 abbr[title]{border-bottom:1px dotted}
  24 b,strong{font-weight:bold}
  25 dfn{font-style:italic}
  26 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  27 mark{background:#ff0;color:#000}
  28 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  29 pre{white-space:pre-wrap}
  30 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  31 small{font-size:80%}
  32 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  33 sup{top:-.5em}
  34 sub{bottom:-.25em}
  35 img{border:0}
  36 svg:not(:root){overflow:hidden}
  37 figure{margin:0}
  38 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  39 legend{border:0;padding:0}
  40 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  41 button,input{line-height:normal}
  42 button,select{text-transform:none}
  43 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  44 button[disabled],html input[disabled]{cursor:default}
  45 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  46 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  47 textarea{overflow:auto;vertical-align:top}
  48 table{border-collapse:collapse;border-spacing:0}
  49 *,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  50 html,body{font-size:100%}
  51 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  52 a:hover{cursor:pointer}
  53 img,object,embed{max-width:100%;height:auto}
  54 object,embed{height:100%}
  55 img{-ms-interpolation-mode:bicubic}
  56 .left{float:left!important}
  57 .right{float:right!important}
  58 .text-left{text-align:left!important}
  59 .text-right{text-align:right!important}
  60 .text-center{text-align:center!important}
  61 .text-justify{text-align:justify!important}
  62 .hide{display:none}
  63 img,object,svg{display:inline-block;vertical-align:middle}
  64 textarea{height:auto;min-height:50px}
  65 select{width:100%}
  66 .center{margin-left:auto;margin-right:auto}
  67 .stretch{width:100%}
  68 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  69 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  70 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  71 a:hover,a:focus{color:#1d4b8f}
  72 a img{border:none}
  73 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  74 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  75 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  76 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  77 h1{font-size:2.125em}
  78 h2{font-size:1.6875em}
  79 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  80 h4,h5{font-size:1.125em}
  81 h6{font-size:1em}
  82 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  83 em,i{font-style:italic;line-height:inherit}
  84 strong,b{font-weight:bold;line-height:inherit}
  85 small{font-size:60%;line-height:inherit}
  86 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  87 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  88 ul,ol{margin-left:1.5em}
  89 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  90 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  91 ul.square{list-style-type:square}
  92 ul.circle{list-style-type:circle}
  93 ul.disc{list-style-type:disc}
  94 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  95 dl dt{margin-bottom:.3125em;font-weight:bold}
  96 dl dd{margin-bottom:1.25em}
  97 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
  98 abbr{text-transform:none}
  99 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
 100 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
 101 blockquote cite::before{content:"\2014 \0020"}
 102 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
 103 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 104 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 105 h1{font-size:2.75em}
 106 h2{font-size:2.3125em}
 107 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 108 h4{font-size:1.4375em}}
 109 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
 110 table thead,table tfoot{background:#f7f8f7}
 111 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 112 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 113 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
 114 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
 115 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 116 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 117 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
 118 .clearfix::after,.float-group::after{clear:both}
 119 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
 120 *:not(pre)>code.nobreak{word-wrap:normal}
 121 *:not(pre)>code.nowrap{white-space:nowrap}
 122 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
 123 em em{font-style:normal}
 124 strong strong{font-weight:400}
 125 .keyseq{color:rgba(51,51,51,.8)}
 126 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 127 .keyseq kbd:first-child{margin-left:0}
 128 .keyseq kbd:last-child{margin-right:0}
 129 .menuseq,.menuref{color:#000}
 130 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 131 .menuseq{word-spacing:-.02em}
 132 .menuseq b.caret{font-size:1.25em;line-height:.8}
 133 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 134 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
 135 b.button::before{content:"[";padding:0 3px 0 2px}
 136 b.button::after{content:"]";padding:0 2px 0 3px}
 137 p a>code:hover{color:rgba(0,0,0,.9)}
 138 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 139 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
 140 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
 141 #content{margin-top:1.25em}
 142 #content::before{content:none}
 143 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 144 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
 145 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
 146 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
 147 #header .details span:first-child{margin-left:-.125em}
 148 #header .details span.email a{color:rgba(0,0,0,.85)}
 149 #header .details br{display:none}
 150 #header .details br+span::before{content:"\00a0\2013\00a0"}
 151 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 152 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
 153 #header #revnumber{text-transform:capitalize}
 154 #header #revnumber::after{content:"\00a0"}
 155 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 156 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
 157 #toc>ul{margin-left:.125em}
 158 #toc ul.sectlevel0>li>a{font-style:italic}
 159 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 160 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 161 #toc li{line-height:1.3334;margin-top:.3334em}
 162 #toc a{text-decoration:none}
 163 #toc a:active{text-decoration:underline}
 164 #toctitle{color:#7a2518;font-size:1.2em}
 165 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
 166 body.toc2{padding-left:15em;padding-right:0}
 167 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 168 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 169 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 170 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 171 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 172 body.toc2.toc-right{padding-left:0;padding-right:15em}
 173 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
 174 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 175 #toc.toc2{width:20em}
 176 #toc.toc2 #toctitle{font-size:1.375em}
 177 #toc.toc2>ul{font-size:.95em}
 178 #toc.toc2 ul ul{padding-left:1.25em}
 179 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 180 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 181 #content #toc>:first-child{margin-top:0}
 182 #content #toc>:last-child{margin-bottom:0}
 183 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
 184 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
 185 #content{margin-bottom:.625em}
 186 .sect1{padding-bottom:.625em}
 187 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
 188 .sect1{padding-bottom:1.25em}}
 189 .sect1:last-child{padding-bottom:0}
 190 .sect1+.sect1{border-top:1px solid #efefed}
 191 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 192 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 193 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 194 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 195 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 196 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 197 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 198 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
 199 .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
 200 table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
 201 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 202 .admonitionblock>table td.icon{text-align:center;width:80px}
 203 .admonitionblock>table td.icon img{max-width:none}
 204 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 205 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
 206 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 207 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
 208 .exampleblock>.content>:first-child{margin-top:0}
 209 .exampleblock>.content>:last-child{margin-bottom:0}
 210 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 211 .sidebarblock>:first-child{margin-top:0}
 212 .sidebarblock>:last-child{margin-bottom:0}
 213 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 214 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 215 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
 216 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
 217 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
 218 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
 219 @media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
 220 @media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
 221 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
 222 .listingblock pre.highlightjs{padding:0}
 223 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
 224 .listingblock pre.prettyprint{border-width:0}
 225 .listingblock>.content{position:relative}
 226 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
 227 .listingblock:hover code[data-lang]::before{display:block}
 228 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999}
 229 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
 230 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 231 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
 232 table.pyhltable td.code{padding-left:.75em;padding-right:0}
 233 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
 234 pre.pygments .lineno{display:inline-block;margin-right:.25em}
 235 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
 236 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 237 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
 238 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 239 .quoteblock blockquote{margin:0;padding:0;border:0}
 240 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 241 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 242 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
 243 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
 244 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
 245 .quoteblock .quoteblock blockquote::before{display:none}
 246 .verseblock{margin:0 1em 1.25em}
 247 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 248 .verseblock pre strong{font-weight:400}
 249 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 250 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 251 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 252 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 253 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
 254 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
 255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{word-spacing:0;line-height:1.6}
 256 .quoteblock.abstract blockquote::before,.quoteblock.abstract p::before{display:none}
 257 table.tableblock{max-width:100%;border-collapse:separate}
 258 p.tableblock:last-child{margin-bottom:0}
 259 td.tableblock>.content{margin-bottom:-1.25em}
 260 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 261 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
 262 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
 263 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
 264 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
 265 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
 266 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
 267 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
 268 table.frame-all{border-width:1px}
 269 table.frame-sides{border-width:0 1px}
 270 table.frame-topbot,table.frame-ends{border-width:1px 0}
 271 table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7}
 272 table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none}
 273 th.halign-left,td.halign-left{text-align:left}
 274 th.halign-right,td.halign-right{text-align:right}
 275 th.halign-center,td.halign-center{text-align:center}
 276 th.valign-top,td.valign-top{vertical-align:top}
 277 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 278 th.valign-middle,td.valign-middle{vertical-align:middle}
 279 table thead th,table tfoot th{font-weight:bold}
 280 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
 281 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 282 p.tableblock>code:only-child{background:none;padding:0}
 283 p.tableblock{font-size:1em}
 284 td>div.verse{white-space:pre}
 285 ol{margin-left:1.75em}
 286 ul li ol{margin-left:1.5em}
 287 dl dd{margin-left:1.125em}
 288 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 289 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 290 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 291 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 292 ul.unstyled,ol.unstyled{margin-left:0}
 293 ul.checklist{margin-left:.625em}
 294 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 295 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
 296 ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
 297 ul.inline>li{margin-left:1.25em}
 298 .unstyled dl dt{font-weight:400;font-style:normal}
 299 ol.arabic{list-style-type:decimal}
 300 ol.decimal{list-style-type:decimal-leading-zero}
 301 ol.loweralpha{list-style-type:lower-alpha}
 302 ol.upperalpha{list-style-type:upper-alpha}
 303 ol.lowerroman{list-style-type:lower-roman}
 304 ol.upperroman{list-style-type:upper-roman}
 305 ol.lowergreek{list-style-type:lower-greek}
 306 .hdlist>table,.colist>table{border:0;background:none}
 307 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 308 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 309 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 310 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 311 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
 312 .colist td:not([class]):first-child img{max-width:none}
 313 .colist td:not([class]):last-child{padding:.25em 0}
 314 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
 315 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
 316 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
 317 .imageblock>.title{margin-bottom:0}
 318 .imageblock.thumb,.imageblock.th{border-width:6px}
 319 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 320 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 321 .image.left{margin-right:.625em}
 322 .image.right{margin-left:.625em}
 323 a.image{text-decoration:none;display:inline-block}
 324 a.image object{pointer-events:none}
 325 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 326 sup.footnote a,sup.footnoteref a{text-decoration:none}
 327 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 328 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 329 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 330 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
 331 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
 332 #footnotes .footnote:last-of-type{margin-bottom:0}
 333 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 334 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
 335 .gist .file-data>table td.line-data{width:99%}
 336 div.unbreakable{page-break-inside:avoid}
 337 .big{font-size:larger}
 338 .small{font-size:smaller}
 339 .underline{text-decoration:underline}
 340 .overline{text-decoration:overline}
 341 .line-through{text-decoration:line-through}
 342 .aqua{color:#00bfbf}
 343 .aqua-background{background-color:#00fafa}
 344 .black{color:#000}
 345 .black-background{background-color:#000}
 346 .blue{color:#0000bf}
 347 .blue-background{background-color:#0000fa}
 348 .fuchsia{color:#bf00bf}
 349 .fuchsia-background{background-color:#fa00fa}
 350 .gray{color:#606060}
 351 .gray-background{background-color:#7d7d7d}
 352 .green{color:#006000}
 353 .green-background{background-color:#007d00}
 354 .lime{color:#00bf00}
 355 .lime-background{background-color:#00fa00}
 356 .maroon{color:#600000}
 357 .maroon-background{background-color:#7d0000}
 358 .navy{color:#000060}
 359 .navy-background{background-color:#00007d}
 360 .olive{color:#606000}
 361 .olive-background{background-color:#7d7d00}
 362 .purple{color:#600060}
 363 .purple-background{background-color:#7d007d}
 364 .red{color:#bf0000}
 365 .red-background{background-color:#fa0000}
 366 .silver{color:#909090}
 367 .silver-background{background-color:#bcbcbc}
 368 .teal{color:#006060}
 369 .teal-background{background-color:#007d7d}
 370 .white{color:#bfbfbf}
 371 .white-background{background-color:#fafafa}
 372 .yellow{color:#bfbf00}
 373 .yellow-background{background-color:#fafa00}
 374 span.icon>.fa{cursor:default}
 375 a span.icon>.fa{cursor:inherit}
 376 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 377 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
 378 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 379 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
 380 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
 381 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
 382 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 383 .conum[data-value] *{color:#fff!important}
 384 .conum[data-value]+b{display:none}
 385 .conum[data-value]::after{content:attr(data-value)}
 386 pre .conum[data-value]{position:relative;top:-.125em}
 387 b.conum *{color:inherit!important}
 388 .conum:not([data-value]):empty{display:none}
 389 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 390 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
 391 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 392 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
 393 p{margin-bottom:1.25rem}
 394 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 395 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 396 .print-only{display:none!important}
 397 @page{margin:1.25cm .75cm}
 398 @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
 399 html{font-size:80%}
 400 a{color:inherit!important;text-decoration:underline!important}
 401 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 402 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 403 abbr[title]::after{content:" (" attr(title) ")"}
 404 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 405 thead{display:table-header-group}
 406 svg{max-width:100%}
 407 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 408 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 409 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 410 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
 411 body.book #header{text-align:center}
 412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
 413 body.book #header .details{border:0!important;display:block;padding:0!important}
 414 body.book #header .details span:first-child{margin-left:0!important}
 415 body.book #header .details br{display:block}
 416 body.book #header .details br+span::before{content:none!important}
 417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 419 .listingblock code[data-lang]::before{display:block}
 420 #footer{padding:0 .9375em}
 421 .hide-on-print{display:none!important}
 422 .print-only{display:block!important}
 423 .hide-for-print{display:none!important}
 424 .show-for-print{display:inherit!important}}
 425 @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
 426 .sect1{padding:0!important}
 427 .sect1+.sect1{border:0}
 428 #footer{background:none}
 429 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
 430 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
 431 </style>
 432 </head>
 433 <body class="book toc2 toc-left">
 434 <div id="header">
 435 <h1>Clamp Rest API</h1>
 436 <div id="toc" class="toc2">
 437 <div id="toctitle">Table of Contents</div>
 438 <ul class="sectlevel1">
 439 <li><a href="#_overview">1. Overview</a>
 440 <ul class="sectlevel2">
 441 <li><a href="#_version_information">1.1. Version information</a></li>
 442 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
 443 </ul>
 444 </li>
 445 <li><a href="#_paths">2. Paths</a>
 446 <ul class="sectlevel2">
 447 <li><a href="#_route30">2.1. GET /v1/clds/cldsInfo</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="#_route31">2.2. GET /v1/healthcheck</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="#_route32">2.3. GET /v1/user/getUser</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="#_route18">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="#_route20">2.5. PUT /v2/dictionary</a>
 472 <ul class="sectlevel3">
 473 <li><a href="#_parameters">2.5.1. Parameters</a></li>
 474 <li><a href="#_responses_5">2.5.2. Responses</a></li>
 475 <li><a href="#_consumes">2.5.3. Consumes</a></li>
 476 <li><a href="#_produces_5">2.5.4. Produces</a></li>
 477 </ul>
 478 </li>
 479 <li><a href="#_v2_dictionary_secondary_names_get">2.6. GET /v2/dictionary/secondary/names</a>
 480 <ul class="sectlevel3">
 481 <li><a href="#_responses_6">2.6.1. Responses</a></li>
 482 <li><a href="#_produces_6">2.6.2. Produces</a></li>
 483 </ul>
 484 </li>
 485 <li><a href="#_v2_dictionary_dictionaryname_get">2.7. GET /v2/dictionary/{dictionaryName}</a>
 486 <ul class="sectlevel3">
 487 <li><a href="#_parameters_2">2.7.1. Parameters</a></li>
 488 <li><a href="#_responses_7">2.7.2. Responses</a></li>
 489 <li><a href="#_produces_7">2.7.3. Produces</a></li>
 490 </ul>
 491 </li>
 492 <li><a href="#_v2_dictionary_name_put">2.8. PUT /v2/dictionary/{name}</a>
 493 <ul class="sectlevel3">
 494 <li><a href="#_parameters_3">2.8.1. Parameters</a></li>
 495 <li><a href="#_responses_8">2.8.2. Responses</a></li>
 496 <li><a href="#_consumes_2">2.8.3. Consumes</a></li>
 497 <li><a href="#_produces_8">2.8.4. Produces</a></li>
 498 </ul>
 499 </li>
 500 <li><a href="#_route22">2.9. DELETE /v2/dictionary/{name}</a>
 501 <ul class="sectlevel3">
 502 <li><a href="#_parameters_4">2.9.1. Parameters</a></li>
 503 <li><a href="#_responses_9">2.9.2. Responses</a></li>
 504 <li><a href="#_produces_9">2.9.3. Produces</a></li>
 505 </ul>
 506 </li>
 507 <li><a href="#_v2_dictionary_name_elements_shortname_delete">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a>
 508 <ul class="sectlevel3">
 509 <li><a href="#_parameters_5">2.10.1. Parameters</a></li>
 510 <li><a href="#_responses_10">2.10.2. Responses</a></li>
 511 <li><a href="#_produces_10">2.10.3. Produces</a></li>
 512 </ul>
 513 </li>
 514 <li><a href="#_route14">2.11. PUT /v2/loop/delete/{loopName}</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 </ul>
 519 </li>
 520 <li><a href="#_route8">2.12. PUT /v2/loop/deploy/{loopName}</a>
 521 <ul class="sectlevel3">
 522 <li><a href="#_parameters_7">2.12.1. Parameters</a></li>
 523 <li><a href="#_responses_12">2.12.2. Responses</a></li>
 524 <li><a href="#_produces_11">2.12.3. Produces</a></li>
 525 </ul>
 526 </li>
 527 <li><a href="#_route2">2.13. GET /v2/loop/getAllNames</a>
 528 <ul class="sectlevel3">
 529 <li><a href="#_responses_13">2.13.1. Responses</a></li>
 530 <li><a href="#_produces_12">2.13.2. Produces</a></li>
 531 </ul>
 532 </li>
 533 <li><a href="#_route15">2.14. GET /v2/loop/getstatus/{loopName}</a>
 534 <ul class="sectlevel3">
 535 <li><a href="#_parameters_8">2.14.1. Parameters</a></li>
 536 <li><a href="#_responses_14">2.14.2. Responses</a></li>
 537 <li><a href="#_produces_13">2.14.3. Produces</a></li>
 538 </ul>
 539 </li>
 540 <li><a href="#_route9">2.15. PUT /v2/loop/refreshOpPolicyJsonSchema/{loopName}</a>
 541 <ul class="sectlevel3">
 542 <li><a href="#_parameters_9">2.15.1. Parameters</a></li>
 543 <li><a href="#_responses_15">2.15.2. Responses</a></li>
 544 <li><a href="#_produces_14">2.15.3. Produces</a></li>
 545 </ul>
 546 </li>
 547 <li><a href="#_route12">2.16. PUT /v2/loop/restart/{loopName}</a>
 548 <ul class="sectlevel3">
 549 <li><a href="#_parameters_10">2.16.1. Parameters</a></li>
 550 <li><a href="#_responses_16">2.16.2. Responses</a></li>
 551 <li><a href="#_produces_15">2.16.3. Produces</a></li>
 552 </ul>
 553 </li>
 554 <li><a href="#_route11">2.17. PUT /v2/loop/stop/{loopName}</a>
 555 <ul class="sectlevel3">
 556 <li><a href="#_parameters_11">2.17.1. Parameters</a></li>
 557 <li><a href="#_responses_17">2.17.2. Responses</a></li>
 558 <li><a href="#_produces_16">2.17.3. Produces</a></li>
 559 </ul>
 560 </li>
 561 <li><a href="#_route13">2.18. PUT /v2/loop/submit/{loopName}</a>
 562 <ul class="sectlevel3">
 563 <li><a href="#_parameters_12">2.18.1. Parameters</a></li>
 564 <li><a href="#_responses_18">2.18.2. Responses</a></li>
 565 <li><a href="#_produces_17">2.18.3. Produces</a></li>
 566 </ul>
 567 </li>
 568 <li><a href="#_route4">2.19. GET /v2/loop/svgRepresentation/{loopName}</a>
 569 <ul class="sectlevel3">
 570 <li><a href="#_parameters_13">2.19.1. Parameters</a></li>
 571 <li><a href="#_responses_19">2.19.2. Responses</a></li>
 572 <li><a href="#_produces_18">2.19.3. Produces</a></li>
 573 </ul>
 574 </li>
 575 <li><a href="#_route10">2.20. PUT /v2/loop/undeploy/{loopName}</a>
 576 <ul class="sectlevel3">
 577 <li><a href="#_parameters_14">2.20.1. Parameters</a></li>
 578 <li><a href="#_responses_20">2.20.2. Responses</a></li>
 579 <li><a href="#_produces_19">2.20.3. Produces</a></li>
 580 </ul>
 581 </li>
 582 <li><a href="#_route5">2.21. POST /v2/loop/updateGlobalProperties/{loopName}</a>
 583 <ul class="sectlevel3">
 584 <li><a href="#_parameters_15">2.21.1. Parameters</a></li>
 585 <li><a href="#_responses_21">2.21.2. Responses</a></li>
 586 <li><a href="#_consumes_3">2.21.3. Consumes</a></li>
 587 <li><a href="#_produces_20">2.21.4. Produces</a></li>
 588 </ul>
 589 </li>
 590 <li><a href="#_route7">2.22. POST /v2/loop/updateMicroservicePolicy/{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="#_consumes_4">2.22.3. Consumes</a></li>
 595 <li><a href="#_produces_21">2.22.4. Produces</a></li>
 596 </ul>
 597 </li>
 598 <li><a href="#_route6">2.23. POST /v2/loop/updateOperationalPolicies/{loopName}</a>
 599 <ul class="sectlevel3">
 600 <li><a href="#_parameters_17">2.23.1. Parameters</a></li>
 601 <li><a href="#_responses_23">2.23.2. Responses</a></li>
 602 <li><a href="#_consumes_5">2.23.3. Consumes</a></li>
 603 <li><a href="#_produces_22">2.23.4. Produces</a></li>
 604 </ul>
 605 </li>
 606 <li><a href="#_route3">2.24. GET /v2/loop/{loopName}</a>
 607 <ul class="sectlevel3">
 608 <li><a href="#_parameters_18">2.24.1. Parameters</a></li>
 609 <li><a href="#_responses_24">2.24.2. Responses</a></li>
 610 <li><a href="#_produces_23">2.24.3. Produces</a></li>
 611 </ul>
 612 </li>
 613 <li><a href="#_route25">2.25. GET /v2/policyToscaModels</a>
 614 <ul class="sectlevel3">
 615 <li><a href="#_responses_25">2.25.1. Responses</a></li>
 616 <li><a href="#_produces_24">2.25.2. Produces</a></li>
 617 </ul>
 618 </li>
 619 <li><a href="#_v2_policytoscamodels_yaml_policymodeltype_get">2.26. GET /v2/policyToscaModels/yaml/{policyModelType}</a>
 620 <ul class="sectlevel3">
 621 <li><a href="#_parameters_19">2.26.1. Parameters</a></li>
 622 <li><a href="#_responses_26">2.26.2. Responses</a></li>
 623 <li><a href="#_produces_25">2.26.3. Produces</a></li>
 624 </ul>
 625 </li>
 626 <li><a href="#_v2_policytoscamodels_policymodeltype_get">2.27. GET /v2/policyToscaModels/{policyModelType}</a>
 627 <ul class="sectlevel3">
 628 <li><a href="#_parameters_20">2.27.1. Parameters</a></li>
 629 <li><a href="#_responses_27">2.27.2. Responses</a></li>
 630 <li><a href="#_produces_26">2.27.3. Produces</a></li>
 631 </ul>
 632 </li>
 633 <li><a href="#_route26">2.28. PUT /v2/policyToscaModels/{policyModelType}</a>
 634 <ul class="sectlevel3">
 635 <li><a href="#_parameters_21">2.28.1. Parameters</a></li>
 636 <li><a href="#_responses_28">2.28.2. Responses</a></li>
 637 <li><a href="#_consumes_6">2.28.3. Consumes</a></li>
 638 <li><a href="#_produces_27">2.28.4. Produces</a></li>
 639 </ul>
 640 </li>
 641 <li><a href="#_route29">2.29. GET /v2/templates</a>
 642 <ul class="sectlevel3">
 643 <li><a href="#_responses_29">2.29.1. Responses</a></li>
 644 <li><a href="#_produces_28">2.29.2. Produces</a></li>
 645 </ul>
 646 </li>
 647 <li><a href="#_v2_templates_names_get">2.30. GET /v2/templates/names</a>
 648 <ul class="sectlevel3">
 649 <li><a href="#_responses_30">2.30.1. Responses</a></li>
 650 <li><a href="#_produces_29">2.30.2. Produces</a></li>
 651 </ul>
 652 </li>
 653 <li><a href="#_v2_templates_templatename_get">2.31. GET /v2/templates/{templateName}</a>
 654 <ul class="sectlevel3">
 655 <li><a href="#_parameters_22">2.31.1. Parameters</a></li>
 656 <li><a href="#_responses_31">2.31.2. Responses</a></li>
 657 <li><a href="#_produces_30">2.31.3. Produces</a></li>
 658 </ul>
 659 </li>
 660 </ul>
 661 </li>
 662 <li><a href="#_definitions">3. Definitions</a>
 663 <ul class="sectlevel2">
 664 <li><a href="#_cldshealthcheck">3.1. CldsHealthCheck</a></li>
 665 <li><a href="#_cldsinfo">3.2. CldsInfo</a></li>
 666 <li><a href="#_dictionary">3.3. Dictionary</a></li>
 667 <li><a href="#_dictionaryelement">3.4. DictionaryElement</a></li>
 668 <li><a href="#_externalcomponent">3.5. ExternalComponent</a></li>
 669 <li><a href="#_externalcomponentstate">3.6. ExternalComponentState</a></li>
 670 <li><a href="#_jsonarray">3.7. JsonArray</a></li>
 671 <li><a href="#_jsonnull">3.8. JsonNull</a></li>
 672 <li><a href="#_jsonobject">3.9. JsonObject</a></li>
 673 <li><a href="#_jsonprimitive">3.10. JsonPrimitive</a></li>
 674 <li><a href="#_loop">3.11. Loop</a></li>
 675 <li><a href="#_loopelementmodel">3.12. LoopElementModel</a></li>
 676 <li><a href="#_looplog">3.13. LoopLog</a></li>
 677 <li><a href="#_looptemplate">3.14. LoopTemplate</a></li>
 678 <li><a href="#_looptemplateloopelementmodel">3.15. LoopTemplateLoopElementModel</a></li>
 679 <li><a href="#_microservicepolicy">3.16. MicroServicePolicy</a></li>
 680 <li><a href="#_number">3.17. Number</a></li>
 681 <li><a href="#_operationalpolicy">3.18. OperationalPolicy</a></li>
 682 <li><a href="#_policymodel">3.19. PolicyModel</a></li>
 683 <li><a href="#_service">3.20. Service</a></li>
 684 </ul>
 685 </li>
 686 </ul>
 687 </div>
 688 </div>
 689 <div id="content">
 690 <div class="sect1">
 691 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
 692 <div class="sectionbody">
 693 <div class="sect2">
 694 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
 695 <div class="paragraph">
 696 <p><em>Version</em> : 5.0.0-SNAPSHOT</p>
 697 </div>
 698 </div>
 699 <div class="sect2">
 700 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
 701 <div class="paragraph">
 702 <p><em>Host</em> : localhost:33699<br>
 703 <em>BasePath</em> : /restservices/clds/<br>
 704 <em>Schemes</em> : HTTP</p>
 705 </div>
 706 </div>
 707 </div>
 708 </div>
 709 <div class="sect1">
 710 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
 711 <div class="sectionbody">
 712 <div class="sect2">
 713 <h3 id="_route30"><a class="anchor" href="#_route30"></a><a class="link" href="#_route30">2.1. GET /v1/clds/cldsInfo</a></h3>
 714 <div class="sect3">
 715 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.1. Responses</a></h4>
 716 <table class="tableblock frame-all grid-all stretch">
 717 <colgroup>
 718 <col style="width: 10%;">
 719 <col style="width: 70%;">
 720 <col style="width: 20%;">
 721 </colgroup>
 722 <thead>
 723 <tr>
 724 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 725 <th class="tableblock halign-left valign-middle">Description</th>
 726 <th class="tableblock halign-left valign-middle">Schema</th>
 727 </tr>
 728 </thead>
 729 <tbody>
 730 <tr>
 731 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 732 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
 733 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
 734 </tr>
 735 </tbody>
 736 </table>
 737 </div>
 738 <div class="sect3">
 739 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.2. Produces</a></h4>
 740 <div class="ulist">
 741 <ul>
 742 <li>
 743 <p><code>application/json</code></p>
 744 </li>
 745 </ul>
 746 </div>
 747 </div>
 748 </div>
 749 <div class="sect2">
 750 <h3 id="_route31"><a class="anchor" href="#_route31"></a><a class="link" href="#_route31">2.2. GET /v1/healthcheck</a></h3>
 751 <div class="sect3">
 752 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
 753 <table class="tableblock frame-all grid-all stretch">
 754 <colgroup>
 755 <col style="width: 10%;">
 756 <col style="width: 70%;">
 757 <col style="width: 20%;">
 758 </colgroup>
 759 <thead>
 760 <tr>
 761 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 762 <th class="tableblock halign-left valign-middle">Description</th>
 763 <th class="tableblock halign-left valign-middle">Schema</th>
 764 </tr>
 765 </thead>
 766 <tbody>
 767 <tr>
 768 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 769 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
 770 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
 771 </tr>
 772 </tbody>
 773 </table>
 774 </div>
 775 <div class="sect3">
 776 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
 777 <div class="ulist">
 778 <ul>
 779 <li>
 780 <p><code>application/json</code></p>
 781 </li>
 782 </ul>
 783 </div>
 784 </div>
 785 </div>
 786 <div class="sect2">
 787 <h3 id="_route32"><a class="anchor" href="#_route32"></a><a class="link" href="#_route32">2.3. GET /v1/user/getUser</a></h3>
 788 <div class="sect3">
 789 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
 790 <table class="tableblock frame-all grid-all stretch">
 791 <colgroup>
 792 <col style="width: 33.3333%;">
 793 <col style="width: 66.6667%;">
 794 </colgroup>
 795 <thead>
 796 <tr>
 797 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 798 <th class="tableblock halign-left valign-middle">Schema</th>
 799 </tr>
 800 </thead>
 801 <tbody>
 802 <tr>
 803 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 804 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
 805 </tr>
 806 </tbody>
 807 </table>
 808 </div>
 809 <div class="sect3">
 810 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
 811 <div class="ulist">
 812 <ul>
 813 <li>
 814 <p><code>text/plain</code></p>
 815 </li>
 816 </ul>
 817 </div>
 818 </div>
 819 </div>
 820 <div class="sect2">
 821 <h3 id="_route18"><a class="anchor" href="#_route18"></a><a class="link" href="#_route18">2.4. GET /v2/dictionary</a></h3>
 822 <div class="sect3">
 823 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.1. Responses</a></h4>
 824 <table class="tableblock frame-all grid-all stretch">
 825 <colgroup>
 826 <col style="width: 10%;">
 827 <col style="width: 70%;">
 828 <col style="width: 20%;">
 829 </colgroup>
 830 <thead>
 831 <tr>
 832 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 833 <th class="tableblock halign-left valign-middle">Description</th>
 834 <th class="tableblock halign-left valign-middle">Schema</th>
 835 </tr>
 836 </thead>
 837 <tbody>
 838 <tr>
 839 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 840 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
 841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
 842 </tr>
 843 </tbody>
 844 </table>
 845 </div>
 846 <div class="sect3">
 847 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.2. Produces</a></h4>
 848 <div class="ulist">
 849 <ul>
 850 <li>
 851 <p><code>application/json</code></p>
 852 </li>
 853 </ul>
 854 </div>
 855 </div>
 856 </div>
 857 <div class="sect2">
 858 <h3 id="_route20"><a class="anchor" href="#_route20"></a><a class="link" href="#_route20">2.5. PUT /v2/dictionary</a></h3>
 859 <div class="sect3">
 860 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.5.1. Parameters</a></h4>
 861 <table class="tableblock frame-all grid-all stretch">
 862 <colgroup>
 863 <col style="width: 22.2222%;">
 864 <col style="width: 33.3333%;">
 865 <col style="width: 44.4445%;">
 866 </colgroup>
 867 <thead>
 868 <tr>
 869 <th class="tableblock halign-left valign-middle">Type</th>
 870 <th class="tableblock halign-left valign-middle">Name</th>
 871 <th class="tableblock halign-left valign-middle">Schema</th>
 872 </tr>
 873 </thead>
 874 <tbody>
 875 <tr>
 876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
 877 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
 878 <em>required</em></p></td>
 879 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
 880 </tr>
 881 </tbody>
 882 </table>
 883 </div>
 884 <div class="sect3">
 885 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
 886 <table class="tableblock frame-all grid-all stretch">
 887 <colgroup>
 888 <col style="width: 10%;">
 889 <col style="width: 70%;">
 890 <col style="width: 20%;">
 891 </colgroup>
 892 <thead>
 893 <tr>
 894 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 895 <th class="tableblock halign-left valign-middle">Description</th>
 896 <th class="tableblock halign-left valign-middle">Schema</th>
 897 </tr>
 898 </thead>
 899 <tbody>
 900 <tr>
 901 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 902 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
 903 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
 904 </tr>
 905 </tbody>
 906 </table>
 907 </div>
 908 <div class="sect3">
 909 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.5.3. Consumes</a></h4>
 910 <div class="ulist">
 911 <ul>
 912 <li>
 913 <p><code>application/json</code></p>
 914 </li>
 915 </ul>
 916 </div>
 917 </div>
 918 <div class="sect3">
 919 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
 920 <div class="ulist">
 921 <ul>
 922 <li>
 923 <p><code>application/json</code></p>
 924 </li>
 925 </ul>
 926 </div>
 927 </div>
 928 </div>
 929 <div class="sect2">
 930 <h3 id="_v2_dictionary_secondary_names_get"><a class="anchor" href="#_v2_dictionary_secondary_names_get"></a><a class="link" href="#_v2_dictionary_secondary_names_get">2.6. GET /v2/dictionary/secondary/names</a></h3>
 931 <div class="sect3">
 932 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
 933 <table class="tableblock frame-all grid-all stretch">
 934 <colgroup>
 935 <col style="width: 10%;">
 936 <col style="width: 70%;">
 937 <col style="width: 20%;">
 938 </colgroup>
 939 <thead>
 940 <tr>
 941 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 942 <th class="tableblock halign-left valign-middle">Description</th>
 943 <th class="tableblock halign-left valign-middle">Schema</th>
 944 </tr>
 945 </thead>
 946 <tbody>
 947 <tr>
 948 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 949 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
 950 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
 951 </tr>
 952 </tbody>
 953 </table>
 954 </div>
 955 <div class="sect3">
 956 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
 957 <div class="ulist">
 958 <ul>
 959 <li>
 960 <p><code>application/json</code></p>
 961 </li>
 962 </ul>
 963 </div>
 964 </div>
 965 </div>
 966 <div class="sect2">
 967 <h3 id="_v2_dictionary_dictionaryname_get"><a class="anchor" href="#_v2_dictionary_dictionaryname_get"></a><a class="link" href="#_v2_dictionary_dictionaryname_get">2.7. GET /v2/dictionary/{dictionaryName}</a></h3>
 968 <div class="sect3">
 969 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.7.1. Parameters</a></h4>
 970 <table class="tableblock frame-all grid-all stretch">
 971 <colgroup>
 972 <col style="width: 22.2222%;">
 973 <col style="width: 33.3333%;">
 974 <col style="width: 44.4445%;">
 975 </colgroup>
 976 <thead>
 977 <tr>
 978 <th class="tableblock halign-left valign-middle">Type</th>
 979 <th class="tableblock halign-left valign-middle">Name</th>
 980 <th class="tableblock halign-left valign-middle">Schema</th>
 981 </tr>
 982 </thead>
 983 <tbody>
 984 <tr>
 985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
 986 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
 987 <em>required</em></p></td>
 988 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 989 </tr>
 990 </tbody>
 991 </table>
 992 </div>
 993 <div class="sect3">
 994 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
 995 <table class="tableblock frame-all grid-all stretch">
 996 <colgroup>
 997 <col style="width: 10%;">
 998 <col style="width: 70%;">
 999 <col style="width: 20%;">
1000 </colgroup>
1001 <thead>
1002 <tr>
1003 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1004 <th class="tableblock halign-left valign-middle">Description</th>
1005 <th class="tableblock halign-left valign-middle">Schema</th>
1006 </tr>
1007 </thead>
1008 <tbody>
1009 <tr>
1010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1011 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1012 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1013 </tr>
1014 </tbody>
1015 </table>
1016 </div>
1017 <div class="sect3">
1018 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1019 <div class="ulist">
1020 <ul>
1021 <li>
1022 <p><code>application/json</code></p>
1023 </li>
1024 </ul>
1025 </div>
1026 </div>
1027 </div>
1028 <div class="sect2">
1029 <h3 id="_v2_dictionary_name_put"><a class="anchor" href="#_v2_dictionary_name_put"></a><a class="link" href="#_v2_dictionary_name_put">2.8. PUT /v2/dictionary/{name}</a></h3>
1030 <div class="sect3">
1031 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.8.1. Parameters</a></h4>
1032 <table class="tableblock frame-all grid-all stretch">
1033 <colgroup>
1034 <col style="width: 22.2222%;">
1035 <col style="width: 33.3333%;">
1036 <col style="width: 44.4445%;">
1037 </colgroup>
1038 <thead>
1039 <tr>
1040 <th class="tableblock halign-left valign-middle">Type</th>
1041 <th class="tableblock halign-left valign-middle">Name</th>
1042 <th class="tableblock halign-left valign-middle">Schema</th>
1043 </tr>
1044 </thead>
1045 <tbody>
1046 <tr>
1047 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1048 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1049 <em>required</em></p></td>
1050 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1051 </tr>
1052 <tr>
1053 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1055 <em>required</em></p></td>
1056 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1057 </tr>
1058 </tbody>
1059 </table>
1060 </div>
1061 <div class="sect3">
1062 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1063 <table class="tableblock frame-all grid-all stretch">
1064 <colgroup>
1065 <col style="width: 10%;">
1066 <col style="width: 70%;">
1067 <col style="width: 20%;">
1068 </colgroup>
1069 <thead>
1070 <tr>
1071 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1072 <th class="tableblock halign-left valign-middle">Description</th>
1073 <th class="tableblock halign-left valign-middle">Schema</th>
1074 </tr>
1075 </thead>
1076 <tbody>
1077 <tr>
1078 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1079 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1080 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dictionary">Dictionary</a></p></td>
1081 </tr>
1082 </tbody>
1083 </table>
1084 </div>
1085 <div class="sect3">
1086 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.8.3. Consumes</a></h4>
1087 <div class="ulist">
1088 <ul>
1089 <li>
1090 <p><code>application/json</code></p>
1091 </li>
1092 </ul>
1093 </div>
1094 </div>
1095 <div class="sect3">
1096 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.4. Produces</a></h4>
1097 <div class="ulist">
1098 <ul>
1099 <li>
1100 <p><code>application/json</code></p>
1101 </li>
1102 </ul>
1103 </div>
1104 </div>
1105 </div>
1106 <div class="sect2">
1107 <h3 id="_route22"><a class="anchor" href="#_route22"></a><a class="link" href="#_route22">2.9. DELETE /v2/dictionary/{name}</a></h3>
1108 <div class="sect3">
1109 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.9.1. Parameters</a></h4>
1110 <table class="tableblock frame-all grid-all stretch">
1111 <colgroup>
1112 <col style="width: 22.2222%;">
1113 <col style="width: 33.3333%;">
1114 <col style="width: 44.4445%;">
1115 </colgroup>
1116 <thead>
1117 <tr>
1118 <th class="tableblock halign-left valign-middle">Type</th>
1119 <th class="tableblock halign-left valign-middle">Name</th>
1120 <th class="tableblock halign-left valign-middle">Schema</th>
1121 </tr>
1122 </thead>
1123 <tbody>
1124 <tr>
1125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1127 <em>required</em></p></td>
1128 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1129 </tr>
1130 </tbody>
1131 </table>
1132 </div>
1133 <div class="sect3">
1134 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1135 <table class="tableblock frame-all grid-all stretch">
1136 <colgroup>
1137 <col style="width: 33.3333%;">
1138 <col style="width: 66.6667%;">
1139 </colgroup>
1140 <thead>
1141 <tr>
1142 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1143 <th class="tableblock halign-left valign-middle">Schema</th>
1144 </tr>
1145 </thead>
1146 <tbody>
1147 <tr>
1148 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1149 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1150 </tr>
1151 </tbody>
1152 </table>
1153 </div>
1154 <div class="sect3">
1155 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1156 <div class="ulist">
1157 <ul>
1158 <li>
1159 <p><code>application/json</code></p>
1160 </li>
1161 </ul>
1162 </div>
1163 </div>
1164 </div>
1165 <div class="sect2">
1166 <h3 id="_v2_dictionary_name_elements_shortname_delete"><a class="anchor" href="#_v2_dictionary_name_elements_shortname_delete"></a><a class="link" href="#_v2_dictionary_name_elements_shortname_delete">2.10. DELETE /v2/dictionary/{name}/elements/{shortName}</a></h3>
1167 <div class="sect3">
1168 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.10.1. Parameters</a></h4>
1169 <table class="tableblock frame-all grid-all stretch">
1170 <colgroup>
1171 <col style="width: 22.2222%;">
1172 <col style="width: 33.3333%;">
1173 <col style="width: 44.4445%;">
1174 </colgroup>
1175 <thead>
1176 <tr>
1177 <th class="tableblock halign-left valign-middle">Type</th>
1178 <th class="tableblock halign-left valign-middle">Name</th>
1179 <th class="tableblock halign-left valign-middle">Schema</th>
1180 </tr>
1181 </thead>
1182 <tbody>
1183 <tr>
1184 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1185 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1186 <em>required</em></p></td>
1187 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1188 </tr>
1189 <tr>
1190 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
1192 <em>required</em></p></td>
1193 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1194 </tr>
1195 </tbody>
1196 </table>
1197 </div>
1198 <div class="sect3">
1199 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1200 <table class="tableblock frame-all grid-all stretch">
1201 <colgroup>
1202 <col style="width: 33.3333%;">
1203 <col style="width: 66.6667%;">
1204 </colgroup>
1205 <thead>
1206 <tr>
1207 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1208 <th class="tableblock halign-left valign-middle">Schema</th>
1209 </tr>
1210 </thead>
1211 <tbody>
1212 <tr>
1213 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1214 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1215 </tr>
1216 </tbody>
1217 </table>
1218 </div>
1219 <div class="sect3">
1220 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.3. Produces</a></h4>
1221 <div class="ulist">
1222 <ul>
1223 <li>
1224 <p><code>application/json</code></p>
1225 </li>
1226 </ul>
1227 </div>
1228 </div>
1229 </div>
1230 <div class="sect2">
1231 <h3 id="_route14"><a class="anchor" href="#_route14"></a><a class="link" href="#_route14">2.11. PUT /v2/loop/delete/{loopName}</a></h3>
1232 <div class="sect3">
1233 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.11.1. Parameters</a></h4>
1234 <table class="tableblock frame-all grid-all stretch">
1235 <colgroup>
1236 <col style="width: 22.2222%;">
1237 <col style="width: 33.3333%;">
1238 <col style="width: 44.4445%;">
1239 </colgroup>
1240 <thead>
1241 <tr>
1242 <th class="tableblock halign-left valign-middle">Type</th>
1243 <th class="tableblock halign-left valign-middle">Name</th>
1244 <th class="tableblock halign-left valign-middle">Schema</th>
1245 </tr>
1246 </thead>
1247 <tbody>
1248 <tr>
1249 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1250 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1251 <em>required</em></p></td>
1252 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1253 </tr>
1254 </tbody>
1255 </table>
1256 </div>
1257 <div class="sect3">
1258 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.2. Responses</a></h4>
1259 <table class="tableblock frame-all grid-all stretch">
1260 <colgroup>
1261 <col style="width: 33.3333%;">
1262 <col style="width: 66.6667%;">
1263 </colgroup>
1264 <thead>
1265 <tr>
1266 <th class="tableblock halign-left valign-middle">HTTP Code</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>200</strong></p></td>
1273 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1274 </tr>
1275 </tbody>
1276 </table>
1277 </div>
1278 </div>
1279 <div class="sect2">
1280 <h3 id="_route8"><a class="anchor" href="#_route8"></a><a class="link" href="#_route8">2.12. PUT /v2/loop/deploy/{loopName}</a></h3>
1281 <div class="sect3">
1282 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.12.1. Parameters</a></h4>
1283 <table class="tableblock frame-all grid-all stretch">
1284 <colgroup>
1285 <col style="width: 22.2222%;">
1286 <col style="width: 33.3333%;">
1287 <col style="width: 44.4445%;">
1288 </colgroup>
1289 <thead>
1290 <tr>
1291 <th class="tableblock halign-left valign-middle">Type</th>
1292 <th class="tableblock halign-left valign-middle">Name</th>
1293 <th class="tableblock halign-left valign-middle">Schema</th>
1294 </tr>
1295 </thead>
1296 <tbody>
1297 <tr>
1298 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1299 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1300 <em>required</em></p></td>
1301 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1302 </tr>
1303 </tbody>
1304 </table>
1305 </div>
1306 <div class="sect3">
1307 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1308 <table class="tableblock frame-all grid-all stretch">
1309 <colgroup>
1310 <col style="width: 10%;">
1311 <col style="width: 70%;">
1312 <col style="width: 20%;">
1313 </colgroup>
1314 <thead>
1315 <tr>
1316 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1317 <th class="tableblock halign-left valign-middle">Description</th>
1318 <th class="tableblock halign-left valign-middle">Schema</th>
1319 </tr>
1320 </thead>
1321 <tbody>
1322 <tr>
1323 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1324 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1325 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1326 </tr>
1327 </tbody>
1328 </table>
1329 </div>
1330 <div class="sect3">
1331 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.12.3. Produces</a></h4>
1332 <div class="ulist">
1333 <ul>
1334 <li>
1335 <p><code>application/json</code></p>
1336 </li>
1337 </ul>
1338 </div>
1339 </div>
1340 </div>
1341 <div class="sect2">
1342 <h3 id="_route2"><a class="anchor" href="#_route2"></a><a class="link" href="#_route2">2.13. GET /v2/loop/getAllNames</a></h3>
1343 <div class="sect3">
1344 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.1. Responses</a></h4>
1345 <table class="tableblock frame-all grid-all stretch">
1346 <colgroup>
1347 <col style="width: 10%;">
1348 <col style="width: 70%;">
1349 <col style="width: 20%;">
1350 </colgroup>
1351 <thead>
1352 <tr>
1353 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1354 <th class="tableblock halign-left valign-middle">Description</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">Output type</p></td>
1362 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
1363 </tr>
1364 </tbody>
1365 </table>
1366 </div>
1367 <div class="sect3">
1368 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.13.2. Produces</a></h4>
1369 <div class="ulist">
1370 <ul>
1371 <li>
1372 <p><code>application/json</code></p>
1373 </li>
1374 </ul>
1375 </div>
1376 </div>
1377 </div>
1378 <div class="sect2">
1379 <h3 id="_route15"><a class="anchor" href="#_route15"></a><a class="link" href="#_route15">2.14. GET /v2/loop/getstatus/{loopName}</a></h3>
1380 <div class="sect3">
1381 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.14.1. Parameters</a></h4>
1382 <table class="tableblock frame-all grid-all stretch">
1383 <colgroup>
1384 <col style="width: 22.2222%;">
1385 <col style="width: 33.3333%;">
1386 <col style="width: 44.4445%;">
1387 </colgroup>
1388 <thead>
1389 <tr>
1390 <th class="tableblock halign-left valign-middle">Type</th>
1391 <th class="tableblock halign-left valign-middle">Name</th>
1392 <th class="tableblock halign-left valign-middle">Schema</th>
1393 </tr>
1394 </thead>
1395 <tbody>
1396 <tr>
1397 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1398 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1399 <em>required</em></p></td>
1400 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1401 </tr>
1402 </tbody>
1403 </table>
1404 </div>
1405 <div class="sect3">
1406 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1407 <table class="tableblock frame-all grid-all stretch">
1408 <colgroup>
1409 <col style="width: 10%;">
1410 <col style="width: 70%;">
1411 <col style="width: 20%;">
1412 </colgroup>
1413 <thead>
1414 <tr>
1415 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1416 <th class="tableblock halign-left valign-middle">Description</th>
1417 <th class="tableblock halign-left valign-middle">Schema</th>
1418 </tr>
1419 </thead>
1420 <tbody>
1421 <tr>
1422 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1423 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1424 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1425 </tr>
1426 </tbody>
1427 </table>
1428 </div>
1429 <div class="sect3">
1430 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.14.3. Produces</a></h4>
1431 <div class="ulist">
1432 <ul>
1433 <li>
1434 <p><code>application/json</code></p>
1435 </li>
1436 </ul>
1437 </div>
1438 </div>
1439 </div>
1440 <div class="sect2">
1441 <h3 id="_route9"><a class="anchor" href="#_route9"></a><a class="link" href="#_route9">2.15. PUT /v2/loop/refreshOpPolicyJsonSchema/{loopName}</a></h3>
1442 <div class="sect3">
1443 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.15.1. Parameters</a></h4>
1444 <table class="tableblock frame-all grid-all stretch">
1445 <colgroup>
1446 <col style="width: 22.2222%;">
1447 <col style="width: 33.3333%;">
1448 <col style="width: 44.4445%;">
1449 </colgroup>
1450 <thead>
1451 <tr>
1452 <th class="tableblock halign-left valign-middle">Type</th>
1453 <th class="tableblock halign-left valign-middle">Name</th>
1454 <th class="tableblock halign-left valign-middle">Schema</th>
1455 </tr>
1456 </thead>
1457 <tbody>
1458 <tr>
1459 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1460 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1461 <em>required</em></p></td>
1462 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1463 </tr>
1464 </tbody>
1465 </table>
1466 </div>
1467 <div class="sect3">
1468 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.2. Responses</a></h4>
1469 <table class="tableblock frame-all grid-all stretch">
1470 <colgroup>
1471 <col style="width: 10%;">
1472 <col style="width: 70%;">
1473 <col style="width: 20%;">
1474 </colgroup>
1475 <thead>
1476 <tr>
1477 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1478 <th class="tableblock halign-left valign-middle">Description</th>
1479 <th class="tableblock halign-left valign-middle">Schema</th>
1480 </tr>
1481 </thead>
1482 <tbody>
1483 <tr>
1484 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1485 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1486 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1487 </tr>
1488 </tbody>
1489 </table>
1490 </div>
1491 <div class="sect3">
1492 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.15.3. Produces</a></h4>
1493 <div class="ulist">
1494 <ul>
1495 <li>
1496 <p><code>application/json</code></p>
1497 </li>
1498 </ul>
1499 </div>
1500 </div>
1501 </div>
1502 <div class="sect2">
1503 <h3 id="_route12"><a class="anchor" href="#_route12"></a><a class="link" href="#_route12">2.16. PUT /v2/loop/restart/{loopName}</a></h3>
1504 <div class="sect3">
1505 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.16.1. Parameters</a></h4>
1506 <table class="tableblock frame-all grid-all stretch">
1507 <colgroup>
1508 <col style="width: 22.2222%;">
1509 <col style="width: 33.3333%;">
1510 <col style="width: 44.4445%;">
1511 </colgroup>
1512 <thead>
1513 <tr>
1514 <th class="tableblock halign-left valign-middle">Type</th>
1515 <th class="tableblock halign-left valign-middle">Name</th>
1516 <th class="tableblock halign-left valign-middle">Schema</th>
1517 </tr>
1518 </thead>
1519 <tbody>
1520 <tr>
1521 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1522 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1523 <em>required</em></p></td>
1524 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1525 </tr>
1526 </tbody>
1527 </table>
1528 </div>
1529 <div class="sect3">
1530 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1531 <table class="tableblock frame-all grid-all stretch">
1532 <colgroup>
1533 <col style="width: 10%;">
1534 <col style="width: 70%;">
1535 <col style="width: 20%;">
1536 </colgroup>
1537 <thead>
1538 <tr>
1539 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1540 <th class="tableblock halign-left valign-middle">Description</th>
1541 <th class="tableblock halign-left valign-middle">Schema</th>
1542 </tr>
1543 </thead>
1544 <tbody>
1545 <tr>
1546 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1547 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1548 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1549 </tr>
1550 </tbody>
1551 </table>
1552 </div>
1553 <div class="sect3">
1554 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.16.3. Produces</a></h4>
1555 <div class="ulist">
1556 <ul>
1557 <li>
1558 <p><code>application/json</code></p>
1559 </li>
1560 </ul>
1561 </div>
1562 </div>
1563 </div>
1564 <div class="sect2">
1565 <h3 id="_route11"><a class="anchor" href="#_route11"></a><a class="link" href="#_route11">2.17. PUT /v2/loop/stop/{loopName}</a></h3>
1566 <div class="sect3">
1567 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.17.1. Parameters</a></h4>
1568 <table class="tableblock frame-all grid-all stretch">
1569 <colgroup>
1570 <col style="width: 22.2222%;">
1571 <col style="width: 33.3333%;">
1572 <col style="width: 44.4445%;">
1573 </colgroup>
1574 <thead>
1575 <tr>
1576 <th class="tableblock halign-left valign-middle">Type</th>
1577 <th class="tableblock halign-left valign-middle">Name</th>
1578 <th class="tableblock halign-left valign-middle">Schema</th>
1579 </tr>
1580 </thead>
1581 <tbody>
1582 <tr>
1583 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1584 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1585 <em>required</em></p></td>
1586 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1587 </tr>
1588 </tbody>
1589 </table>
1590 </div>
1591 <div class="sect3">
1592 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1593 <table class="tableblock frame-all grid-all stretch">
1594 <colgroup>
1595 <col style="width: 10%;">
1596 <col style="width: 70%;">
1597 <col style="width: 20%;">
1598 </colgroup>
1599 <thead>
1600 <tr>
1601 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1602 <th class="tableblock halign-left valign-middle">Description</th>
1603 <th class="tableblock halign-left valign-middle">Schema</th>
1604 </tr>
1605 </thead>
1606 <tbody>
1607 <tr>
1608 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1609 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1610 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1611 </tr>
1612 </tbody>
1613 </table>
1614 </div>
1615 <div class="sect3">
1616 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.17.3. Produces</a></h4>
1617 <div class="ulist">
1618 <ul>
1619 <li>
1620 <p><code>application/json</code></p>
1621 </li>
1622 </ul>
1623 </div>
1624 </div>
1625 </div>
1626 <div class="sect2">
1627 <h3 id="_route13"><a class="anchor" href="#_route13"></a><a class="link" href="#_route13">2.18. PUT /v2/loop/submit/{loopName}</a></h3>
1628 <div class="sect3">
1629 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.18.1. Parameters</a></h4>
1630 <table class="tableblock frame-all grid-all stretch">
1631 <colgroup>
1632 <col style="width: 22.2222%;">
1633 <col style="width: 33.3333%;">
1634 <col style="width: 44.4445%;">
1635 </colgroup>
1636 <thead>
1637 <tr>
1638 <th class="tableblock halign-left valign-middle">Type</th>
1639 <th class="tableblock halign-left valign-middle">Name</th>
1640 <th class="tableblock halign-left valign-middle">Schema</th>
1641 </tr>
1642 </thead>
1643 <tbody>
1644 <tr>
1645 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1646 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1647 <em>required</em></p></td>
1648 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1649 </tr>
1650 </tbody>
1651 </table>
1652 </div>
1653 <div class="sect3">
1654 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.2. Responses</a></h4>
1655 <table class="tableblock frame-all grid-all stretch">
1656 <colgroup>
1657 <col style="width: 10%;">
1658 <col style="width: 70%;">
1659 <col style="width: 20%;">
1660 </colgroup>
1661 <thead>
1662 <tr>
1663 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1664 <th class="tableblock halign-left valign-middle">Description</th>
1665 <th class="tableblock halign-left valign-middle">Schema</th>
1666 </tr>
1667 </thead>
1668 <tbody>
1669 <tr>
1670 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1671 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1672 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1673 </tr>
1674 </tbody>
1675 </table>
1676 </div>
1677 <div class="sect3">
1678 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.18.3. Produces</a></h4>
1679 <div class="ulist">
1680 <ul>
1681 <li>
1682 <p><code>application/json</code></p>
1683 </li>
1684 </ul>
1685 </div>
1686 </div>
1687 </div>
1688 <div class="sect2">
1689 <h3 id="_route4"><a class="anchor" href="#_route4"></a><a class="link" href="#_route4">2.19. GET /v2/loop/svgRepresentation/{loopName}</a></h3>
1690 <div class="sect3">
1691 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.19.1. Parameters</a></h4>
1692 <table class="tableblock frame-all grid-all stretch">
1693 <colgroup>
1694 <col style="width: 22.2222%;">
1695 <col style="width: 33.3333%;">
1696 <col style="width: 44.4445%;">
1697 </colgroup>
1698 <thead>
1699 <tr>
1700 <th class="tableblock halign-left valign-middle">Type</th>
1701 <th class="tableblock halign-left valign-middle">Name</th>
1702 <th class="tableblock halign-left valign-middle">Schema</th>
1703 </tr>
1704 </thead>
1705 <tbody>
1706 <tr>
1707 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1708 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1709 <em>required</em></p></td>
1710 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1711 </tr>
1712 </tbody>
1713 </table>
1714 </div>
1715 <div class="sect3">
1716 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1717 <table class="tableblock frame-all grid-all stretch">
1718 <colgroup>
1719 <col style="width: 10%;">
1720 <col style="width: 70%;">
1721 <col style="width: 20%;">
1722 </colgroup>
1723 <thead>
1724 <tr>
1725 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1726 <th class="tableblock halign-left valign-middle">Description</th>
1727 <th class="tableblock halign-left valign-middle">Schema</th>
1728 </tr>
1729 </thead>
1730 <tbody>
1731 <tr>
1732 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1733 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1734 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1735 </tr>
1736 </tbody>
1737 </table>
1738 </div>
1739 <div class="sect3">
1740 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.19.3. Produces</a></h4>
1741 <div class="ulist">
1742 <ul>
1743 <li>
1744 <p><code>application/xml</code></p>
1745 </li>
1746 </ul>
1747 </div>
1748 </div>
1749 </div>
1750 <div class="sect2">
1751 <h3 id="_route10"><a class="anchor" href="#_route10"></a><a class="link" href="#_route10">2.20. PUT /v2/loop/undeploy/{loopName}</a></h3>
1752 <div class="sect3">
1753 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.20.1. Parameters</a></h4>
1754 <table class="tableblock frame-all grid-all stretch">
1755 <colgroup>
1756 <col style="width: 22.2222%;">
1757 <col style="width: 33.3333%;">
1758 <col style="width: 44.4445%;">
1759 </colgroup>
1760 <thead>
1761 <tr>
1762 <th class="tableblock halign-left valign-middle">Type</th>
1763 <th class="tableblock halign-left valign-middle">Name</th>
1764 <th class="tableblock halign-left valign-middle">Schema</th>
1765 </tr>
1766 </thead>
1767 <tbody>
1768 <tr>
1769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1770 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1771 <em>required</em></p></td>
1772 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1773 </tr>
1774 </tbody>
1775 </table>
1776 </div>
1777 <div class="sect3">
1778 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.2. Responses</a></h4>
1779 <table class="tableblock frame-all grid-all stretch">
1780 <colgroup>
1781 <col style="width: 10%;">
1782 <col style="width: 70%;">
1783 <col style="width: 20%;">
1784 </colgroup>
1785 <thead>
1786 <tr>
1787 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1788 <th class="tableblock halign-left valign-middle">Description</th>
1789 <th class="tableblock halign-left valign-middle">Schema</th>
1790 </tr>
1791 </thead>
1792 <tbody>
1793 <tr>
1794 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1795 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1796 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1797 </tr>
1798 </tbody>
1799 </table>
1800 </div>
1801 <div class="sect3">
1802 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.20.3. Produces</a></h4>
1803 <div class="ulist">
1804 <ul>
1805 <li>
1806 <p><code>application/json</code></p>
1807 </li>
1808 </ul>
1809 </div>
1810 </div>
1811 </div>
1812 <div class="sect2">
1813 <h3 id="_route5"><a class="anchor" href="#_route5"></a><a class="link" href="#_route5">2.21. POST /v2/loop/updateGlobalProperties/{loopName}</a></h3>
1814 <div class="sect3">
1815 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.21.1. Parameters</a></h4>
1816 <table class="tableblock frame-all grid-all stretch">
1817 <colgroup>
1818 <col style="width: 22.2222%;">
1819 <col style="width: 33.3333%;">
1820 <col style="width: 44.4445%;">
1821 </colgroup>
1822 <thead>
1823 <tr>
1824 <th class="tableblock halign-left valign-middle">Type</th>
1825 <th class="tableblock halign-left valign-middle">Name</th>
1826 <th class="tableblock halign-left valign-middle">Schema</th>
1827 </tr>
1828 </thead>
1829 <tbody>
1830 <tr>
1831 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1832 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1833 <em>required</em></p></td>
1834 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1835 </tr>
1836 <tr>
1837 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1838 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1839 <em>required</em></p></td>
1840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
1841 </tr>
1842 </tbody>
1843 </table>
1844 </div>
1845 <div class="sect3">
1846 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
1847 <table class="tableblock frame-all grid-all stretch">
1848 <colgroup>
1849 <col style="width: 10%;">
1850 <col style="width: 70%;">
1851 <col style="width: 20%;">
1852 </colgroup>
1853 <thead>
1854 <tr>
1855 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1856 <th class="tableblock halign-left valign-middle">Description</th>
1857 <th class="tableblock halign-left valign-middle">Schema</th>
1858 </tr>
1859 </thead>
1860 <tbody>
1861 <tr>
1862 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1863 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1864 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
1865 </tr>
1866 </tbody>
1867 </table>
1868 </div>
1869 <div class="sect3">
1870 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.21.3. Consumes</a></h4>
1871 <div class="ulist">
1872 <ul>
1873 <li>
1874 <p><code>application/json</code></p>
1875 </li>
1876 </ul>
1877 </div>
1878 </div>
1879 <div class="sect3">
1880 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.21.4. Produces</a></h4>
1881 <div class="ulist">
1882 <ul>
1883 <li>
1884 <p><code>application/json</code></p>
1885 </li>
1886 </ul>
1887 </div>
1888 </div>
1889 </div>
1890 <div class="sect2">
1891 <h3 id="_route7"><a class="anchor" href="#_route7"></a><a class="link" href="#_route7">2.22. POST /v2/loop/updateMicroservicePolicy/{loopName}</a></h3>
1892 <div class="sect3">
1893 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.22.1. Parameters</a></h4>
1894 <table class="tableblock frame-all grid-all stretch">
1895 <colgroup>
1896 <col style="width: 22.2222%;">
1897 <col style="width: 33.3333%;">
1898 <col style="width: 44.4445%;">
1899 </colgroup>
1900 <thead>
1901 <tr>
1902 <th class="tableblock halign-left valign-middle">Type</th>
1903 <th class="tableblock halign-left valign-middle">Name</th>
1904 <th class="tableblock halign-left valign-middle">Schema</th>
1905 </tr>
1906 </thead>
1907 <tbody>
1908 <tr>
1909 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1910 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1911 <em>required</em></p></td>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1913 </tr>
1914 <tr>
1915 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1916 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1917 <em>required</em></p></td>
1918 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1919 </tr>
1920 </tbody>
1921 </table>
1922 </div>
1923 <div class="sect3">
1924 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.2. Responses</a></h4>
1925 <table class="tableblock frame-all grid-all stretch">
1926 <colgroup>
1927 <col style="width: 10%;">
1928 <col style="width: 70%;">
1929 <col style="width: 20%;">
1930 </colgroup>
1931 <thead>
1932 <tr>
1933 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1934 <th class="tableblock halign-left valign-middle">Description</th>
1935 <th class="tableblock halign-left valign-middle">Schema</th>
1936 </tr>
1937 </thead>
1938 <tbody>
1939 <tr>
1940 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1941 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_microservicepolicy">MicroServicePolicy</a></p></td>
1943 </tr>
1944 </tbody>
1945 </table>
1946 </div>
1947 <div class="sect3">
1948 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.22.3. Consumes</a></h4>
1949 <div class="ulist">
1950 <ul>
1951 <li>
1952 <p><code>application/json</code></p>
1953 </li>
1954 </ul>
1955 </div>
1956 </div>
1957 <div class="sect3">
1958 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.22.4. Produces</a></h4>
1959 <div class="ulist">
1960 <ul>
1961 <li>
1962 <p><code>application/json</code></p>
1963 </li>
1964 </ul>
1965 </div>
1966 </div>
1967 </div>
1968 <div class="sect2">
1969 <h3 id="_route6"><a class="anchor" href="#_route6"></a><a class="link" href="#_route6">2.23. POST /v2/loop/updateOperationalPolicies/{loopName}</a></h3>
1970 <div class="sect3">
1971 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.23.1. Parameters</a></h4>
1972 <table class="tableblock frame-all grid-all stretch">
1973 <colgroup>
1974 <col style="width: 22.2222%;">
1975 <col style="width: 33.3333%;">
1976 <col style="width: 44.4445%;">
1977 </colgroup>
1978 <thead>
1979 <tr>
1980 <th class="tableblock halign-left valign-middle">Type</th>
1981 <th class="tableblock halign-left valign-middle">Name</th>
1982 <th class="tableblock halign-left valign-middle">Schema</th>
1983 </tr>
1984 </thead>
1985 <tbody>
1986 <tr>
1987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1988 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
1989 <em>required</em></p></td>
1990 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1991 </tr>
1992 <tr>
1993 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1994 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1995 <em>required</em></p></td>
1996 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
1997 </tr>
1998 </tbody>
1999 </table>
2000 </div>
2001 <div class="sect3">
2002 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.2. Responses</a></h4>
2003 <table class="tableblock frame-all grid-all stretch">
2004 <colgroup>
2005 <col style="width: 10%;">
2006 <col style="width: 70%;">
2007 <col style="width: 20%;">
2008 </colgroup>
2009 <thead>
2010 <tr>
2011 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2012 <th class="tableblock halign-left valign-middle">Description</th>
2013 <th class="tableblock halign-left valign-middle">Schema</th>
2014 </tr>
2015 </thead>
2016 <tbody>
2017 <tr>
2018 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2019 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2020 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2021 </tr>
2022 </tbody>
2023 </table>
2024 </div>
2025 <div class="sect3">
2026 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.23.3. Consumes</a></h4>
2027 <div class="ulist">
2028 <ul>
2029 <li>
2030 <p><code>application/json</code></p>
2031 </li>
2032 </ul>
2033 </div>
2034 </div>
2035 <div class="sect3">
2036 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.23.4. Produces</a></h4>
2037 <div class="ulist">
2038 <ul>
2039 <li>
2040 <p><code>application/json</code></p>
2041 </li>
2042 </ul>
2043 </div>
2044 </div>
2045 </div>
2046 <div class="sect2">
2047 <h3 id="_route3"><a class="anchor" href="#_route3"></a><a class="link" href="#_route3">2.24. GET /v2/loop/{loopName}</a></h3>
2048 <div class="sect3">
2049 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.24.1. Parameters</a></h4>
2050 <table class="tableblock frame-all grid-all stretch">
2051 <colgroup>
2052 <col style="width: 22.2222%;">
2053 <col style="width: 33.3333%;">
2054 <col style="width: 44.4445%;">
2055 </colgroup>
2056 <thead>
2057 <tr>
2058 <th class="tableblock halign-left valign-middle">Type</th>
2059 <th class="tableblock halign-left valign-middle">Name</th>
2060 <th class="tableblock halign-left valign-middle">Schema</th>
2061 </tr>
2062 </thead>
2063 <tbody>
2064 <tr>
2065 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2066 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopName</strong><br>
2067 <em>required</em></p></td>
2068 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2069 </tr>
2070 </tbody>
2071 </table>
2072 </div>
2073 <div class="sect3">
2074 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.2. Responses</a></h4>
2075 <table class="tableblock frame-all grid-all stretch">
2076 <colgroup>
2077 <col style="width: 10%;">
2078 <col style="width: 70%;">
2079 <col style="width: 20%;">
2080 </colgroup>
2081 <thead>
2082 <tr>
2083 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2084 <th class="tableblock halign-left valign-middle">Description</th>
2085 <th class="tableblock halign-left valign-middle">Schema</th>
2086 </tr>
2087 </thead>
2088 <tbody>
2089 <tr>
2090 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2091 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2092 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
2093 </tr>
2094 </tbody>
2095 </table>
2096 </div>
2097 <div class="sect3">
2098 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.24.3. Produces</a></h4>
2099 <div class="ulist">
2100 <ul>
2101 <li>
2102 <p><code>application/json</code></p>
2103 </li>
2104 </ul>
2105 </div>
2106 </div>
2107 </div>
2108 <div class="sect2">
2109 <h3 id="_route25"><a class="anchor" href="#_route25"></a><a class="link" href="#_route25">2.25. GET /v2/policyToscaModels</a></h3>
2110 <div class="sect3">
2111 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.1. Responses</a></h4>
2112 <table class="tableblock frame-all grid-all stretch">
2113 <colgroup>
2114 <col style="width: 10%;">
2115 <col style="width: 70%;">
2116 <col style="width: 20%;">
2117 </colgroup>
2118 <thead>
2119 <tr>
2120 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2121 <th class="tableblock halign-left valign-middle">Description</th>
2122 <th class="tableblock halign-left valign-middle">Schema</th>
2123 </tr>
2124 </thead>
2125 <tbody>
2126 <tr>
2127 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2128 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2129 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2130 </tr>
2131 </tbody>
2132 </table>
2133 </div>
2134 <div class="sect3">
2135 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.25.2. Produces</a></h4>
2136 <div class="ulist">
2137 <ul>
2138 <li>
2139 <p><code>application/json</code></p>
2140 </li>
2141 </ul>
2142 </div>
2143 </div>
2144 </div>
2145 <div class="sect2">
2146 <h3 id="_v2_policytoscamodels_yaml_policymodeltype_get"><a class="anchor" href="#_v2_policytoscamodels_yaml_policymodeltype_get"></a><a class="link" href="#_v2_policytoscamodels_yaml_policymodeltype_get">2.26. GET /v2/policyToscaModels/yaml/{policyModelType}</a></h3>
2147 <div class="sect3">
2148 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.26.1. Parameters</a></h4>
2149 <table class="tableblock frame-all grid-all stretch">
2150 <colgroup>
2151 <col style="width: 22.2222%;">
2152 <col style="width: 33.3333%;">
2153 <col style="width: 44.4445%;">
2154 </colgroup>
2155 <thead>
2156 <tr>
2157 <th class="tableblock halign-left valign-middle">Type</th>
2158 <th class="tableblock halign-left valign-middle">Name</th>
2159 <th class="tableblock halign-left valign-middle">Schema</th>
2160 </tr>
2161 </thead>
2162 <tbody>
2163 <tr>
2164 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2165 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2166 <em>required</em></p></td>
2167 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2168 </tr>
2169 </tbody>
2170 </table>
2171 </div>
2172 <div class="sect3">
2173 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2174 <table class="tableblock frame-all grid-all stretch">
2175 <colgroup>
2176 <col style="width: 10%;">
2177 <col style="width: 70%;">
2178 <col style="width: 20%;">
2179 </colgroup>
2180 <thead>
2181 <tr>
2182 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2183 <th class="tableblock halign-left valign-middle">Description</th>
2184 <th class="tableblock halign-left valign-middle">Schema</th>
2185 </tr>
2186 </thead>
2187 <tbody>
2188 <tr>
2189 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2190 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2191 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2192 </tr>
2193 </tbody>
2194 </table>
2195 </div>
2196 <div class="sect3">
2197 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.26.3. Produces</a></h4>
2198 <div class="ulist">
2199 <ul>
2200 <li>
2201 <p><code>application/json</code></p>
2202 </li>
2203 </ul>
2204 </div>
2205 </div>
2206 </div>
2207 <div class="sect2">
2208 <h3 id="_v2_policytoscamodels_policymodeltype_get"><a class="anchor" href="#_v2_policytoscamodels_policymodeltype_get"></a><a class="link" href="#_v2_policytoscamodels_policymodeltype_get">2.27. GET /v2/policyToscaModels/{policyModelType}</a></h3>
2209 <div class="sect3">
2210 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a><a class="link" href="#_parameters_20">2.27.1. Parameters</a></h4>
2211 <table class="tableblock frame-all grid-all stretch">
2212 <colgroup>
2213 <col style="width: 22.2222%;">
2214 <col style="width: 33.3333%;">
2215 <col style="width: 44.4445%;">
2216 </colgroup>
2217 <thead>
2218 <tr>
2219 <th class="tableblock halign-left valign-middle">Type</th>
2220 <th class="tableblock halign-left valign-middle">Name</th>
2221 <th class="tableblock halign-left valign-middle">Schema</th>
2222 </tr>
2223 </thead>
2224 <tbody>
2225 <tr>
2226 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2227 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2228 <em>required</em></p></td>
2229 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2230 </tr>
2231 </tbody>
2232 </table>
2233 </div>
2234 <div class="sect3">
2235 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.2. Responses</a></h4>
2236 <table class="tableblock frame-all grid-all stretch">
2237 <colgroup>
2238 <col style="width: 10%;">
2239 <col style="width: 70%;">
2240 <col style="width: 20%;">
2241 </colgroup>
2242 <thead>
2243 <tr>
2244 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2245 <th class="tableblock halign-left valign-middle">Description</th>
2246 <th class="tableblock halign-left valign-middle">Schema</th>
2247 </tr>
2248 </thead>
2249 <tbody>
2250 <tr>
2251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2252 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2254 </tr>
2255 </tbody>
2256 </table>
2257 </div>
2258 <div class="sect3">
2259 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.27.3. Produces</a></h4>
2260 <div class="ulist">
2261 <ul>
2262 <li>
2263 <p><code>application/json</code></p>
2264 </li>
2265 </ul>
2266 </div>
2267 </div>
2268 </div>
2269 <div class="sect2">
2270 <h3 id="_route26"><a class="anchor" href="#_route26"></a><a class="link" href="#_route26">2.28. PUT /v2/policyToscaModels/{policyModelType}</a></h3>
2271 <div class="sect3">
2272 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a><a class="link" href="#_parameters_21">2.28.1. Parameters</a></h4>
2273 <table class="tableblock frame-all grid-all stretch">
2274 <colgroup>
2275 <col style="width: 22.2222%;">
2276 <col style="width: 33.3333%;">
2277 <col style="width: 44.4445%;">
2278 </colgroup>
2279 <thead>
2280 <tr>
2281 <th class="tableblock halign-left valign-middle">Type</th>
2282 <th class="tableblock halign-left valign-middle">Name</th>
2283 <th class="tableblock halign-left valign-middle">Schema</th>
2284 </tr>
2285 </thead>
2286 <tbody>
2287 <tr>
2288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2289 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
2290 <em>required</em></p></td>
2291 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2292 </tr>
2293 <tr>
2294 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2295 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2296 <em>required</em></p></td>
2297 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2298 </tr>
2299 </tbody>
2300 </table>
2301 </div>
2302 <div class="sect3">
2303 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.2. Responses</a></h4>
2304 <table class="tableblock frame-all grid-all stretch">
2305 <colgroup>
2306 <col style="width: 10%;">
2307 <col style="width: 70%;">
2308 <col style="width: 20%;">
2309 </colgroup>
2310 <thead>
2311 <tr>
2312 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2313 <th class="tableblock halign-left valign-middle">Description</th>
2314 <th class="tableblock halign-left valign-middle">Schema</th>
2315 </tr>
2316 </thead>
2317 <tbody>
2318 <tr>
2319 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2320 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2321 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
2322 </tr>
2323 </tbody>
2324 </table>
2325 </div>
2326 <div class="sect3">
2327 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.28.3. Consumes</a></h4>
2328 <div class="ulist">
2329 <ul>
2330 <li>
2331 <p><code>plain/text</code></p>
2332 </li>
2333 </ul>
2334 </div>
2335 </div>
2336 <div class="sect3">
2337 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.28.4. Produces</a></h4>
2338 <div class="ulist">
2339 <ul>
2340 <li>
2341 <p><code>application/json</code></p>
2342 </li>
2343 </ul>
2344 </div>
2345 </div>
2346 </div>
2347 <div class="sect2">
2348 <h3 id="_route29"><a class="anchor" href="#_route29"></a><a class="link" href="#_route29">2.29. GET /v2/templates</a></h3>
2349 <div class="sect3">
2350 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.1. Responses</a></h4>
2351 <table class="tableblock frame-all grid-all stretch">
2352 <colgroup>
2353 <col style="width: 10%;">
2354 <col style="width: 70%;">
2355 <col style="width: 20%;">
2356 </colgroup>
2357 <thead>
2358 <tr>
2359 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2360 <th class="tableblock halign-left valign-middle">Description</th>
2361 <th class="tableblock halign-left valign-middle">Schema</th>
2362 </tr>
2363 </thead>
2364 <tbody>
2365 <tr>
2366 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2367 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2369 </tr>
2370 </tbody>
2371 </table>
2372 </div>
2373 <div class="sect3">
2374 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.29.2. Produces</a></h4>
2375 <div class="ulist">
2376 <ul>
2377 <li>
2378 <p><code>application/json</code></p>
2379 </li>
2380 </ul>
2381 </div>
2382 </div>
2383 </div>
2384 <div class="sect2">
2385 <h3 id="_v2_templates_names_get"><a class="anchor" href="#_v2_templates_names_get"></a><a class="link" href="#_v2_templates_names_get">2.30. GET /v2/templates/names</a></h3>
2386 <div class="sect3">
2387 <h4 id="_responses_30"><a class="anchor" href="#_responses_30"></a><a class="link" href="#_responses_30">2.30.1. Responses</a></h4>
2388 <table class="tableblock frame-all grid-all stretch">
2389 <colgroup>
2390 <col style="width: 10%;">
2391 <col style="width: 70%;">
2392 <col style="width: 20%;">
2393 </colgroup>
2394 <thead>
2395 <tr>
2396 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2397 <th class="tableblock halign-left valign-middle">Description</th>
2398 <th class="tableblock halign-left valign-middle">Schema</th>
2399 </tr>
2400 </thead>
2401 <tbody>
2402 <tr>
2403 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2404 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2405 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
2406 </tr>
2407 </tbody>
2408 </table>
2409 </div>
2410 <div class="sect3">
2411 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.30.2. Produces</a></h4>
2412 <div class="ulist">
2413 <ul>
2414 <li>
2415 <p><code>application/json</code></p>
2416 </li>
2417 </ul>
2418 </div>
2419 </div>
2420 </div>
2421 <div class="sect2">
2422 <h3 id="_v2_templates_templatename_get"><a class="anchor" href="#_v2_templates_templatename_get"></a><a class="link" href="#_v2_templates_templatename_get">2.31. GET /v2/templates/{templateName}</a></h3>
2423 <div class="sect3">
2424 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a><a class="link" href="#_parameters_22">2.31.1. Parameters</a></h4>
2425 <table class="tableblock frame-all grid-all stretch">
2426 <colgroup>
2427 <col style="width: 22.2222%;">
2428 <col style="width: 33.3333%;">
2429 <col style="width: 44.4445%;">
2430 </colgroup>
2431 <thead>
2432 <tr>
2433 <th class="tableblock halign-left valign-middle">Type</th>
2434 <th class="tableblock halign-left valign-middle">Name</th>
2435 <th class="tableblock halign-left valign-middle">Schema</th>
2436 </tr>
2437 </thead>
2438 <tbody>
2439 <tr>
2440 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2441 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2442 <em>required</em></p></td>
2443 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2444 </tr>
2445 </tbody>
2446 </table>
2447 </div>
2448 <div class="sect3">
2449 <h4 id="_responses_31"><a class="anchor" href="#_responses_31"></a><a class="link" href="#_responses_31">2.31.2. Responses</a></h4>
2450 <table class="tableblock frame-all grid-all stretch">
2451 <colgroup>
2452 <col style="width: 10%;">
2453 <col style="width: 70%;">
2454 <col style="width: 20%;">
2455 </colgroup>
2456 <thead>
2457 <tr>
2458 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2459 <th class="tableblock halign-left valign-middle">Description</th>
2460 <th class="tableblock halign-left valign-middle">Schema</th>
2461 </tr>
2462 </thead>
2463 <tbody>
2464 <tr>
2465 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2466 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2467 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
2468 </tr>
2469 </tbody>
2470 </table>
2471 </div>
2472 <div class="sect3">
2473 <h4 id="_produces_30"><a class="anchor" href="#_produces_30"></a><a class="link" href="#_produces_30">2.31.3. Produces</a></h4>
2474 <div class="ulist">
2475 <ul>
2476 <li>
2477 <p><code>application/json</code></p>
2478 </li>
2479 </ul>
2480 </div>
2481 </div>
2482 </div>
2483 </div>
2484 </div>
2485 <div class="sect1">
2486 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
2487 <div class="sectionbody">
2488 <div class="sect2">
2489 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a><a class="link" href="#_cldshealthcheck">3.1. CldsHealthCheck</a></h3>
2490 <table class="tableblock frame-all grid-all stretch">
2491 <colgroup>
2492 <col style="width: 42.8571%;">
2493 <col style="width: 57.1429%;">
2494 </colgroup>
2495 <thead>
2496 <tr>
2497 <th class="tableblock halign-left valign-middle">Name</th>
2498 <th class="tableblock halign-left valign-middle">Schema</th>
2499 </tr>
2500 </thead>
2501 <tbody>
2502 <tr>
2503 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2504 <em>optional</em></p></td>
2505 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2506 </tr>
2507 <tr>
2508 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
2509 <em>optional</em></p></td>
2510 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2511 </tr>
2512 <tr>
2513 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
2514 <em>optional</em></p></td>
2515 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2516 </tr>
2517 </tbody>
2518 </table>
2519 </div>
2520 <div class="sect2">
2521 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a><a class="link" href="#_cldsinfo">3.2. CldsInfo</a></h3>
2522 <table class="tableblock frame-all grid-all stretch">
2523 <colgroup>
2524 <col style="width: 42.8571%;">
2525 <col style="width: 57.1429%;">
2526 </colgroup>
2527 <thead>
2528 <tr>
2529 <th class="tableblock halign-left valign-middle">Name</th>
2530 <th class="tableblock halign-left valign-middle">Schema</th>
2531 </tr>
2532 </thead>
2533 <tbody>
2534 <tr>
2535 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
2536 <em>optional</em></p></td>
2537 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2538 </tr>
2539 <tr>
2540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
2541 <em>optional</em></p></td>
2542 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2543 </tr>
2544 <tr>
2545 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
2546 <em>optional</em></p></td>
2547 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2548 </tr>
2549 <tr>
2550 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTosca</strong><br>
2551 <em>optional</em></p></td>
2552 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2553 </tr>
2554 <tr>
2555 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
2556 <em>optional</em></p></td>
2557 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2558 </tr>
2559 <tr>
2560 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
2561 <em>optional</em></p></td>
2562 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2563 </tr>
2564 <tr>
2565 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTosca</strong><br>
2566 <em>optional</em></p></td>
2567 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2568 </tr>
2569 <tr>
2570 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
2571 <em>optional</em></p></td>
2572 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2573 </tr>
2574 </tbody>
2575 </table>
2576 </div>
2577 <div class="sect2">
2578 <h3 id="_dictionary"><a class="anchor" href="#_dictionary"></a><a class="link" href="#_dictionary">3.3. Dictionary</a></h3>
2579 <table class="tableblock frame-all grid-all stretch">
2580 <colgroup>
2581 <col style="width: 42.8571%;">
2582 <col style="width: 57.1429%;">
2583 </colgroup>
2584 <thead>
2585 <tr>
2586 <th class="tableblock halign-left valign-middle">Name</th>
2587 <th class="tableblock halign-left valign-middle">Schema</th>
2588 </tr>
2589 </thead>
2590 <tbody>
2591 <tr>
2592 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
2593 <em>optional</em></p></td>
2594 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2595 </tr>
2596 <tr>
2597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
2598 <em>optional</em></p></td>
2599 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2600 </tr>
2601 <tr>
2602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryElements</strong><br>
2603 <em>optional</em></p></td>
2604 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_dictionaryelement">DictionaryElement</a> &gt; array</p></td>
2605 </tr>
2606 <tr>
2607 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2608 <em>optional</em></p></td>
2609 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2610 </tr>
2611 <tr>
2612 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>secondLevelDictionary</strong><br>
2613 <em>optional</em></p></td>
2614 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2615 </tr>
2616 <tr>
2617 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionaryType</strong><br>
2618 <em>optional</em></p></td>
2619 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2620 </tr>
2621 <tr>
2622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
2623 <em>optional</em></p></td>
2624 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2625 </tr>
2626 <tr>
2627 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
2628 <em>optional</em></p></td>
2629 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2630 </tr>
2631 </tbody>
2632 </table>
2633 </div>
2634 <div class="sect2">
2635 <h3 id="_dictionaryelement"><a class="anchor" href="#_dictionaryelement"></a><a class="link" href="#_dictionaryelement">3.4. DictionaryElement</a></h3>
2636 <table class="tableblock frame-all grid-all stretch">
2637 <colgroup>
2638 <col style="width: 42.8571%;">
2639 <col style="width: 57.1429%;">
2640 </colgroup>
2641 <thead>
2642 <tr>
2643 <th class="tableblock halign-left valign-middle">Name</th>
2644 <th class="tableblock halign-left valign-middle">Schema</th>
2645 </tr>
2646 </thead>
2647 <tbody>
2648 <tr>
2649 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
2650 <em>optional</em></p></td>
2651 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2652 </tr>
2653 <tr>
2654 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
2655 <em>optional</em></p></td>
2656 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2657 </tr>
2658 <tr>
2659 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2660 <em>optional</em></p></td>
2661 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2662 </tr>
2663 <tr>
2664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2665 <em>optional</em></p></td>
2666 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2667 </tr>
2668 <tr>
2669 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
2670 <em>optional</em></p></td>
2671 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2672 </tr>
2673 <tr>
2674 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subDictionary</strong><br>
2675 <em>optional</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>type</strong><br>
2680 <em>optional</em></p></td>
2681 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2682 </tr>
2683 <tr>
2684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
2685 <em>optional</em></p></td>
2686 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2687 </tr>
2688 <tr>
2689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
2690 <em>optional</em></p></td>
2691 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2692 </tr>
2693 <tr>
2694 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByDictionaries</strong><br>
2695 <em>optional</em></p></td>
2696 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_dictionary">Dictionary</a> &gt; array</p></td>
2697 </tr>
2698 </tbody>
2699 </table>
2700 </div>
2701 <div class="sect2">
2702 <h3 id="_externalcomponent"><a class="anchor" href="#_externalcomponent"></a><a class="link" href="#_externalcomponent">3.5. ExternalComponent</a></h3>
2703 <table class="tableblock frame-all grid-all stretch">
2704 <colgroup>
2705 <col style="width: 42.8571%;">
2706 <col style="width: 57.1429%;">
2707 </colgroup>
2708 <thead>
2709 <tr>
2710 <th class="tableblock halign-left valign-middle">Name</th>
2711 <th class="tableblock halign-left valign-middle">Schema</th>
2712 </tr>
2713 </thead>
2714 <tbody>
2715 <tr>
2716 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>componentName</strong><br>
2717 <em>optional</em></p></td>
2718 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2719 </tr>
2720 <tr>
2721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
2722 <em>optional</em></p></td>
2723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_externalcomponentstate">ExternalComponentState</a></p></td>
2724 </tr>
2725 </tbody>
2726 </table>
2727 </div>
2728 <div class="sect2">
2729 <h3 id="_externalcomponentstate"><a class="anchor" href="#_externalcomponentstate"></a><a class="link" href="#_externalcomponentstate">3.6. ExternalComponentState</a></h3>
2730 <table class="tableblock frame-all grid-all stretch">
2731 <colgroup>
2732 <col style="width: 42.8571%;">
2733 <col style="width: 57.1429%;">
2734 </colgroup>
2735 <thead>
2736 <tr>
2737 <th class="tableblock halign-left valign-middle">Name</th>
2738 <th class="tableblock halign-left valign-middle">Schema</th>
2739 </tr>
2740 </thead>
2741 <tbody>
2742 <tr>
2743 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2744 <em>optional</em></p></td>
2745 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2746 </tr>
2747 <tr>
2748 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
2749 <em>optional</em></p></td>
2750 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2751 </tr>
2752 <tr>
2753 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>stateName</strong><br>
2754 <em>optional</em></p></td>
2755 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2756 </tr>
2757 </tbody>
2758 </table>
2759 </div>
2760 <div class="sect2">
2761 <h3 id="_jsonarray"><a class="anchor" href="#_jsonarray"></a><a class="link" href="#_jsonarray">3.7. JsonArray</a></h3>
2762 <table class="tableblock frame-all grid-all stretch">
2763 <colgroup>
2764 <col style="width: 42.8571%;">
2765 <col style="width: 57.1429%;">
2766 </colgroup>
2767 <thead>
2768 <tr>
2769 <th class="tableblock halign-left valign-middle">Name</th>
2770 <th class="tableblock halign-left valign-middle">Schema</th>
2771 </tr>
2772 </thead>
2773 <tbody>
2774 <tr>
2775 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2776 <em>optional</em></p></td>
2777 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2778 </tr>
2779 <tr>
2780 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2781 <em>optional</em></p></td>
2782 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2783 </tr>
2784 <tr>
2785 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2786 <em>optional</em></p></td>
2787 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2788 </tr>
2789 <tr>
2790 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2791 <em>optional</em></p></td>
2792 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2793 </tr>
2794 <tr>
2795 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2796 <em>optional</em></p></td>
2797 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2798 </tr>
2799 <tr>
2800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2801 <em>optional</em></p></td>
2802 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2803 </tr>
2804 <tr>
2805 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2806 <em>optional</em></p></td>
2807 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2808 </tr>
2809 <tr>
2810 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2811 <em>optional</em></p></td>
2812 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2813 </tr>
2814 <tr>
2815 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2816 <em>optional</em></p></td>
2817 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2818 </tr>
2819 <tr>
2820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2821 <em>optional</em></p></td>
2822 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2823 </tr>
2824 <tr>
2825 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2826 <em>optional</em></p></td>
2827 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2828 </tr>
2829 <tr>
2830 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2831 <em>optional</em></p></td>
2832 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2833 </tr>
2834 <tr>
2835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2836 <em>optional</em></p></td>
2837 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2838 </tr>
2839 <tr>
2840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2841 <em>optional</em></p></td>
2842 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2843 </tr>
2844 <tr>
2845 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2846 <em>optional</em></p></td>
2847 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2848 </tr>
2849 <tr>
2850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2851 <em>optional</em></p></td>
2852 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2853 </tr>
2854 <tr>
2855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2856 <em>optional</em></p></td>
2857 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2858 </tr>
2859 <tr>
2860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2861 <em>optional</em></p></td>
2862 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2863 </tr>
2864 <tr>
2865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2866 <em>optional</em></p></td>
2867 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2868 </tr>
2869 <tr>
2870 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2871 <em>optional</em></p></td>
2872 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2873 </tr>
2874 </tbody>
2875 </table>
2876 </div>
2877 <div class="sect2">
2878 <h3 id="_jsonnull"><a class="anchor" href="#_jsonnull"></a><a class="link" href="#_jsonnull">3.8. JsonNull</a></h3>
2879 <table class="tableblock frame-all grid-all stretch">
2880 <colgroup>
2881 <col style="width: 42.8571%;">
2882 <col style="width: 57.1429%;">
2883 </colgroup>
2884 <thead>
2885 <tr>
2886 <th class="tableblock halign-left valign-middle">Name</th>
2887 <th class="tableblock halign-left valign-middle">Schema</th>
2888 </tr>
2889 </thead>
2890 <tbody>
2891 <tr>
2892 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
2893 <em>optional</em></p></td>
2894 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
2895 </tr>
2896 <tr>
2897 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
2898 <em>optional</em></p></td>
2899 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
2900 </tr>
2901 <tr>
2902 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
2903 <em>optional</em></p></td>
2904 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2905 </tr>
2906 <tr>
2907 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
2908 <em>optional</em></p></td>
2909 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
2910 </tr>
2911 <tr>
2912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
2913 <em>optional</em></p></td>
2914 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2915 </tr>
2916 <tr>
2917 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
2918 <em>optional</em></p></td>
2919 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2920 </tr>
2921 <tr>
2922 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
2923 <em>optional</em></p></td>
2924 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
2925 </tr>
2926 <tr>
2927 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
2928 <em>optional</em></p></td>
2929 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2930 </tr>
2931 <tr>
2932 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
2933 <em>optional</em></p></td>
2934 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
2935 </tr>
2936 <tr>
2937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
2938 <em>optional</em></p></td>
2939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
2940 </tr>
2941 <tr>
2942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
2943 <em>optional</em></p></td>
2944 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
2945 </tr>
2946 <tr>
2947 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
2948 <em>optional</em></p></td>
2949 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
2950 </tr>
2951 <tr>
2952 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
2953 <em>optional</em></p></td>
2954 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
2955 </tr>
2956 <tr>
2957 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
2958 <em>optional</em></p></td>
2959 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
2960 </tr>
2961 <tr>
2962 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
2963 <em>optional</em></p></td>
2964 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2965 </tr>
2966 <tr>
2967 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
2968 <em>optional</em></p></td>
2969 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2970 </tr>
2971 <tr>
2972 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
2973 <em>optional</em></p></td>
2974 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2975 </tr>
2976 <tr>
2977 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
2978 <em>optional</em></p></td>
2979 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2980 </tr>
2981 <tr>
2982 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
2983 <em>optional</em></p></td>
2984 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2985 </tr>
2986 <tr>
2987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
2988 <em>optional</em></p></td>
2989 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2990 </tr>
2991 </tbody>
2992 </table>
2993 </div>
2994 <div class="sect2">
2995 <h3 id="_jsonobject"><a class="anchor" href="#_jsonobject"></a><a class="link" href="#_jsonobject">3.9. JsonObject</a></h3>
2996 <table class="tableblock frame-all grid-all stretch">
2997 <colgroup>
2998 <col style="width: 42.8571%;">
2999 <col style="width: 57.1429%;">
3000 </colgroup>
3001 <thead>
3002 <tr>
3003 <th class="tableblock halign-left valign-middle">Name</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>asBigDecimal</strong><br>
3010 <em>optional</em></p></td>
3011 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3012 </tr>
3013 <tr>
3014 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3015 <em>optional</em></p></td>
3016 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3017 </tr>
3018 <tr>
3019 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3020 <em>optional</em></p></td>
3021 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3022 </tr>
3023 <tr>
3024 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3025 <em>optional</em></p></td>
3026 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3027 </tr>
3028 <tr>
3029 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3030 <em>optional</em></p></td>
3031 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3032 </tr>
3033 <tr>
3034 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3035 <em>optional</em></p></td>
3036 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3037 </tr>
3038 <tr>
3039 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3040 <em>optional</em></p></td>
3041 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3042 </tr>
3043 <tr>
3044 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3045 <em>optional</em></p></td>
3046 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3047 </tr>
3048 <tr>
3049 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3050 <em>optional</em></p></td>
3051 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3052 </tr>
3053 <tr>
3054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3055 <em>optional</em></p></td>
3056 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3057 </tr>
3058 <tr>
3059 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3060 <em>optional</em></p></td>
3061 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3062 </tr>
3063 <tr>
3064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3065 <em>optional</em></p></td>
3066 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3067 </tr>
3068 <tr>
3069 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3070 <em>optional</em></p></td>
3071 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3072 </tr>
3073 <tr>
3074 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3075 <em>optional</em></p></td>
3076 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3077 </tr>
3078 <tr>
3079 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3080 <em>optional</em></p></td>
3081 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3082 </tr>
3083 <tr>
3084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3085 <em>optional</em></p></td>
3086 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3087 </tr>
3088 <tr>
3089 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3090 <em>optional</em></p></td>
3091 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3092 </tr>
3093 <tr>
3094 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3095 <em>optional</em></p></td>
3096 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3097 </tr>
3098 <tr>
3099 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3100 <em>optional</em></p></td>
3101 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3102 </tr>
3103 <tr>
3104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3105 <em>optional</em></p></td>
3106 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3107 </tr>
3108 </tbody>
3109 </table>
3110 </div>
3111 <div class="sect2">
3112 <h3 id="_jsonprimitive"><a class="anchor" href="#_jsonprimitive"></a><a class="link" href="#_jsonprimitive">3.10. JsonPrimitive</a></h3>
3113 <table class="tableblock frame-all grid-all stretch">
3114 <colgroup>
3115 <col style="width: 42.8571%;">
3116 <col style="width: 57.1429%;">
3117 </colgroup>
3118 <thead>
3119 <tr>
3120 <th class="tableblock halign-left valign-middle">Name</th>
3121 <th class="tableblock halign-left valign-middle">Schema</th>
3122 </tr>
3123 </thead>
3124 <tbody>
3125 <tr>
3126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigDecimal</strong><br>
3127 <em>optional</em></p></td>
3128 <td class="tableblock halign-left valign-middle"><p class="tableblock">number</p></td>
3129 </tr>
3130 <tr>
3131 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBigInteger</strong><br>
3132 <em>optional</em></p></td>
3133 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer</p></td>
3134 </tr>
3135 <tr>
3136 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asBoolean</strong><br>
3137 <em>optional</em></p></td>
3138 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3139 </tr>
3140 <tr>
3141 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asByte</strong><br>
3142 <em>optional</em></p></td>
3143 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (byte)</p></td>
3144 </tr>
3145 <tr>
3146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asCharacter</strong><br>
3147 <em>optional</em></p></td>
3148 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3149 </tr>
3150 <tr>
3151 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asDouble</strong><br>
3152 <em>optional</em></p></td>
3153 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
3154 </tr>
3155 <tr>
3156 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asFloat</strong><br>
3157 <em>optional</em></p></td>
3158 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (float)</p></td>
3159 </tr>
3160 <tr>
3161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asInt</strong><br>
3162 <em>optional</em></p></td>
3163 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3164 </tr>
3165 <tr>
3166 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonArray</strong><br>
3167 <em>optional</em></p></td>
3168 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonarray">JsonArray</a></p></td>
3169 </tr>
3170 <tr>
3171 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonNull</strong><br>
3172 <em>optional</em></p></td>
3173 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonnull">JsonNull</a></p></td>
3174 </tr>
3175 <tr>
3176 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonObject</strong><br>
3177 <em>optional</em></p></td>
3178 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3179 </tr>
3180 <tr>
3181 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asJsonPrimitive</strong><br>
3182 <em>optional</em></p></td>
3183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonprimitive">JsonPrimitive</a></p></td>
3184 </tr>
3185 <tr>
3186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asLong</strong><br>
3187 <em>optional</em></p></td>
3188 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3189 </tr>
3190 <tr>
3191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asNumber</strong><br>
3192 <em>optional</em></p></td>
3193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_number">Number</a></p></td>
3194 </tr>
3195 <tr>
3196 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asShort</strong><br>
3197 <em>optional</em></p></td>
3198 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3199 </tr>
3200 <tr>
3201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>asString</strong><br>
3202 <em>optional</em></p></td>
3203 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3204 </tr>
3205 <tr>
3206 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>boolean</strong><br>
3207 <em>optional</em></p></td>
3208 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3209 </tr>
3210 <tr>
3211 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonArray</strong><br>
3212 <em>optional</em></p></td>
3213 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3214 </tr>
3215 <tr>
3216 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonNull</strong><br>
3217 <em>optional</em></p></td>
3218 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3219 </tr>
3220 <tr>
3221 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonObject</strong><br>
3222 <em>optional</em></p></td>
3223 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3224 </tr>
3225 <tr>
3226 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonPrimitive</strong><br>
3227 <em>optional</em></p></td>
3228 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3229 </tr>
3230 <tr>
3231 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>number</strong><br>
3232 <em>optional</em></p></td>
3233 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3234 </tr>
3235 <tr>
3236 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>string</strong><br>
3237 <em>optional</em></p></td>
3238 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3239 </tr>
3240 </tbody>
3241 </table>
3242 </div>
3243 <div class="sect2">
3244 <h3 id="_loop"><a class="anchor" href="#_loop"></a><a class="link" href="#_loop">3.11. Loop</a></h3>
3245 <table class="tableblock frame-all grid-all stretch">
3246 <colgroup>
3247 <col style="width: 42.8571%;">
3248 <col style="width: 57.1429%;">
3249 </colgroup>
3250 <thead>
3251 <tr>
3252 <th class="tableblock halign-left valign-middle">Name</th>
3253 <th class="tableblock halign-left valign-middle">Schema</th>
3254 </tr>
3255 </thead>
3256 <tbody>
3257 <tr>
3258 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>components</strong><br>
3259 <em>optional</em></p></td>
3260 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string, <a href="#_externalcomponent">ExternalComponent</a> &gt; map</p></td>
3261 </tr>
3262 <tr>
3263 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3264 <em>optional</em></p></td>
3265 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3266 </tr>
3267 <tr>
3268 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3269 <em>optional</em></p></td>
3270 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3271 </tr>
3272 <tr>
3273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
3274 <em>optional</em></p></td>
3275 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3276 </tr>
3277 <tr>
3278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
3279 <em>optional</em></p></td>
3280 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3281 </tr>
3282 <tr>
3283 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>globalPropertiesJson</strong><br>
3284 <em>optional</em></p></td>
3285 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3286 </tr>
3287 <tr>
3288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastComputedState</strong><br>
3289 <em>optional</em></p></td>
3290 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)</p></td>
3291 </tr>
3292 <tr>
3293 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopLogs</strong><br>
3294 <em>optional</em></p></td>
3295 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looplog">LoopLog</a> &gt; array</p></td>
3296 </tr>
3297 <tr>
3298 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
3299 <em>optional</em></p></td>
3300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3301 </tr>
3302 <tr>
3303 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>microServicePolicies</strong><br>
3304 <em>optional</em></p></td>
3305 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_microservicepolicy">MicroServicePolicy</a> &gt; array</p></td>
3306 </tr>
3307 <tr>
3308 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3309 <em>optional</em></p></td>
3310 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3311 </tr>
3312 <tr>
3313 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3314 <em>optional</em></p></td>
3315 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3316 </tr>
3317 <tr>
3318 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>operationalPolicies</strong><br>
3319 <em>optional</em></p></td>
3320 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_operationalpolicy">OperationalPolicy</a> &gt; array</p></td>
3321 </tr>
3322 <tr>
3323 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3324 <em>optional</em></p></td>
3325 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3326 </tr>
3327 <tr>
3328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3329 <em>optional</em></p></td>
3330 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3331 </tr>
3332 <tr>
3333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3334 <em>optional</em></p></td>
3335 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3336 </tr>
3337 </tbody>
3338 </table>
3339 </div>
3340 <div class="sect2">
3341 <h3 id="_loopelementmodel"><a class="anchor" href="#_loopelementmodel"></a><a class="link" href="#_loopelementmodel">3.12. LoopElementModel</a></h3>
3342 <table class="tableblock frame-all grid-all stretch">
3343 <colgroup>
3344 <col style="width: 42.8571%;">
3345 <col style="width: 57.1429%;">
3346 </colgroup>
3347 <thead>
3348 <tr>
3349 <th class="tableblock halign-left valign-middle">Name</th>
3350 <th class="tableblock halign-left valign-middle">Schema</th>
3351 </tr>
3352 </thead>
3353 <tbody>
3354 <tr>
3355 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3356 <em>optional</em></p></td>
3357 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3358 </tr>
3359 <tr>
3360 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3361 <em>optional</em></p></td>
3362 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3363 </tr>
3364 <tr>
3365 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3366 <em>optional</em></p></td>
3367 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3368 </tr>
3369 <tr>
3370 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3371 <em>optional</em></p></td>
3372 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3373 </tr>
3374 <tr>
3375 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementType</strong><br>
3376 <em>optional</em></p></td>
3377 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3378 </tr>
3379 <tr>
3380 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3381 <em>optional</em></p></td>
3382 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3383 </tr>
3384 <tr>
3385 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModels</strong><br>
3386 <em>optional</em></p></td>
3387 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_policymodel">PolicyModel</a> &gt; array</p></td>
3388 </tr>
3389 <tr>
3390 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shortName</strong><br>
3391 <em>optional</em></p></td>
3392 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3393 </tr>
3394 <tr>
3395 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3396 <em>optional</em></p></td>
3397 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3398 </tr>
3399 <tr>
3400 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3401 <em>optional</em></p></td>
3402 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3403 </tr>
3404 <tr>
3405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoopTemplates</strong><br>
3406 <em>optional</em></p></td>
3407 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
3408 </tr>
3409 </tbody>
3410 </table>
3411 </div>
3412 <div class="sect2">
3413 <h3 id="_looplog"><a class="anchor" href="#_looplog"></a><a class="link" href="#_looplog">3.13. LoopLog</a></h3>
3414 <table class="tableblock frame-all grid-all stretch">
3415 <colgroup>
3416 <col style="width: 42.8571%;">
3417 <col style="width: 57.1429%;">
3418 </colgroup>
3419 <thead>
3420 <tr>
3421 <th class="tableblock halign-left valign-middle">Name</th>
3422 <th class="tableblock halign-left valign-middle">Schema</th>
3423 </tr>
3424 </thead>
3425 <tbody>
3426 <tr>
3427 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3428 <em>optional</em></p></td>
3429 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3430 </tr>
3431 <tr>
3432 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logComponent</strong><br>
3433 <em>optional</em></p></td>
3434 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3435 </tr>
3436 <tr>
3437 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logInstant</strong><br>
3438 <em>optional</em></p></td>
3439 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3440 </tr>
3441 <tr>
3442 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>logType</strong><br>
3443 <em>optional</em></p></td>
3444 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (INFO, WARNING, ERROR)</p></td>
3445 </tr>
3446 <tr>
3447 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
3448 <em>optional</em></p></td>
3449 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3450 </tr>
3451 <tr>
3452 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
3453 <em>optional</em></p></td>
3454 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3455 </tr>
3456 </tbody>
3457 </table>
3458 </div>
3459 <div class="sect2">
3460 <h3 id="_looptemplate"><a class="anchor" href="#_looptemplate"></a><a class="link" href="#_looptemplate">3.14. LoopTemplate</a></h3>
3461 <table class="tableblock frame-all grid-all stretch">
3462 <colgroup>
3463 <col style="width: 42.8571%;">
3464 <col style="width: 57.1429%;">
3465 </colgroup>
3466 <thead>
3467 <tr>
3468 <th class="tableblock halign-left valign-middle">Name</th>
3469 <th class="tableblock halign-left valign-middle">Schema</th>
3470 </tr>
3471 </thead>
3472 <tbody>
3473 <tr>
3474 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>allowedLoopType</strong><br>
3475 <em>optional</em></p></td>
3476 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (OPEN, CLOSED, HYBRID)</p></td>
3477 </tr>
3478 <tr>
3479 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprint</strong><br>
3480 <em>optional</em></p></td>
3481 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3482 </tr>
3483 <tr>
3484 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3485 <em>optional</em></p></td>
3486 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3487 </tr>
3488 <tr>
3489 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3490 <em>optional</em></p></td>
3491 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3492 </tr>
3493 <tr>
3494 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3495 <em>optional</em></p></td>
3496 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3497 </tr>
3498 <tr>
3499 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModelsUsed</strong><br>
3500 <em>optional</em></p></td>
3501 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_looptemplateloopelementmodel">LoopTemplateLoopElementModel</a> &gt; array</p></td>
3502 </tr>
3503 <tr>
3504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>maximumInstancesAllowed</strong><br>
3505 <em>optional</em></p></td>
3506 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3507 </tr>
3508 <tr>
3509 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelService</strong><br>
3510 <em>optional</em></p></td>
3511 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3512 </tr>
3513 <tr>
3514 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3515 <em>optional</em></p></td>
3516 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3517 </tr>
3518 <tr>
3519 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>svgRepresentation</strong><br>
3520 <em>optional</em></p></td>
3521 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3522 </tr>
3523 <tr>
3524 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>uniqueBlueprint</strong><br>
3525 <em>optional</em></p></td>
3526 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3527 </tr>
3528 <tr>
3529 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3530 <em>optional</em></p></td>
3531 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3532 </tr>
3533 <tr>
3534 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3535 <em>optional</em></p></td>
3536 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3537 </tr>
3538 </tbody>
3539 </table>
3540 </div>
3541 <div class="sect2">
3542 <h3 id="_looptemplateloopelementmodel"><a class="anchor" href="#_looptemplateloopelementmodel"></a><a class="link" href="#_looptemplateloopelementmodel">3.15. LoopTemplateLoopElementModel</a></h3>
3543 <table class="tableblock frame-all grid-all stretch">
3544 <colgroup>
3545 <col style="width: 42.8571%;">
3546 <col style="width: 57.1429%;">
3547 </colgroup>
3548 <thead>
3549 <tr>
3550 <th class="tableblock halign-left valign-middle">Name</th>
3551 <th class="tableblock halign-left valign-middle">Schema</th>
3552 </tr>
3553 </thead>
3554 <tbody>
3555 <tr>
3556 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>flowOrder</strong><br>
3557 <em>optional</em></p></td>
3558 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
3559 </tr>
3560 <tr>
3561 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
3562 <em>optional</em></p></td>
3563 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
3564 </tr>
3565 <tr>
3566 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopTemplate</strong><br>
3567 <em>optional</em></p></td>
3568 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_looptemplate">LoopTemplate</a></p></td>
3569 </tr>
3570 </tbody>
3571 </table>
3572 </div>
3573 <div class="sect2">
3574 <h3 id="_microservicepolicy"><a class="anchor" href="#_microservicepolicy"></a><a class="link" href="#_microservicepolicy">3.16. MicroServicePolicy</a></h3>
3575 <table class="tableblock frame-all grid-all stretch">
3576 <colgroup>
3577 <col style="width: 42.8571%;">
3578 <col style="width: 57.1429%;">
3579 </colgroup>
3580 <thead>
3581 <tr>
3582 <th class="tableblock halign-left valign-middle">Name</th>
3583 <th class="tableblock halign-left valign-middle">Schema</th>
3584 </tr>
3585 </thead>
3586 <tbody>
3587 <tr>
3588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
3589 <em>optional</em></p></td>
3590 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3591 </tr>
3592 <tr>
3593 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>context</strong><br>
3594 <em>optional</em></p></td>
3595 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3596 </tr>
3597 <tr>
3598 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3599 <em>optional</em></p></td>
3600 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3601 </tr>
3602 <tr>
3603 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3604 <em>optional</em></p></td>
3605 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3606 </tr>
3607 <tr>
3608 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeBlueprintId</strong><br>
3609 <em>optional</em></p></td>
3610 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3611 </tr>
3612 <tr>
3613 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentId</strong><br>
3614 <em>optional</em></p></td>
3615 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3616 </tr>
3617 <tr>
3618 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dcaeDeploymentStatusUrl</strong><br>
3619 <em>optional</em></p></td>
3620 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3621 </tr>
3622 <tr>
3623 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deviceTypeScope</strong><br>
3624 <em>optional</em></p></td>
3625 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3626 </tr>
3627 <tr>
3628 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
3629 <em>optional</em></p></td>
3630 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3631 </tr>
3632 <tr>
3633 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
3634 <em>optional</em></p></td>
3635 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
3636 </tr>
3637 <tr>
3638 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelType</strong><br>
3639 <em>optional</em></p></td>
3640 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3641 </tr>
3642 <tr>
3643 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3644 <em>optional</em></p></td>
3645 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3646 </tr>
3647 <tr>
3648 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
3649 <em>optional</em></p></td>
3650 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3651 </tr>
3652 <tr>
3653 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyTosca</strong><br>
3654 <em>optional</em></p></td>
3655 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3656 </tr>
3657 <tr>
3658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>shared</strong><br>
3659 <em>optional</em></p></td>
3660 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
3661 </tr>
3662 <tr>
3663 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3664 <em>optional</em></p></td>
3665 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3666 </tr>
3667 <tr>
3668 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3669 <em>optional</em></p></td>
3670 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3671 </tr>
3672 <tr>
3673 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByLoops</strong><br>
3674 <em>optional</em></p></td>
3675 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loop">Loop</a> &gt; array</p></td>
3676 </tr>
3677 </tbody>
3678 </table>
3679 </div>
3680 <div class="sect2">
3681 <h3 id="_number"><a class="anchor" href="#_number"></a><a class="link" href="#_number">3.17. Number</a></h3>
3682 <div class="paragraph">
3683 <p><em>Type</em> : object</p>
3684 </div>
3685 </div>
3686 <div class="sect2">
3687 <h3 id="_operationalpolicy"><a class="anchor" href="#_operationalpolicy"></a><a class="link" href="#_operationalpolicy">3.18. OperationalPolicy</a></h3>
3688 <table class="tableblock frame-all grid-all stretch">
3689 <colgroup>
3690 <col style="width: 42.8571%;">
3691 <col style="width: 57.1429%;">
3692 </colgroup>
3693 <thead>
3694 <tr>
3695 <th class="tableblock halign-left valign-middle">Name</th>
3696 <th class="tableblock halign-left valign-middle">Schema</th>
3697 </tr>
3698 </thead>
3699 <tbody>
3700 <tr>
3701 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>configurationsJson</strong><br>
3702 <em>optional</em></p></td>
3703 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3704 </tr>
3705 <tr>
3706 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3707 <em>optional</em></p></td>
3708 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3709 </tr>
3710 <tr>
3711 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3712 <em>optional</em></p></td>
3713 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3714 </tr>
3715 <tr>
3716 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>jsonRepresentation</strong><br>
3717 <em>optional</em></p></td>
3718 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3719 </tr>
3720 <tr>
3721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loop</strong><br>
3722 <em>optional</em></p></td>
3723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loop">Loop</a></p></td>
3724 </tr>
3725 <tr>
3726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>loopElementModel</strong><br>
3727 <em>optional</em></p></td>
3728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_loopelementmodel">LoopElementModel</a></p></td>
3729 </tr>
3730 <tr>
3731 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3732 <em>optional</em></p></td>
3733 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3734 </tr>
3735 <tr>
3736 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>pdpGroup</strong><br>
3737 <em>optional</em></p></td>
3738 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3739 </tr>
3740 <tr>
3741 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModel</strong><br>
3742 <em>optional</em></p></td>
3743 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_policymodel">PolicyModel</a></p></td>
3744 </tr>
3745 <tr>
3746 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3747 <em>optional</em></p></td>
3748 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3749 </tr>
3750 <tr>
3751 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3752 <em>optional</em></p></td>
3753 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3754 </tr>
3755 </tbody>
3756 </table>
3757 </div>
3758 <div class="sect2">
3759 <h3 id="_policymodel"><a class="anchor" href="#_policymodel"></a><a class="link" href="#_policymodel">3.19. PolicyModel</a></h3>
3760 <table class="tableblock frame-all grid-all stretch">
3761 <colgroup>
3762 <col style="width: 42.8571%;">
3763 <col style="width: 57.1429%;">
3764 </colgroup>
3765 <thead>
3766 <tr>
3767 <th class="tableblock halign-left valign-middle">Name</th>
3768 <th class="tableblock halign-left valign-middle">Schema</th>
3769 </tr>
3770 </thead>
3771 <tbody>
3772 <tr>
3773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
3774 <em>optional</em></p></td>
3775 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3776 </tr>
3777 <tr>
3778 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
3779 <em>optional</em></p></td>
3780 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3781 </tr>
3782 <tr>
3783 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyAcronym</strong><br>
3784 <em>optional</em></p></td>
3785 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3786 </tr>
3787 <tr>
3788 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelTosca</strong><br>
3789 <em>optional</em></p></td>
3790 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3791 </tr>
3792 <tr>
3793 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyModelType</strong><br>
3794 <em>optional</em></p></td>
3795 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3796 </tr>
3797 <tr>
3798 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
3799 <em>optional</em></p></td>
3800 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3801 </tr>
3802 <tr>
3803 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedDate</strong><br>
3804 <em>optional</em></p></td>
3805 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int64)</p></td>
3806 </tr>
3807 <tr>
3808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>usedByElementModels</strong><br>
3809 <em>optional</em></p></td>
3810 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_loopelementmodel">LoopElementModel</a> &gt; array</p></td>
3811 </tr>
3812 <tr>
3813 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
3814 <em>optional</em></p></td>
3815 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3816 </tr>
3817 </tbody>
3818 </table>
3819 </div>
3820 <div class="sect2">
3821 <h3 id="_service"><a class="anchor" href="#_service"></a><a class="link" href="#_service">3.20. Service</a></h3>
3822 <table class="tableblock frame-all grid-all stretch">
3823 <colgroup>
3824 <col style="width: 42.8571%;">
3825 <col style="width: 57.1429%;">
3826 </colgroup>
3827 <thead>
3828 <tr>
3829 <th class="tableblock halign-left valign-middle">Name</th>
3830 <th class="tableblock halign-left valign-middle">Schema</th>
3831 </tr>
3832 </thead>
3833 <tbody>
3834 <tr>
3835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3836 <em>optional</em></p></td>
3837 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3838 </tr>
3839 <tr>
3840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceDetails</strong><br>
3841 <em>optional</em></p></td>
3842 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3843 </tr>
3844 <tr>
3845 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceDetails</strong><br>
3846 <em>optional</em></p></td>
3847 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_jsonobject">JsonObject</a></p></td>
3848 </tr>
3849 <tr>
3850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUuid</strong><br>
3851 <em>optional</em></p></td>
3852 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3853 </tr>
3854 <tr>
3855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
3856 <em>optional</em></p></td>
3857 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3858 </tr>
3859 </tbody>
3860 </table>
3861 </div>
3862 </div>
3863 </div>
3864 </div>
3865 <div id="footer">
3866 <div id="footer-text">
3867 Last updated 2020-02-12 02:20:53 PST
3868 </div>
3869 </div>
3870 </body>
3871 </html>