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.6.1">
8 <title>Clamp Rest API</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
12 /* Remove comment around @import statement below when using as a custom stylesheet */
13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
15 audio,canvas,video{display:inline-block}
16 audio:not([controls]){display:none;height:0}
17 [hidden],template{display:none}
18 script{display:none!important}
19 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
20 a{background:transparent}
21 a:focus{outline:thin dotted}
22 a:active,a:hover{outline:0}
23 h1{font-size:2em;margin:.67em 0}
24 abbr[title]{border-bottom:1px dotted}
25 b,strong{font-weight:bold}
26 dfn{font-style:italic}
27 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
28 mark{background:#ff0;color:#000}
29 code,kbd,pre,samp{font-family:monospace;font-size:1em}
30 pre{white-space:pre-wrap}
31 q{quotes:"\201C" "\201D" "\2018" "\2019"}
33 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
37 svg:not(:root){overflow:hidden}
39 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
40 legend{border:0;padding:0}
41 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
42 button,input{line-height:normal}
43 button,select{text-transform:none}
44 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
45 button[disabled],html input[disabled]{cursor:default}
46 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
47 input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
48 input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
49 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
50 textarea{overflow:auto;vertical-align:top}
51 table{border-collapse:collapse;border-spacing:0}
52 *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
53 html,body{font-size:100%}
54 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
55 a:hover{cursor:pointer}
56 img,object,embed{max-width:100%;height:auto}
57 object,embed{height:100%}
58 img{-ms-interpolation-mode:bicubic}
59 .left{float:left!important}
60 .right{float:right!important}
61 .text-left{text-align:left!important}
62 .text-right{text-align:right!important}
63 .text-center{text-align:center!important}
64 .text-justify{text-align:justify!important}
66 img,object,svg{display:inline-block;vertical-align:middle}
67 textarea{height:auto;min-height:50px}
69 .center{margin-left:auto;margin-right:auto}
71 p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
72 .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}
73 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
74 a{color:#2156a5;text-decoration:underline;line-height:inherit}
75 a:hover,a:focus{color:#1d4b8f}
77 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
78 p aside{font-size:.875em;line-height:1.35;font-style:italic}
79 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
80 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
82 h2{font-size:1.6875em}
83 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
84 h4,h5{font-size:1.125em}
86 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
87 em,i{font-style:italic;line-height:inherit}
88 strong,b{font-weight:bold;line-height:inherit}
89 small{font-size:60%;line-height:inherit}
90 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
91 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
92 ul,ol{margin-left:1.5em}
93 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
94 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
95 ul.square{list-style-type:square}
96 ul.circle{list-style-type:circle}
97 ul.disc{list-style-type:disc}
98 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
99 dl dt{margin-bottom:.3125em;font-weight:bold}
100 dl dd{margin-bottom:1.25em}
101 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
102 abbr{text-transform:none}
103 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
104 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
105 blockquote cite:before{content:"\2014 \0020"}
106 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
107 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
108 @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
110 h2{font-size:2.3125em}
111 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
112 h4{font-size:1.4375em}}
113 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
114 table thead,table tfoot{background:#f7f8f7;font-weight:bold}
115 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
116 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
117 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
118 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
119 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
120 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
121 .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
122 .clearfix:after,.float-group:after{clear:both}
123 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
124 *:not(pre)>code.nobreak{word-wrap:normal}
125 *:not(pre)>code.nowrap{white-space:nowrap}
126 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
127 em em{font-style:normal}
128 strong strong{font-weight:400}
129 .keyseq{color:rgba(51,51,51,.8)}
130 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
131 .keyseq kbd:first-child{margin-left:0}
132 .keyseq kbd:last-child{margin-right:0}
133 .menuseq,.menuref{color:#000}
134 .menuseq b:not(.caret),.menuref{font-weight:inherit}
135 .menuseq{word-spacing:-.02em}
136 .menuseq b.caret{font-size:1.25em;line-height:.8}
137 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
138 b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
139 b.button:before{content:"[";padding:0 3px 0 2px}
140 b.button:after{content:"]";padding:0 2px 0 3px}
141 p a>code:hover{color:rgba(0,0,0,.9)}
142 #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}
143 #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
144 #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
145 #content{margin-top:1.25em}
146 #content:before{content:none}
147 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
148 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
149 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
150 #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}
151 #header .details span:first-child{margin-left:-.125em}
152 #header .details span.email a{color:rgba(0,0,0,.85)}
153 #header .details br{display:none}
154 #header .details br+span:before{content:"\00a0\2013\00a0"}
155 #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
156 #header .details br+span#revremark:before{content:"\00a0|\00a0"}
157 #header #revnumber{text-transform:capitalize}
158 #header #revnumber:after{content:"\00a0"}
159 #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}
160 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
161 #toc>ul{margin-left:.125em}
162 #toc ul.sectlevel0>li>a{font-style:italic}
163 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
164 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
165 #toc li{line-height:1.3334;margin-top:.3334em}
166 #toc a{text-decoration:none}
167 #toc a:active{text-decoration:underline}
168 #toctitle{color:#7a2518;font-size:1.2em}
169 @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
170 body.toc2{padding-left:15em;padding-right:0}
171 #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}
172 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
173 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
174 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
175 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
176 body.toc2.toc-right{padding-left:0;padding-right:15em}
177 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
178 @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
179 #toc.toc2{width:20em}
180 #toc.toc2 #toctitle{font-size:1.375em}
181 #toc.toc2>ul{font-size:.95em}
182 #toc.toc2 ul ul{padding-left:1.25em}
183 body.toc2.toc-right{padding-left:0;padding-right:20em}}
184 #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}
185 #content #toc>:first-child{margin-top:0}
186 #content #toc>:last-child{margin-bottom:0}
187 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
188 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
189 .sect1{padding-bottom:.625em}
190 @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
191 .sect1+.sect1{border-top:1px solid #efefed}
192 #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}
193 #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}
194 #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}
195 #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}
196 #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}
197 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
198 .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}
199 table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
200 .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
201 table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
202 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
203 .admonitionblock>table td.icon{text-align:center;width:80px}
204 .admonitionblock>table td.icon img{max-width:initial}
205 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
206 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
207 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
208 .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}
209 .exampleblock>.content>:first-child{margin-top:0}
210 .exampleblock>.content>:last-child{margin-bottom:0}
211 .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}
212 .sidebarblock>:first-child{margin-top:0}
213 .sidebarblock>:last-child{margin-bottom:0}
214 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
215 .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}
216 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
217 .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}
218 .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}
219 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
220 @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
221 @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
222 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
223 .listingblock pre.highlightjs{padding:0}
224 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
225 .listingblock pre.prettyprint{border-width:0}
226 .listingblock>.content{position:relative}
227 .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}
228 .listingblock:hover code[data-lang]:before{display:block}
229 .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
230 .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
231 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
232 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
233 table.pyhltable td.code{padding-left:.75em;padding-right:0}
234 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
235 pre.pygments .lineno{display:inline-block;margin-right:.25em}
236 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
237 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
238 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
239 .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}
240 .quoteblock blockquote{margin:0;padding:0;border:0}
241 .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)}
242 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
243 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
244 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
245 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
246 .quoteblock .quoteblock blockquote:before{display:none}
247 .verseblock{margin:0 1em 1.25em 1em}
248 .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}
249 .verseblock pre strong{font-weight:400}
250 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
251 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
252 .quoteblock .attribution br,.verseblock .attribution br{display:none}
253 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
254 .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
256 .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
257 table.tableblock{max-width:100%;border-collapse:separate}
258 table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
259 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
260 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
261 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
262 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
263 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px 0}
264 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0 0}
265 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
266 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
267 table.frame-all{border-width:1px}
268 table.frame-sides{border-width:0 1px}
269 table.frame-topbot{border-width:1px 0}
270 th.halign-left,td.halign-left{text-align:left}
271 th.halign-right,td.halign-right{text-align:right}
272 th.halign-center,td.halign-center{text-align:center}
273 th.valign-top,td.valign-top{vertical-align:top}
274 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
275 th.valign-middle,td.valign-middle{vertical-align:middle}
276 table thead th,table tfoot th{font-weight:bold}
277 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
278 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
279 p.tableblock>code:only-child{background:none;padding:0}
280 p.tableblock{font-size:1em}
281 td>div.verse{white-space:pre}
282 ol{margin-left:1.75em}
283 ul li ol{margin-left:1.5em}
284 dl dd{margin-left:1.125em}
285 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
286 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
287 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
288 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
289 ul.unstyled,ol.unstyled{margin-left:0}
290 ul.checklist{margin-left:.625em}
291 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
292 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
293 ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
294 ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
295 ul.inline>li>*{display:block}
296 .unstyled dl dt{font-weight:400;font-style:normal}
297 ol.arabic{list-style-type:decimal}
298 ol.decimal{list-style-type:decimal-leading-zero}
299 ol.loweralpha{list-style-type:lower-alpha}
300 ol.upperalpha{list-style-type:upper-alpha}
301 ol.lowerroman{list-style-type:lower-roman}
302 ol.upperroman{list-style-type:upper-roman}
303 ol.lowergreek{list-style-type:lower-greek}
304 .hdlist>table,.colist>table{border:0;background:none}
305 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
306 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
307 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
308 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
309 .colist>table tr>td:first-of-type{padding:.4em .75em 0 .75em;line-height:1;vertical-align:top}
310 .colist>table tr>td:first-of-type img{max-width:initial}
311 .colist>table tr>td:last-of-type{padding:.25em 0}
312 .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}
313 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
314 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
315 .imageblock>.title{margin-bottom:0}
316 .imageblock.thumb,.imageblock.th{border-width:6px}
317 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
318 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
319 .image.left{margin-right:.625em}
320 .image.right{margin-left:.625em}
321 a.image{text-decoration:none;display:inline-block}
322 a.image object{pointer-events:none}
323 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
324 sup.footnote a,sup.footnoteref a{text-decoration:none}
325 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
326 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
327 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
328 #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}
329 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
330 #footnotes .footnote:last-of-type{margin-bottom:0}
331 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
332 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
333 .gist .file-data>table td.line-data{width:99%}
334 div.unbreakable{page-break-inside:avoid}
335 .big{font-size:larger}
336 .small{font-size:smaller}
337 .underline{text-decoration:underline}
338 .overline{text-decoration:overline}
339 .line-through{text-decoration:line-through}
341 .aqua-background{background-color:#00fafa}
343 .black-background{background-color:#000}
345 .blue-background{background-color:#0000fa}
346 .fuchsia{color:#bf00bf}
347 .fuchsia-background{background-color:#fa00fa}
349 .gray-background{background-color:#7d7d7d}
350 .green{color:#006000}
351 .green-background{background-color:#007d00}
353 .lime-background{background-color:#00fa00}
354 .maroon{color:#600000}
355 .maroon-background{background-color:#7d0000}
357 .navy-background{background-color:#00007d}
358 .olive{color:#606000}
359 .olive-background{background-color:#7d7d00}
360 .purple{color:#600060}
361 .purple-background{background-color:#7d007d}
363 .red-background{background-color:#fa0000}
364 .silver{color:#909090}
365 .silver-background{background-color:#bcbcbc}
367 .teal-background{background-color:#007d7d}
368 .white{color:#bfbfbf}
369 .white-background{background-color:#fafafa}
370 .yellow{color:#bfbf00}
371 .yellow-background{background-color:#fafa00}
372 span.icon>.fa{cursor:default}
373 a span.icon>.fa{cursor:inherit}
374 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
375 .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
376 .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
377 .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
378 .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
379 .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
380 .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}
381 .conum[data-value] *{color:#fff!important}
382 .conum[data-value]+b{display:none}
383 .conum[data-value]:after{content:attr(data-value)}
384 pre .conum[data-value]{position:relative;top:-.125em}
385 b.conum *{color:inherit!important}
386 .conum:not([data-value]):empty{display:none}
387 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
388 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
389 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
390 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
391 p{margin-bottom:1.25rem}
392 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
393 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
394 .print-only{display:none!important}
395 @media print{@page{margin:1.25cm .75cm}
396 *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
397 a{color:inherit!important;text-decoration:underline!important}
398 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
399 a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
400 abbr[title]:after{content:" (" attr(title) ")"}
401 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
402 thead{display:table-header-group}
404 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
405 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
406 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
407 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
408 .sect1{padding-bottom:0!important}
409 .sect1+.sect1{border:0!important}
410 #header>h1:first-child{margin-top:1.25rem}
411 body.book #header{text-align:center}
412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
413 body.book #header .details{border:0!important;display:block;padding:0!important}
414 body.book #header .details span:first-child{margin-left:0!important}
415 body.book #header .details br{display:block}
416 body.book #header .details br+span:before{content:none!important}
417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
419 .listingblock code[data-lang]:before{display:block}
420 #footer{background:none!important;padding:0 .9375em}
421 #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
422 .hide-on-print{display:none!important}
423 .print-only{display:block!important}
424 .hide-for-print{display:none!important}
425 .show-for-print{display:inherit!important}}
428 <body class="book toc2 toc-left">
430 <h1>Clamp Rest API</h1>
431 <div id="toc" class="toc2">
432 <div id="toctitle">Table of Contents</div>
433 <ul class="sectlevel1">
434 <li><a href="#_overview">1. Overview</a>
435 <ul class="sectlevel2">
436 <li><a href="#_version_information">1.1. Version information</a></li>
437 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
440 <li><a href="#_paths">2. Paths</a>
441 <ul class="sectlevel2">
442 <li><a href="#_route10">2.1. PUT /clds/action/{action}/{modelName}?test={test}</a>
443 <ul class="sectlevel3">
444 <li><a href="#_parameters">2.1.1. Parameters</a></li>
445 <li><a href="#_responses">2.1.2. Responses</a></li>
446 <li><a href="#_consumes">2.1.3. Consumes</a></li>
447 <li><a href="#_produces">2.1.4. Produces</a></li>
450 <li><a href="#_route2">2.2. GET /clds/cldsDetails</a>
451 <ul class="sectlevel3">
452 <li><a href="#_responses_2">2.2.1. Responses</a></li>
453 <li><a href="#_produces_2">2.2.2. Produces</a></li>
456 <li><a href="#_route3">2.3. GET /clds/cldsInfo</a>
457 <ul class="sectlevel3">
458 <li><a href="#_responses_3">2.3.1. Responses</a></li>
459 <li><a href="#_produces_3">2.3.2. Produces</a></li>
462 <li><a href="#_route11">2.4. POST /clds/dcae/event?test={test}</a>
463 <ul class="sectlevel3">
464 <li><a href="#_parameters_2">2.4.1. Parameters</a></li>
465 <li><a href="#_responses_4">2.4.2. Responses</a></li>
466 <li><a href="#_consumes_2">2.4.3. Consumes</a></li>
467 <li><a href="#_produces_4">2.4.4. Produces</a></li>
470 <li><a href="#_route15">2.5. PUT /clds/deploy/{modelName}</a>
471 <ul class="sectlevel3">
472 <li><a href="#_parameters_3">2.5.1. Parameters</a></li>
473 <li><a href="#_responses_5">2.5.2. Responses</a></li>
474 <li><a href="#_consumes_3">2.5.3. Consumes</a></li>
475 <li><a href="#_produces_5">2.5.4. Produces</a></li>
478 <li><a href="#_route9">2.6. GET /clds/model-names</a>
479 <ul class="sectlevel3">
480 <li><a href="#_responses_6">2.6.1. Responses</a></li>
481 <li><a href="#_produces_6">2.6.2. Produces</a></li>
484 <li><a href="#_route5">2.7. GET /clds/model/bpmn/{modelName}</a>
485 <ul class="sectlevel3">
486 <li><a href="#_parameters_4">2.7.1. Parameters</a></li>
487 <li><a href="#_responses_7">2.7.2. Responses</a></li>
488 <li><a href="#_produces_7">2.7.3. Produces</a></li>
491 <li><a href="#_route6">2.8. GET /clds/model/image/{modelName}</a>
492 <ul class="sectlevel3">
493 <li><a href="#_parameters_5">2.8.1. Parameters</a></li>
494 <li><a href="#_responses_8">2.8.2. Responses</a></li>
495 <li><a href="#_produces_8">2.8.3. Produces</a></li>
498 <li><a href="#_route7">2.9. GET /clds/model/{modelName}</a>
499 <ul class="sectlevel3">
500 <li><a href="#_parameters_6">2.9.1. Parameters</a></li>
501 <li><a href="#_responses_9">2.9.2. Responses</a></li>
502 <li><a href="#_produces_9">2.9.3. Produces</a></li>
505 <li><a href="#_route8">2.10. PUT /clds/model/{modelName}</a>
506 <ul class="sectlevel3">
507 <li><a href="#_parameters_7">2.10.1. Parameters</a></li>
508 <li><a href="#_responses_10">2.10.2. Responses</a></li>
509 <li><a href="#_consumes_4">2.10.3. Consumes</a></li>
510 <li><a href="#_produces_10">2.10.4. Produces</a></li>
513 <li><a href="#_route13">2.11. GET /clds/properties</a>
514 <ul class="sectlevel3">
515 <li><a href="#_responses_11">2.11.1. Responses</a></li>
516 <li><a href="#_produces_11">2.11.2. Produces</a></li>
519 <li><a href="#_route14">2.12. GET /clds/properties/{serviceInvariantUUID}?refresh={refresh}</a>
520 <ul class="sectlevel3">
521 <li><a href="#_parameters_8">2.12.1. Parameters</a></li>
522 <li><a href="#_responses_12">2.12.2. Responses</a></li>
523 <li><a href="#_produces_12">2.12.3. Produces</a></li>
526 <li><a href="#_route12">2.13. GET /clds/sdc/services</a>
527 <ul class="sectlevel3">
528 <li><a href="#_responses_13">2.13.1. Responses</a></li>
529 <li><a href="#_produces_13">2.13.2. Produces</a></li>
532 <li><a href="#_route16">2.14. PUT /clds/undeploy/{modelName}</a>
533 <ul class="sectlevel3">
534 <li><a href="#_parameters_9">2.14.1. Parameters</a></li>
535 <li><a href="#_responses_14">2.14.2. Responses</a></li>
536 <li><a href="#_consumes_5">2.14.3. Consumes</a></li>
537 <li><a href="#_produces_14">2.14.4. Produces</a></li>
540 <li><a href="#_route21">2.15. GET /cldsTempate/template-names</a>
541 <ul class="sectlevel3">
542 <li><a href="#_responses_15">2.15.1. Responses</a></li>
543 <li><a href="#_produces_15">2.15.2. Produces</a></li>
546 <li><a href="#_route17">2.16. GET /cldsTempate/template/bpmn/{templateName}</a>
547 <ul class="sectlevel3">
548 <li><a href="#_parameters_10">2.16.1. Parameters</a></li>
549 <li><a href="#_responses_16">2.16.2. Responses</a></li>
550 <li><a href="#_produces_16">2.16.3. Produces</a></li>
553 <li><a href="#_route18">2.17. GET /cldsTempate/template/image/{templateName}</a>
554 <ul class="sectlevel3">
555 <li><a href="#_parameters_11">2.17.1. Parameters</a></li>
556 <li><a href="#_responses_17">2.17.2. Responses</a></li>
557 <li><a href="#_produces_17">2.17.3. Produces</a></li>
560 <li><a href="#_route19">2.18. GET /cldsTempate/template/{templateName}</a>
561 <ul class="sectlevel3">
562 <li><a href="#_parameters_12">2.18.1. Parameters</a></li>
563 <li><a href="#_responses_18">2.18.2. Responses</a></li>
564 <li><a href="#_produces_18">2.18.3. Produces</a></li>
567 <li><a href="#_route20">2.19. PUT /cldsTempate/template/{templateName}</a>
568 <ul class="sectlevel3">
569 <li><a href="#_parameters_13">2.19.1. Parameters</a></li>
570 <li><a href="#_responses_19">2.19.2. Responses</a></li>
571 <li><a href="#_consumes_6">2.19.3. Consumes</a></li>
572 <li><a href="#_produces_19">2.19.4. Produces</a></li>
575 <li><a href="#_route4">2.20. GET /healthcheck</a>
576 <ul class="sectlevel3">
577 <li><a href="#_responses_20">2.20.1. Responses</a></li>
578 <li><a href="#_produces_20">2.20.2. Produces</a></li>
581 <li><a href="#_route22">2.21. GET /user/getUser</a>
582 <ul class="sectlevel3">
583 <li><a href="#_responses_21">2.21.1. Responses</a></li>
584 <li><a href="#_produces_21">2.21.2. Produces</a></li>
589 <li><a href="#_definitions">3. Definitions</a>
590 <ul class="sectlevel2">
591 <li><a href="#_cldsevent">3.1. CldsEvent</a></li>
592 <li><a href="#_cldsinfo">3.2. CldsInfo</a></li>
593 <li><a href="#_cldsmodel">3.3. CldsModel</a></li>
594 <li><a href="#_cldsmodelinstance">3.4. CldsModelInstance</a></li>
595 <li><a href="#_cldsmonitoringdetails">3.5. CldsMonitoringDetails</a></li>
596 <li><a href="#_cldstemplate">3.6. CldsTemplate</a></li>
597 <li><a href="#_dcaeevent">3.7. DcaeEvent</a></li>
598 <li><a href="#_valueitem">3.8. ValueItem</a></li>
606 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
607 <div class="sectionbody">
609 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
610 <div class="paragraph">
611 <p><em>Version</em> : 3.0.0-SNAPSHOT</p>
615 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
616 <div class="paragraph">
617 <p><em>Host</em> : 0.0.0.0<br>
618 <em>BasePath</em> : /restservices/clds/v1/<br>
619 <em>Schemes</em> : HTTP</p>
625 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
626 <div class="sectionbody">
628 <h3 id="_route10"><a class="anchor" href="#_route10"></a><a class="link" href="#_route10">2.1. PUT /clds/action/{action}/{modelName}?test={test}</a></h3>
630 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.1.1. Parameters</a></h4>
631 <table class="tableblock frame-all grid-all spread">
633 <col style="width: 22.2222%;">
634 <col style="width: 33.3333%;">
635 <col style="width: 44.4445%;">
639 <th class="tableblock halign-left valign-middle">Type</th>
640 <th class="tableblock halign-left valign-middle">Name</th>
641 <th class="tableblock halign-left valign-middle">Schema</th>
646 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
647 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
648 <em>required</em></p></td>
649 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
653 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName}?test={test</strong><br>
654 <em>required</em></p></td>
655 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
659 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
660 <em>required</em></p></td>
661 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
667 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.2. Responses</a></h4>
668 <table class="tableblock frame-all grid-all spread">
670 <col style="width: 33.3333%;">
671 <col style="width: 66.6667%;">
675 <th class="tableblock halign-left valign-middle">HTTP Code</th>
676 <th class="tableblock halign-left valign-middle">Schema</th>
681 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
682 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
688 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.1.3. Consumes</a></h4>
692 <p><code>application/json</code></p>
698 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.4. Produces</a></h4>
702 <p><code>application/json</code></p>
709 <h3 id="_route2"><a class="anchor" href="#_route2"></a><a class="link" href="#_route2">2.2. GET /clds/cldsDetails</a></h3>
711 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
712 <table class="tableblock frame-all grid-all spread">
714 <col style="width: 10%;">
715 <col style="width: 70%;">
716 <col style="width: 20%;">
720 <th class="tableblock halign-left valign-middle">HTTP Code</th>
721 <th class="tableblock halign-left valign-middle">Description</th>
722 <th class="tableblock halign-left valign-middle">Schema</th>
727 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
728 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmonitoringdetails">CldsMonitoringDetails</a></p></td>
735 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
739 <p><code>application/json</code></p>
746 <h3 id="_route3"><a class="anchor" href="#_route3"></a><a class="link" href="#_route3">2.3. GET /clds/cldsInfo</a></h3>
748 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
749 <table class="tableblock frame-all grid-all spread">
751 <col style="width: 10%;">
752 <col style="width: 70%;">
753 <col style="width: 20%;">
757 <th class="tableblock halign-left valign-middle">HTTP Code</th>
758 <th class="tableblock halign-left valign-middle">Description</th>
759 <th class="tableblock halign-left valign-middle">Schema</th>
764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
765 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
766 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
772 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
776 <p><code>application/json</code></p>
783 <h3 id="_route11"><a class="anchor" href="#_route11"></a><a class="link" href="#_route11">2.4. POST /clds/dcae/event?test={test}</a></h3>
785 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.4.1. Parameters</a></h4>
786 <table class="tableblock frame-all grid-all spread">
788 <col style="width: 22.2222%;">
789 <col style="width: 33.3333%;">
790 <col style="width: 44.4445%;">
794 <th class="tableblock halign-left valign-middle">Type</th>
795 <th class="tableblock halign-left valign-middle">Name</th>
796 <th class="tableblock halign-left valign-middle">Schema</th>
801 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
802 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
803 <em>required</em></p></td>
804 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dcaeevent">DcaeEvent</a></p></td>
810 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.2. Responses</a></h4>
811 <table class="tableblock frame-all grid-all spread">
813 <col style="width: 33.3333%;">
814 <col style="width: 66.6667%;">
818 <th class="tableblock halign-left valign-middle">HTTP Code</th>
819 <th class="tableblock halign-left valign-middle">Schema</th>
824 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
825 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
831 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.4.3. Consumes</a></h4>
835 <p><code>application/json</code></p>
841 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.4. Produces</a></h4>
845 <p><code>application/json</code></p>
852 <h3 id="_route15"><a class="anchor" href="#_route15"></a><a class="link" href="#_route15">2.5. PUT /clds/deploy/{modelName}</a></h3>
854 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.5.1. Parameters</a></h4>
855 <table class="tableblock frame-all grid-all spread">
857 <col style="width: 22.2222%;">
858 <col style="width: 33.3333%;">
859 <col style="width: 44.4445%;">
863 <th class="tableblock halign-left valign-middle">Type</th>
864 <th class="tableblock halign-left valign-middle">Name</th>
865 <th class="tableblock halign-left valign-middle">Schema</th>
870 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
872 <em>required</em></p></td>
873 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
877 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
878 <em>required</em></p></td>
879 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
885 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
886 <table class="tableblock frame-all grid-all spread">
888 <col style="width: 33.3333%;">
889 <col style="width: 66.6667%;">
893 <th class="tableblock halign-left valign-middle">HTTP Code</th>
894 <th class="tableblock halign-left valign-middle">Schema</th>
899 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
900 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
906 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.5.3. Consumes</a></h4>
910 <p><code>application/json</code></p>
916 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
920 <p><code>application/json</code></p>
927 <h3 id="_route9"><a class="anchor" href="#_route9"></a><a class="link" href="#_route9">2.6. GET /clds/model-names</a></h3>
929 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
930 <table class="tableblock frame-all grid-all spread">
932 <col style="width: 10%;">
933 <col style="width: 70%;">
934 <col style="width: 20%;">
938 <th class="tableblock halign-left valign-middle">HTTP Code</th>
939 <th class="tableblock halign-left valign-middle">Description</th>
940 <th class="tableblock halign-left valign-middle">Schema</th>
945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
946 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
947 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_valueitem">ValueItem</a></p></td>
953 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
957 <p><code>application/json</code></p>
964 <h3 id="_route5"><a class="anchor" href="#_route5"></a><a class="link" href="#_route5">2.7. GET /clds/model/bpmn/{modelName}</a></h3>
966 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.7.1. Parameters</a></h4>
967 <table class="tableblock frame-all grid-all spread">
969 <col style="width: 22.2222%;">
970 <col style="width: 33.3333%;">
971 <col style="width: 44.4445%;">
975 <th class="tableblock halign-left valign-middle">Type</th>
976 <th class="tableblock halign-left valign-middle">Name</th>
977 <th class="tableblock halign-left valign-middle">Schema</th>
982 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
984 <em>required</em></p></td>
985 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
991 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
992 <table class="tableblock frame-all grid-all spread">
994 <col style="width: 33.3333%;">
995 <col style="width: 66.6667%;">
999 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1000 <th class="tableblock halign-left valign-middle">Schema</th>
1005 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1006 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1012 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1016 <p><code>text/xml</code></p>
1023 <h3 id="_route6"><a class="anchor" href="#_route6"></a><a class="link" href="#_route6">2.8. GET /clds/model/image/{modelName}</a></h3>
1025 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.8.1. Parameters</a></h4>
1026 <table class="tableblock frame-all grid-all spread">
1028 <col style="width: 22.2222%;">
1029 <col style="width: 33.3333%;">
1030 <col style="width: 44.4445%;">
1034 <th class="tableblock halign-left valign-middle">Type</th>
1035 <th class="tableblock halign-left valign-middle">Name</th>
1036 <th class="tableblock halign-left valign-middle">Schema</th>
1041 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1042 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1043 <em>required</em></p></td>
1044 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1050 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1051 <table class="tableblock frame-all grid-all spread">
1053 <col style="width: 33.3333%;">
1054 <col style="width: 66.6667%;">
1058 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1059 <th class="tableblock halign-left valign-middle">Schema</th>
1064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1065 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1071 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.3. Produces</a></h4>
1075 <p><code>text/xml</code></p>
1082 <h3 id="_route7"><a class="anchor" href="#_route7"></a><a class="link" href="#_route7">2.9. GET /clds/model/{modelName}</a></h3>
1084 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.9.1. Parameters</a></h4>
1085 <table class="tableblock frame-all grid-all spread">
1087 <col style="width: 22.2222%;">
1088 <col style="width: 33.3333%;">
1089 <col style="width: 44.4445%;">
1093 <th class="tableblock halign-left valign-middle">Type</th>
1094 <th class="tableblock halign-left valign-middle">Name</th>
1095 <th class="tableblock halign-left valign-middle">Schema</th>
1100 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1101 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1102 <em>required</em></p></td>
1103 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1109 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1110 <table class="tableblock frame-all grid-all spread">
1112 <col style="width: 10%;">
1113 <col style="width: 70%;">
1114 <col style="width: 20%;">
1118 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1119 <th class="tableblock halign-left valign-middle">Description</th>
1120 <th class="tableblock halign-left valign-middle">Schema</th>
1125 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1126 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1127 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1133 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1137 <p><code>application/json</code></p>
1144 <h3 id="_route8"><a class="anchor" href="#_route8"></a><a class="link" href="#_route8">2.10. PUT /clds/model/{modelName}</a></h3>
1146 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.10.1. Parameters</a></h4>
1147 <table class="tableblock frame-all grid-all spread">
1149 <col style="width: 22.2222%;">
1150 <col style="width: 33.3333%;">
1151 <col style="width: 44.4445%;">
1155 <th class="tableblock halign-left valign-middle">Type</th>
1156 <th class="tableblock halign-left valign-middle">Name</th>
1157 <th class="tableblock halign-left valign-middle">Schema</th>
1162 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1163 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1164 <em>required</em></p></td>
1165 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1168 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1169 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1170 <em>required</em></p></td>
1171 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1177 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1178 <table class="tableblock frame-all grid-all spread">
1180 <col style="width: 10%;">
1181 <col style="width: 70%;">
1182 <col style="width: 20%;">
1186 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1187 <th class="tableblock halign-left valign-middle">Description</th>
1188 <th class="tableblock halign-left valign-middle">Schema</th>
1193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1194 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1195 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1201 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.10.3. Consumes</a></h4>
1205 <p><code>application/json</code></p>
1211 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.4. Produces</a></h4>
1215 <p><code>application/json</code></p>
1222 <h3 id="_route13"><a class="anchor" href="#_route13"></a><a class="link" href="#_route13">2.11. GET /clds/properties</a></h3>
1224 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.1. Responses</a></h4>
1225 <table class="tableblock frame-all grid-all spread">
1227 <col style="width: 33.3333%;">
1228 <col style="width: 66.6667%;">
1232 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1233 <th class="tableblock halign-left valign-middle">Schema</th>
1238 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1239 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1245 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.2. Produces</a></h4>
1249 <p><code>application/json</code></p>
1256 <h3 id="_route14"><a class="anchor" href="#_route14"></a><a class="link" href="#_route14">2.12. GET /clds/properties/{serviceInvariantUUID}?refresh={refresh}</a></h3>
1258 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.12.1. Parameters</a></h4>
1259 <table class="tableblock frame-all grid-all spread">
1261 <col style="width: 22.2222%;">
1262 <col style="width: 33.3333%;">
1263 <col style="width: 44.4445%;">
1267 <th class="tableblock halign-left valign-middle">Type</th>
1268 <th class="tableblock halign-left valign-middle">Name</th>
1269 <th class="tableblock halign-left valign-middle">Schema</th>
1274 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1275 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceInvariantUUID}?refresh={refresh</strong><br>
1276 <em>required</em></p></td>
1277 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1283 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1284 <table class="tableblock frame-all grid-all spread">
1286 <col style="width: 33.3333%;">
1287 <col style="width: 66.6667%;">
1291 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1292 <th class="tableblock halign-left valign-middle">Schema</th>
1297 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1298 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1304 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.3. Produces</a></h4>
1308 <p><code>application/json</code></p>
1315 <h3 id="_route12"><a class="anchor" href="#_route12"></a><a class="link" href="#_route12">2.13. GET /clds/sdc/services</a></h3>
1317 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.1. Responses</a></h4>
1318 <table class="tableblock frame-all grid-all spread">
1320 <col style="width: 33.3333%;">
1321 <col style="width: 66.6667%;">
1325 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1326 <th class="tableblock halign-left valign-middle">Schema</th>
1331 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1332 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1338 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.13.2. Produces</a></h4>
1342 <p><code>application/json</code></p>
1349 <h3 id="_route16"><a class="anchor" href="#_route16"></a><a class="link" href="#_route16">2.14. PUT /clds/undeploy/{modelName}</a></h3>
1351 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.14.1. Parameters</a></h4>
1352 <table class="tableblock frame-all grid-all spread">
1354 <col style="width: 22.2222%;">
1355 <col style="width: 33.3333%;">
1356 <col style="width: 44.4445%;">
1360 <th class="tableblock halign-left valign-middle">Type</th>
1361 <th class="tableblock halign-left valign-middle">Name</th>
1362 <th class="tableblock halign-left valign-middle">Schema</th>
1367 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1369 <em>required</em></p></td>
1370 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1373 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1374 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1375 <em>required</em></p></td>
1376 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1382 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1383 <table class="tableblock frame-all grid-all spread">
1385 <col style="width: 33.3333%;">
1386 <col style="width: 66.6667%;">
1390 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1391 <th class="tableblock halign-left valign-middle">Schema</th>
1396 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1397 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1403 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.14.3. Consumes</a></h4>
1407 <p><code>application/json</code></p>
1413 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.14.4. Produces</a></h4>
1417 <p><code>application/json</code></p>
1424 <h3 id="_route21"><a class="anchor" href="#_route21"></a><a class="link" href="#_route21">2.15. GET /cldsTempate/template-names</a></h3>
1426 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.1. Responses</a></h4>
1427 <table class="tableblock frame-all grid-all spread">
1429 <col style="width: 10%;">
1430 <col style="width: 70%;">
1431 <col style="width: 20%;">
1435 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1436 <th class="tableblock halign-left valign-middle">Description</th>
1437 <th class="tableblock halign-left valign-middle">Schema</th>
1442 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1443 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1444 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_valueitem">ValueItem</a></p></td>
1450 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.15.2. Produces</a></h4>
1454 <p><code>application/json</code></p>
1461 <h3 id="_route17"><a class="anchor" href="#_route17"></a><a class="link" href="#_route17">2.16. GET /cldsTempate/template/bpmn/{templateName}</a></h3>
1463 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.16.1. Parameters</a></h4>
1464 <table class="tableblock frame-all grid-all spread">
1466 <col style="width: 22.2222%;">
1467 <col style="width: 33.3333%;">
1468 <col style="width: 44.4445%;">
1472 <th class="tableblock halign-left valign-middle">Type</th>
1473 <th class="tableblock halign-left valign-middle">Name</th>
1474 <th class="tableblock halign-left valign-middle">Schema</th>
1479 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1480 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1481 <em>required</em></p></td>
1482 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1488 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1489 <table class="tableblock frame-all grid-all spread">
1491 <col style="width: 33.3333%;">
1492 <col style="width: 66.6667%;">
1496 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1497 <th class="tableblock halign-left valign-middle">Schema</th>
1502 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1503 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1509 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.16.3. Produces</a></h4>
1513 <p><code>text/xml</code></p>
1520 <h3 id="_route18"><a class="anchor" href="#_route18"></a><a class="link" href="#_route18">2.17. GET /cldsTempate/template/image/{templateName}</a></h3>
1522 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.17.1. Parameters</a></h4>
1523 <table class="tableblock frame-all grid-all spread">
1525 <col style="width: 22.2222%;">
1526 <col style="width: 33.3333%;">
1527 <col style="width: 44.4445%;">
1531 <th class="tableblock halign-left valign-middle">Type</th>
1532 <th class="tableblock halign-left valign-middle">Name</th>
1533 <th class="tableblock halign-left valign-middle">Schema</th>
1538 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1539 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1540 <em>required</em></p></td>
1541 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1547 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1548 <table class="tableblock frame-all grid-all spread">
1550 <col style="width: 33.3333%;">
1551 <col style="width: 66.6667%;">
1555 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1556 <th class="tableblock halign-left valign-middle">Schema</th>
1561 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1562 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1568 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.17.3. Produces</a></h4>
1572 <p><code>text/xml</code></p>
1579 <h3 id="_route19"><a class="anchor" href="#_route19"></a><a class="link" href="#_route19">2.18. GET /cldsTempate/template/{templateName}</a></h3>
1581 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.18.1. Parameters</a></h4>
1582 <table class="tableblock frame-all grid-all spread">
1584 <col style="width: 22.2222%;">
1585 <col style="width: 33.3333%;">
1586 <col style="width: 44.4445%;">
1590 <th class="tableblock halign-left valign-middle">Type</th>
1591 <th class="tableblock halign-left valign-middle">Name</th>
1592 <th class="tableblock halign-left valign-middle">Schema</th>
1597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1598 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1599 <em>required</em></p></td>
1600 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1606 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.2. Responses</a></h4>
1607 <table class="tableblock frame-all grid-all spread">
1609 <col style="width: 10%;">
1610 <col style="width: 70%;">
1611 <col style="width: 20%;">
1615 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1616 <th class="tableblock halign-left valign-middle">Description</th>
1617 <th class="tableblock halign-left valign-middle">Schema</th>
1622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1623 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1624 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1630 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.18.3. Produces</a></h4>
1634 <p><code>application/json</code></p>
1641 <h3 id="_route20"><a class="anchor" href="#_route20"></a><a class="link" href="#_route20">2.19. PUT /cldsTempate/template/{templateName}</a></h3>
1643 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.19.1. Parameters</a></h4>
1644 <table class="tableblock frame-all grid-all spread">
1646 <col style="width: 22.2222%;">
1647 <col style="width: 33.3333%;">
1648 <col style="width: 44.4445%;">
1652 <th class="tableblock halign-left valign-middle">Type</th>
1653 <th class="tableblock halign-left valign-middle">Name</th>
1654 <th class="tableblock halign-left valign-middle">Schema</th>
1659 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1660 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1661 <em>required</em></p></td>
1662 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1665 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1666 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1667 <em>required</em></p></td>
1668 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1674 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1675 <table class="tableblock frame-all grid-all spread">
1677 <col style="width: 10%;">
1678 <col style="width: 70%;">
1679 <col style="width: 20%;">
1683 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1684 <th class="tableblock halign-left valign-middle">Description</th>
1685 <th class="tableblock halign-left valign-middle">Schema</th>
1690 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1691 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1692 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1698 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.19.3. Consumes</a></h4>
1702 <p><code>application/json</code></p>
1708 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.19.4. Produces</a></h4>
1712 <p><code>application/json</code></p>
1719 <h3 id="_route4"><a class="anchor" href="#_route4"></a><a class="link" href="#_route4">2.20. GET /healthcheck</a></h3>
1721 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.1. Responses</a></h4>
1722 <table class="tableblock frame-all grid-all spread">
1724 <col style="width: 33.3333%;">
1725 <col style="width: 66.6667%;">
1729 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1730 <th class="tableblock halign-left valign-middle">Schema</th>
1735 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1736 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1742 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.20.2. Produces</a></h4>
1746 <p><code>application/json</code></p>
1753 <h3 id="_route22"><a class="anchor" href="#_route22"></a><a class="link" href="#_route22">2.21. GET /user/getUser</a></h3>
1755 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.1. Responses</a></h4>
1756 <table class="tableblock frame-all grid-all spread">
1758 <col style="width: 33.3333%;">
1759 <col style="width: 66.6667%;">
1763 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1764 <th class="tableblock halign-left valign-middle">Schema</th>
1769 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1770 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1776 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.21.2. Produces</a></h4>
1780 <p><code>text/plain</code></p>
1789 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
1790 <div class="sectionbody">
1792 <h3 id="_cldsevent"><a class="anchor" href="#_cldsevent"></a><a class="link" href="#_cldsevent">3.1. CldsEvent</a></h3>
1793 <table class="tableblock frame-all grid-all spread">
1795 <col style="width: 42.8571%;">
1796 <col style="width: 57.1429%;">
1800 <th class="tableblock halign-left valign-middle">Name</th>
1801 <th class="tableblock halign-left valign-middle">Schema</th>
1806 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionCd</strong><br>
1807 <em>optional</em></p></td>
1808 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1811 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionStateCd</strong><br>
1812 <em>optional</em></p></td>
1813 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1816 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1817 <em>optional</em></p></td>
1818 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1821 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>processInstanceId</strong><br>
1822 <em>optional</em></p></td>
1823 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
1827 <em>optional</em></p></td>
1828 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1834 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a><a class="link" href="#_cldsinfo">3.2. CldsInfo</a></h3>
1835 <table class="tableblock frame-all grid-all spread">
1837 <col style="width: 42.8571%;">
1838 <col style="width: 57.1429%;">
1842 <th class="tableblock halign-left valign-middle">Name</th>
1843 <th class="tableblock halign-left valign-middle">Schema</th>
1848 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
1849 <em>optional</em></p></td>
1850 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1853 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
1854 <em>optional</em></p></td>
1855 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
1859 <em>optional</em></p></td>
1860 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1863 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
1864 <em>optional</em></p></td>
1865 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
1869 <em>optional</em></p></td>
1870 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1873 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
1874 <em>optional</em></p></td>
1875 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1881 <h3 id="_cldsmodel"><a class="anchor" href="#_cldsmodel"></a><a class="link" href="#_cldsmodel">3.3. CldsModel</a></h3>
1882 <table class="tableblock frame-all grid-all spread">
1884 <col style="width: 42.8571%;">
1885 <col style="width: 57.1429%;">
1889 <th class="tableblock halign-left valign-middle">Name</th>
1890 <th class="tableblock halign-left valign-middle">Schema</th>
1895 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprintText</strong><br>
1896 <em>optional</em></p></td>
1897 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1900 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
1901 <em>optional</em></p></td>
1902 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1905 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsModelInstanceList</strong><br>
1906 <em>optional</em></p></td>
1907 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
1910 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
1911 <em>optional</em></p></td>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1915 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
1916 <em>optional</em></p></td>
1917 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1920 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
1921 <em>optional</em></p></td>
1922 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1925 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
1926 <em>optional</em></p></td>
1927 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>docText</strong><br>
1931 <em>optional</em></p></td>
1932 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1935 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
1936 <em>optional</em></p></td>
1937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsevent">CldsEvent</a></p></td>
1940 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1941 <em>optional</em></p></td>
1942 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
1946 <em>optional</em></p></td>
1947 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1950 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1951 <em>optional</em></p></td>
1952 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1955 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permittedActionCd</strong><br>
1956 <em>optional</em></p></td>
1957 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
1960 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
1961 <em>optional</em></p></td>
1962 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1965 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
1966 <em>optional</em></p></td>
1967 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1970 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateId</strong><br>
1971 <em>optional</em></p></td>
1972 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1976 <em>optional</em></p></td>
1977 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1980 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeId</strong><br>
1981 <em>optional</em></p></td>
1982 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeName</strong><br>
1986 <em>optional</em></p></td>
1987 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1993 <h3 id="_cldsmodelinstance"><a class="anchor" href="#_cldsmodelinstance"></a><a class="link" href="#_cldsmodelinstance">3.4. CldsModelInstance</a></h3>
1994 <table class="tableblock frame-all grid-all spread">
1996 <col style="width: 42.8571%;">
1997 <col style="width: 57.1429%;">
2001 <th class="tableblock halign-left valign-middle">Name</th>
2002 <th class="tableblock halign-left valign-middle">Schema</th>
2007 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>location</strong><br>
2008 <em>optional</em></p></td>
2009 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2012 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelInstanceId</strong><br>
2013 <em>optional</em></p></td>
2014 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2017 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>vmName</strong><br>
2018 <em>optional</em></p></td>
2019 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2025 <h3 id="_cldsmonitoringdetails"><a class="anchor" href="#_cldsmonitoringdetails"></a><a class="link" href="#_cldsmonitoringdetails">3.5. CldsMonitoringDetails</a></h3>
2026 <table class="tableblock frame-all grid-all spread">
2028 <col style="width: 42.8571%;">
2029 <col style="width: 57.1429%;">
2033 <th class="tableblock halign-left valign-middle">Name</th>
2034 <th class="tableblock halign-left valign-middle">Schema</th>
2039 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
2040 <em>optional</em></p></td>
2041 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2044 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>closeloopName</strong><br>
2045 <em>optional</em></p></td>
2046 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2049 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2050 <em>optional</em></p></td>
2051 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
2055 <em>optional</em></p></td>
2056 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2059 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceTypeId</strong><br>
2060 <em>optional</em></p></td>
2061 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2065 <em>optional</em></p></td>
2066 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2069 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>timestamp</strong><br>
2070 <em>optional</em></p></td>
2071 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2074 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2075 <em>optional</em></p></td>
2076 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2082 <h3 id="_cldstemplate"><a class="anchor" href="#_cldstemplate"></a><a class="link" href="#_cldstemplate">3.6. CldsTemplate</a></h3>
2083 <table class="tableblock frame-all grid-all spread">
2085 <col style="width: 42.8571%;">
2086 <col style="width: 57.1429%;">
2090 <th class="tableblock halign-left valign-middle">Name</th>
2091 <th class="tableblock halign-left valign-middle">Schema</th>
2096 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnId</strong><br>
2097 <em>optional</em></p></td>
2098 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2101 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2102 <em>optional</em></p></td>
2103 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2106 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnUserid</strong><br>
2107 <em>optional</em></p></td>
2108 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2111 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2112 <em>optional</em></p></td>
2113 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2116 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2117 <em>optional</em></p></td>
2118 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2121 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2122 <em>optional</em></p></td>
2123 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageId</strong><br>
2127 <em>optional</em></p></td>
2128 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2131 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2132 <em>optional</em></p></td>
2133 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2136 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageUserid</strong><br>
2137 <em>optional</em></p></td>
2138 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2141 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2142 <em>optional</em></p></td>
2143 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propId</strong><br>
2147 <em>optional</em></p></td>
2148 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2151 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2152 <em>optional</em></p></td>
2153 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2156 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propUserid</strong><br>
2157 <em>optional</em></p></td>
2158 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userAuthorizedToUpdate</strong><br>
2162 <em>optional</em></p></td>
2163 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2169 <h3 id="_dcaeevent"><a class="anchor" href="#_dcaeevent"></a><a class="link" href="#_dcaeevent">3.7. DcaeEvent</a></h3>
2170 <table class="tableblock frame-all grid-all spread">
2172 <col style="width: 42.8571%;">
2173 <col style="width: 57.1429%;">
2177 <th class="tableblock halign-left valign-middle">Name</th>
2178 <th class="tableblock halign-left valign-middle">Schema</th>
2183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactName</strong><br>
2184 <em>optional</em></p></td>
2185 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2188 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsActionCd</strong><br>
2189 <em>optional</em></p></td>
2190 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2194 <em>optional</em></p></td>
2195 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2199 <em>optional</em></p></td>
2200 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2203 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>instances</strong><br>
2204 <em>optional</em></p></td>
2205 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
2208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceUUID</strong><br>
2209 <em>optional</em></p></td>
2210 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2213 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUUID</strong><br>
2214 <em>optional</em></p></td>
2215 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2221 <h3 id="_valueitem"><a class="anchor" href="#_valueitem"></a><a class="link" href="#_valueitem">3.8. ValueItem</a></h3>
2222 <table class="tableblock frame-all grid-all spread">
2224 <col style="width: 42.8571%;">
2225 <col style="width: 57.1429%;">
2229 <th class="tableblock halign-left valign-middle">Name</th>
2230 <th class="tableblock halign-left valign-middle">Schema</th>
2235 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
2236 <em>optional</em></p></td>
2237 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2246 <div id="footer-text">
2247 Last updated 2018-06-05 12:10:11 +02:00