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="#_route27">2.20. GET /dictionary</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="#_route26">2.21. PUT /dictionary/{dictionaryName}</a>
582 <ul class="sectlevel3">
583 <li><a href="#_parameters_14">2.21.1. Parameters</a></li>
584 <li><a href="#_responses_21">2.21.2. Responses</a></li>
585 <li><a href="#_consumes_7">2.21.3. Consumes</a></li>
586 <li><a href="#_produces_21">2.21.4. Produces</a></li>
589 <li><a href="#_route29">2.22. GET /dictionary/{dictionaryName}/items</a>
590 <ul class="sectlevel3">
591 <li><a href="#_parameters_15">2.22.1. Parameters</a></li>
592 <li><a href="#_responses_22">2.22.2. Responses</a></li>
593 <li><a href="#_produces_22">2.22.3. Produces</a></li>
596 <li><a href="#_route28">2.23. PUT /dictionary/{dictionaryName}/items</a>
597 <ul class="sectlevel3">
598 <li><a href="#_parameters_16">2.23.1. Parameters</a></li>
599 <li><a href="#_responses_23">2.23.2. Responses</a></li>
600 <li><a href="#_consumes_8">2.23.3. Consumes</a></li>
601 <li><a href="#_produces_23">2.23.4. Produces</a></li>
604 <li><a href="#_route4">2.24. GET /healthcheck</a>
605 <ul class="sectlevel3">
606 <li><a href="#_responses_24">2.24.1. Responses</a></li>
607 <li><a href="#_produces_24">2.24.2. Produces</a></li>
610 <li><a href="#_route24">2.25. GET /tosca/models</a>
611 <ul class="sectlevel3">
612 <li><a href="#_responses_25">2.25.1. Responses</a></li>
613 <li><a href="#_produces_25">2.25.2. Produces</a></li>
616 <li><a href="#_route23">2.26. GET /tosca/models/policyType/{policyType}</a>
617 <ul class="sectlevel3">
618 <li><a href="#_parameters_17">2.26.1. Parameters</a></li>
619 <li><a href="#_responses_26">2.26.2. Responses</a></li>
620 <li><a href="#_produces_26">2.26.3. Produces</a></li>
623 <li><a href="#_route25">2.27. GET /tosca/models/{toscaModelName}</a>
624 <ul class="sectlevel3">
625 <li><a href="#_parameters_18">2.27.1. Parameters</a></li>
626 <li><a href="#_responses_27">2.27.2. Responses</a></li>
627 <li><a href="#_produces_27">2.27.3. Produces</a></li>
630 <li><a href="#_route22">2.28. PUT /tosca/models/{toscaModelName}</a>
631 <ul class="sectlevel3">
632 <li><a href="#_parameters_19">2.28.1. Parameters</a></li>
633 <li><a href="#_responses_28">2.28.2. Responses</a></li>
634 <li><a href="#_consumes_9">2.28.3. Consumes</a></li>
635 <li><a href="#_produces_28">2.28.4. Produces</a></li>
638 <li><a href="#_route30">2.29. GET /user/getUser</a>
639 <ul class="sectlevel3">
640 <li><a href="#_responses_29">2.29.1. Responses</a></li>
641 <li><a href="#_produces_29">2.29.2. Produces</a></li>
646 <li><a href="#_definitions">3. Definitions</a>
647 <ul class="sectlevel2">
648 <li><a href="#_cldsdictionary">3.1. CldsDictionary</a></li>
649 <li><a href="#_cldsdictionaryitem">3.2. CldsDictionaryItem</a></li>
650 <li><a href="#_cldsevent">3.3. CldsEvent</a></li>
651 <li><a href="#_cldsinfo">3.4. CldsInfo</a></li>
652 <li><a href="#_cldsmodel">3.5. CldsModel</a></li>
653 <li><a href="#_cldsmodelinstance">3.6. CldsModelInstance</a></li>
654 <li><a href="#_cldsmonitoringdetails">3.7. CldsMonitoringDetails</a></li>
655 <li><a href="#_cldstemplate">3.8. CldsTemplate</a></li>
656 <li><a href="#_cldstoscamodel">3.9. CldsToscaModel</a></li>
657 <li><a href="#_dcaeevent">3.10. DcaeEvent</a></li>
658 <li><a href="#_valueitem">3.11. ValueItem</a></li>
666 <h2 id="_overview"><a class="anchor" href="#_overview"></a><a class="link" href="#_overview">1. Overview</a></h2>
667 <div class="sectionbody">
669 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a><a class="link" href="#_version_information">1.1. Version information</a></h3>
670 <div class="paragraph">
671 <p><em>Version</em> : 3.0.3-SNAPSHOT</p>
675 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a><a class="link" href="#_uri_scheme">1.2. URI scheme</a></h3>
676 <div class="paragraph">
677 <p><em>Host</em> : 0.0.0.0<br>
678 <em>BasePath</em> : /restservices/clds/v1/<br>
679 <em>Schemes</em> : HTTP</p>
685 <h2 id="_paths"><a class="anchor" href="#_paths"></a><a class="link" href="#_paths">2. Paths</a></h2>
686 <div class="sectionbody">
688 <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>
690 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a><a class="link" href="#_parameters">2.1.1. Parameters</a></h4>
691 <table class="tableblock frame-all grid-all spread">
693 <col style="width: 22.2222%;">
694 <col style="width: 33.3333%;">
695 <col style="width: 44.4445%;">
699 <th class="tableblock halign-left valign-middle">Type</th>
700 <th class="tableblock halign-left valign-middle">Name</th>
701 <th class="tableblock halign-left valign-middle">Schema</th>
706 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
707 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
708 <em>required</em></p></td>
709 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
712 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
713 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName}?test={test</strong><br>
714 <em>required</em></p></td>
715 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
718 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
720 <em>required</em></p></td>
721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
727 <h4 id="_responses"><a class="anchor" href="#_responses"></a><a class="link" href="#_responses">2.1.2. Responses</a></h4>
728 <table class="tableblock frame-all grid-all spread">
730 <col style="width: 33.3333%;">
731 <col style="width: 66.6667%;">
735 <th class="tableblock halign-left valign-middle">HTTP Code</th>
736 <th class="tableblock halign-left valign-middle">Schema</th>
741 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
742 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
748 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a><a class="link" href="#_consumes">2.1.3. Consumes</a></h4>
752 <p><code>application/json</code></p>
758 <h4 id="_produces"><a class="anchor" href="#_produces"></a><a class="link" href="#_produces">2.1.4. Produces</a></h4>
762 <p><code>application/json</code></p>
769 <h3 id="_route2"><a class="anchor" href="#_route2"></a><a class="link" href="#_route2">2.2. GET /clds/cldsDetails</a></h3>
771 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a><a class="link" href="#_responses_2">2.2.1. Responses</a></h4>
772 <table class="tableblock frame-all grid-all spread">
774 <col style="width: 10%;">
775 <col style="width: 70%;">
776 <col style="width: 20%;">
780 <th class="tableblock halign-left valign-middle">HTTP Code</th>
781 <th class="tableblock halign-left valign-middle">Description</th>
782 <th class="tableblock halign-left valign-middle">Schema</th>
787 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
788 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
789 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmonitoringdetails">CldsMonitoringDetails</a></p></td>
795 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a><a class="link" href="#_produces_2">2.2.2. Produces</a></h4>
799 <p><code>application/json</code></p>
806 <h3 id="_route3"><a class="anchor" href="#_route3"></a><a class="link" href="#_route3">2.3. GET /clds/cldsInfo</a></h3>
808 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a><a class="link" href="#_responses_3">2.3.1. Responses</a></h4>
809 <table class="tableblock frame-all grid-all spread">
811 <col style="width: 10%;">
812 <col style="width: 70%;">
813 <col style="width: 20%;">
817 <th class="tableblock halign-left valign-middle">HTTP Code</th>
818 <th class="tableblock halign-left valign-middle">Description</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">Output type</p></td>
826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsinfo">CldsInfo</a></p></td>
832 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a><a class="link" href="#_produces_3">2.3.2. Produces</a></h4>
836 <p><code>application/json</code></p>
843 <h3 id="_route11"><a class="anchor" href="#_route11"></a><a class="link" href="#_route11">2.4. POST /clds/dcae/event?test={test}</a></h3>
845 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a><a class="link" href="#_parameters_2">2.4.1. Parameters</a></h4>
846 <table class="tableblock frame-all grid-all spread">
848 <col style="width: 22.2222%;">
849 <col style="width: 33.3333%;">
850 <col style="width: 44.4445%;">
854 <th class="tableblock halign-left valign-middle">Type</th>
855 <th class="tableblock halign-left valign-middle">Name</th>
856 <th class="tableblock halign-left valign-middle">Schema</th>
861 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
862 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
863 <em>required</em></p></td>
864 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_dcaeevent">DcaeEvent</a></p></td>
870 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a><a class="link" href="#_responses_4">2.4.2. Responses</a></h4>
871 <table class="tableblock frame-all grid-all spread">
873 <col style="width: 33.3333%;">
874 <col style="width: 66.6667%;">
878 <th class="tableblock halign-left valign-middle">HTTP Code</th>
879 <th class="tableblock halign-left valign-middle">Schema</th>
884 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
885 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
891 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a><a class="link" href="#_consumes_2">2.4.3. Consumes</a></h4>
895 <p><code>application/json</code></p>
901 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a><a class="link" href="#_produces_4">2.4.4. Produces</a></h4>
905 <p><code>application/json</code></p>
912 <h3 id="_route15"><a class="anchor" href="#_route15"></a><a class="link" href="#_route15">2.5. PUT /clds/deploy/{modelName}</a></h3>
914 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a><a class="link" href="#_parameters_3">2.5.1. Parameters</a></h4>
915 <table class="tableblock frame-all grid-all spread">
917 <col style="width: 22.2222%;">
918 <col style="width: 33.3333%;">
919 <col style="width: 44.4445%;">
923 <th class="tableblock halign-left valign-middle">Type</th>
924 <th class="tableblock halign-left valign-middle">Name</th>
925 <th class="tableblock halign-left valign-middle">Schema</th>
930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
931 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
932 <em>required</em></p></td>
933 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
936 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
938 <em>required</em></p></td>
939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
945 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a><a class="link" href="#_responses_5">2.5.2. Responses</a></h4>
946 <table class="tableblock frame-all grid-all spread">
948 <col style="width: 33.3333%;">
949 <col style="width: 66.6667%;">
953 <th class="tableblock halign-left valign-middle">HTTP Code</th>
954 <th class="tableblock halign-left valign-middle">Schema</th>
959 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
960 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
966 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a><a class="link" href="#_consumes_3">2.5.3. Consumes</a></h4>
970 <p><code>application/json</code></p>
976 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a><a class="link" href="#_produces_5">2.5.4. Produces</a></h4>
980 <p><code>application/json</code></p>
987 <h3 id="_route9"><a class="anchor" href="#_route9"></a><a class="link" href="#_route9">2.6. GET /clds/model-names</a></h3>
989 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a><a class="link" href="#_responses_6">2.6.1. Responses</a></h4>
990 <table class="tableblock frame-all grid-all spread">
992 <col style="width: 10%;">
993 <col style="width: 70%;">
994 <col style="width: 20%;">
998 <th class="tableblock halign-left valign-middle">HTTP Code</th>
999 <th class="tableblock halign-left valign-middle">Description</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">Output type</p></td>
1007 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_valueitem">ValueItem</a></p></td>
1013 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a><a class="link" href="#_produces_6">2.6.2. Produces</a></h4>
1017 <p><code>application/json</code></p>
1024 <h3 id="_route5"><a class="anchor" href="#_route5"></a><a class="link" href="#_route5">2.7. GET /clds/model/bpmn/{modelName}</a></h3>
1026 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a><a class="link" href="#_parameters_4">2.7.1. Parameters</a></h4>
1027 <table class="tableblock frame-all grid-all spread">
1029 <col style="width: 22.2222%;">
1030 <col style="width: 33.3333%;">
1031 <col style="width: 44.4445%;">
1035 <th class="tableblock halign-left valign-middle">Type</th>
1036 <th class="tableblock halign-left valign-middle">Name</th>
1037 <th class="tableblock halign-left valign-middle">Schema</th>
1042 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1043 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1044 <em>required</em></p></td>
1045 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1051 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a><a class="link" href="#_responses_7">2.7.2. Responses</a></h4>
1052 <table class="tableblock frame-all grid-all spread">
1054 <col style="width: 33.3333%;">
1055 <col style="width: 66.6667%;">
1059 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1060 <th class="tableblock halign-left valign-middle">Schema</th>
1065 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1066 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1072 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a><a class="link" href="#_produces_7">2.7.3. Produces</a></h4>
1076 <p><code>text/xml</code></p>
1083 <h3 id="_route6"><a class="anchor" href="#_route6"></a><a class="link" href="#_route6">2.8. GET /clds/model/image/{modelName}</a></h3>
1085 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a><a class="link" href="#_parameters_5">2.8.1. Parameters</a></h4>
1086 <table class="tableblock frame-all grid-all spread">
1088 <col style="width: 22.2222%;">
1089 <col style="width: 33.3333%;">
1090 <col style="width: 44.4445%;">
1094 <th class="tableblock halign-left valign-middle">Type</th>
1095 <th class="tableblock halign-left valign-middle">Name</th>
1096 <th class="tableblock halign-left valign-middle">Schema</th>
1101 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1102 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1103 <em>required</em></p></td>
1104 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1110 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a><a class="link" href="#_responses_8">2.8.2. Responses</a></h4>
1111 <table class="tableblock frame-all grid-all spread">
1113 <col style="width: 33.3333%;">
1114 <col style="width: 66.6667%;">
1118 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1119 <th class="tableblock halign-left valign-middle">Schema</th>
1124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1125 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1131 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a><a class="link" href="#_produces_8">2.8.3. Produces</a></h4>
1135 <p><code>text/xml</code></p>
1142 <h3 id="_route7"><a class="anchor" href="#_route7"></a><a class="link" href="#_route7">2.9. GET /clds/model/{modelName}</a></h3>
1144 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a><a class="link" href="#_parameters_6">2.9.1. Parameters</a></h4>
1145 <table class="tableblock frame-all grid-all spread">
1147 <col style="width: 22.2222%;">
1148 <col style="width: 33.3333%;">
1149 <col style="width: 44.4445%;">
1153 <th class="tableblock halign-left valign-middle">Type</th>
1154 <th class="tableblock halign-left valign-middle">Name</th>
1155 <th class="tableblock halign-left valign-middle">Schema</th>
1160 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1161 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1162 <em>required</em></p></td>
1163 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1169 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a><a class="link" href="#_responses_9">2.9.2. Responses</a></h4>
1170 <table class="tableblock frame-all grid-all spread">
1172 <col style="width: 10%;">
1173 <col style="width: 70%;">
1174 <col style="width: 20%;">
1178 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1179 <th class="tableblock halign-left valign-middle">Description</th>
1180 <th class="tableblock halign-left valign-middle">Schema</th>
1185 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1186 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1187 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1193 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a><a class="link" href="#_produces_9">2.9.3. Produces</a></h4>
1197 <p><code>application/json</code></p>
1204 <h3 id="_route8"><a class="anchor" href="#_route8"></a><a class="link" href="#_route8">2.10. PUT /clds/model/{modelName}</a></h3>
1206 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a><a class="link" href="#_parameters_7">2.10.1. Parameters</a></h4>
1207 <table class="tableblock frame-all grid-all spread">
1209 <col style="width: 22.2222%;">
1210 <col style="width: 33.3333%;">
1211 <col style="width: 44.4445%;">
1215 <th class="tableblock halign-left valign-middle">Type</th>
1216 <th class="tableblock halign-left valign-middle">Name</th>
1217 <th class="tableblock halign-left valign-middle">Schema</th>
1222 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1223 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1224 <em>required</em></p></td>
1225 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1228 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1229 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1230 <em>required</em></p></td>
1231 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1237 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a><a class="link" href="#_responses_10">2.10.2. Responses</a></h4>
1238 <table class="tableblock frame-all grid-all spread">
1240 <col style="width: 10%;">
1241 <col style="width: 70%;">
1242 <col style="width: 20%;">
1246 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1247 <th class="tableblock halign-left valign-middle">Description</th>
1248 <th class="tableblock halign-left valign-middle">Schema</th>
1253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1254 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1261 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a><a class="link" href="#_consumes_4">2.10.3. Consumes</a></h4>
1265 <p><code>application/json</code></p>
1271 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a><a class="link" href="#_produces_10">2.10.4. Produces</a></h4>
1275 <p><code>application/json</code></p>
1282 <h3 id="_route13"><a class="anchor" href="#_route13"></a><a class="link" href="#_route13">2.11. GET /clds/properties</a></h3>
1284 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a><a class="link" href="#_responses_11">2.11.1. Responses</a></h4>
1285 <table class="tableblock frame-all grid-all spread">
1287 <col style="width: 33.3333%;">
1288 <col style="width: 66.6667%;">
1292 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1293 <th class="tableblock halign-left valign-middle">Schema</th>
1298 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1299 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1305 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a><a class="link" href="#_produces_11">2.11.2. Produces</a></h4>
1309 <p><code>application/json</code></p>
1316 <h3 id="_route14"><a class="anchor" href="#_route14"></a><a class="link" href="#_route14">2.12. GET /clds/properties/{serviceInvariantUUID}?refresh={refresh}</a></h3>
1318 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a><a class="link" href="#_parameters_8">2.12.1. Parameters</a></h4>
1319 <table class="tableblock frame-all grid-all spread">
1321 <col style="width: 22.2222%;">
1322 <col style="width: 33.3333%;">
1323 <col style="width: 44.4445%;">
1327 <th class="tableblock halign-left valign-middle">Type</th>
1328 <th class="tableblock halign-left valign-middle">Name</th>
1329 <th class="tableblock halign-left valign-middle">Schema</th>
1334 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1335 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceInvariantUUID}?refresh={refresh</strong><br>
1336 <em>required</em></p></td>
1337 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1343 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a><a class="link" href="#_responses_12">2.12.2. Responses</a></h4>
1344 <table class="tableblock frame-all grid-all spread">
1346 <col style="width: 33.3333%;">
1347 <col style="width: 66.6667%;">
1351 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1352 <th class="tableblock halign-left valign-middle">Schema</th>
1357 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1358 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1364 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a><a class="link" href="#_produces_12">2.12.3. Produces</a></h4>
1368 <p><code>application/json</code></p>
1375 <h3 id="_route12"><a class="anchor" href="#_route12"></a><a class="link" href="#_route12">2.13. GET /clds/sdc/services</a></h3>
1377 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a><a class="link" href="#_responses_13">2.13.1. Responses</a></h4>
1378 <table class="tableblock frame-all grid-all spread">
1380 <col style="width: 33.3333%;">
1381 <col style="width: 66.6667%;">
1385 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1386 <th class="tableblock halign-left valign-middle">Schema</th>
1391 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1392 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1398 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a><a class="link" href="#_produces_13">2.13.2. Produces</a></h4>
1402 <p><code>application/json</code></p>
1409 <h3 id="_route16"><a class="anchor" href="#_route16"></a><a class="link" href="#_route16">2.14. PUT /clds/undeploy/{modelName}</a></h3>
1411 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a><a class="link" href="#_parameters_9">2.14.1. Parameters</a></h4>
1412 <table class="tableblock frame-all grid-all spread">
1414 <col style="width: 22.2222%;">
1415 <col style="width: 33.3333%;">
1416 <col style="width: 44.4445%;">
1420 <th class="tableblock halign-left valign-middle">Type</th>
1421 <th class="tableblock halign-left valign-middle">Name</th>
1422 <th class="tableblock halign-left valign-middle">Schema</th>
1427 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1428 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
1429 <em>required</em></p></td>
1430 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1434 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1435 <em>required</em></p></td>
1436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsmodel">CldsModel</a></p></td>
1442 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a><a class="link" href="#_responses_14">2.14.2. Responses</a></h4>
1443 <table class="tableblock frame-all grid-all spread">
1445 <col style="width: 33.3333%;">
1446 <col style="width: 66.6667%;">
1450 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1451 <th class="tableblock halign-left valign-middle">Schema</th>
1456 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1457 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1463 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a><a class="link" href="#_consumes_5">2.14.3. Consumes</a></h4>
1467 <p><code>application/json</code></p>
1473 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a><a class="link" href="#_produces_14">2.14.4. Produces</a></h4>
1477 <p><code>application/json</code></p>
1484 <h3 id="_route21"><a class="anchor" href="#_route21"></a><a class="link" href="#_route21">2.15. GET /cldsTempate/template-names</a></h3>
1486 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a><a class="link" href="#_responses_15">2.15.1. Responses</a></h4>
1487 <table class="tableblock frame-all grid-all spread">
1489 <col style="width: 10%;">
1490 <col style="width: 70%;">
1491 <col style="width: 20%;">
1495 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1496 <th class="tableblock halign-left valign-middle">Description</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">Output type</p></td>
1504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_valueitem">ValueItem</a></p></td>
1510 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a><a class="link" href="#_produces_15">2.15.2. Produces</a></h4>
1514 <p><code>application/json</code></p>
1521 <h3 id="_route17"><a class="anchor" href="#_route17"></a><a class="link" href="#_route17">2.16. GET /cldsTempate/template/bpmn/{templateName}</a></h3>
1523 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a><a class="link" href="#_parameters_10">2.16.1. Parameters</a></h4>
1524 <table class="tableblock frame-all grid-all spread">
1526 <col style="width: 22.2222%;">
1527 <col style="width: 33.3333%;">
1528 <col style="width: 44.4445%;">
1532 <th class="tableblock halign-left valign-middle">Type</th>
1533 <th class="tableblock halign-left valign-middle">Name</th>
1534 <th class="tableblock halign-left valign-middle">Schema</th>
1539 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1541 <em>required</em></p></td>
1542 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1548 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a><a class="link" href="#_responses_16">2.16.2. Responses</a></h4>
1549 <table class="tableblock frame-all grid-all spread">
1551 <col style="width: 33.3333%;">
1552 <col style="width: 66.6667%;">
1556 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1557 <th class="tableblock halign-left valign-middle">Schema</th>
1562 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1563 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1569 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a><a class="link" href="#_produces_16">2.16.3. Produces</a></h4>
1573 <p><code>text/xml</code></p>
1580 <h3 id="_route18"><a class="anchor" href="#_route18"></a><a class="link" href="#_route18">2.17. GET /cldsTempate/template/image/{templateName}</a></h3>
1582 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a><a class="link" href="#_parameters_11">2.17.1. Parameters</a></h4>
1583 <table class="tableblock frame-all grid-all spread">
1585 <col style="width: 22.2222%;">
1586 <col style="width: 33.3333%;">
1587 <col style="width: 44.4445%;">
1591 <th class="tableblock halign-left valign-middle">Type</th>
1592 <th class="tableblock halign-left valign-middle">Name</th>
1593 <th class="tableblock halign-left valign-middle">Schema</th>
1598 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1599 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1600 <em>required</em></p></td>
1601 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1607 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a><a class="link" href="#_responses_17">2.17.2. Responses</a></h4>
1608 <table class="tableblock frame-all grid-all spread">
1610 <col style="width: 33.3333%;">
1611 <col style="width: 66.6667%;">
1615 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1616 <th class="tableblock halign-left valign-middle">Schema</th>
1621 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1622 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1628 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a><a class="link" href="#_produces_17">2.17.3. Produces</a></h4>
1632 <p><code>text/xml</code></p>
1639 <h3 id="_route19"><a class="anchor" href="#_route19"></a><a class="link" href="#_route19">2.18. GET /cldsTempate/template/{templateName}</a></h3>
1641 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a><a class="link" href="#_parameters_12">2.18.1. Parameters</a></h4>
1642 <table class="tableblock frame-all grid-all spread">
1644 <col style="width: 22.2222%;">
1645 <col style="width: 33.3333%;">
1646 <col style="width: 44.4445%;">
1650 <th class="tableblock halign-left valign-middle">Type</th>
1651 <th class="tableblock halign-left valign-middle">Name</th>
1652 <th class="tableblock halign-left valign-middle">Schema</th>
1657 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1659 <em>required</em></p></td>
1660 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1666 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a><a class="link" href="#_responses_18">2.18.2. Responses</a></h4>
1667 <table class="tableblock frame-all grid-all spread">
1669 <col style="width: 10%;">
1670 <col style="width: 70%;">
1671 <col style="width: 20%;">
1675 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1676 <th class="tableblock halign-left valign-middle">Description</th>
1677 <th class="tableblock halign-left valign-middle">Schema</th>
1682 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1683 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1690 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a><a class="link" href="#_produces_18">2.18.3. Produces</a></h4>
1694 <p><code>application/json</code></p>
1701 <h3 id="_route20"><a class="anchor" href="#_route20"></a><a class="link" href="#_route20">2.19. PUT /cldsTempate/template/{templateName}</a></h3>
1703 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a><a class="link" href="#_parameters_13">2.19.1. Parameters</a></h4>
1704 <table class="tableblock frame-all grid-all spread">
1706 <col style="width: 22.2222%;">
1707 <col style="width: 33.3333%;">
1708 <col style="width: 44.4445%;">
1712 <th class="tableblock halign-left valign-middle">Type</th>
1713 <th class="tableblock halign-left valign-middle">Name</th>
1714 <th class="tableblock halign-left valign-middle">Schema</th>
1719 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1720 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
1721 <em>required</em></p></td>
1722 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1725 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1727 <em>required</em></p></td>
1728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1734 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a><a class="link" href="#_responses_19">2.19.2. Responses</a></h4>
1735 <table class="tableblock frame-all grid-all spread">
1737 <col style="width: 10%;">
1738 <col style="width: 70%;">
1739 <col style="width: 20%;">
1743 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1744 <th class="tableblock halign-left valign-middle">Description</th>
1745 <th class="tableblock halign-left valign-middle">Schema</th>
1750 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1751 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1752 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstemplate">CldsTemplate</a></p></td>
1758 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a><a class="link" href="#_consumes_6">2.19.3. Consumes</a></h4>
1762 <p><code>application/json</code></p>
1768 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a><a class="link" href="#_produces_19">2.19.4. Produces</a></h4>
1772 <p><code>application/json</code></p>
1779 <h3 id="_route27"><a class="anchor" href="#_route27"></a><a class="link" href="#_route27">2.20. GET /dictionary</a></h3>
1781 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a><a class="link" href="#_responses_20">2.20.1. Responses</a></h4>
1782 <table class="tableblock frame-all grid-all spread">
1784 <col style="width: 10%;">
1785 <col style="width: 70%;">
1786 <col style="width: 20%;">
1790 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1791 <th class="tableblock halign-left valign-middle">Description</th>
1792 <th class="tableblock halign-left valign-middle">Schema</th>
1797 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1798 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1805 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a><a class="link" href="#_produces_20">2.20.2. Produces</a></h4>
1809 <p><code>application/json</code></p>
1816 <h3 id="_route26"><a class="anchor" href="#_route26"></a><a class="link" href="#_route26">2.21. PUT /dictionary/{dictionaryName}</a></h3>
1818 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a><a class="link" href="#_parameters_14">2.21.1. Parameters</a></h4>
1819 <table class="tableblock frame-all grid-all spread">
1821 <col style="width: 22.2222%;">
1822 <col style="width: 33.3333%;">
1823 <col style="width: 44.4445%;">
1827 <th class="tableblock halign-left valign-middle">Type</th>
1828 <th class="tableblock halign-left valign-middle">Name</th>
1829 <th class="tableblock halign-left valign-middle">Schema</th>
1834 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1836 <em>required</em></p></td>
1837 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1840 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1841 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1842 <em>required</em></p></td>
1843 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1849 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a><a class="link" href="#_responses_21">2.21.2. Responses</a></h4>
1850 <table class="tableblock frame-all grid-all spread">
1852 <col style="width: 10%;">
1853 <col style="width: 70%;">
1854 <col style="width: 20%;">
1858 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1859 <th class="tableblock halign-left valign-middle">Description</th>
1860 <th class="tableblock halign-left valign-middle">Schema</th>
1865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1866 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1867 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1873 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a><a class="link" href="#_consumes_7">2.21.3. Consumes</a></h4>
1877 <p><code>application/json</code></p>
1883 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a><a class="link" href="#_produces_21">2.21.4. Produces</a></h4>
1887 <p><code>application/json</code></p>
1894 <h3 id="_route29"><a class="anchor" href="#_route29"></a><a class="link" href="#_route29">2.22. GET /dictionary/{dictionaryName}/items</a></h3>
1896 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a><a class="link" href="#_parameters_15">2.22.1. Parameters</a></h4>
1897 <table class="tableblock frame-all grid-all spread">
1899 <col style="width: 22.2222%;">
1900 <col style="width: 33.3333%;">
1901 <col style="width: 44.4445%;">
1905 <th class="tableblock halign-left valign-middle">Type</th>
1906 <th class="tableblock halign-left valign-middle">Name</th>
1907 <th class="tableblock halign-left valign-middle">Schema</th>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1913 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1914 <em>required</em></p></td>
1915 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1921 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a><a class="link" href="#_responses_22">2.22.2. Responses</a></h4>
1922 <table class="tableblock frame-all grid-all spread">
1924 <col style="width: 10%;">
1925 <col style="width: 70%;">
1926 <col style="width: 20%;">
1930 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1931 <th class="tableblock halign-left valign-middle">Description</th>
1932 <th class="tableblock halign-left valign-middle">Schema</th>
1937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1938 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
1939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionary">CldsDictionary</a></p></td>
1945 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a><a class="link" href="#_produces_22">2.22.3. Produces</a></h4>
1949 <p><code>application/json</code></p>
1956 <h3 id="_route28"><a class="anchor" href="#_route28"></a><a class="link" href="#_route28">2.23. PUT /dictionary/{dictionaryName}/items</a></h3>
1958 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a><a class="link" href="#_parameters_16">2.23.1. Parameters</a></h4>
1959 <table class="tableblock frame-all grid-all spread">
1961 <col style="width: 22.2222%;">
1962 <col style="width: 33.3333%;">
1963 <col style="width: 44.4445%;">
1967 <th class="tableblock halign-left valign-middle">Type</th>
1968 <th class="tableblock halign-left valign-middle">Name</th>
1969 <th class="tableblock halign-left valign-middle">Schema</th>
1974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1975 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
1976 <em>required</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>Body</strong></p></td>
1981 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
1982 <em>required</em></p></td>
1983 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionaryitem">CldsDictionaryItem</a></p></td>
1989 <h4 id="_responses_23"><a class="anchor" href="#_responses_23"></a><a class="link" href="#_responses_23">2.23.2. Responses</a></h4>
1990 <table class="tableblock frame-all grid-all spread">
1992 <col style="width: 10%;">
1993 <col style="width: 70%;">
1994 <col style="width: 20%;">
1998 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1999 <th class="tableblock halign-left valign-middle">Description</th>
2000 <th class="tableblock halign-left valign-middle">Schema</th>
2005 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2006 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2007 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsdictionaryitem">CldsDictionaryItem</a></p></td>
2013 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a><a class="link" href="#_consumes_8">2.23.3. Consumes</a></h4>
2017 <p><code>application/json</code></p>
2023 <h4 id="_produces_23"><a class="anchor" href="#_produces_23"></a><a class="link" href="#_produces_23">2.23.4. Produces</a></h4>
2027 <p><code>application/json</code></p>
2034 <h3 id="_route4"><a class="anchor" href="#_route4"></a><a class="link" href="#_route4">2.24. GET /healthcheck</a></h3>
2036 <h4 id="_responses_24"><a class="anchor" href="#_responses_24"></a><a class="link" href="#_responses_24">2.24.1. Responses</a></h4>
2037 <table class="tableblock frame-all grid-all spread">
2039 <col style="width: 33.3333%;">
2040 <col style="width: 66.6667%;">
2044 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2045 <th class="tableblock halign-left valign-middle">Schema</th>
2050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2051 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2057 <h4 id="_produces_24"><a class="anchor" href="#_produces_24"></a><a class="link" href="#_produces_24">2.24.2. Produces</a></h4>
2061 <p><code>application/json</code></p>
2068 <h3 id="_route24"><a class="anchor" href="#_route24"></a><a class="link" href="#_route24">2.25. GET /tosca/models</a></h3>
2070 <h4 id="_responses_25"><a class="anchor" href="#_responses_25"></a><a class="link" href="#_responses_25">2.25.1. Responses</a></h4>
2071 <table class="tableblock frame-all grid-all spread">
2073 <col style="width: 10%;">
2074 <col style="width: 70%;">
2075 <col style="width: 20%;">
2079 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2080 <th class="tableblock halign-left valign-middle">Description</th>
2081 <th class="tableblock halign-left valign-middle">Schema</th>
2086 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2087 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2088 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2094 <h4 id="_produces_25"><a class="anchor" href="#_produces_25"></a><a class="link" href="#_produces_25">2.25.2. Produces</a></h4>
2098 <p><code>application/json</code></p>
2105 <h3 id="_route23"><a class="anchor" href="#_route23"></a><a class="link" href="#_route23">2.26. GET /tosca/models/policyType/{policyType}</a></h3>
2107 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a><a class="link" href="#_parameters_17">2.26.1. Parameters</a></h4>
2108 <table class="tableblock frame-all grid-all spread">
2110 <col style="width: 22.2222%;">
2111 <col style="width: 33.3333%;">
2112 <col style="width: 44.4445%;">
2116 <th class="tableblock halign-left valign-middle">Type</th>
2117 <th class="tableblock halign-left valign-middle">Name</th>
2118 <th class="tableblock halign-left valign-middle">Schema</th>
2123 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2124 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
2125 <em>required</em></p></td>
2126 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2132 <h4 id="_responses_26"><a class="anchor" href="#_responses_26"></a><a class="link" href="#_responses_26">2.26.2. Responses</a></h4>
2133 <table class="tableblock frame-all grid-all spread">
2135 <col style="width: 33.3333%;">
2136 <col style="width: 66.6667%;">
2140 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2141 <th class="tableblock halign-left valign-middle">Schema</th>
2146 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2147 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2153 <h4 id="_produces_26"><a class="anchor" href="#_produces_26"></a><a class="link" href="#_produces_26">2.26.3. Produces</a></h4>
2157 <p><code>application/json</code></p>
2164 <h3 id="_route25"><a class="anchor" href="#_route25"></a><a class="link" href="#_route25">2.27. GET /tosca/models/{toscaModelName}</a></h3>
2166 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a><a class="link" href="#_parameters_18">2.27.1. Parameters</a></h4>
2167 <table class="tableblock frame-all grid-all spread">
2169 <col style="width: 22.2222%;">
2170 <col style="width: 33.3333%;">
2171 <col style="width: 44.4445%;">
2175 <th class="tableblock halign-left valign-middle">Type</th>
2176 <th class="tableblock halign-left valign-middle">Name</th>
2177 <th class="tableblock halign-left valign-middle">Schema</th>
2182 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelName</strong><br>
2184 <em>required</em></p></td>
2185 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2191 <h4 id="_responses_27"><a class="anchor" href="#_responses_27"></a><a class="link" href="#_responses_27">2.27.2. Responses</a></h4>
2192 <table class="tableblock frame-all grid-all spread">
2194 <col style="width: 10%;">
2195 <col style="width: 70%;">
2196 <col style="width: 20%;">
2200 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2201 <th class="tableblock halign-left valign-middle">Description</th>
2202 <th class="tableblock halign-left valign-middle">Schema</th>
2207 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2208 <td class="tableblock halign-left valign-middle"><p class="tableblock">Output type</p></td>
2209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2215 <h4 id="_produces_27"><a class="anchor" href="#_produces_27"></a><a class="link" href="#_produces_27">2.27.3. Produces</a></h4>
2219 <p><code>application/json</code></p>
2226 <h3 id="_route22"><a class="anchor" href="#_route22"></a><a class="link" href="#_route22">2.28. PUT /tosca/models/{toscaModelName}</a></h3>
2228 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a><a class="link" href="#_parameters_19">2.28.1. Parameters</a></h4>
2229 <table class="tableblock frame-all grid-all spread">
2231 <col style="width: 22.2222%;">
2232 <col style="width: 33.3333%;">
2233 <col style="width: 44.4445%;">
2237 <th class="tableblock halign-left valign-middle">Type</th>
2238 <th class="tableblock halign-left valign-middle">Name</th>
2239 <th class="tableblock halign-left valign-middle">Schema</th>
2244 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
2245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelName</strong><br>
2246 <em>required</em></p></td>
2247 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
2251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>body</strong><br>
2252 <em>required</em></p></td>
2253 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldstoscamodel">CldsToscaModel</a></p></td>
2259 <h4 id="_responses_28"><a class="anchor" href="#_responses_28"></a><a class="link" href="#_responses_28">2.28.2. Responses</a></h4>
2260 <table class="tableblock frame-all grid-all spread">
2262 <col style="width: 33.3333%;">
2263 <col style="width: 66.6667%;">
2267 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2268 <th class="tableblock halign-left valign-middle">Schema</th>
2273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2274 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2280 <h4 id="_consumes_9"><a class="anchor" href="#_consumes_9"></a><a class="link" href="#_consumes_9">2.28.3. Consumes</a></h4>
2284 <p><code>application/json</code></p>
2290 <h4 id="_produces_28"><a class="anchor" href="#_produces_28"></a><a class="link" href="#_produces_28">2.28.4. Produces</a></h4>
2294 <p><code>application/json</code></p>
2301 <h3 id="_route30"><a class="anchor" href="#_route30"></a><a class="link" href="#_route30">2.29. GET /user/getUser</a></h3>
2303 <h4 id="_responses_29"><a class="anchor" href="#_responses_29"></a><a class="link" href="#_responses_29">2.29.1. Responses</a></h4>
2304 <table class="tableblock frame-all grid-all spread">
2306 <col style="width: 33.3333%;">
2307 <col style="width: 66.6667%;">
2311 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2312 <th class="tableblock halign-left valign-middle">Schema</th>
2317 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
2318 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
2324 <h4 id="_produces_29"><a class="anchor" href="#_produces_29"></a><a class="link" href="#_produces_29">2.29.2. Produces</a></h4>
2328 <p><code>text/plain</code></p>
2337 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a><a class="link" href="#_definitions">3. Definitions</a></h2>
2338 <div class="sectionbody">
2340 <h3 id="_cldsdictionary"><a class="anchor" href="#_cldsdictionary"></a><a class="link" href="#_cldsdictionary">3.1. CldsDictionary</a></h3>
2341 <table class="tableblock frame-all grid-all spread">
2343 <col style="width: 42.8571%;">
2344 <col style="width: 57.1429%;">
2348 <th class="tableblock halign-left valign-middle">Name</th>
2349 <th class="tableblock halign-left valign-middle">Schema</th>
2354 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsDictionaryItems</strong><br>
2355 <em>optional</em></p></td>
2356 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsdictionaryitem">CldsDictionaryItem</a> > array</p></td>
2359 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
2360 <em>optional</em></p></td>
2361 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2364 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryId</strong><br>
2365 <em>optional</em></p></td>
2366 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2369 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryName</strong><br>
2370 <em>optional</em></p></td>
2371 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2374 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastUpdatedDate</strong><br>
2375 <em>optional</em></p></td>
2376 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2379 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
2380 <em>optional</em></p></td>
2381 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2387 <h3 id="_cldsdictionaryitem"><a class="anchor" href="#_cldsdictionaryitem"></a><a class="link" href="#_cldsdictionaryitem">3.2. CldsDictionaryItem</a></h3>
2388 <table class="tableblock frame-all grid-all spread">
2390 <col style="width: 42.8571%;">
2391 <col style="width: 57.1429%;">
2395 <th class="tableblock halign-left valign-middle">Name</th>
2396 <th class="tableblock halign-left valign-middle">Schema</th>
2401 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdBy</strong><br>
2402 <em>optional</em></p></td>
2403 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2406 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementDesc</strong><br>
2407 <em>optional</em></p></td>
2408 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2411 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementId</strong><br>
2412 <em>optional</em></p></td>
2413 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2416 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementName</strong><br>
2417 <em>optional</em></p></td>
2418 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2421 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementShortName</strong><br>
2422 <em>optional</em></p></td>
2423 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2426 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictElementType</strong><br>
2427 <em>optional</em></p></td>
2428 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2431 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>dictionaryId</strong><br>
2432 <em>optional</em></p></td>
2433 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastUpdatedDate</strong><br>
2437 <em>optional</em></p></td>
2438 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2441 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>updatedBy</strong><br>
2442 <em>optional</em></p></td>
2443 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2449 <h3 id="_cldsevent"><a class="anchor" href="#_cldsevent"></a><a class="link" href="#_cldsevent">3.3. CldsEvent</a></h3>
2450 <table class="tableblock frame-all grid-all spread">
2452 <col style="width: 42.8571%;">
2453 <col style="width: 57.1429%;">
2457 <th class="tableblock halign-left valign-middle">Name</th>
2458 <th class="tableblock halign-left valign-middle">Schema</th>
2463 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionCd</strong><br>
2464 <em>optional</em></p></td>
2465 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2468 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>actionStateCd</strong><br>
2469 <em>optional</em></p></td>
2470 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2473 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2474 <em>optional</em></p></td>
2475 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2478 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>processInstanceId</strong><br>
2479 <em>optional</em></p></td>
2480 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2483 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2484 <em>optional</em></p></td>
2485 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2491 <h3 id="_cldsinfo"><a class="anchor" href="#_cldsinfo"></a><a class="link" href="#_cldsinfo">3.4. CldsInfo</a></h3>
2492 <table class="tableblock frame-all grid-all spread">
2494 <col style="width: 42.8571%;">
2495 <col style="width: 57.1429%;">
2499 <th class="tableblock halign-left valign-middle">Name</th>
2500 <th class="tableblock halign-left valign-middle">Schema</th>
2505 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsVersion</strong><br>
2506 <em>optional</em></p></td>
2507 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2510 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadCl</strong><br>
2511 <em>optional</em></p></td>
2512 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2515 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTemplate</strong><br>
2516 <em>optional</em></p></td>
2517 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2520 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionReadTosca</strong><br>
2521 <em>optional</em></p></td>
2522 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2525 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateCl</strong><br>
2526 <em>optional</em></p></td>
2527 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2530 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTemplate</strong><br>
2531 <em>optional</em></p></td>
2532 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2535 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permissionUpdateTosca</strong><br>
2536 <em>optional</em></p></td>
2537 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2540 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userName</strong><br>
2541 <em>optional</em></p></td>
2542 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2548 <h3 id="_cldsmodel"><a class="anchor" href="#_cldsmodel"></a><a class="link" href="#_cldsmodel">3.5. CldsModel</a></h3>
2549 <table class="tableblock frame-all grid-all spread">
2551 <col style="width: 42.8571%;">
2552 <col style="width: 57.1429%;">
2556 <th class="tableblock halign-left valign-middle">Name</th>
2557 <th class="tableblock halign-left valign-middle">Schema</th>
2562 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>blueprintText</strong><br>
2563 <em>optional</em></p></td>
2564 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2567 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2568 <em>optional</em></p></td>
2569 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2572 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsModelInstanceList</strong><br>
2573 <em>optional</em></p></td>
2574 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
2577 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2578 <em>optional</em></p></td>
2579 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2582 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2583 <em>optional</em></p></td>
2584 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2587 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2588 <em>optional</em></p></td>
2589 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2592 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2593 <em>optional</em></p></td>
2594 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentStatusUrl</strong><br>
2598 <em>optional</em></p></td>
2599 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>docText</strong><br>
2603 <em>optional</em></p></td>
2604 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2607 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>errorMessageForUi</strong><br>
2608 <em>optional</em></p></td>
2609 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2612 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2613 <em>optional</em></p></td>
2614 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_cldsevent">CldsEvent</a></p></td>
2617 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2618 <em>optional</em></p></td>
2619 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2623 <em>optional</em></p></td>
2624 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2627 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2628 <em>optional</em></p></td>
2629 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2632 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>permittedActionCd</strong><br>
2633 <em>optional</em></p></td>
2634 <td class="tableblock halign-left valign-middle"><p class="tableblock">< string > array</p></td>
2637 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2638 <em>optional</em></p></td>
2639 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2642 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
2643 <em>optional</em></p></td>
2644 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2647 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateId</strong><br>
2648 <em>optional</em></p></td>
2649 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2653 <em>optional</em></p></td>
2654 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2657 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeId</strong><br>
2658 <em>optional</em></p></td>
2659 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2662 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>typeName</strong><br>
2663 <em>optional</em></p></td>
2664 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2670 <h3 id="_cldsmodelinstance"><a class="anchor" href="#_cldsmodelinstance"></a><a class="link" href="#_cldsmodelinstance">3.6. CldsModelInstance</a></h3>
2671 <table class="tableblock frame-all grid-all spread">
2673 <col style="width: 42.8571%;">
2674 <col style="width: 57.1429%;">
2678 <th class="tableblock halign-left valign-middle">Name</th>
2679 <th class="tableblock halign-left valign-middle">Schema</th>
2684 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>location</strong><br>
2685 <em>optional</em></p></td>
2686 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2689 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelInstanceId</strong><br>
2690 <em>optional</em></p></td>
2691 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2694 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>vmName</strong><br>
2695 <em>optional</em></p></td>
2696 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2702 <h3 id="_cldsmonitoringdetails"><a class="anchor" href="#_cldsmonitoringdetails"></a><a class="link" href="#_cldsmonitoringdetails">3.7. CldsMonitoringDetails</a></h3>
2703 <table class="tableblock frame-all grid-all spread">
2705 <col style="width: 42.8571%;">
2706 <col style="width: 57.1429%;">
2710 <th class="tableblock halign-left valign-middle">Name</th>
2711 <th class="tableblock halign-left valign-middle">Schema</th>
2716 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
2717 <em>optional</em></p></td>
2718 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>closeloopName</strong><br>
2722 <em>optional</em></p></td>
2723 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>deploymentId</strong><br>
2727 <em>optional</em></p></td>
2728 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2731 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelName</strong><br>
2732 <em>optional</em></p></td>
2733 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2736 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceTypeId</strong><br>
2737 <em>optional</em></p></td>
2738 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2741 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>templateName</strong><br>
2742 <em>optional</em></p></td>
2743 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2746 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>timestamp</strong><br>
2747 <em>optional</em></p></td>
2748 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2751 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userid</strong><br>
2752 <em>optional</em></p></td>
2753 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2759 <h3 id="_cldstemplate"><a class="anchor" href="#_cldstemplate"></a><a class="link" href="#_cldstemplate">3.8. CldsTemplate</a></h3>
2760 <table class="tableblock frame-all grid-all spread">
2762 <col style="width: 42.8571%;">
2763 <col style="width: 57.1429%;">
2767 <th class="tableblock halign-left valign-middle">Name</th>
2768 <th class="tableblock halign-left valign-middle">Schema</th>
2773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnId</strong><br>
2774 <em>optional</em></p></td>
2775 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2778 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnText</strong><br>
2779 <em>optional</em></p></td>
2780 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2783 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bpmnUserid</strong><br>
2784 <em>optional</em></p></td>
2785 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2788 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNamePrefix</strong><br>
2789 <em>optional</em></p></td>
2790 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2793 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlNameUuid</strong><br>
2794 <em>optional</em></p></td>
2795 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2798 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2799 <em>optional</em></p></td>
2800 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2803 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageId</strong><br>
2804 <em>optional</em></p></td>
2805 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageText</strong><br>
2809 <em>optional</em></p></td>
2810 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2813 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>imageUserid</strong><br>
2814 <em>optional</em></p></td>
2815 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2818 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2819 <em>optional</em></p></td>
2820 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2823 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propId</strong><br>
2824 <em>optional</em></p></td>
2825 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2828 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propText</strong><br>
2829 <em>optional</em></p></td>
2830 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2833 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>propUserid</strong><br>
2834 <em>optional</em></p></td>
2835 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2838 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userAuthorizedToUpdate</strong><br>
2839 <em>optional</em></p></td>
2840 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2846 <h3 id="_cldstoscamodel"><a class="anchor" href="#_cldstoscamodel"></a><a class="link" href="#_cldstoscamodel">3.9. CldsToscaModel</a></h3>
2847 <table class="tableblock frame-all grid-all spread">
2849 <col style="width: 42.8571%;">
2850 <col style="width: 57.1429%;">
2854 <th class="tableblock halign-left valign-middle">Name</th>
2855 <th class="tableblock halign-left valign-middle">Schema</th>
2860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>createdDate</strong><br>
2861 <em>optional</em></p></td>
2862 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2866 <em>optional</em></p></td>
2867 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2870 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lastUpdatedDate</strong><br>
2871 <em>optional</em></p></td>
2872 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2875 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>policyType</strong><br>
2876 <em>optional</em></p></td>
2877 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2880 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>revisionId</strong><br>
2881 <em>optional</em></p></td>
2882 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2885 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelJson</strong><br>
2886 <em>optional</em></p></td>
2887 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2890 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelName</strong><br>
2891 <em>optional</em></p></td>
2892 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2895 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelYaml</strong><br>
2896 <em>optional</em></p></td>
2897 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2900 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userId</strong><br>
2901 <em>optional</em></p></td>
2902 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2905 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
2906 <em>optional</em></p></td>
2907 <td class="tableblock halign-left valign-middle"><p class="tableblock">number (double)</p></td>
2913 <h3 id="_dcaeevent"><a class="anchor" href="#_dcaeevent"></a><a class="link" href="#_dcaeevent">3.10. DcaeEvent</a></h3>
2914 <table class="tableblock frame-all grid-all spread">
2916 <col style="width: 42.8571%;">
2917 <col style="width: 57.1429%;">
2921 <th class="tableblock halign-left valign-middle">Name</th>
2922 <th class="tableblock halign-left valign-middle">Schema</th>
2927 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactName</strong><br>
2928 <em>optional</em></p></td>
2929 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2932 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>cldsActionCd</strong><br>
2933 <em>optional</em></p></td>
2934 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2937 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>controlName</strong><br>
2938 <em>optional</em></p></td>
2939 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2943 <em>optional</em></p></td>
2944 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2947 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>instances</strong><br>
2948 <em>optional</em></p></td>
2949 <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_cldsmodelinstance">CldsModelInstance</a> > array</p></td>
2952 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceUUID</strong><br>
2953 <em>optional</em></p></td>
2954 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2957 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceUUID</strong><br>
2958 <em>optional</em></p></td>
2959 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2965 <h3 id="_valueitem"><a class="anchor" href="#_valueitem"></a><a class="link" href="#_valueitem">3.11. ValueItem</a></h3>
2966 <table class="tableblock frame-all grid-all spread">
2968 <col style="width: 42.8571%;">
2969 <col style="width: 57.1429%;">
2973 <th class="tableblock halign-left valign-middle">Name</th>
2974 <th class="tableblock halign-left valign-middle">Schema</th>
2979 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
2980 <em>optional</em></p></td>
2981 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2990 <div id="footer-text">
2991 Last updated 2018-08-27 13:47:59 +02:00