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.3">
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
12 /* Remove comment around @import statement below when using as a 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 [hidden],template{display:none}
18 script{display:none!important}
19 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
21 a{background:transparent}
22 a:focus{outline:thin dotted}
23 a:active,a:hover{outline:0}
24 h1{font-size:2em;margin:.67em 0}
25 abbr[title]{border-bottom:1px dotted}
26 b,strong{font-weight:bold}
27 dfn{font-style:italic}
28 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
29 mark{background:#ff0;color:#000}
30 code,kbd,pre,samp{font-family:monospace;font-size:1em}
31 pre{white-space:pre-wrap}
32 q{quotes:"\201C" "\201D" "\2018" "\2019"}
34 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
38 svg:not(:root){overflow:hidden}
40 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
41 legend{border:0;padding:0}
42 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
43 button,input{line-height:normal}
44 button,select{text-transform:none}
45 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
46 button[disabled],html input[disabled]{cursor:default}
47 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
48 input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
49 input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
50 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
51 textarea{overflow:auto;vertical-align:top}
52 table{border-collapse:collapse;border-spacing:0}
53 *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
54 html,body{font-size:100%}
55 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}
56 a:hover{cursor:pointer}
57 img,object,embed{max-width:100%;height:auto}
58 object,embed{height:100%}
59 img{-ms-interpolation-mode:bicubic}
60 .left{float:left!important}
61 .right{float:right!important}
62 .text-left{text-align:left!important}
63 .text-right{text-align:right!important}
64 .text-center{text-align:center!important}
65 .text-justify{text-align:justify!important}
67 body{-webkit-font-smoothing:antialiased}
68 img,object,svg{display:inline-block;vertical-align:middle}
69 textarea{height:auto;min-height:50px}
71 .center{margin-left:auto;margin-right:auto}
73 p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
74 .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}
75 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}
76 a{color:#2156a5;text-decoration:underline;line-height:inherit}
77 a:hover,a:focus{color:#1d4b8f}
79 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
80 p aside{font-size:.875em;line-height:1.35;font-style:italic}
81 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}
82 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}
84 h2{font-size:1.6875em}
85 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
86 h4,h5{font-size:1.125em}
88 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
89 em,i{font-style:italic;line-height:inherit}
90 strong,b{font-weight:bold;line-height:inherit}
91 small{font-size:60%;line-height:inherit}
92 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
93 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
94 ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
95 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
96 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
97 ul.square{list-style-type:square}
98 ul.circle{list-style-type:circle}
99 ul.disc{list-style-type:disc}
100 ul.no-bullet{list-style:none}
101 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
102 dl dt{margin-bottom:.3125em;font-weight:bold}
103 dl dd{margin-bottom:1.25em}
104 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
105 abbr{text-transform:none}
106 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
107 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
108 blockquote cite:before{content:"\2014 \0020"}
109 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
110 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
111 @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
113 h2{font-size:2.3125em}
114 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
115 h4{font-size:1.4375em}}
116 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
117 table thead,table tfoot{background:#f7f8f7;font-weight:bold}
118 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}
119 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
120 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
121 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}
123 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
124 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
125 .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
126 .clearfix:after,.float-group:after{clear:both}
127 *: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}
128 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}
129 .keyseq{color:rgba(51,51,51,.8)}
130 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}
131 .keyseq kbd:first-child{margin-left:0}
132 .keyseq kbd:last-child{margin-right:0}
133 .menuseq,.menu{color:rgba(0,0,0,.8)}
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 only 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 only 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 .sect1{padding-bottom:.625em}
186 @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
187 .sect1+.sect1{border-top:1px solid #efefed}
188 #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}
189 #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}
190 #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}
191 #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}
192 #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}
193 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
194 .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}
195 table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
196 .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
197 table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
198 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
199 .admonitionblock>table td.icon{text-align:center;width:80px}
200 .admonitionblock>table td.icon img{max-width:none}
201 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
202 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
203 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
204 .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}
205 .exampleblock>.content>:first-child{margin-top:0}
206 .exampleblock>.content>:last-child{margin-bottom:0}
207 .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}
208 .sidebarblock>:first-child{margin-top:0}
209 .sidebarblock>:last-child{margin-bottom:0}
210 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
211 .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}
212 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
213 .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}
214 .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}
215 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
216 @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
217 @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
218 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
219 .listingblock pre.highlightjs{padding:0}
220 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
221 .listingblock pre.prettyprint{border-width:0}
222 .listingblock>.content{position:relative}
223 .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}
224 .listingblock:hover code[data-lang]:before{display:block}
225 .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
226 .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
227 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
228 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
229 table.pyhltable td.code{padding-left:.75em;padding-right:0}
230 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
231 pre.pygments .lineno{display:inline-block;margin-right:.25em}
232 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
233 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
234 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
235 .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}
236 .quoteblock blockquote{margin:0;padding:0;border:0}
237 .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)}
238 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
239 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
240 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
241 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
242 .quoteblock .quoteblock blockquote:before{display:none}
243 .verseblock{margin:0 1em 1.25em 1em}
244 .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}
245 .verseblock pre strong{font-weight:400}
246 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
247 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
248 .quoteblock .attribution br,.verseblock .attribution br{display:none}
249 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
250 .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
251 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
252 .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
253 table.tableblock{max-width:100%;border-collapse:separate}
254 table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
255 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
256 table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
257 table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
258 table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
259 table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
260 table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
261 table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
262 table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
263 table.frame-all{border-width:1px}
264 table.frame-sides{border-width:0 1px}
265 table.frame-topbot{border-width:1px 0}
266 th.halign-left,td.halign-left{text-align:left}
267 th.halign-right,td.halign-right{text-align:right}
268 th.halign-center,td.halign-center{text-align:center}
269 th.valign-top,td.valign-top{vertical-align:top}
270 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
271 th.valign-middle,td.valign-middle{vertical-align:middle}
272 table thead th,table tfoot th{font-weight:bold}
273 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
274 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
275 p.tableblock>code:only-child{background:none;padding:0}
276 p.tableblock{font-size:1em}
277 td>div.verse{white-space:pre}
278 ol{margin-left:1.75em}
279 ul li ol{margin-left:1.5em}
280 dl dd{margin-left:1.125em}
281 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
282 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
283 ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
284 ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
285 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
286 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
287 ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
288 ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
289 ul.inline>li>*{display:block}
290 .unstyled dl dt{font-weight:400;font-style:normal}
291 ol.arabic{list-style-type:decimal}
292 ol.decimal{list-style-type:decimal-leading-zero}
293 ol.loweralpha{list-style-type:lower-alpha}
294 ol.upperalpha{list-style-type:upper-alpha}
295 ol.lowerroman{list-style-type:lower-roman}
296 ol.upperroman{list-style-type:upper-roman}
297 ol.lowergreek{list-style-type:lower-greek}
298 .hdlist>table,.colist>table{border:0;background:none}
299 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
300 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
301 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
302 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
303 .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
304 .colist>table tr>td:last-of-type{padding:.25em 0}
305 .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}
306 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
307 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
308 .imageblock>.title{margin-bottom:0}
309 .imageblock.thumb,.imageblock.th{border-width:6px}
310 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
311 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
312 .image.left{margin-right:.625em}
313 .image.right{margin-left:.625em}
314 a.image{text-decoration:none;display:inline-block}
315 a.image object{pointer-events:none}
316 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
317 sup.footnote a,sup.footnoteref a{text-decoration:none}
318 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
319 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
320 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
321 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
322 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
323 #footnotes .footnote:last-of-type{margin-bottom:0}
324 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
325 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
326 .gist .file-data>table td.line-data{width:99%}
327 div.unbreakable{page-break-inside:avoid}
328 .big{font-size:larger}
329 .small{font-size:smaller}
330 .underline{text-decoration:underline}
331 .overline{text-decoration:overline}
332 .line-through{text-decoration:line-through}
334 .aqua-background{background-color:#00fafa}
336 .black-background{background-color:#000}
338 .blue-background{background-color:#0000fa}
339 .fuchsia{color:#bf00bf}
340 .fuchsia-background{background-color:#fa00fa}
342 .gray-background{background-color:#7d7d7d}
343 .green{color:#006000}
344 .green-background{background-color:#007d00}
346 .lime-background{background-color:#00fa00}
347 .maroon{color:#600000}
348 .maroon-background{background-color:#7d0000}
350 .navy-background{background-color:#00007d}
351 .olive{color:#606000}
352 .olive-background{background-color:#7d7d00}
353 .purple{color:#600060}
354 .purple-background{background-color:#7d007d}
356 .red-background{background-color:#fa0000}
357 .silver{color:#909090}
358 .silver-background{background-color:#bcbcbc}
360 .teal-background{background-color:#007d7d}
361 .white{color:#bfbfbf}
362 .white-background{background-color:#fafafa}
363 .yellow{color:#bfbf00}
364 .yellow-background{background-color:#fafa00}
365 span.icon>.fa{cursor:default}
366 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
367 .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
368 .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
369 .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
370 .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
371 .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
372 .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}
373 .conum[data-value] *{color:#fff!important}
374 .conum[data-value]+b{display:none}
375 .conum[data-value]:after{content:attr(data-value)}
376 pre .conum[data-value]{position:relative;top:-.125em}
377 b.conum *{color:inherit!important}
378 .conum:not([data-value]):empty{display:none}
379 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
380 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
381 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
382 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
383 p{margin-bottom:1.25rem}
384 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
385 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
386 .print-only{display:none!important}
387 @media print{@page{margin:1.25cm .75cm}
388 *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
389 a{color:inherit!important;text-decoration:underline!important}
390 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
391 a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
392 abbr[title]:after{content:" (" attr(title) ")"}
393 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
394 thead{display:table-header-group}
396 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
397 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
398 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
399 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
400 .sect1{padding-bottom:0!important}
401 .sect1+.sect1{border:0!important}
402 #header>h1:first-child{margin-top:1.25rem}
403 body.book #header{text-align:center}
404 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
405 body.book #header .details{border:0!important;display:block;padding:0!important}
406 body.book #header .details span:first-child{margin-left:0!important}
407 body.book #header .details br{display:block}
408 body.book #header .details br+span:before{content:none!important}
409 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
410 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
411 .listingblock code[data-lang]:before{display:block}
412 #footer{background:none!important;padding:0 .9375em}
413 #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
414 .hide-on-print{display:none!important}
415 .print-only{display:block!important}
416 .hide-for-print{display:none!important}
417 .show-for-print{display:inherit!important}}
420 <body class="book toc2 toc-left">
423 <div id="toc" class="toc2">
424 <div id="toctitle">Table of Contents</div>
425 <ul class="sectlevel1">
426 <li><a href="#_overview">1. Overview</a>
427 <ul class="sectlevel2">
428 <li><a href="#_version_information">1.1. Version information</a></li>
429 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
432 <li><a href="#_paths">2. Paths</a>
433 <ul class="sectlevel2">
434 <li><a href="#_clds_action_action_modelname_put">2.1. PUT /clds/action/{action}/{modelName}</a>
435 <ul class="sectlevel3">
436 <li><a href="#_description">2.1.1. Description</a></li>
437 <li><a href="#_parameters">2.1.2. Parameters</a></li>
438 <li><a href="#_responses">2.1.3. Responses</a></li>
439 <li><a href="#_consumes">2.1.4. Consumes</a></li>
440 <li><a href="#_produces">2.1.5. Produces</a></li>
443 <li><a href="#_clds_cldsdetails_get">2.2. GET /clds/cldsDetails</a>
444 <ul class="sectlevel3">
445 <li><a href="#_responses_2">2.2.1. Responses</a></li>
446 <li><a href="#_produces_2">2.2.2. Produces</a></li>
449 <li><a href="#_clds_cldsinfo_get">2.3. GET /clds/cldsInfo</a>
450 <ul class="sectlevel3">
451 <li><a href="#_responses_3">2.3.1. Responses</a></li>
452 <li><a href="#_produces_3">2.3.2. Produces</a></li>
455 <li><a href="#_clds_dcae_event_post">2.4. POST /clds/dcae/event</a>
456 <ul class="sectlevel3">
457 <li><a href="#_description_2">2.4.1. Description</a></li>
458 <li><a href="#_parameters_2">2.4.2. Parameters</a></li>
459 <li><a href="#_responses_4">2.4.3. Responses</a></li>
460 <li><a href="#_consumes_2">2.4.4. Consumes</a></li>
461 <li><a href="#_produces_4">2.4.5. Produces</a></li>
464 <li><a href="#_clds_deploy_modelname_put">2.5. PUT /clds/deploy/{modelName}</a>
465 <ul class="sectlevel3">
466 <li><a href="#_parameters_3">2.5.1. Parameters</a></li>
467 <li><a href="#_responses_5">2.5.2. Responses</a></li>
468 <li><a href="#_consumes_3">2.5.3. Consumes</a></li>
469 <li><a href="#_produces_5">2.5.4. Produces</a></li>
472 <li><a href="#_clds_healthcheck_get">2.6. GET /clds/healthcheck</a>
473 <ul class="sectlevel3">
474 <li><a href="#_description_3">2.6.1. Description</a></li>
475 <li><a href="#_responses_6">2.6.2. Responses</a></li>
476 <li><a href="#_produces_6">2.6.3. Produces</a></li>
479 <li><a href="#_clds_model-names_get">2.7. GET /clds/model-names</a>
480 <ul class="sectlevel3">
481 <li><a href="#_description_4">2.7.1. Description</a></li>
482 <li><a href="#_responses_7">2.7.2. Responses</a></li>
483 <li><a href="#_produces_7">2.7.3. Produces</a></li>
486 <li><a href="#_clds_model_bpmn_modelname_get">2.8. GET /clds/model/bpmn/{modelName}</a>
487 <ul class="sectlevel3">
488 <li><a href="#_description_5">2.8.1. Description</a></li>
489 <li><a href="#_parameters_4">2.8.2. Parameters</a></li>
490 <li><a href="#_responses_8">2.8.3. Responses</a></li>
491 <li><a href="#_produces_8">2.8.4. Produces</a></li>
494 <li><a href="#_clds_model_image_modelname_get">2.9. GET /clds/model/image/{modelName}</a>
495 <ul class="sectlevel3">
496 <li><a href="#_description_6">2.9.1. Description</a></li>
497 <li><a href="#_parameters_5">2.9.2. Parameters</a></li>
498 <li><a href="#_responses_9">2.9.3. Responses</a></li>
499 <li><a href="#_produces_9">2.9.4. Produces</a></li>
502 <li><a href="#_clds_model_modelname_get">2.10. GET /clds/model/{modelName}</a>
503 <ul class="sectlevel3">
504 <li><a href="#_description_7">2.10.1. Description</a></li>
505 <li><a href="#_parameters_6">2.10.2. Parameters</a></li>
506 <li><a href="#_responses_10">2.10.3. Responses</a></li>
507 <li><a href="#_produces_10">2.10.4. Produces</a></li>
510 <li><a href="#_clds_model_modelname_put">2.11. PUT /clds/model/{modelName}</a>
511 <ul class="sectlevel3">
512 <li><a href="#_description_8">2.11.1. Description</a></li>
513 <li><a href="#_parameters_7">2.11.2. Parameters</a></li>
514 <li><a href="#_responses_11">2.11.3. Responses</a></li>
515 <li><a href="#_consumes_4">2.11.4. Consumes</a></li>
516 <li><a href="#_produces_11">2.11.5. Produces</a></li>
519 <li><a href="#_clds_properties_get">2.12. GET /clds/properties</a>
520 <ul class="sectlevel3">
521 <li><a href="#_description_9">2.12.1. Description</a></li>
522 <li><a href="#_responses_12">2.12.2. Responses</a></li>
523 <li><a href="#_produces_12">2.12.3. Produces</a></li>
526 <li><a href="#_clds_properties_serviceinvariantuuid_get">2.13. GET /clds/properties/{serviceInvariantUUID}</a>
527 <ul class="sectlevel3">
528 <li><a href="#_description_10">2.13.1. Description</a></li>
529 <li><a href="#_parameters_8">2.13.2. Parameters</a></li>
530 <li><a href="#_responses_13">2.13.3. Responses</a></li>
531 <li><a href="#_produces_13">2.13.4. Produces</a></li>
534 <li><a href="#_clds_sdc_services_get">2.14. GET /clds/sdc/services</a>
535 <ul class="sectlevel3">
536 <li><a href="#_description_11">2.14.1. Description</a></li>
537 <li><a href="#_responses_14">2.14.2. Responses</a></li>
538 <li><a href="#_produces_14">2.14.3. Produces</a></li>
541 <li><a href="#_clds_undeploy_modelname_put">2.15. PUT /clds/undeploy/{modelName}</a>
542 <ul class="sectlevel3">
543 <li><a href="#_parameters_9">2.15.1. Parameters</a></li>
544 <li><a href="#_responses_15">2.15.2. Responses</a></li>
545 <li><a href="#_consumes_5">2.15.3. Consumes</a></li>
546 <li><a href="#_produces_15">2.15.4. Produces</a></li>
549 <li><a href="#_cldstempate_template-names_get">2.16. GET /cldsTempate/template-names</a>
550 <ul class="sectlevel3">
551 <li><a href="#_description_12">2.16.1. Description</a></li>
552 <li><a href="#_responses_16">2.16.2. Responses</a></li>
553 <li><a href="#_produces_16">2.16.3. Produces</a></li>
556 <li><a href="#_cldstempate_template_bpmn_templatename_get">2.17. GET /cldsTempate/template/bpmn/{templateName}</a>
557 <ul class="sectlevel3">
558 <li><a href="#_description_13">2.17.1. Description</a></li>
559 <li><a href="#_parameters_10">2.17.2. Parameters</a></li>
560 <li><a href="#_responses_17">2.17.3. Responses</a></li>
561 <li><a href="#_produces_17">2.17.4. Produces</a></li>
564 <li><a href="#_cldstempate_template_image_templatename_get">2.18. GET /cldsTempate/template/image/{templateName}</a>
565 <ul class="sectlevel3">
566 <li><a href="#_description_14">2.18.1. Description</a></li>
567 <li><a href="#_parameters_11">2.18.2. Parameters</a></li>
568 <li><a href="#_responses_18">2.18.3. Responses</a></li>
569 <li><a href="#_produces_18">2.18.4. Produces</a></li>
572 <li><a href="#_cldstempate_template_templatename_get">2.19. GET /cldsTempate/template/{templateName}</a>
573 <ul class="sectlevel3">
574 <li><a href="#_description_15">2.19.1. Description</a></li>
575 <li><a href="#_parameters_12">2.19.2. Parameters</a></li>
576 <li><a href="#_responses_19">2.19.3. Responses</a></li>
577 <li><a href="#_produces_19">2.19.4. Produces</a></li>
580 <li><a href="#_cldstempate_template_templatename_put">2.20. PUT /cldsTempate/template/{templateName}</a>
581 <ul class="sectlevel3">
582 <li><a href="#_description_16">2.20.1. Description</a></li>
583 <li><a href="#_parameters_13">2.20.2. Parameters</a></li>
584 <li><a href="#_responses_20">2.20.3. Responses</a></li>
585 <li><a href="#_consumes_6">2.20.4. Consumes</a></li>
586 <li><a href="#_produces_20">2.20.5. Produces</a></li>
589 <li><a href="#_healthcheck_get">2.21. GET /healthcheck</a>
590 <ul class="sectlevel3">
591 <li><a href="#_description_17">2.21.1. Description</a></li>
592 <li><a href="#_responses_21">2.21.2. Responses</a></li>
593 <li><a href="#_produces_21">2.21.3. Produces</a></li>
596 <li><a href="#_user_getuser_get">2.22. GET /user/getUser</a>
597 <ul class="sectlevel3">
598 <li><a href="#_description_18">2.22.1. Description</a></li>
599 <li><a href="#_responses_22">2.22.2. Responses</a></li>
600 <li><a href="#_produces_22">2.22.3. Produces</a></li>
605 <li><a href="#_definitions">3. Definitions</a>
606 <ul class="sectlevel2">
607 <li><a href="#_cldsevent">3.1. CldsEvent</a></li>
608 <li><a href="#_cldshealthcheck">3.2. CldsHealthCheck</a></li>
609 <li><a href="#_cldsinfo">3.3. CldsInfo</a></li>
610 <li><a href="#_cldsmodel">3.4. CldsModel</a></li>
611 <li><a href="#_cldsmodelinstance">3.5. CldsModelInstance</a></li>
612 <li><a href="#_cldsmonitoringdetails">3.6. CldsMonitoringDetails</a></li>
613 <li><a href="#_cldstemplate">3.7. CldsTemplate</a></li>
614 <li><a href="#_dcaeevent">3.8. DcaeEvent</a></li>
615 <li><a href="#_valueitem">3.9. ValueItem</a></li>
623 <h2 id="_overview"><a class="anchor" href="#_overview"></a>1. Overview</h2>
624 <div class="sectionbody">
626 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a>1.1. Version information</h3>
627 <div class="paragraph">
628 <p><em>Version</em> : 3.0.0-SNAPSHOT</p>
632 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a>1.2. URI scheme</h3>
633 <div class="paragraph">
634 <p><em>BasePath</em> : /clamp/restservices/clds/v1<br>
635 <em>Schemes</em> : HTTP</p>
641 <h2 id="_paths"><a class="anchor" href="#_paths"></a>2. Paths</h2>
642 <div class="sectionbody">
644 <h3 id="_clds_action_action_modelname_put"><a class="anchor" href="#_clds_action_action_modelname_put"></a>2.1. PUT /clds/action/{action}/{modelName}</h3>
646 <h4 id="_description"><a class="anchor" href="#_description"></a>2.1.1. Description</h4>
647 <div class="paragraph">
648 <p>REST service that saves and processes an action for a CLDS model by name.</p>
652 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a>2.1.2. Parameters</h4>
653 <table class="tableblock frame-all grid-all spread">
655 <col style="width: 22%;">
656 <col style="width: 33%;">
657 <col style="width: 44%;">
661 <th class="tableblock halign-left valign-middle">Type</th>
662 <th class="tableblock halign-left valign-middle">Name</th>
663 <th class="tableblock halign-left valign-middle">Schema</th>
668 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
669 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
670 <em>required</em></p></td>
671 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
674 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
675 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
676 <em>required</em></p></td>
677 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
680 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
681 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>test</strong><br>
682 <em>required</em></p></td>
683 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
686 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
687 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
688 <em>required</em></p></td>
689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
695 <h4 id="_responses"><a class="anchor" href="#_responses"></a>2.1.3. Responses</h4>
696 <table class="tableblock frame-all grid-all spread">
698 <col style="width: 10%;">
699 <col style="width: 70%;">
700 <col style="width: 20%;">
704 <th class="tableblock halign-left valign-middle">HTTP Code</th>
705 <th class="tableblock halign-left valign-middle">Description</th>
706 <th class="tableblock halign-left valign-middle">Schema</th>
711 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
712 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
713 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
716 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
717 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
718 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
724 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a>2.1.4. Consumes</h4>
728 <p><code>application/json</code></p>
734 <h4 id="_produces"><a class="anchor" href="#_produces"></a>2.1.5. Produces</h4>
738 <p><code>application/json</code></p>
745 <h3 id="_clds_cldsdetails_get"><a class="anchor" href="#_clds_cldsdetails_get"></a>2.2. GET /clds/cldsDetails</h3>
747 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a>2.2.1. Responses</h4>
748 <table class="tableblock frame-all grid-all spread">
750 <col style="width: 10%;">
751 <col style="width: 70%;">
752 <col style="width: 20%;">
756 <th class="tableblock halign-left valign-middle">HTTP Code</th>
757 <th class="tableblock halign-left valign-middle">Description</th>
758 <th class="tableblock halign-left valign-middle">Schema</th>
763 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
764 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
765 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmonitoringdetails">CldsMonitoringDetails</a> > array</p></td>
771 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a>2.2.2. Produces</h4>
775 <p><code>application/json</code></p>
782 <h3 id="_clds_cldsinfo_get"><a class="anchor" href="#_clds_cldsinfo_get"></a>2.3. GET /clds/cldsInfo</h3>
784 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a>2.3.1. Responses</h4>
785 <table class="tableblock frame-all grid-all spread">
787 <col style="width: 10%;">
788 <col style="width: 70%;">
789 <col style="width: 20%;">
793 <th class="tableblock halign-left valign-middle">HTTP Code</th>
794 <th class="tableblock halign-left valign-middle">Description</th>
795 <th class="tableblock halign-left valign-middle">Schema</th>
800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
801 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
802 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
808 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a>2.3.2. Produces</h4>
812 <p><code>application/json</code></p>
819 <h3 id="_clds_dcae_event_post"><a class="anchor" href="#_clds_dcae_event_post"></a>2.4. POST /clds/dcae/event</h3>
821 <h4 id="_description_2"><a class="anchor" href="#_description_2"></a>2.4.1. Description</h4>
822 <div class="paragraph">
823 <p>REST service that accepts events for a model.</p>
827 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a>2.4.2. Parameters</h4>
828 <table class="tableblock frame-all grid-all spread">
830 <col style="width: 22%;">
831 <col style="width: 33%;">
832 <col style="width: 44%;">
836 <th class="tableblock halign-left valign-middle">Type</th>
837 <th class="tableblock halign-left valign-middle">Name</th>
838 <th class="tableblock halign-left valign-middle">Schema</th>
843 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
844 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>test</strong><br>
845 <em>required</em></p></td>
846 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
849 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
851 <em>required</em></p></td>
852 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dcaeevent">DcaeEvent</a></p></td>
858 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a>2.4.3. Responses</h4>
859 <table class="tableblock frame-all grid-all spread">
861 <col style="width: 10%;">
862 <col style="width: 70%;">
863 <col style="width: 20%;">
867 <th class="tableblock halign-left valign-middle">HTTP Code</th>
868 <th class="tableblock halign-left valign-middle">Description</th>
869 <th class="tableblock halign-left valign-middle">Schema</th>
874 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
875 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
876 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
882 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a>2.4.4. Consumes</h4>
886 <p><code>application/json</code></p>
892 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a>2.4.5. Produces</h4>
896 <p><code>application/json</code></p>
903 <h3 id="_clds_deploy_modelname_put"><a class="anchor" href="#_clds_deploy_modelname_put"></a>2.5. PUT /clds/deploy/{modelName}</h3>
905 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a>2.5.1. Parameters</h4>
906 <table class="tableblock frame-all grid-all spread">
908 <col style="width: 22%;">
909 <col style="width: 33%;">
910 <col style="width: 44%;">
914 <th class="tableblock halign-left valign-middle">Type</th>
915 <th class="tableblock halign-left valign-middle">Name</th>
916 <th class="tableblock halign-left valign-middle">Schema</th>
921 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
922 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
923 <em>required</em></p></td>
924 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
927 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
928 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
929 <em>required</em></p></td>
930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
936 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a>2.5.2. Responses</h4>
937 <table class="tableblock frame-all grid-all spread">
939 <col style="width: 10%;">
940 <col style="width: 70%;">
941 <col style="width: 20%;">
945 <th class="tableblock halign-left valign-middle">HTTP Code</th>
946 <th class="tableblock halign-left valign-middle">Description</th>
947 <th class="tableblock halign-left valign-middle">Schema</th>
952 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
953 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
954 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
957 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
958 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
959 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
965 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a>2.5.3. Consumes</h4>
969 <p><code>application/json</code></p>
975 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a>2.5.4. Produces</h4>
979 <p><code>application/json</code></p>
986 <h3 id="_clds_healthcheck_get"><a class="anchor" href="#_clds_healthcheck_get"></a>2.6. GET /clds/healthcheck</h3>
988 <h4 id="_description_3"><a class="anchor" href="#_description_3"></a>2.6.1. Description</h4>
989 <div class="paragraph">
990 <p>REST service that retrieves clds healthcheck information.</p>
994 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a>2.6.2. Responses</h4>
995 <table class="tableblock frame-all grid-all spread">
997 <col style="width: 10%;">
998 <col style="width: 70%;">
999 <col style="width: 20%;">
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>
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">OK</p></td>
1012 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
1015 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1016 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
1017 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
1023 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a>2.6.3. Produces</h4>
1027 <p><code>application/json</code></p>
1034 <h3 id="_clds_model-names_get"><a class="anchor" href="#_clds_model-names_get"></a>2.7. GET /clds/model-names</h3>
1036 <h4 id="_description_4"><a class="anchor" href="#_description_4"></a>2.7.1. Description</h4>
1037 <div class="paragraph">
1038 <p>REST service that retrieves a list of CLDS model names.</p>
1042 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a>2.7.2. Responses</h4>
1043 <table class="tableblock frame-all grid-all spread">
1045 <col style="width: 10%;">
1046 <col style="width: 70%;">
1047 <col style="width: 20%;">
1051 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1052 <th class="tableblock halign-left valign-middle">Description</th>
1053 <th class="tableblock halign-left valign-middle">Schema</th>
1058 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1059 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1060 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_valueitem">ValueItem</a> > array</p></td>
1066 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a>2.7.3. Produces</h4>
1070 <p><code>application/json</code></p>
1077 <h3 id="_clds_model_bpmn_modelname_get"><a class="anchor" href="#_clds_model_bpmn_modelname_get"></a>2.8. GET /clds/model/bpmn/{modelName}</h3>
1079 <h4 id="_description_5"><a class="anchor" href="#_description_5"></a>2.8.1. Description</h4>
1080 <div class="paragraph">
1081 <p>REST service that retrieves BPMN for a CLDS model name from the database.<br>
1082 This is subset of the json getModel. This is only expected to be used for<br>
1083 testing purposes, not by the UI.</p>
1087 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a>2.8.2. Parameters</h4>
1088 <table class="tableblock frame-all grid-all spread">
1090 <col style="width: 22%;">
1091 <col style="width: 33%;">
1092 <col style="width: 44%;">
1096 <th class="tableblock halign-left valign-middle">Type</th>
1097 <th class="tableblock halign-left valign-middle">Name</th>
1098 <th class="tableblock halign-left valign-middle">Schema</th>
1103 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1104 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1105 <em>required</em></p></td>
1106 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1112 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a>2.8.3. Responses</h4>
1113 <table class="tableblock frame-all grid-all spread">
1115 <col style="width: 10%;">
1116 <col style="width: 70%;">
1117 <col style="width: 20%;">
1121 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1122 <th class="tableblock halign-left valign-middle">Description</th>
1123 <th class="tableblock halign-left valign-middle">Schema</th>
1128 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1129 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1130 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1136 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a>2.8.4. Produces</h4>
1140 <p><code>text/xml</code></p>
1147 <h3 id="_clds_model_image_modelname_get"><a class="anchor" href="#_clds_model_image_modelname_get"></a>2.9. GET /clds/model/image/{modelName}</h3>
1149 <h4 id="_description_6"><a class="anchor" href="#_description_6"></a>2.9.1. Description</h4>
1150 <div class="paragraph">
1151 <p>REST service that retrieves image for a CLDS model name from the<br>
1152 database. This is subset of the json getModel. This is only expected to<br>
1153 be used for testing purposes, not by the UI.</p>
1157 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a>2.9.2. Parameters</h4>
1158 <table class="tableblock frame-all grid-all spread">
1160 <col style="width: 22%;">
1161 <col style="width: 33%;">
1162 <col style="width: 44%;">
1166 <th class="tableblock halign-left valign-middle">Type</th>
1167 <th class="tableblock halign-left valign-middle">Name</th>
1168 <th class="tableblock halign-left valign-middle">Schema</th>
1173 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1174 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1175 <em>required</em></p></td>
1176 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1182 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a>2.9.3. Responses</h4>
1183 <table class="tableblock frame-all grid-all spread">
1185 <col style="width: 10%;">
1186 <col style="width: 70%;">
1187 <col style="width: 20%;">
1191 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1192 <th class="tableblock halign-left valign-middle">Description</th>
1193 <th class="tableblock halign-left valign-middle">Schema</th>
1198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1199 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1200 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1206 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a>2.9.4. Produces</h4>
1210 <p><code>text/xml</code></p>
1217 <h3 id="_clds_model_modelname_get"><a class="anchor" href="#_clds_model_modelname_get"></a>2.10. GET /clds/model/{modelName}</h3>
1219 <h4 id="_description_7"><a class="anchor" href="#_description_7"></a>2.10.1. Description</h4>
1220 <div class="paragraph">
1221 <p>REST service that retrieves a CLDS model by name from the database.</p>
1225 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a>2.10.2. Parameters</h4>
1226 <table class="tableblock frame-all grid-all spread">
1228 <col style="width: 22%;">
1229 <col style="width: 33%;">
1230 <col style="width: 44%;">
1234 <th class="tableblock halign-left valign-middle">Type</th>
1235 <th class="tableblock halign-left valign-middle">Name</th>
1236 <th class="tableblock halign-left valign-middle">Schema</th>
1241 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1242 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1243 <em>required</em></p></td>
1244 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1250 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a>2.10.3. Responses</h4>
1251 <table class="tableblock frame-all grid-all spread">
1253 <col style="width: 10%;">
1254 <col style="width: 70%;">
1255 <col style="width: 20%;">
1259 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1260 <th class="tableblock halign-left valign-middle">Description</th>
1261 <th class="tableblock halign-left valign-middle">Schema</th>
1266 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1267 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1268 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1274 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a>2.10.4. Produces</h4>
1278 <p><code>application/json</code></p>
1285 <h3 id="_clds_model_modelname_put"><a class="anchor" href="#_clds_model_modelname_put"></a>2.11. PUT /clds/model/{modelName}</h3>
1287 <h4 id="_description_8"><a class="anchor" href="#_description_8"></a>2.11.1. Description</h4>
1288 <div class="paragraph">
1289 <p>REST service that saves a CLDS model by name in the database.</p>
1293 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a>2.11.2. Parameters</h4>
1294 <table class="tableblock frame-all grid-all spread">
1296 <col style="width: 22%;">
1297 <col style="width: 33%;">
1298 <col style="width: 44%;">
1302 <th class="tableblock halign-left valign-middle">Type</th>
1303 <th class="tableblock halign-left valign-middle">Name</th>
1304 <th class="tableblock halign-left valign-middle">Schema</th>
1309 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1310 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1311 <em>required</em></p></td>
1312 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1315 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1317 <em>required</em></p></td>
1318 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1324 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a>2.11.3. Responses</h4>
1325 <table class="tableblock frame-all grid-all spread">
1327 <col style="width: 10%;">
1328 <col style="width: 70%;">
1329 <col style="width: 20%;">
1333 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1334 <th class="tableblock halign-left valign-middle">Description</th>
1335 <th class="tableblock halign-left valign-middle">Schema</th>
1340 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1341 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1342 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1348 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a>2.11.4. Consumes</h4>
1352 <p><code>application/json</code></p>
1358 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a>2.11.5. Produces</h4>
1362 <p><code>application/json</code></p>
1369 <h3 id="_clds_properties_get"><a class="anchor" href="#_clds_properties_get"></a>2.12. GET /clds/properties</h3>
1371 <h4 id="_description_9"><a class="anchor" href="#_description_9"></a>2.12.1. Description</h4>
1372 <div class="paragraph">
1373 <p>REST service that retrieves total properties required by UI</p>
1377 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a>2.12.2. Responses</h4>
1378 <table class="tableblock frame-all grid-all spread">
1380 <col style="width: 10%;">
1381 <col style="width: 70%;">
1382 <col style="width: 20%;">
1386 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1387 <th class="tableblock halign-left valign-middle">Description</th>
1388 <th class="tableblock halign-left valign-middle">Schema</th>
1393 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1394 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1395 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1401 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a>2.12.3. Produces</h4>
1405 <p><code>application/json</code></p>
1412 <h3 id="_clds_properties_serviceinvariantuuid_get"><a class="anchor" href="#_clds_properties_serviceinvariantuuid_get"></a>2.13. GET /clds/properties/{serviceInvariantUUID}</h3>
1414 <h4 id="_description_10"><a class="anchor" href="#_description_10"></a>2.13.1. Description</h4>
1415 <div class="paragraph">
1416 <p>REST service that retrieves total properties by using invariantUUID based<br>
1417 on refresh and non refresh</p>
1421 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a>2.13.2. Parameters</h4>
1422 <table class="tableblock frame-all grid-all spread">
1424 <col style="width: 18%;">
1425 <col style="width: 27%;">
1426 <col style="width: 36%;">
1427 <col style="width: 18%;">
1431 <th class="tableblock halign-left valign-middle">Type</th>
1432 <th class="tableblock halign-left valign-middle">Name</th>
1433 <th class="tableblock halign-left valign-middle">Schema</th>
1434 <th class="tableblock halign-left valign-middle">Default</th>
1439 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1440 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceInvariantUUID</strong><br>
1441 <em>required</em></p></td>
1442 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1443 <td class="tableblock halign-left valign-middle"></td>
1446 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1447 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>refresh</strong><br>
1448 <em>optional</em></p></td>
1449 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1450 <td class="tableblock halign-left valign-middle"><p class="tableblock"><code>"false"</code></p></td>
1456 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a>2.13.3. Responses</h4>
1457 <table class="tableblock frame-all grid-all spread">
1459 <col style="width: 10%;">
1460 <col style="width: 70%;">
1461 <col style="width: 20%;">
1465 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1466 <th class="tableblock halign-left valign-middle">Description</th>
1467 <th class="tableblock halign-left valign-middle">Schema</th>
1472 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1473 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1474 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1480 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a>2.13.4. Produces</h4>
1484 <p><code>application/json</code></p>
1491 <h3 id="_clds_sdc_services_get"><a class="anchor" href="#_clds_sdc_services_get"></a>2.14. GET /clds/sdc/services</h3>
1493 <h4 id="_description_11"><a class="anchor" href="#_description_11"></a>2.14.1. Description</h4>
1494 <div class="paragraph">
1495 <p>REST service that retrieves sdc services</p>
1499 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a>2.14.2. Responses</h4>
1500 <table class="tableblock frame-all grid-all spread">
1502 <col style="width: 10%;">
1503 <col style="width: 70%;">
1504 <col style="width: 20%;">
1508 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1509 <th class="tableblock halign-left valign-middle">Description</th>
1510 <th class="tableblock halign-left valign-middle">Schema</th>
1515 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1516 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1517 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1523 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a>2.14.3. Produces</h4>
1527 <p><code>application/json</code></p>
1534 <h3 id="_clds_undeploy_modelname_put"><a class="anchor" href="#_clds_undeploy_modelname_put"></a>2.15. PUT /clds/undeploy/{modelName}</h3>
1536 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a>2.15.1. Parameters</h4>
1537 <table class="tableblock frame-all grid-all spread">
1539 <col style="width: 22%;">
1540 <col style="width: 33%;">
1541 <col style="width: 44%;">
1545 <th class="tableblock halign-left valign-middle">Type</th>
1546 <th class="tableblock halign-left valign-middle">Name</th>
1547 <th class="tableblock halign-left valign-middle">Schema</th>
1552 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1553 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1554 <em>required</em></p></td>
1555 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1558 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1559 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1560 <em>required</em></p></td>
1561 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1567 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a>2.15.2. Responses</h4>
1568 <table class="tableblock frame-all grid-all spread">
1570 <col style="width: 10%;">
1571 <col style="width: 70%;">
1572 <col style="width: 20%;">
1576 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1577 <th class="tableblock halign-left valign-middle">Description</th>
1578 <th class="tableblock halign-left valign-middle">Schema</th>
1583 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1584 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1585 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1589 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
1590 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1596 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a>2.15.3. Consumes</h4>
1600 <p><code>application/json</code></p>
1606 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a>2.15.4. Produces</h4>
1610 <p><code>application/json</code></p>
1617 <h3 id="_cldstempate_template-names_get"><a class="anchor" href="#_cldstempate_template-names_get"></a>2.16. GET /cldsTempate/template-names</h3>
1619 <h4 id="_description_12"><a class="anchor" href="#_description_12"></a>2.16.1. Description</h4>
1620 <div class="paragraph">
1621 <p>REST service that retrieves a list of CLDS template names.</p>
1625 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a>2.16.2. Responses</h4>
1626 <table class="tableblock frame-all grid-all spread">
1628 <col style="width: 10%;">
1629 <col style="width: 70%;">
1630 <col style="width: 20%;">
1634 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1635 <th class="tableblock halign-left valign-middle">Description</th>
1636 <th class="tableblock halign-left valign-middle">Schema</th>
1641 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1642 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1643 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_valueitem">ValueItem</a> > array</p></td>
1649 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a>2.16.3. Produces</h4>
1653 <p><code>application/json</code></p>
1660 <h3 id="_cldstempate_template_bpmn_templatename_get"><a class="anchor" href="#_cldstempate_template_bpmn_templatename_get"></a>2.17. GET /cldsTempate/template/bpmn/{templateName}</h3>
1662 <h4 id="_description_13"><a class="anchor" href="#_description_13"></a>2.17.1. Description</h4>
1663 <div class="paragraph">
1664 <p>REST service that retrieves BPMN for a CLDS template name from the<br>
1665 database. This is subset of the json getModel. This is only expected to<br>
1666 be used for testing purposes, not by the UI.</p>
1670 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a>2.17.2. Parameters</h4>
1671 <table class="tableblock frame-all grid-all spread">
1673 <col style="width: 22%;">
1674 <col style="width: 33%;">
1675 <col style="width: 44%;">
1679 <th class="tableblock halign-left valign-middle">Type</th>
1680 <th class="tableblock halign-left valign-middle">Name</th>
1681 <th class="tableblock halign-left valign-middle">Schema</th>
1686 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1687 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1688 <em>required</em></p></td>
1689 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1695 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a>2.17.3. Responses</h4>
1696 <table class="tableblock frame-all grid-all spread">
1698 <col style="width: 10%;">
1699 <col style="width: 70%;">
1700 <col style="width: 20%;">
1704 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1705 <th class="tableblock halign-left valign-middle">Description</th>
1706 <th class="tableblock halign-left valign-middle">Schema</th>
1711 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1712 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1713 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1719 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a>2.17.4. Produces</h4>
1723 <p><code>text/xml</code></p>
1730 <h3 id="_cldstempate_template_image_templatename_get"><a class="anchor" href="#_cldstempate_template_image_templatename_get"></a>2.18. GET /cldsTempate/template/image/{templateName}</h3>
1732 <h4 id="_description_14"><a class="anchor" href="#_description_14"></a>2.18.1. Description</h4>
1733 <div class="paragraph">
1734 <p>REST service that retrieves image for a CLDS template name from the<br>
1735 database. This is subset of the json getModel. This is only expected to<br>
1736 be used for testing purposes, not by the UI.</p>
1740 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a>2.18.2. Parameters</h4>
1741 <table class="tableblock frame-all grid-all spread">
1743 <col style="width: 22%;">
1744 <col style="width: 33%;">
1745 <col style="width: 44%;">
1749 <th class="tableblock halign-left valign-middle">Type</th>
1750 <th class="tableblock halign-left valign-middle">Name</th>
1751 <th class="tableblock halign-left valign-middle">Schema</th>
1756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1757 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1758 <em>required</em></p></td>
1759 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1765 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a>2.18.3. Responses</h4>
1766 <table class="tableblock frame-all grid-all spread">
1768 <col style="width: 10%;">
1769 <col style="width: 70%;">
1770 <col style="width: 20%;">
1774 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1775 <th class="tableblock halign-left valign-middle">Description</th>
1776 <th class="tableblock halign-left valign-middle">Schema</th>
1781 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1782 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1783 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1789 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a>2.18.4. Produces</h4>
1793 <p><code>text/xml</code></p>
1800 <h3 id="_cldstempate_template_templatename_get"><a class="anchor" href="#_cldstempate_template_templatename_get"></a>2.19. GET /cldsTempate/template/{templateName}</h3>
1802 <h4 id="_description_15"><a class="anchor" href="#_description_15"></a>2.19.1. Description</h4>
1803 <div class="paragraph">
1804 <p>REST service that retrieves a CLDS template by name from the database.</p>
1808 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a>2.19.2. Parameters</h4>
1809 <table class="tableblock frame-all grid-all spread">
1811 <col style="width: 22%;">
1812 <col style="width: 33%;">
1813 <col style="width: 44%;">
1817 <th class="tableblock halign-left valign-middle">Type</th>
1818 <th class="tableblock halign-left valign-middle">Name</th>
1819 <th class="tableblock halign-left valign-middle">Schema</th>
1824 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1825 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1826 <em>required</em></p></td>
1827 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1833 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a>2.19.3. Responses</h4>
1834 <table class="tableblock frame-all grid-all spread">
1836 <col style="width: 10%;">
1837 <col style="width: 70%;">
1838 <col style="width: 20%;">
1842 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1843 <th class="tableblock halign-left valign-middle">Description</th>
1844 <th class="tableblock halign-left valign-middle">Schema</th>
1849 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1850 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1851 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1857 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a>2.19.4. Produces</h4>
1861 <p><code>application/json</code></p>
1868 <h3 id="_cldstempate_template_templatename_put"><a class="anchor" href="#_cldstempate_template_templatename_put"></a>2.20. PUT /cldsTempate/template/{templateName}</h3>
1870 <h4 id="_description_16"><a class="anchor" href="#_description_16"></a>2.20.1. Description</h4>
1871 <div class="paragraph">
1872 <p>REST service that saves a CLDS template by name in the database.</p>
1876 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a>2.20.2. Parameters</h4>
1877 <table class="tableblock frame-all grid-all spread">
1879 <col style="width: 22%;">
1880 <col style="width: 33%;">
1881 <col style="width: 44%;">
1885 <th class="tableblock halign-left valign-middle">Type</th>
1886 <th class="tableblock halign-left valign-middle">Name</th>
1887 <th class="tableblock halign-left valign-middle">Schema</th>
1892 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1893 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1894 <em>required</em></p></td>
1895 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1899 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1900 <em>required</em></p></td>
1901 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1907 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a>2.20.3. Responses</h4>
1908 <table class="tableblock frame-all grid-all spread">
1910 <col style="width: 10%;">
1911 <col style="width: 70%;">
1912 <col style="width: 20%;">
1916 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1917 <th class="tableblock halign-left valign-middle">Description</th>
1918 <th class="tableblock halign-left valign-middle">Schema</th>
1923 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1924 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1925 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1931 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a>2.20.4. Consumes</h4>
1935 <p><code>application/json</code></p>
1941 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a>2.20.5. Produces</h4>
1945 <p><code>application/json</code></p>
1952 <h3 id="_healthcheck_get"><a class="anchor" href="#_healthcheck_get"></a>2.21. GET /healthcheck</h3>
1954 <h4 id="_description_17"><a class="anchor" href="#_description_17"></a>2.21.1. Description</h4>
1955 <div class="paragraph">
1956 <p>REST service that retrieves clds healthcheck information.</p>
1960 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a>2.21.2. Responses</h4>
1961 <table class="tableblock frame-all grid-all spread">
1963 <col style="width: 10%;">
1964 <col style="width: 70%;">
1965 <col style="width: 20%;">
1969 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1970 <th class="tableblock halign-left valign-middle">Description</th>
1971 <th class="tableblock halign-left valign-middle">Schema</th>
1976 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1977 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1978 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
1981 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1982 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
1983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
1989 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a>2.21.3. Produces</h4>
1993 <p><code>application/json</code></p>
2000 <h3 id="_user_getuser_get"><a class="anchor" href="#_user_getuser_get"></a>2.22. GET /user/getUser</h3>
2002 <h4 id="_description_18"><a class="anchor" href="#_description_18"></a>2.22.1. Description</h4>
2003 <div class="paragraph">
2004 <p>REST service that returns the username.</p>
2008 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a>2.22.2. Responses</h4>
2009 <table class="tableblock frame-all grid-all spread">
2011 <col style="width: 10%;">
2012 <col style="width: 70%;">
2013 <col style="width: 20%;">
2017 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2018 <th class="tableblock halign-left valign-middle">Description</th>
2019 <th class="tableblock halign-left valign-middle">Schema</th>
2024 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2025 <td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
2026 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2032 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a>2.22.3. Produces</h4>
2036 <p><code>text/plain</code></p>
2045 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a>3. Definitions</h2>
2046 <div class="sectionbody">
2048 <h3 id="_cldsevent"><a class="anchor" href="#_cldsevent"></a>3.1. CldsEvent</h3>
2049 <table class="tableblock frame-all grid-all spread">
2051 <col style="width: 42%;">
2052 <col style="width: 57%;">
2056 <th class="tableblock halign-left valign-middle">Name</th>
2057 <th class="tableblock halign-left valign-middle">Schema</th>
2062 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionAndStateCd</strong><br>
2063 <em>optional</em></p></td>
2064 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2067 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionCd</strong><br>
2068 <em>optional</em></p></td>
2069 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2072 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionStateCd</strong><br>
2073 <em>optional</em></p></td>
2074 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2077 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2078 <em>optional</em></p></td>
2079 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2082 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>processInstanceId</strong><br>
2083 <em>optional</em></p></td>
2084 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2087 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2088 <em>optional</em></p></td>
2089 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2095 <h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a>3.2. CldsHealthCheck</h3>
2096 <table class="tableblock frame-all grid-all spread">
2098 <col style="width: 42%;">
2099 <col style="width: 57%;">
2103 <th class="tableblock halign-left valign-middle">Name</th>
2104 <th class="tableblock halign-left valign-middle">Schema</th>
2109 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2110 <em>optional</em></p></td>
2111 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
2115 <em>optional</em></p></td>
2116 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2119 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
2120 <em>optional</em></p></td>
2121 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2127 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a>3.3. CldsInfo</h3>
2128 <table class="tableblock frame-all grid-all spread">
2130 <col style="width: 42%;">
2131 <col style="width: 57%;">
2135 <th class="tableblock halign-left valign-middle">Name</th>
2136 <th class="tableblock halign-left valign-middle">Schema</th>
2141 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
2142 <em>optional</em></p></td>
2143 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
2147 <em>optional</em></p></td>
2148 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2151 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
2152 <em>optional</em></p></td>
2153 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2156 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
2157 <em>optional</em></p></td>
2158 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
2162 <em>optional</em></p></td>
2163 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2166 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
2167 <em>optional</em></p></td>
2168 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2174 <h3 id="_cldsmodel"><a class="anchor" href="#_cldsmodel"></a>3.4. CldsModel</h3>
2175 <table class="tableblock frame-all grid-all spread">
2177 <col style="width: 42%;">
2178 <col style="width: 57%;">
2182 <th class="tableblock halign-left valign-middle">Name</th>
2183 <th class="tableblock halign-left valign-middle">Schema</th>
2188 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprintText</strong><br>
2189 <em>optional</em></p></td>
2190 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2194 <em>optional</em></p></td>
2195 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsModelInstanceList</strong><br>
2199 <em>optional</em></p></td>
2200 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
2203 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2204 <em>optional</em></p></td>
2205 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2209 <em>optional</em></p></td>
2210 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2213 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2214 <em>optional</em></p></td>
2215 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2218 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2219 <em>optional</em></p></td>
2220 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2223 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>docText</strong><br>
2224 <em>optional</em></p></td>
2225 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2228 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2229 <em>optional</em></p></td>
2230 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsevent">CldsEvent</a></p></td>
2233 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2234 <em>optional</em></p></td>
2235 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2238 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2239 <em>optional</em></p></td>
2240 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2243 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2244 <em>optional</em></p></td>
2245 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permittedActionCd</strong><br>
2249 <em>optional</em></p></td>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2254 <em>optional</em></p></td>
2255 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2258 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
2259 <em>optional</em></p></td>
2260 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2263 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateId</strong><br>
2264 <em>optional</em></p></td>
2265 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2268 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2269 <em>optional</em></p></td>
2270 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeId</strong><br>
2274 <em>optional</em></p></td>
2275 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeName</strong><br>
2279 <em>optional</em></p></td>
2280 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2286 <h3 id="_cldsmodelinstance"><a class="anchor" href="#_cldsmodelinstance"></a>3.5. CldsModelInstance</h3>
2287 <table class="tableblock frame-all grid-all spread">
2289 <col style="width: 42%;">
2290 <col style="width: 57%;">
2294 <th class="tableblock halign-left valign-middle">Name</th>
2295 <th class="tableblock halign-left valign-middle">Schema</th>
2300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>location</strong><br>
2301 <em>optional</em></p></td>
2302 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2305 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelInstanceId</strong><br>
2306 <em>optional</em></p></td>
2307 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2310 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>vmName</strong><br>
2311 <em>optional</em></p></td>
2312 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2318 <h3 id="_cldsmonitoringdetails"><a class="anchor" href="#_cldsmonitoringdetails"></a>3.6. CldsMonitoringDetails</h3>
2319 <table class="tableblock frame-all grid-all spread">
2321 <col style="width: 42%;">
2322 <col style="width: 57%;">
2326 <th class="tableblock halign-left valign-middle">Name</th>
2327 <th class="tableblock halign-left valign-middle">Schema</th>
2332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
2333 <em>optional</em></p></td>
2334 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2337 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>closeloopName</strong><br>
2338 <em>optional</em></p></td>
2339 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2342 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2343 <em>optional</em></p></td>
2344 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2347 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
2348 <em>optional</em></p></td>
2349 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2352 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceTypeId</strong><br>
2353 <em>optional</em></p></td>
2354 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2357 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2358 <em>optional</em></p></td>
2359 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2362 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>timestamp</strong><br>
2363 <em>optional</em></p></td>
2364 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2367 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2368 <em>optional</em></p></td>
2369 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2375 <h3 id="_cldstemplate"><a class="anchor" href="#_cldstemplate"></a>3.7. CldsTemplate</h3>
2376 <table class="tableblock frame-all grid-all spread">
2378 <col style="width: 42%;">
2379 <col style="width: 57%;">
2383 <th class="tableblock halign-left valign-middle">Name</th>
2384 <th class="tableblock halign-left valign-middle">Schema</th>
2389 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnId</strong><br>
2390 <em>optional</em></p></td>
2391 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2394 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2395 <em>optional</em></p></td>
2396 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2399 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnUserid</strong><br>
2400 <em>optional</em></p></td>
2401 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2404 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2405 <em>optional</em></p></td>
2406 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2409 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2410 <em>optional</em></p></td>
2411 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2414 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2415 <em>optional</em></p></td>
2416 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2419 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageId</strong><br>
2420 <em>optional</em></p></td>
2421 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2424 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2425 <em>optional</em></p></td>
2426 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2429 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageUserid</strong><br>
2430 <em>optional</em></p></td>
2431 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2434 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2435 <em>optional</em></p></td>
2436 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2439 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propId</strong><br>
2440 <em>optional</em></p></td>
2441 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2444 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2445 <em>optional</em></p></td>
2446 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2449 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propUserid</strong><br>
2450 <em>optional</em></p></td>
2451 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2454 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userAuthorizedToUpdate</strong><br>
2455 <em>optional</em></p></td>
2456 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2462 <h3 id="_dcaeevent"><a class="anchor" href="#_dcaeevent"></a>3.8. DcaeEvent</h3>
2463 <table class="tableblock frame-all grid-all spread">
2465 <col style="width: 42%;">
2466 <col style="width: 57%;">
2470 <th class="tableblock halign-left valign-middle">Name</th>
2471 <th class="tableblock halign-left valign-middle">Schema</th>
2476 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactName</strong><br>
2477 <em>optional</em></p></td>
2478 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2481 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsActionCd</strong><br>
2482 <em>optional</em></p></td>
2483 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2486 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2487 <em>optional</em></p></td>
2488 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2491 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2492 <em>optional</em></p></td>
2493 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2496 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>instances</strong><br>
2497 <em>optional</em></p></td>
2498 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
2501 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceUUID</strong><br>
2502 <em>optional</em></p></td>
2503 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2506 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUUID</strong><br>
2507 <em>optional</em></p></td>
2508 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2514 <h3 id="_valueitem"><a class="anchor" href="#_valueitem"></a>3.9. ValueItem</h3>
2515 <table class="tableblock frame-all grid-all spread">
2517 <col style="width: 42%;">
2518 <col style="width: 57%;">
2522 <th class="tableblock halign-left valign-middle">Name</th>
2523 <th class="tableblock halign-left valign-middle">Schema</th>
2528 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
2529 <em>optional</em></p></td>
2530 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2539 <div id="footer-text">
2540 Last updated 2018-06-05 12:10:11 +02:00