Gitiles
Code Review Sign In
gerrit.nordix.org / onap / clamp / 2aad6d681dcbea5564425648375f7ddca2080940 / . / docs / swagger / swagger.html
blob: 184a46a91ef3cafab6705aab5fe8c071f3e32c0b [file] [log] [blame]
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame^]1<!DOCTYPE html>
2<html lang="en">
3<head>
4<meta charset="UTF-8">
5<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
6<meta name="viewport" content="width=device-width, initial-scale=1.0">
7<meta name="generator" content="Asciidoctor 1.5.3">
8<title>clamp</title>
9<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
10<style>
11/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
12/* 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";*/
14article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
15audio,canvas,video{display:inline-block}
16audio:not([controls]){display:none;height:0}
17[hidden],template{display:none}
18script{display:none!important}
19html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
20body{margin:0}
21a{background:transparent}
22a:focus{outline:thin dotted}
23a:active,a:hover{outline:0}
24h1{font-size:2em;margin:.67em 0}
25abbr[title]{border-bottom:1px dotted}
26b,strong{font-weight:bold}
27dfn{font-style:italic}
28hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
29mark{background:#ff0;color:#000}
30code,kbd,pre,samp{font-family:monospace;font-size:1em}
31pre{white-space:pre-wrap}
32q{quotes:"\201C" "\201D" "\2018" "\2019"}
33small{font-size:80%}
34sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
35sup{top:-.5em}
36sub{bottom:-.25em}
37img{border:0}
38svg:not(:root){overflow:hidden}
39figure{margin:0}
40fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
41legend{border:0;padding:0}
42button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
43button,input{line-height:normal}
44button,select{text-transform:none}
45button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
46button[disabled],html input[disabled]{cursor:default}
47input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
48input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
49input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
50button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
51textarea{overflow:auto;vertical-align:top}
52table{border-collapse:collapse;border-spacing:0}
53*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
54html,body{font-size:100%}
55body{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}
56a:hover{cursor:pointer}
57img,object,embed{max-width:100%;height:auto}
58object,embed{height:100%}
59img{-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}
66.hide{display:none}
67body{-webkit-font-smoothing:antialiased}
68img,object,svg{display:inline-block;vertical-align:middle}
69textarea{height:auto;min-height:50px}
70select{width:100%}
71.center{margin-left:auto;margin-right:auto}
72.spread{width:100%}
73p.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}
75div,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}
76a{color:#2156a5;text-decoration:underline;line-height:inherit}
77a:hover,a:focus{color:#1d4b8f}
78a img{border:none}
79p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
80p aside{font-size:.875em;line-height:1.35;font-style:italic}
81h1,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}
82h1 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}
83h1{font-size:2.125em}
84h2{font-size:1.6875em}
85h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
86h4,h5{font-size:1.125em}
87h6{font-size:1em}
88hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
89em,i{font-style:italic;line-height:inherit}
90strong,b{font-weight:bold;line-height:inherit}
91small{font-size:60%;line-height:inherit}
92code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
93ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
94ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
95ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
96ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
97ul.square{list-style-type:square}
98ul.circle{list-style-type:circle}
99ul.disc{list-style-type:disc}
100ul.no-bullet{list-style:none}
101ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
102dl dt{margin-bottom:.3125em;font-weight:bold}
103dl dd{margin-bottom:1.25em}
104abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
105abbr{text-transform:none}
106blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
107blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
108blockquote cite:before{content:"\2014 \0020"}
109blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
110blockquote,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}
112h1{font-size:2.75em}
113h2{font-size:2.3125em}
114h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
115h4{font-size:1.4375em}}
116table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
117table thead,table tfoot{background:#f7f8f7;font-weight:bold}
118table 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}
119table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
120table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
121table 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}
122body{tab-size:4}
123h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
124h1 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}
128pre,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)}
130kbd{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)}
134b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
135b.button:before{content:"[";padding:0 3px 0 2px}
136b.button:after{content:"]";padding:0 2px 0 3px}
137p 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}
166body.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}
172body.toc2.toc-right{padding-left:0;padding-right:15em}
173body.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}
179body.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}
195table.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)}
197table.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:"$"}
227table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
228table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
229table.pyhltable td.code{padding-left:.75em;padding-right:0}
230pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
231pre.pygments .lineno{display:inline-block;margin-right:.25em}
232table.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}
253table.tableblock{max-width:100%;border-collapse:separate}
254table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
255table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
256table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
257table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
258table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
259table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
260table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
261table.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}
262table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
263table.frame-all{border-width:1px}
264table.frame-sides{border-width:0 1px}
265table.frame-topbot{border-width:1px 0}
266th.halign-left,td.halign-left{text-align:left}
267th.halign-right,td.halign-right{text-align:right}
268th.halign-center,td.halign-center{text-align:center}
269th.valign-top,td.valign-top{vertical-align:top}
270th.valign-bottom,td.valign-bottom{vertical-align:bottom}
271th.valign-middle,td.valign-middle{vertical-align:middle}
272table thead th,table tfoot th{font-weight:bold}
273tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
274tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
275p.tableblock>code:only-child{background:none;padding:0}
276p.tableblock{font-size:1em}
277td>div.verse{white-space:pre}
278ol{margin-left:1.75em}
279ul li ol{margin-left:1.5em}
280dl dd{margin-left:1.125em}
281dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
282ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
283ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
284ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
285ul.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}
286ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
287ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
288ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
289ul.inline>li>*{display:block}
290.unstyled dl dt{font-weight:400;font-style:normal}
291ol.arabic{list-style-type:decimal}
292ol.decimal{list-style-type:decimal-leading-zero}
293ol.loweralpha{list-style-type:lower-alpha}
294ol.upperalpha{list-style-type:upper-alpha}
295ol.lowerroman{list-style-type:lower-roman}
296ol.upperroman{list-style-type:upper-roman}
297ol.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}
300td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
301td.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}
314a.image{text-decoration:none;display:inline-block}
315a.image object{pointer-events:none}
316sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
317sup.footnote a,sup.footnoteref a{text-decoration:none}
318sup.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%}
327div.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}
333.aqua{color:#00bfbf}
334.aqua-background{background-color:#00fafa}
335.black{color:#000}
336.black-background{background-color:#000}
337.blue{color:#0000bf}
338.blue-background{background-color:#0000fa}
339.fuchsia{color:#bf00bf}
340.fuchsia-background{background-color:#fa00fa}
341.gray{color:#606060}
342.gray-background{background-color:#7d7d7d}
343.green{color:#006000}
344.green-background{background-color:#007d00}
345.lime{color:#00bf00}
346.lime-background{background-color:#00fa00}
347.maroon{color:#600000}
348.maroon-background{background-color:#7d0000}
349.navy{color:#000060}
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}
355.red{color:#bf0000}
356.red-background{background-color:#fa0000}
357.silver{color:#909090}
358.silver-background{background-color:#bcbcbc}
359.teal{color:#006060}
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}
365span.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)}
376pre .conum[data-value]{position:relative;top:-.125em}
377b.conum *{color:inherit!important}
378.conum:not([data-value]):empty{display:none}
379dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
380h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
381p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
382p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
383p{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}
389a{color:inherit!important;text-decoration:underline!important}
390a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
391a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
392abbr[title]:after{content:" (" attr(title) ")"}
393pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
394thead{display:table-header-group}
395svg{max-width:100%}
396p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
397h2,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}
403body.book #header{text-align:center}
404body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
405body.book #header .details{border:0!important;display:block;padding:0!important}
406body.book #header .details span:first-child{margin-left:0!important}
407body.book #header .details br{display:block}
408body.book #header .details br+span:before{content:none!important}
409body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
410body.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}}
418</style>
419</head>
420<body class="book toc2 toc-left">
421<div id="header">
422<h1>clamp</h1>
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>
430</ul>
431</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>
441</ul>
442</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>
447</ul>
448</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>
453</ul>
454</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>
462</ul>
463</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>
470</ul>
471</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>
477</ul>
478</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>
484</ul>
485</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>
492</ul>
493</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>
500</ul>
501</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>
508</ul>
509</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>
517</ul>
518</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>
524</ul>
525</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>
532</ul>
533</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>
539</ul>
540</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>
547</ul>
548</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>
554</ul>
555</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>
562</ul>
563</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>
570</ul>
571</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>
578</ul>
579</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>
587</ul>
588</li>
589<li><a href="#_user_username_get">2.21. GET /user/{userName}</a>
590<ul class="sectlevel3">
591<li><a href="#_description_17">2.21.1. Description</a></li>
592<li><a href="#_parameters_14">2.21.2. Parameters</a></li>
593<li><a href="#_responses_21">2.21.3. Responses</a></li>
594<li><a href="#_produces_21">2.21.4. Produces</a></li>
595</ul>
596</li>
597</ul>
598</li>
599<li><a href="#_definitions">3. Definitions</a>
600<ul class="sectlevel2">
601<li><a href="#_cldsevent">3.1. CldsEvent</a></li>
602<li><a href="#_cldshealthcheck">3.2. CldsHealthCheck</a></li>
603<li><a href="#_cldsinfo">3.3. CldsInfo</a></li>
604<li><a href="#_cldsmodel">3.4. CldsModel</a></li>
605<li><a href="#_cldsmodelinstance">3.5. CldsModelInstance</a></li>
606<li><a href="#_cldsmonitoringdetails">3.6. CldsMonitoringDetails</a></li>
607<li><a href="#_cldstemplate">3.7. CldsTemplate</a></li>
608<li><a href="#_dcaeevent">3.8. DcaeEvent</a></li>
609<li><a href="#_valueitem">3.9. ValueItem</a></li>
610</ul>
611</li>
612</ul>
613</div>
614</div>
615<div id="content">
616<div class="sect1">
617<h2 id="_overview"><a class="anchor" href="#_overview"></a>1. Overview</h2>
618<div class="sectionbody">
619<div class="sect2">
620<h3 id="_version_information"><a class="anchor" href="#_version_information"></a>1.1. Version information</h3>
621<div class="paragraph">
622<p><em>Version</em> : 2.0.0-SNAPSHOT</p>
623</div>
624</div>
625<div class="sect2">
626<h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a>1.2. URI scheme</h3>
627<div class="paragraph">
628<p><em>BasePath</em> : /clamp/restservices/clds/v1<br>
629<em>Schemes</em> : HTTP</p>
630</div>
631</div>
632</div>
633</div>
634<div class="sect1">
635<h2 id="_paths"><a class="anchor" href="#_paths"></a>2. Paths</h2>
636<div class="sectionbody">
637<div class="sect2">
638<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>
639<div class="sect3">
640<h4 id="_description"><a class="anchor" href="#_description"></a>2.1.1. Description</h4>
641<div class="paragraph">
642<p>REST service that saves and processes an action for a CLDS model by name.</p>
643</div>
644</div>
645<div class="sect3">
646<h4 id="_parameters"><a class="anchor" href="#_parameters"></a>2.1.2. Parameters</h4>
647<table class="tableblock frame-all grid-all spread">
648<colgroup>
649<col style="width: 22%;">
650<col style="width: 33%;">
651<col style="width: 44%;">
652</colgroup>
653<thead>
654<tr>
655<th class="tableblock halign-left valign-middle">Type</th>
656<th class="tableblock halign-left valign-middle">Name</th>
657<th class="tableblock halign-left valign-middle">Schema</th>
658</tr>
659</thead>
660<tbody>
661<tr>
662<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
663<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
664<em>required</em></p></td>
665<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
666</tr>
667<tr>
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>modelName</strong><br>
670<em>required</em></p></td>
671<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
672</tr>
673<tr>
674<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
675<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>test</strong><br>
676<em>required</em></p></td>
677<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
678</tr>
679<tr>
680<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
681<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
682<em>required</em></p></td>
683<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
684</tr>
685</tbody>
686</table>
687</div>
688<div class="sect3">
689<h4 id="_responses"><a class="anchor" href="#_responses"></a>2.1.3. Responses</h4>
690<table class="tableblock frame-all grid-all spread">
691<colgroup>
692<col style="width: 10%;">
693<col style="width: 70%;">
694<col style="width: 20%;">
695</colgroup>
696<thead>
697<tr>
698<th class="tableblock halign-left valign-middle">HTTP Code</th>
699<th class="tableblock halign-left valign-middle">Description</th>
700<th class="tableblock halign-left valign-middle">Schema</th>
701</tr>
702</thead>
703<tbody>
704<tr>
705<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
706<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
707<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
708</tr>
709<tr>
710<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
711<td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
712<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
713</tr>
714</tbody>
715</table>
716</div>
717<div class="sect3">
718<h4 id="_consumes"><a class="anchor" href="#_consumes"></a>2.1.4. Consumes</h4>
719<div class="ulist">
720<ul>
721<li>
722<p><code>application/json</code></p>
723</li>
724</ul>
725</div>
726</div>
727<div class="sect3">
728<h4 id="_produces"><a class="anchor" href="#_produces"></a>2.1.5. Produces</h4>
729<div class="ulist">
730<ul>
731<li>
732<p><code>application/json</code></p>
733</li>
734</ul>
735</div>
736</div>
737</div>
738<div class="sect2">
739<h3 id="_clds_cldsdetails_get"><a class="anchor" href="#_clds_cldsdetails_get"></a>2.2. GET /clds/cldsDetails</h3>
740<div class="sect3">
741<h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a>2.2.1. Responses</h4>
742<table class="tableblock frame-all grid-all spread">
743<colgroup>
744<col style="width: 10%;">
745<col style="width: 70%;">
746<col style="width: 20%;">
747</colgroup>
748<thead>
749<tr>
750<th class="tableblock halign-left valign-middle">HTTP Code</th>
751<th class="tableblock halign-left valign-middle">Description</th>
752<th class="tableblock halign-left valign-middle">Schema</th>
753</tr>
754</thead>
755<tbody>
756<tr>
757<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
758<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
759<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_cldsmonitoringdetails">CldsMonitoringDetails</a> &gt; array</p></td>
760</tr>
761</tbody>
762</table>
763</div>
764<div class="sect3">
765<h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a>2.2.2. Produces</h4>
766<div class="ulist">
767<ul>
768<li>
769<p><code>application/json</code></p>
770</li>
771</ul>
772</div>
773</div>
774</div>
775<div class="sect2">
776<h3 id="_clds_cldsinfo_get"><a class="anchor" href="#_clds_cldsinfo_get"></a>2.3. GET /clds/cldsInfo</h3>
777<div class="sect3">
778<h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a>2.3.1. Responses</h4>
779<table class="tableblock frame-all grid-all spread">
780<colgroup>
781<col style="width: 10%;">
782<col style="width: 70%;">
783<col style="width: 20%;">
784</colgroup>
785<thead>
786<tr>
787<th class="tableblock halign-left valign-middle">HTTP Code</th>
788<th class="tableblock halign-left valign-middle">Description</th>
789<th class="tableblock halign-left valign-middle">Schema</th>
790</tr>
791</thead>
792<tbody>
793<tr>
794<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
795<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
796<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
797</tr>
798</tbody>
799</table>
800</div>
801<div class="sect3">
802<h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a>2.3.2. Produces</h4>
803<div class="ulist">
804<ul>
805<li>
806<p><code>application/json</code></p>
807</li>
808</ul>
809</div>
810</div>
811</div>
812<div class="sect2">
813<h3 id="_clds_dcae_event_post"><a class="anchor" href="#_clds_dcae_event_post"></a>2.4. POST /clds/dcae/event</h3>
814<div class="sect3">
815<h4 id="_description_2"><a class="anchor" href="#_description_2"></a>2.4.1. Description</h4>
816<div class="paragraph">
817<p>REST service that accepts events for a model.</p>
818</div>
819</div>
820<div class="sect3">
821<h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a>2.4.2. Parameters</h4>
822<table class="tableblock frame-all grid-all spread">
823<colgroup>
824<col style="width: 22%;">
825<col style="width: 33%;">
826<col style="width: 44%;">
827</colgroup>
828<thead>
829<tr>
830<th class="tableblock halign-left valign-middle">Type</th>
831<th class="tableblock halign-left valign-middle">Name</th>
832<th class="tableblock halign-left valign-middle">Schema</th>
833</tr>
834</thead>
835<tbody>
836<tr>
837<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
838<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>test</strong><br>
839<em>required</em></p></td>
840<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
841</tr>
842<tr>
843<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
844<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
845<em>required</em></p></td>
846<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dcaeevent">DcaeEvent</a></p></td>
847</tr>
848</tbody>
849</table>
850</div>
851<div class="sect3">
852<h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a>2.4.3. Responses</h4>
853<table class="tableblock frame-all grid-all spread">
854<colgroup>
855<col style="width: 10%;">
856<col style="width: 70%;">
857<col style="width: 20%;">
858</colgroup>
859<thead>
860<tr>
861<th class="tableblock halign-left valign-middle">HTTP Code</th>
862<th class="tableblock halign-left valign-middle">Description</th>
863<th class="tableblock halign-left valign-middle">Schema</th>
864</tr>
865</thead>
866<tbody>
867<tr>
868<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
869<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
870<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
871</tr>
872</tbody>
873</table>
874</div>
875<div class="sect3">
876<h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a>2.4.4. Consumes</h4>
877<div class="ulist">
878<ul>
879<li>
880<p><code>application/json</code></p>
881</li>
882</ul>
883</div>
884</div>
885<div class="sect3">
886<h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a>2.4.5. Produces</h4>
887<div class="ulist">
888<ul>
889<li>
890<p><code>application/json</code></p>
891</li>
892</ul>
893</div>
894</div>
895</div>
896<div class="sect2">
897<h3 id="_clds_deploy_modelname_put"><a class="anchor" href="#_clds_deploy_modelname_put"></a>2.5. PUT /clds/deploy/{modelName}</h3>
898<div class="sect3">
899<h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a>2.5.1. Parameters</h4>
900<table class="tableblock frame-all grid-all spread">
901<colgroup>
902<col style="width: 22%;">
903<col style="width: 33%;">
904<col style="width: 44%;">
905</colgroup>
906<thead>
907<tr>
908<th class="tableblock halign-left valign-middle">Type</th>
909<th class="tableblock halign-left valign-middle">Name</th>
910<th class="tableblock halign-left valign-middle">Schema</th>
911</tr>
912</thead>
913<tbody>
914<tr>
915<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
916<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
917<em>required</em></p></td>
918<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
919</tr>
920<tr>
921<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
922<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
923<em>required</em></p></td>
924<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
925</tr>
926</tbody>
927</table>
928</div>
929<div class="sect3">
930<h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a>2.5.2. Responses</h4>
931<table class="tableblock frame-all grid-all spread">
932<colgroup>
933<col style="width: 10%;">
934<col style="width: 70%;">
935<col style="width: 20%;">
936</colgroup>
937<thead>
938<tr>
939<th class="tableblock halign-left valign-middle">HTTP Code</th>
940<th class="tableblock halign-left valign-middle">Description</th>
941<th class="tableblock halign-left valign-middle">Schema</th>
942</tr>
943</thead>
944<tbody>
945<tr>
946<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
947<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
948<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
949</tr>
950<tr>
951<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
952<td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
953<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
954</tr>
955</tbody>
956</table>
957</div>
958<div class="sect3">
959<h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a>2.5.3. Consumes</h4>
960<div class="ulist">
961<ul>
962<li>
963<p><code>application/json</code></p>
964</li>
965</ul>
966</div>
967</div>
968<div class="sect3">
969<h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a>2.5.4. Produces</h4>
970<div class="ulist">
971<ul>
972<li>
973<p><code>application/json</code></p>
974</li>
975</ul>
976</div>
977</div>
978</div>
979<div class="sect2">
980<h3 id="_clds_healthcheck_get"><a class="anchor" href="#_clds_healthcheck_get"></a>2.6. GET /clds/healthcheck</h3>
981<div class="sect3">
982<h4 id="_description_3"><a class="anchor" href="#_description_3"></a>2.6.1. Description</h4>
983<div class="paragraph">
984<p>REST service that retrieves clds healthcheck information.</p>
985</div>
986</div>
987<div class="sect3">
988<h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a>2.6.2. Responses</h4>
989<table class="tableblock frame-all grid-all spread">
990<colgroup>
991<col style="width: 10%;">
992<col style="width: 70%;">
993<col style="width: 20%;">
994</colgroup>
995<thead>
996<tr>
997<th class="tableblock halign-left valign-middle">HTTP Code</th>
998<th class="tableblock halign-left valign-middle">Description</th>
999<th class="tableblock halign-left valign-middle">Schema</th>
1000</tr>
1001</thead>
1002<tbody>
1003<tr>
1004<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1005<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1006<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
1007</tr>
1008<tr>
1009<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1010<td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
1011<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldshealthcheck">CldsHealthCheck</a></p></td>
1012</tr>
1013</tbody>
1014</table>
1015</div>
1016<div class="sect3">
1017<h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a>2.6.3. Produces</h4>
1018<div class="ulist">
1019<ul>
1020<li>
1021<p><code>application/json</code></p>
1022</li>
1023</ul>
1024</div>
1025</div>
1026</div>
1027<div class="sect2">
1028<h3 id="_clds_model-names_get"><a class="anchor" href="#_clds_model-names_get"></a>2.7. GET /clds/model-names</h3>
1029<div class="sect3">
1030<h4 id="_description_4"><a class="anchor" href="#_description_4"></a>2.7.1. Description</h4>
1031<div class="paragraph">
1032<p>REST service that retrieves a list of CLDS model names.</p>
1033</div>
1034</div>
1035<div class="sect3">
1036<h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a>2.7.2. Responses</h4>
1037<table class="tableblock frame-all grid-all spread">
1038<colgroup>
1039<col style="width: 10%;">
1040<col style="width: 70%;">
1041<col style="width: 20%;">
1042</colgroup>
1043<thead>
1044<tr>
1045<th class="tableblock halign-left valign-middle">HTTP Code</th>
1046<th class="tableblock halign-left valign-middle">Description</th>
1047<th class="tableblock halign-left valign-middle">Schema</th>
1048</tr>
1049</thead>
1050<tbody>
1051<tr>
1052<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1053<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1054<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_valueitem">ValueItem</a> &gt; array</p></td>
1055</tr>
1056</tbody>
1057</table>
1058</div>
1059<div class="sect3">
1060<h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a>2.7.3. Produces</h4>
1061<div class="ulist">
1062<ul>
1063<li>
1064<p><code>application/json</code></p>
1065</li>
1066</ul>
1067</div>
1068</div>
1069</div>
1070<div class="sect2">
1071<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>
1072<div class="sect3">
1073<h4 id="_description_5"><a class="anchor" href="#_description_5"></a>2.8.1. Description</h4>
1074<div class="paragraph">
1075<p>REST service that retrieves BPMN for a CLDS model name from the database.<br>
1076 This is subset of the json getModel. This is only expected to be used for<br>
1077 testing purposes, not by the UI.</p>
1078</div>
1079</div>
1080<div class="sect3">
1081<h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a>2.8.2. Parameters</h4>
1082<table class="tableblock frame-all grid-all spread">
1083<colgroup>
1084<col style="width: 22%;">
1085<col style="width: 33%;">
1086<col style="width: 44%;">
1087</colgroup>
1088<thead>
1089<tr>
1090<th class="tableblock halign-left valign-middle">Type</th>
1091<th class="tableblock halign-left valign-middle">Name</th>
1092<th class="tableblock halign-left valign-middle">Schema</th>
1093</tr>
1094</thead>
1095<tbody>
1096<tr>
1097<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1098<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1099<em>required</em></p></td>
1100<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1101</tr>
1102</tbody>
1103</table>
1104</div>
1105<div class="sect3">
1106<h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a>2.8.3. Responses</h4>
1107<table class="tableblock frame-all grid-all spread">
1108<colgroup>
1109<col style="width: 10%;">
1110<col style="width: 70%;">
1111<col style="width: 20%;">
1112</colgroup>
1113<thead>
1114<tr>
1115<th class="tableblock halign-left valign-middle">HTTP Code</th>
1116<th class="tableblock halign-left valign-middle">Description</th>
1117<th class="tableblock halign-left valign-middle">Schema</th>
1118</tr>
1119</thead>
1120<tbody>
1121<tr>
1122<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1123<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1124<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1125</tr>
1126</tbody>
1127</table>
1128</div>
1129<div class="sect3">
1130<h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a>2.8.4. Produces</h4>
1131<div class="ulist">
1132<ul>
1133<li>
1134<p><code>text/xml</code></p>
1135</li>
1136</ul>
1137</div>
1138</div>
1139</div>
1140<div class="sect2">
1141<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>
1142<div class="sect3">
1143<h4 id="_description_6"><a class="anchor" href="#_description_6"></a>2.9.1. Description</h4>
1144<div class="paragraph">
1145<p>REST service that retrieves image for a CLDS model name from the<br>
1146 database. This is subset of the json getModel. This is only expected to<br>
1147 be used for testing purposes, not by the UI.</p>
1148</div>
1149</div>
1150<div class="sect3">
1151<h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a>2.9.2. Parameters</h4>
1152<table class="tableblock frame-all grid-all spread">
1153<colgroup>
1154<col style="width: 22%;">
1155<col style="width: 33%;">
1156<col style="width: 44%;">
1157</colgroup>
1158<thead>
1159<tr>
1160<th class="tableblock halign-left valign-middle">Type</th>
1161<th class="tableblock halign-left valign-middle">Name</th>
1162<th class="tableblock halign-left valign-middle">Schema</th>
1163</tr>
1164</thead>
1165<tbody>
1166<tr>
1167<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1168<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1169<em>required</em></p></td>
1170<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1171</tr>
1172</tbody>
1173</table>
1174</div>
1175<div class="sect3">
1176<h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a>2.9.3. Responses</h4>
1177<table class="tableblock frame-all grid-all spread">
1178<colgroup>
1179<col style="width: 10%;">
1180<col style="width: 70%;">
1181<col style="width: 20%;">
1182</colgroup>
1183<thead>
1184<tr>
1185<th class="tableblock halign-left valign-middle">HTTP Code</th>
1186<th class="tableblock halign-left valign-middle">Description</th>
1187<th class="tableblock halign-left valign-middle">Schema</th>
1188</tr>
1189</thead>
1190<tbody>
1191<tr>
1192<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1193<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1194<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1195</tr>
1196</tbody>
1197</table>
1198</div>
1199<div class="sect3">
1200<h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a>2.9.4. Produces</h4>
1201<div class="ulist">
1202<ul>
1203<li>
1204<p><code>text/xml</code></p>
1205</li>
1206</ul>
1207</div>
1208</div>
1209</div>
1210<div class="sect2">
1211<h3 id="_clds_model_modelname_get"><a class="anchor" href="#_clds_model_modelname_get"></a>2.10. GET /clds/model/{modelName}</h3>
1212<div class="sect3">
1213<h4 id="_description_7"><a class="anchor" href="#_description_7"></a>2.10.1. Description</h4>
1214<div class="paragraph">
1215<p>REST service that retrieves a CLDS model by name from the database.</p>
1216</div>
1217</div>
1218<div class="sect3">
1219<h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a>2.10.2. Parameters</h4>
1220<table class="tableblock frame-all grid-all spread">
1221<colgroup>
1222<col style="width: 22%;">
1223<col style="width: 33%;">
1224<col style="width: 44%;">
1225</colgroup>
1226<thead>
1227<tr>
1228<th class="tableblock halign-left valign-middle">Type</th>
1229<th class="tableblock halign-left valign-middle">Name</th>
1230<th class="tableblock halign-left valign-middle">Schema</th>
1231</tr>
1232</thead>
1233<tbody>
1234<tr>
1235<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1236<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1237<em>required</em></p></td>
1238<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1239</tr>
1240</tbody>
1241</table>
1242</div>
1243<div class="sect3">
1244<h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a>2.10.3. Responses</h4>
1245<table class="tableblock frame-all grid-all spread">
1246<colgroup>
1247<col style="width: 10%;">
1248<col style="width: 70%;">
1249<col style="width: 20%;">
1250</colgroup>
1251<thead>
1252<tr>
1253<th class="tableblock halign-left valign-middle">HTTP Code</th>
1254<th class="tableblock halign-left valign-middle">Description</th>
1255<th class="tableblock halign-left valign-middle">Schema</th>
1256</tr>
1257</thead>
1258<tbody>
1259<tr>
1260<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1261<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1262<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1263</tr>
1264</tbody>
1265</table>
1266</div>
1267<div class="sect3">
1268<h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a>2.10.4. Produces</h4>
1269<div class="ulist">
1270<ul>
1271<li>
1272<p><code>application/json</code></p>
1273</li>
1274</ul>
1275</div>
1276</div>
1277</div>
1278<div class="sect2">
1279<h3 id="_clds_model_modelname_put"><a class="anchor" href="#_clds_model_modelname_put"></a>2.11. PUT /clds/model/{modelName}</h3>
1280<div class="sect3">
1281<h4 id="_description_8"><a class="anchor" href="#_description_8"></a>2.11.1. Description</h4>
1282<div class="paragraph">
1283<p>REST service that saves a CLDS model by name in the database.</p>
1284</div>
1285</div>
1286<div class="sect3">
1287<h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a>2.11.2. Parameters</h4>
1288<table class="tableblock frame-all grid-all spread">
1289<colgroup>
1290<col style="width: 22%;">
1291<col style="width: 33%;">
1292<col style="width: 44%;">
1293</colgroup>
1294<thead>
1295<tr>
1296<th class="tableblock halign-left valign-middle">Type</th>
1297<th class="tableblock halign-left valign-middle">Name</th>
1298<th class="tableblock halign-left valign-middle">Schema</th>
1299</tr>
1300</thead>
1301<tbody>
1302<tr>
1303<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1304<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1305<em>required</em></p></td>
1306<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1307</tr>
1308<tr>
1309<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1310<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1311<em>required</em></p></td>
1312<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1313</tr>
1314</tbody>
1315</table>
1316</div>
1317<div class="sect3">
1318<h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a>2.11.3. Responses</h4>
1319<table class="tableblock frame-all grid-all spread">
1320<colgroup>
1321<col style="width: 10%;">
1322<col style="width: 70%;">
1323<col style="width: 20%;">
1324</colgroup>
1325<thead>
1326<tr>
1327<th class="tableblock halign-left valign-middle">HTTP Code</th>
1328<th class="tableblock halign-left valign-middle">Description</th>
1329<th class="tableblock halign-left valign-middle">Schema</th>
1330</tr>
1331</thead>
1332<tbody>
1333<tr>
1334<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1335<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1336<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1337</tr>
1338</tbody>
1339</table>
1340</div>
1341<div class="sect3">
1342<h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a>2.11.4. Consumes</h4>
1343<div class="ulist">
1344<ul>
1345<li>
1346<p><code>application/json</code></p>
1347</li>
1348</ul>
1349</div>
1350</div>
1351<div class="sect3">
1352<h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a>2.11.5. Produces</h4>
1353<div class="ulist">
1354<ul>
1355<li>
1356<p><code>application/json</code></p>
1357</li>
1358</ul>
1359</div>
1360</div>
1361</div>
1362<div class="sect2">
1363<h3 id="_clds_properties_get"><a class="anchor" href="#_clds_properties_get"></a>2.12. GET /clds/properties</h3>
1364<div class="sect3">
1365<h4 id="_description_9"><a class="anchor" href="#_description_9"></a>2.12.1. Description</h4>
1366<div class="paragraph">
1367<p>REST service that retrieves total properties required by UI</p>
1368</div>
1369</div>
1370<div class="sect3">
1371<h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a>2.12.2. Responses</h4>
1372<table class="tableblock frame-all grid-all spread">
1373<colgroup>
1374<col style="width: 10%;">
1375<col style="width: 70%;">
1376<col style="width: 20%;">
1377</colgroup>
1378<thead>
1379<tr>
1380<th class="tableblock halign-left valign-middle">HTTP Code</th>
1381<th class="tableblock halign-left valign-middle">Description</th>
1382<th class="tableblock halign-left valign-middle">Schema</th>
1383</tr>
1384</thead>
1385<tbody>
1386<tr>
1387<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1388<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1389<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1390</tr>
1391</tbody>
1392</table>
1393</div>
1394<div class="sect3">
1395<h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a>2.12.3. Produces</h4>
1396<div class="ulist">
1397<ul>
1398<li>
1399<p><code>application/json</code></p>
1400</li>
1401</ul>
1402</div>
1403</div>
1404</div>
1405<div class="sect2">
1406<h3 id="_clds_properties_serviceinvariantuuid_get"><a class="anchor" href="#_clds_properties_serviceinvariantuuid_get"></a>2.13. GET /clds/properties/{serviceInvariantUUID}</h3>
1407<div class="sect3">
1408<h4 id="_description_10"><a class="anchor" href="#_description_10"></a>2.13.1. Description</h4>
1409<div class="paragraph">
1410<p>REST service that retrieves total properties by using invariantUUID based<br>
1411 on refresh and non refresh</p>
1412</div>
1413</div>
1414<div class="sect3">
1415<h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a>2.13.2. Parameters</h4>
1416<table class="tableblock frame-all grid-all spread">
1417<colgroup>
1418<col style="width: 18%;">
1419<col style="width: 27%;">
1420<col style="width: 36%;">
1421<col style="width: 18%;">
1422</colgroup>
1423<thead>
1424<tr>
1425<th class="tableblock halign-left valign-middle">Type</th>
1426<th class="tableblock halign-left valign-middle">Name</th>
1427<th class="tableblock halign-left valign-middle">Schema</th>
1428<th class="tableblock halign-left valign-middle">Default</th>
1429</tr>
1430</thead>
1431<tbody>
1432<tr>
1433<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1434<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceInvariantUUID</strong><br>
1435<em>required</em></p></td>
1436<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1437<td class="tableblock halign-left valign-middle"></td>
1438</tr>
1439<tr>
1440<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1441<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>refresh</strong><br>
1442<em>optional</em></p></td>
1443<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1444<td class="tableblock halign-left valign-middle"><p class="tableblock"><code>"false"</code></p></td>
1445</tr>
1446</tbody>
1447</table>
1448</div>
1449<div class="sect3">
1450<h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a>2.13.3. Responses</h4>
1451<table class="tableblock frame-all grid-all spread">
1452<colgroup>
1453<col style="width: 10%;">
1454<col style="width: 70%;">
1455<col style="width: 20%;">
1456</colgroup>
1457<thead>
1458<tr>
1459<th class="tableblock halign-left valign-middle">HTTP Code</th>
1460<th class="tableblock halign-left valign-middle">Description</th>
1461<th class="tableblock halign-left valign-middle">Schema</th>
1462</tr>
1463</thead>
1464<tbody>
1465<tr>
1466<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1467<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1468<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1469</tr>
1470</tbody>
1471</table>
1472</div>
1473<div class="sect3">
1474<h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a>2.13.4. Produces</h4>
1475<div class="ulist">
1476<ul>
1477<li>
1478<p><code>application/json</code></p>
1479</li>
1480</ul>
1481</div>
1482</div>
1483</div>
1484<div class="sect2">
1485<h3 id="_clds_sdc_services_get"><a class="anchor" href="#_clds_sdc_services_get"></a>2.14. GET /clds/sdc/services</h3>
1486<div class="sect3">
1487<h4 id="_description_11"><a class="anchor" href="#_description_11"></a>2.14.1. Description</h4>
1488<div class="paragraph">
1489<p>REST service that retrieves sdc services</p>
1490</div>
1491</div>
1492<div class="sect3">
1493<h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a>2.14.2. Responses</h4>
1494<table class="tableblock frame-all grid-all spread">
1495<colgroup>
1496<col style="width: 10%;">
1497<col style="width: 70%;">
1498<col style="width: 20%;">
1499</colgroup>
1500<thead>
1501<tr>
1502<th class="tableblock halign-left valign-middle">HTTP Code</th>
1503<th class="tableblock halign-left valign-middle">Description</th>
1504<th class="tableblock halign-left valign-middle">Schema</th>
1505</tr>
1506</thead>
1507<tbody>
1508<tr>
1509<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1510<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1511<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1512</tr>
1513</tbody>
1514</table>
1515</div>
1516<div class="sect3">
1517<h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a>2.14.3. Produces</h4>
1518<div class="ulist">
1519<ul>
1520<li>
1521<p><code>application/json</code></p>
1522</li>
1523</ul>
1524</div>
1525</div>
1526</div>
1527<div class="sect2">
1528<h3 id="_clds_undeploy_modelname_put"><a class="anchor" href="#_clds_undeploy_modelname_put"></a>2.15. PUT /clds/undeploy/{modelName}</h3>
1529<div class="sect3">
1530<h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a>2.15.1. Parameters</h4>
1531<table class="tableblock frame-all grid-all spread">
1532<colgroup>
1533<col style="width: 22%;">
1534<col style="width: 33%;">
1535<col style="width: 44%;">
1536</colgroup>
1537<thead>
1538<tr>
1539<th class="tableblock halign-left valign-middle">Type</th>
1540<th class="tableblock halign-left valign-middle">Name</th>
1541<th class="tableblock halign-left valign-middle">Schema</th>
1542</tr>
1543</thead>
1544<tbody>
1545<tr>
1546<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1547<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1548<em>required</em></p></td>
1549<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1550</tr>
1551<tr>
1552<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1553<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1554<em>required</em></p></td>
1555<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1556</tr>
1557</tbody>
1558</table>
1559</div>
1560<div class="sect3">
1561<h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a>2.15.2. Responses</h4>
1562<table class="tableblock frame-all grid-all spread">
1563<colgroup>
1564<col style="width: 10%;">
1565<col style="width: 70%;">
1566<col style="width: 20%;">
1567</colgroup>
1568<thead>
1569<tr>
1570<th class="tableblock halign-left valign-middle">HTTP Code</th>
1571<th class="tableblock halign-left valign-middle">Description</th>
1572<th class="tableblock halign-left valign-middle">Schema</th>
1573</tr>
1574</thead>
1575<tbody>
1576<tr>
1577<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1578<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1579<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1580</tr>
1581<tr>
1582<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1583<td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p></td>
1584<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1585</tr>
1586</tbody>
1587</table>
1588</div>
1589<div class="sect3">
1590<h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a>2.15.3. Consumes</h4>
1591<div class="ulist">
1592<ul>
1593<li>
1594<p><code>application/json</code></p>
1595</li>
1596</ul>
1597</div>
1598</div>
1599<div class="sect3">
1600<h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a>2.15.4. Produces</h4>
1601<div class="ulist">
1602<ul>
1603<li>
1604<p><code>application/json</code></p>
1605</li>
1606</ul>
1607</div>
1608</div>
1609</div>
1610<div class="sect2">
1611<h3 id="_cldstempate_template-names_get"><a class="anchor" href="#_cldstempate_template-names_get"></a>2.16. GET /cldsTempate/template-names</h3>
1612<div class="sect3">
1613<h4 id="_description_12"><a class="anchor" href="#_description_12"></a>2.16.1. Description</h4>
1614<div class="paragraph">
1615<p>REST service that retrieves a list of CLDS template names.</p>
1616</div>
1617</div>
1618<div class="sect3">
1619<h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a>2.16.2. Responses</h4>
1620<table class="tableblock frame-all grid-all spread">
1621<colgroup>
1622<col style="width: 10%;">
1623<col style="width: 70%;">
1624<col style="width: 20%;">
1625</colgroup>
1626<thead>
1627<tr>
1628<th class="tableblock halign-left valign-middle">HTTP Code</th>
1629<th class="tableblock halign-left valign-middle">Description</th>
1630<th class="tableblock halign-left valign-middle">Schema</th>
1631</tr>
1632</thead>
1633<tbody>
1634<tr>
1635<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1636<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1637<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_valueitem">ValueItem</a> &gt; array</p></td>
1638</tr>
1639</tbody>
1640</table>
1641</div>
1642<div class="sect3">
1643<h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a>2.16.3. Produces</h4>
1644<div class="ulist">
1645<ul>
1646<li>
1647<p><code>application/json</code></p>
1648</li>
1649</ul>
1650</div>
1651</div>
1652</div>
1653<div class="sect2">
1654<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>
1655<div class="sect3">
1656<h4 id="_description_13"><a class="anchor" href="#_description_13"></a>2.17.1. Description</h4>
1657<div class="paragraph">
1658<p>REST service that retrieves BPMN for a CLDS template name from the<br>
1659 database. This is subset of the json getModel. This is only expected to<br>
1660 be used for testing purposes, not by the UI.</p>
1661</div>
1662</div>
1663<div class="sect3">
1664<h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a>2.17.2. Parameters</h4>
1665<table class="tableblock frame-all grid-all spread">
1666<colgroup>
1667<col style="width: 22%;">
1668<col style="width: 33%;">
1669<col style="width: 44%;">
1670</colgroup>
1671<thead>
1672<tr>
1673<th class="tableblock halign-left valign-middle">Type</th>
1674<th class="tableblock halign-left valign-middle">Name</th>
1675<th class="tableblock halign-left valign-middle">Schema</th>
1676</tr>
1677</thead>
1678<tbody>
1679<tr>
1680<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1681<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1682<em>required</em></p></td>
1683<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1684</tr>
1685</tbody>
1686</table>
1687</div>
1688<div class="sect3">
1689<h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a>2.17.3. Responses</h4>
1690<table class="tableblock frame-all grid-all spread">
1691<colgroup>
1692<col style="width: 10%;">
1693<col style="width: 70%;">
1694<col style="width: 20%;">
1695</colgroup>
1696<thead>
1697<tr>
1698<th class="tableblock halign-left valign-middle">HTTP Code</th>
1699<th class="tableblock halign-left valign-middle">Description</th>
1700<th class="tableblock halign-left valign-middle">Schema</th>
1701</tr>
1702</thead>
1703<tbody>
1704<tr>
1705<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1706<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1707<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1708</tr>
1709</tbody>
1710</table>
1711</div>
1712<div class="sect3">
1713<h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a>2.17.4. Produces</h4>
1714<div class="ulist">
1715<ul>
1716<li>
1717<p><code>text/xml</code></p>
1718</li>
1719</ul>
1720</div>
1721</div>
1722</div>
1723<div class="sect2">
1724<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>
1725<div class="sect3">
1726<h4 id="_description_14"><a class="anchor" href="#_description_14"></a>2.18.1. Description</h4>
1727<div class="paragraph">
1728<p>REST service that retrieves image for a CLDS template name from the<br>
1729 database. This is subset of the json getModel. This is only expected to<br>
1730 be used for testing purposes, not by the UI.</p>
1731</div>
1732</div>
1733<div class="sect3">
1734<h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a>2.18.2. Parameters</h4>
1735<table class="tableblock frame-all grid-all spread">
1736<colgroup>
1737<col style="width: 22%;">
1738<col style="width: 33%;">
1739<col style="width: 44%;">
1740</colgroup>
1741<thead>
1742<tr>
1743<th class="tableblock halign-left valign-middle">Type</th>
1744<th class="tableblock halign-left valign-middle">Name</th>
1745<th class="tableblock halign-left valign-middle">Schema</th>
1746</tr>
1747</thead>
1748<tbody>
1749<tr>
1750<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1751<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1752<em>required</em></p></td>
1753<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1754</tr>
1755</tbody>
1756</table>
1757</div>
1758<div class="sect3">
1759<h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a>2.18.3. Responses</h4>
1760<table class="tableblock frame-all grid-all spread">
1761<colgroup>
1762<col style="width: 10%;">
1763<col style="width: 70%;">
1764<col style="width: 20%;">
1765</colgroup>
1766<thead>
1767<tr>
1768<th class="tableblock halign-left valign-middle">HTTP Code</th>
1769<th class="tableblock halign-left valign-middle">Description</th>
1770<th class="tableblock halign-left valign-middle">Schema</th>
1771</tr>
1772</thead>
1773<tbody>
1774<tr>
1775<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1776<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1777<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1778</tr>
1779</tbody>
1780</table>
1781</div>
1782<div class="sect3">
1783<h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a>2.18.4. Produces</h4>
1784<div class="ulist">
1785<ul>
1786<li>
1787<p><code>text/xml</code></p>
1788</li>
1789</ul>
1790</div>
1791</div>
1792</div>
1793<div class="sect2">
1794<h3 id="_cldstempate_template_templatename_get"><a class="anchor" href="#_cldstempate_template_templatename_get"></a>2.19. GET /cldsTempate/template/{templateName}</h3>
1795<div class="sect3">
1796<h4 id="_description_15"><a class="anchor" href="#_description_15"></a>2.19.1. Description</h4>
1797<div class="paragraph">
1798<p>REST service that retrieves a CLDS template by name from the database.</p>
1799</div>
1800</div>
1801<div class="sect3">
1802<h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a>2.19.2. Parameters</h4>
1803<table class="tableblock frame-all grid-all spread">
1804<colgroup>
1805<col style="width: 22%;">
1806<col style="width: 33%;">
1807<col style="width: 44%;">
1808</colgroup>
1809<thead>
1810<tr>
1811<th class="tableblock halign-left valign-middle">Type</th>
1812<th class="tableblock halign-left valign-middle">Name</th>
1813<th class="tableblock halign-left valign-middle">Schema</th>
1814</tr>
1815</thead>
1816<tbody>
1817<tr>
1818<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1819<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1820<em>required</em></p></td>
1821<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1822</tr>
1823</tbody>
1824</table>
1825</div>
1826<div class="sect3">
1827<h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a>2.19.3. Responses</h4>
1828<table class="tableblock frame-all grid-all spread">
1829<colgroup>
1830<col style="width: 10%;">
1831<col style="width: 70%;">
1832<col style="width: 20%;">
1833</colgroup>
1834<thead>
1835<tr>
1836<th class="tableblock halign-left valign-middle">HTTP Code</th>
1837<th class="tableblock halign-left valign-middle">Description</th>
1838<th class="tableblock halign-left valign-middle">Schema</th>
1839</tr>
1840</thead>
1841<tbody>
1842<tr>
1843<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1844<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1845<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1846</tr>
1847</tbody>
1848</table>
1849</div>
1850<div class="sect3">
1851<h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a>2.19.4. Produces</h4>
1852<div class="ulist">
1853<ul>
1854<li>
1855<p><code>application/json</code></p>
1856</li>
1857</ul>
1858</div>
1859</div>
1860</div>
1861<div class="sect2">
1862<h3 id="_cldstempate_template_templatename_put"><a class="anchor" href="#_cldstempate_template_templatename_put"></a>2.20. PUT /cldsTempate/template/{templateName}</h3>
1863<div class="sect3">
1864<h4 id="_description_16"><a class="anchor" href="#_description_16"></a>2.20.1. Description</h4>
1865<div class="paragraph">
1866<p>REST service that saves a CLDS template by name in the database.</p>
1867</div>
1868</div>
1869<div class="sect3">
1870<h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a>2.20.2. Parameters</h4>
1871<table class="tableblock frame-all grid-all spread">
1872<colgroup>
1873<col style="width: 22%;">
1874<col style="width: 33%;">
1875<col style="width: 44%;">
1876</colgroup>
1877<thead>
1878<tr>
1879<th class="tableblock halign-left valign-middle">Type</th>
1880<th class="tableblock halign-left valign-middle">Name</th>
1881<th class="tableblock halign-left valign-middle">Schema</th>
1882</tr>
1883</thead>
1884<tbody>
1885<tr>
1886<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1887<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1888<em>required</em></p></td>
1889<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1890</tr>
1891<tr>
1892<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1893<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1894<em>required</em></p></td>
1895<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1896</tr>
1897</tbody>
1898</table>
1899</div>
1900<div class="sect3">
1901<h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a>2.20.3. Responses</h4>
1902<table class="tableblock frame-all grid-all spread">
1903<colgroup>
1904<col style="width: 10%;">
1905<col style="width: 70%;">
1906<col style="width: 20%;">
1907</colgroup>
1908<thead>
1909<tr>
1910<th class="tableblock halign-left valign-middle">HTTP Code</th>
1911<th class="tableblock halign-left valign-middle">Description</th>
1912<th class="tableblock halign-left valign-middle">Schema</th>
1913</tr>
1914</thead>
1915<tbody>
1916<tr>
1917<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1918<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1919<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1920</tr>
1921</tbody>
1922</table>
1923</div>
1924<div class="sect3">
1925<h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a>2.20.4. Consumes</h4>
1926<div class="ulist">
1927<ul>
1928<li>
1929<p><code>application/json</code></p>
1930</li>
1931</ul>
1932</div>
1933</div>
1934<div class="sect3">
1935<h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a>2.20.5. Produces</h4>
1936<div class="ulist">
1937<ul>
1938<li>
1939<p><code>application/json</code></p>
1940</li>
1941</ul>
1942</div>
1943</div>
1944</div>
1945<div class="sect2">
1946<h3 id="_user_username_get"><a class="anchor" href="#_user_username_get"></a>2.21. GET /user/{userName}</h3>
1947<div class="sect3">
1948<h4 id="_description_17"><a class="anchor" href="#_description_17"></a>2.21.1. Description</h4>
1949<div class="paragraph">
1950<p>REST service that returns the username.</p>
1951</div>
1952</div>
1953<div class="sect3">
1954<h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a>2.21.2. Parameters</h4>
1955<table class="tableblock frame-all grid-all spread">
1956<colgroup>
1957<col style="width: 22%;">
1958<col style="width: 33%;">
1959<col style="width: 44%;">
1960</colgroup>
1961<thead>
1962<tr>
1963<th class="tableblock halign-left valign-middle">Type</th>
1964<th class="tableblock halign-left valign-middle">Name</th>
1965<th class="tableblock halign-left valign-middle">Schema</th>
1966</tr>
1967</thead>
1968<tbody>
1969<tr>
1970<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1971<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
1972<em>required</em></p></td>
1973<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1974</tr>
1975</tbody>
1976</table>
1977</div>
1978<div class="sect3">
1979<h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a>2.21.3. Responses</h4>
1980<table class="tableblock frame-all grid-all spread">
1981<colgroup>
1982<col style="width: 10%;">
1983<col style="width: 70%;">
1984<col style="width: 20%;">
1985</colgroup>
1986<thead>
1987<tr>
1988<th class="tableblock halign-left valign-middle">HTTP Code</th>
1989<th class="tableblock halign-left valign-middle">Description</th>
1990<th class="tableblock halign-left valign-middle">Schema</th>
1991</tr>
1992</thead>
1993<tbody>
1994<tr>
1995<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1996<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
1997<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1998</tr>
1999</tbody>
2000</table>
2001</div>
2002<div class="sect3">
2003<h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a>2.21.4. Produces</h4>
2004<div class="ulist">
2005<ul>
2006<li>
2007<p><code>text/plain</code></p>
2008</li>
2009</ul>
2010</div>
2011</div>
2012</div>
2013</div>
2014</div>
2015<div class="sect1">
2016<h2 id="_definitions"><a class="anchor" href="#_definitions"></a>3. Definitions</h2>
2017<div class="sectionbody">
2018<div class="sect2">
2019<h3 id="_cldsevent"><a class="anchor" href="#_cldsevent"></a>3.1. CldsEvent</h3>
2020<table class="tableblock frame-all grid-all spread">
2021<colgroup>
2022<col style="width: 42%;">
2023<col style="width: 57%;">
2024</colgroup>
2025<thead>
2026<tr>
2027<th class="tableblock halign-left valign-middle">Name</th>
2028<th class="tableblock halign-left valign-middle">Schema</th>
2029</tr>
2030</thead>
2031<tbody>
2032<tr>
2033<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionAndStateCd</strong><br>
2034<em>optional</em></p></td>
2035<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2036</tr>
2037<tr>
2038<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionCd</strong><br>
2039<em>optional</em></p></td>
2040<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2041</tr>
2042<tr>
2043<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionStateCd</strong><br>
2044<em>optional</em></p></td>
2045<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2046</tr>
2047<tr>
2048<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2049<em>optional</em></p></td>
2050<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2051</tr>
2052<tr>
2053<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>processInstanceId</strong><br>
2054<em>optional</em></p></td>
2055<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2056</tr>
2057<tr>
2058<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2059<em>optional</em></p></td>
2060<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2061</tr>
2062</tbody>
2063</table>
2064</div>
2065<div class="sect2">
2066<h3 id="_cldshealthcheck"><a class="anchor" href="#_cldshealthcheck"></a>3.2. CldsHealthCheck</h3>
2067<table class="tableblock frame-all grid-all spread">
2068<colgroup>
2069<col style="width: 42%;">
2070<col style="width: 57%;">
2071</colgroup>
2072<thead>
2073<tr>
2074<th class="tableblock halign-left valign-middle">Name</th>
2075<th class="tableblock halign-left valign-middle">Schema</th>
2076</tr>
2077</thead>
2078<tbody>
2079<tr>
2080<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2081<em>optional</em></p></td>
2082<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2083</tr>
2084<tr>
2085<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckComponent</strong><br>
2086<em>optional</em></p></td>
2087<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2088</tr>
2089<tr>
2090<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>healthCheckStatus</strong><br>
2091<em>optional</em></p></td>
2092<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2093</tr>
2094</tbody>
2095</table>
2096</div>
2097<div class="sect2">
2098<h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a>3.3. CldsInfo</h3>
2099<table class="tableblock frame-all grid-all spread">
2100<colgroup>
2101<col style="width: 42%;">
2102<col style="width: 57%;">
2103</colgroup>
2104<thead>
2105<tr>
2106<th class="tableblock halign-left valign-middle">Name</th>
2107<th class="tableblock halign-left valign-middle">Schema</th>
2108</tr>
2109</thead>
2110<tbody>
2111<tr>
2112<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
2113<em>optional</em></p></td>
2114<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2115</tr>
2116<tr>
2117<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
2118<em>optional</em></p></td>
2119<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2120</tr>
2121<tr>
2122<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
2123<em>optional</em></p></td>
2124<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2125</tr>
2126<tr>
2127<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
2128<em>optional</em></p></td>
2129<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2130</tr>
2131<tr>
2132<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
2133<em>optional</em></p></td>
2134<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2135</tr>
2136<tr>
2137<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
2138<em>optional</em></p></td>
2139<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2140</tr>
2141</tbody>
2142</table>
2143</div>
2144<div class="sect2">
2145<h3 id="_cldsmodel"><a class="anchor" href="#_cldsmodel"></a>3.4. CldsModel</h3>
2146<table class="tableblock frame-all grid-all spread">
2147<colgroup>
2148<col style="width: 42%;">
2149<col style="width: 57%;">
2150</colgroup>
2151<thead>
2152<tr>
2153<th class="tableblock halign-left valign-middle">Name</th>
2154<th class="tableblock halign-left valign-middle">Schema</th>
2155</tr>
2156</thead>
2157<tbody>
2158<tr>
2159<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprintText</strong><br>
2160<em>optional</em></p></td>
2161<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2162</tr>
2163<tr>
2164<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2165<em>optional</em></p></td>
2166<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2167</tr>
2168<tr>
2169<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsModelInstanceList</strong><br>
2170<em>optional</em></p></td>
2171<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_cldsmodelinstance">CldsModelInstance</a> &gt; array</p></td>
2172</tr>
2173<tr>
2174<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2175<em>optional</em></p></td>
2176<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2177</tr>
2178<tr>
2179<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2180<em>optional</em></p></td>
2181<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2182</tr>
2183<tr>
2184<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2185<em>optional</em></p></td>
2186<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2187</tr>
2188<tr>
2189<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2190<em>optional</em></p></td>
2191<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2192</tr>
2193<tr>
2194<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>docText</strong><br>
2195<em>optional</em></p></td>
2196<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2197</tr>
2198<tr>
2199<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2200<em>optional</em></p></td>
2201<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsevent">CldsEvent</a></p></td>
2202</tr>
2203<tr>
2204<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2205<em>optional</em></p></td>
2206<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2207</tr>
2208<tr>
2209<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2210<em>optional</em></p></td>
2211<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2212</tr>
2213<tr>
2214<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2215<em>optional</em></p></td>
2216<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2217</tr>
2218<tr>
2219<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permittedActionCd</strong><br>
2220<em>optional</em></p></td>
2221<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; string &gt; array</p></td>
2222</tr>
2223<tr>
2224<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2225<em>optional</em></p></td>
2226<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2227</tr>
2228<tr>
2229<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
2230<em>optional</em></p></td>
2231<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2232</tr>
2233<tr>
2234<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateId</strong><br>
2235<em>optional</em></p></td>
2236<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2237</tr>
2238<tr>
2239<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2240<em>optional</em></p></td>
2241<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2242</tr>
2243<tr>
2244<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeId</strong><br>
2245<em>optional</em></p></td>
2246<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2247</tr>
2248<tr>
2249<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeName</strong><br>
2250<em>optional</em></p></td>
2251<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2252</tr>
2253</tbody>
2254</table>
2255</div>
2256<div class="sect2">
2257<h3 id="_cldsmodelinstance"><a class="anchor" href="#_cldsmodelinstance"></a>3.5. CldsModelInstance</h3>
2258<table class="tableblock frame-all grid-all spread">
2259<colgroup>
2260<col style="width: 42%;">
2261<col style="width: 57%;">
2262</colgroup>
2263<thead>
2264<tr>
2265<th class="tableblock halign-left valign-middle">Name</th>
2266<th class="tableblock halign-left valign-middle">Schema</th>
2267</tr>
2268</thead>
2269<tbody>
2270<tr>
2271<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>location</strong><br>
2272<em>optional</em></p></td>
2273<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2274</tr>
2275<tr>
2276<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelInstanceId</strong><br>
2277<em>optional</em></p></td>
2278<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2279</tr>
2280<tr>
2281<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>vmName</strong><br>
2282<em>optional</em></p></td>
2283<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2284</tr>
2285</tbody>
2286</table>
2287</div>
2288<div class="sect2">
2289<h3 id="_cldsmonitoringdetails"><a class="anchor" href="#_cldsmonitoringdetails"></a>3.6. CldsMonitoringDetails</h3>
2290<table class="tableblock frame-all grid-all spread">
2291<colgroup>
2292<col style="width: 42%;">
2293<col style="width: 57%;">
2294</colgroup>
2295<thead>
2296<tr>
2297<th class="tableblock halign-left valign-middle">Name</th>
2298<th class="tableblock halign-left valign-middle">Schema</th>
2299</tr>
2300</thead>
2301<tbody>
2302<tr>
2303<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
2304<em>optional</em></p></td>
2305<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2306</tr>
2307<tr>
2308<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>closeloopName</strong><br>
2309<em>optional</em></p></td>
2310<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2311</tr>
2312<tr>
2313<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2314<em>optional</em></p></td>
2315<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2316</tr>
2317<tr>
2318<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
2319<em>optional</em></p></td>
2320<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2321</tr>
2322<tr>
2323<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceTypeId</strong><br>
2324<em>optional</em></p></td>
2325<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2326</tr>
2327<tr>
2328<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2329<em>optional</em></p></td>
2330<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2331</tr>
2332<tr>
2333<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>timestamp</strong><br>
2334<em>optional</em></p></td>
2335<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2336</tr>
2337<tr>
2338<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2339<em>optional</em></p></td>
2340<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2341</tr>
2342</tbody>
2343</table>
2344</div>
2345<div class="sect2">
2346<h3 id="_cldstemplate"><a class="anchor" href="#_cldstemplate"></a>3.7. CldsTemplate</h3>
2347<table class="tableblock frame-all grid-all spread">
2348<colgroup>
2349<col style="width: 42%;">
2350<col style="width: 57%;">
2351</colgroup>
2352<thead>
2353<tr>
2354<th class="tableblock halign-left valign-middle">Name</th>
2355<th class="tableblock halign-left valign-middle">Schema</th>
2356</tr>
2357</thead>
2358<tbody>
2359<tr>
2360<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnId</strong><br>
2361<em>optional</em></p></td>
2362<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2363</tr>
2364<tr>
2365<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2366<em>optional</em></p></td>
2367<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2368</tr>
2369<tr>
2370<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnUserid</strong><br>
2371<em>optional</em></p></td>
2372<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2373</tr>
2374<tr>
2375<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2376<em>optional</em></p></td>
2377<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2378</tr>
2379<tr>
2380<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2381<em>optional</em></p></td>
2382<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2383</tr>
2384<tr>
2385<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2386<em>optional</em></p></td>
2387<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2388</tr>
2389<tr>
2390<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageId</strong><br>
2391<em>optional</em></p></td>
2392<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2393</tr>
2394<tr>
2395<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2396<em>optional</em></p></td>
2397<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2398</tr>
2399<tr>
2400<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageUserid</strong><br>
2401<em>optional</em></p></td>
2402<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2403</tr>
2404<tr>
2405<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2406<em>optional</em></p></td>
2407<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2408</tr>
2409<tr>
2410<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propId</strong><br>
2411<em>optional</em></p></td>
2412<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2413</tr>
2414<tr>
2415<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2416<em>optional</em></p></td>
2417<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2418</tr>
2419<tr>
2420<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propUserid</strong><br>
2421<em>optional</em></p></td>
2422<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2423</tr>
2424<tr>
2425<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userAuthorizedToUpdate</strong><br>
2426<em>optional</em></p></td>
2427<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2428</tr>
2429</tbody>
2430</table>
2431</div>
2432<div class="sect2">
2433<h3 id="_dcaeevent"><a class="anchor" href="#_dcaeevent"></a>3.8. DcaeEvent</h3>
2434<table class="tableblock frame-all grid-all spread">
2435<colgroup>
2436<col style="width: 42%;">
2437<col style="width: 57%;">
2438</colgroup>
2439<thead>
2440<tr>
2441<th class="tableblock halign-left valign-middle">Name</th>
2442<th class="tableblock halign-left valign-middle">Schema</th>
2443</tr>
2444</thead>
2445<tbody>
2446<tr>
2447<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactName</strong><br>
2448<em>optional</em></p></td>
2449<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2450</tr>
2451<tr>
2452<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsActionCd</strong><br>
2453<em>optional</em></p></td>
2454<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2455</tr>
2456<tr>
2457<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2458<em>optional</em></p></td>
2459<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2460</tr>
2461<tr>
2462<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2463<em>optional</em></p></td>
2464<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2465</tr>
2466<tr>
2467<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>instances</strong><br>
2468<em>optional</em></p></td>
2469<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_cldsmodelinstance">CldsModelInstance</a> &gt; array</p></td>
2470</tr>
2471<tr>
2472<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceUUID</strong><br>
2473<em>optional</em></p></td>
2474<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2475</tr>
2476<tr>
2477<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUUID</strong><br>
2478<em>optional</em></p></td>
2479<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2480</tr>
2481</tbody>
2482</table>
2483</div>
2484<div class="sect2">
2485<h3 id="_valueitem"><a class="anchor" href="#_valueitem"></a>3.9. ValueItem</h3>
2486<table class="tableblock frame-all grid-all spread">
2487<colgroup>
2488<col style="width: 42%;">
2489<col style="width: 57%;">
2490</colgroup>
2491<thead>
2492<tr>
2493<th class="tableblock halign-left valign-middle">Name</th>
2494<th class="tableblock halign-left valign-middle">Schema</th>
2495</tr>
2496</thead>
2497<tbody>
2498<tr>
2499<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
2500<em>optional</em></p></td>
2501<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2502</tr>
2503</tbody>
2504</table>
2505</div>
2506</div>
2507</div>
2508</div>
2509<div id="footer">
2510<div id="footer-text">
2511Last updated 2018-05-16 16:54:06 +02:00
2512</div>
2513</div>
2514</body>
2515</html>