docs/swagger/swagger.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta name="generator" content="Asciidoctor 0.1.4">
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <title>DistributionAndExternalAPIs</title>
   8 <style>
   9 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  10 article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; }
  11 audio, canvas, video { display: inline-block; }
  12 audio:not([controls]) { display: none; height: 0; }
  13 [hidden] { display: none; }
  14 html { background: #fff; color: #000; font-family: sans-serif; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%; }
  15 body { margin: 0; }
  16 a:focus { outline: thin dotted; }
  17 a:active, a:hover { outline: 0; }
  18 h1 { font-size: 2em; margin: 0.67em 0; }
  19 abbr[title] { border-bottom: 1px dotted; }
  20 b, strong { font-weight: bold; }
  21 dfn { font-style: italic; }
  22 hr { -moz-box-sizing: content-box; box-sizing: content-box; height: 0; }
  23 mark { background: #ff0; color: #000; }
  24 code, kbd, pre, samp { font-family: monospace, serif; font-size: 1em; }
  25 pre { white-space: pre-wrap; }
  26 q { quotes: "\201C" "\201D" "\2018" "\2019"; }
  27 small { font-size: 80%; }
  28 sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
  29 sup { top: -0.5em; }
  30 sub { bottom: -0.25em; }
  31 img { border: 0; }
  32 svg:not(:root) { overflow: hidden; }
  33 figure { margin: 0; }
  34 fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; }
  35 legend { border: 0; padding: 0; }
  36 button, input, select, textarea { font-family: inherit; font-size: 100%; margin: 0; }
  37 button, input { line-height: normal; }
  38 button, select { text-transform: none; }
  39 button, html input[type="button"], input[type="reset"], input[type="submit"] { -webkit-appearance: button; cursor: pointer; }
  40 button[disabled], html input[disabled] { cursor: default; }
  41 input[type="checkbox"], input[type="radio"] { box-sizing: border-box; padding: 0; }
  42 input[type="search"] { -webkit-appearance: textfield; -moz-box-sizing: content-box; -webkit-box-sizing: content-box; box-sizing: content-box; }
  43 input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; }
  44 button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; }
  45 textarea { overflow: auto; vertical-align: top; }
  46 table { border-collapse: collapse; border-spacing: 0; }
  47 *, *:before, *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }
  48 html, body { font-size: 100%; }
  49 body { background: white; color: #222222; padding: 0; margin: 0; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; line-height: 1; position: relative; cursor: auto; }
  50 a:hover { cursor: pointer; }
  51 a:focus { outline: none; }
  52 img, object, embed { max-width: 100%; height: auto; }
  53 object, embed { height: 100%; }
  54 img { -ms-interpolation-mode: bicubic; }
  55 #map_canvas img, #map_canvas embed, #map_canvas object, .map_canvas img, .map_canvas embed, .map_canvas object { max-width: none !important; }
  56 .left { float: left !important; }
  57 .right { float: right !important; }
  58 .text-left { text-align: left !important; }
  59 .text-right { text-align: right !important; }
  60 .text-center { text-align: center !important; }
  61 .text-justify { text-align: justify !important; }
  62 .hide { display: none; }
  63 .antialiased, body { -webkit-font-smoothing: antialiased; }
  64 img { display: inline-block; vertical-align: middle; }
  65 textarea { height: auto; min-height: 50px; }
  66 select { width: 100%; }
  67 p.lead, .paragraph.lead > p, #preamble > .sectionbody > .paragraph:first-of-type p { font-size: 1.21875em; line-height: 1.6; }
  68 .subheader, #content #toctitle, .admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title, .tableblock > caption { line-height: 1.4; color: #7a2518; font-weight: 300; margin-top: 0.2em; margin-bottom: 0.5em; }
  69 div, dl, dt, dd, ul, ol, li, h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6, pre, form, p, blockquote, th, td { margin: 0; padding: 0; direction: ltr; }
  70 a { color: #005498; text-decoration: underline; line-height: inherit; }
  71 a:hover, a:focus { color: #00467f; }
  72 a img { border: none; }
  73 p { font-family: inherit; font-weight: normal; font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; text-rendering: optimizeLegibility; }
  74 p aside { font-size: 0.875em; line-height: 1.35; font-style: italic; }
  75 h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { font-family: Georgia, "URW Bookman L", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; color: #ba3925; text-rendering: optimizeLegibility; margin-top: 1em; margin-bottom: 0.5em; line-height: 1.2125em; }
  76 h1 small, h2 small, h3 small, #toctitle small, .sidebarblock > .content > .title small, h4 small, h5 small, h6 small { font-size: 60%; color: #e99b8f; line-height: 0; }
  77 h1 { font-size: 2.125em; }
  78 h2 { font-size: 1.6875em; }
  79 h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.375em; }
  80 h4 { font-size: 1.125em; }
  81 h5 { font-size: 1.125em; }
  82 h6 { font-size: 1em; }
  83 hr { border: solid #dddddd; border-width: 1px 0 0; clear: both; margin: 1.25em 0 1.1875em; height: 0; }
  84 em, i { font-style: italic; line-height: inherit; }
  85 strong, b { font-weight: bold; line-height: inherit; }
  86 small { font-size: 60%; line-height: inherit; }
  87 code { font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; color: #6d180b; }
  88 ul, ol, dl { font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; list-style-position: outside; font-family: inherit; }
  89 ul, ol { margin-left: 1.5em; }
  90 ul li ul, ul li ol { margin-left: 1.25em; margin-bottom: 0; font-size: 1em; }
  91 ul.square li ul, ul.circle li ul, ul.disc li ul { list-style: inherit; }
  92 ul.square { list-style-type: square; }
  93 ul.circle { list-style-type: circle; }
  94 ul.disc { list-style-type: disc; }
  95 ul.no-bullet { list-style: none; }
  96 ol li ul, ol li ol { margin-left: 1.25em; margin-bottom: 0; }
  97 dl dt { margin-bottom: 0.3125em; font-weight: bold; }
  98 dl dd { margin-bottom: 1.25em; }
  99 abbr, acronym { text-transform: uppercase; font-size: 90%; color: #222222; border-bottom: 1px dotted #dddddd; cursor: help; }
 100 abbr { text-transform: none; }
 101 blockquote { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; }
 102 blockquote cite { display: block; font-size: inherit; color: #555555; }
 103 blockquote cite:before { content: "\2014 \0020"; }
 104 blockquote cite a, blockquote cite a:visited { color: #555555; }
 105 blockquote, blockquote p { line-height: 1.6; color: #6f6f6f; }
 106 .vcard { display: inline-block; margin: 0 0 1.25em 0; border: 1px solid #dddddd; padding: 0.625em 0.75em; }
 107 .vcard li { margin: 0; display: block; }
 108 .vcard .fn { font-weight: bold; font-size: 0.9375em; }
 109 .vevent .summary { font-weight: bold; }
 110 .vevent abbr { cursor: auto; text-decoration: none; font-weight: bold; border: none; padding: 0 0.0625em; }
 111 @media only screen and (min-width: 768px) { h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { line-height: 1.4; }
 112   h1 { font-size: 2.75em; }
 113   h2 { font-size: 2.3125em; }
 114   h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.6875em; }
 115   h4 { font-size: 1.4375em; } }
 116 .print-only { display: none !important; }
 117 @media print { * { background: transparent !important; color: #000 !important; box-shadow: none !important; text-shadow: none !important; }
 118   a, a:visited { text-decoration: underline; }
 119   a[href]:after { content: " (" attr(href) ")"; }
 120   abbr[title]:after { content: " (" attr(title) ")"; }
 121   .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; }
 122   pre, blockquote { border: 1px solid #999; page-break-inside: avoid; }
 123   thead { display: table-header-group; }
 124   tr, img { page-break-inside: avoid; }
 125   img { max-width: 100% !important; }
 126   @page { margin: 0.5cm; }
 127   p, h2, h3, #toctitle, .sidebarblock > .content > .title { orphans: 3; widows: 3; }
 128   h2, h3, #toctitle, .sidebarblock > .content > .title { page-break-after: avoid; }
 129   .hide-on-print { display: none !important; }
 130   .print-only { display: block !important; }
 131   .hide-for-print { display: none !important; }
 132   .show-for-print { display: inherit !important; } }
 133 table { background: white; margin-bottom: 1.25em; border: solid 1px #dddddd; }
 134 table thead, table tfoot { background: whitesmoke; font-weight: bold; }
 135 table thead tr th, table thead tr td, table tfoot tr th, table tfoot tr td { padding: 0.5em 0.625em 0.625em; font-size: inherit; color: #222222; text-align: left; }
 136 table tr th, table tr td { padding: 0.5625em 0.625em; font-size: inherit; color: #222222; }
 137 table tr.even, table tr.alt, table tr:nth-of-type(even) { background: #f9f9f9; }
 138 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; }
 139 .clearfix:before, .clearfix:after, .float-group:before, .float-group:after { content: " "; display: table; }
 140 .clearfix:after, .float-group:after { clear: both; }
 141 *:not(pre) > code { font-size: 0.9375em; padding: 1px 3px 0; white-space: nowrap; background-color: #f2f2f2; border: 1px solid #cccccc; -webkit-border-radius: 4px; border-radius: 4px; text-shadow: none; }
 142 pre, pre > code { line-height: 1.4; color: inherit; font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; }
 143 kbd.keyseq { color: #555555; }
 144 kbd:not(.keyseq) { display: inline-block; color: #222222; font-size: 0.75em; line-height: 1.4; background-color: #F7F7F7; border: 1px solid #ccc; -webkit-border-radius: 3px; border-radius: 3px; -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; margin: -0.15em 0.15em 0 0.15em; padding: 0.2em 0.6em 0.2em 0.5em; vertical-align: middle; white-space: nowrap; }
 145 kbd kbd:first-child { margin-left: 0; }
 146 kbd kbd:last-child { margin-right: 0; }
 147 .menuseq, .menu { color: #090909; }
 148 p a > code:hover { color: #561309; }
 149 #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: 0.9375em; padding-right: 0.9375em; }
 150 #header:before, #header:after, #content:before, #content:after, #footnotes:before, #footnotes:after, #footer:before, #footer:after { content: " "; display: table; }
 151 #header:after, #content:after, #footnotes:after, #footer:after { clear: both; }
 152 #header { margin-bottom: 2.5em; }
 153 #header > h1 { color: black; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; }
 154 #header span { color: #6f6f6f; }
 155 #header #revnumber { text-transform: capitalize; }
 156 #header br { display: none; }
 157 #header br + span { padding-left: 3px; }
 158 #header br + span:before { content: "\2013 \0020"; }
 159 #header br + span.author { padding-left: 0; }
 160 #header br + span.author:before { content: ", "; }
 161 #toc { border-bottom: 3px double #ebebeb; padding-bottom: 1.25em; }
 162 #toc > ul { margin-left: 0.25em; }
 163 #toc ul.sectlevel0 > li > a { font-style: italic; }
 164 #toc ul.sectlevel0 ul.sectlevel1 { margin-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; }
 165 #toc ul { list-style-type: none; }
 166 #toctitle { color: #7a2518; }
 167 @media only screen and (min-width: 1280px) { body.toc2 { padding-left: 20em; }
 168   #toc.toc2 { position: fixed; width: 20em; left: 0; top: 0; border-right: 1px solid #ebebeb; border-bottom: 0; z-index: 1000; padding: 1em; height: 100%; overflow: auto; }
 169   #toc.toc2 #toctitle { margin-top: 0; }
 170   #toc.toc2 > ul { font-size: .95em; }
 171   #toc.toc2 ul ul { margin-left: 0; padding-left: 1.25em; }
 172   #toc.toc2 ul.sectlevel0 ul.sectlevel1 { padding-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; }
 173   body.toc2.toc-right { padding-left: 0; padding-right: 20em; }
 174   body.toc2.toc-right #toc.toc2 { border-right: 0; border-left: 1px solid #ebebeb; left: auto; right: 0; } }
 175 #content #toc { border-style: solid; border-width: 1px; border-color: #d9d9d9; margin-bottom: 1.25em; padding: 1.25em; background: #f2f2f2; border-width: 0; -webkit-border-radius: 4px; border-radius: 4px; }
 176 #content #toc > :first-child { margin-top: 0; }
 177 #content #toc > :last-child { margin-bottom: 0; }
 178 #content #toc a { text-decoration: none; }
 179 #content #toctitle { font-weight: bold; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-size: 1em; padding-left: 0.125em; }
 180 #footer { max-width: 100%; background-color: #222222; padding: 1.25em; }
 181 #footer-text { color: #dddddd; line-height: 1.44; }
 182 .sect1 { padding-bottom: 1.25em; }
 183 .sect1 + .sect1 { border-top: 3px double #ebebeb; }
 184 #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; width: 1em; margin-left: -1em; display: block; text-decoration: none; visibility: hidden; text-align: center; font-weight: normal; }
 185 #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; vertical-align: text-top; display: block; margin-top: 0.05em; }
 186 #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; }
 187 #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; }
 188 #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; }
 189 .imageblock, .literalblock, .listingblock, .verseblock, .videoblock { margin-bottom: 1.25em; }
 190 .admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { text-align: left; font-weight: bold; }
 191 .tableblock > caption { text-align: left; font-weight: bold; white-space: nowrap; overflow: visible; max-width: 0; }
 192 table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; }
 193 .admonitionblock > table { border: 0; background: none; width: 100%; }
 194 .admonitionblock > table td.icon { text-align: center; width: 80px; }
 195 .admonitionblock > table td.icon img { max-width: none; }
 196 .admonitionblock > table td.icon .title { font-weight: bold; text-transform: uppercase; }
 197 .admonitionblock > table td.content { padding-left: 1.125em; padding-right: 1.25em; border-left: 1px solid #dddddd; color: #6f6f6f; }
 198 .admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; }
 199 .exampleblock > .content { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.25em; padding: 1.25em; background: white; -webkit-border-radius: 4px; border-radius: 4px; }
 200 .exampleblock > .content > :first-child { margin-top: 0; }
 201 .exampleblock > .content > :last-child { margin-bottom: 0; }
 202 .exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6, .exampleblock > .content p { color: #333333; }
 203 .exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6 { line-height: 1; margin-bottom: 0.625em; }
 204 .exampleblock > .content h1.subheader, .exampleblock > .content h2.subheader, .exampleblock > .content h3.subheader, .exampleblock > .content .subheader#toctitle, .sidebarblock.exampleblock > .content > .subheader.title, .exampleblock > .content h4.subheader, .exampleblock > .content h5.subheader, .exampleblock > .content h6.subheader { line-height: 1.4; }
 205 .exampleblock.result > .content { -webkit-box-shadow: 0 1px 8px #d9d9d9; box-shadow: 0 1px 8px #d9d9d9; }
 206 .sidebarblock { border-style: solid; border-width: 1px; border-color: #d9d9d9; margin-bottom: 1.25em; padding: 1.25em; background: #f2f2f2; -webkit-border-radius: 4px; border-radius: 4px; }
 207 .sidebarblock > :first-child { margin-top: 0; }
 208 .sidebarblock > :last-child { margin-bottom: 0; }
 209 .sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6, .sidebarblock p { color: #333333; }
 210 .sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6 { line-height: 1; margin-bottom: 0.625em; }
 211 .sidebarblock h1.subheader, .sidebarblock h2.subheader, .sidebarblock h3.subheader, .sidebarblock .subheader#toctitle, .sidebarblock > .content > .subheader.title, .sidebarblock h4.subheader, .sidebarblock h5.subheader, .sidebarblock h6.subheader { line-height: 1.4; }
 212 .sidebarblock > .content > .title { color: #7a2518; margin-top: 0; line-height: 1.6; }
 213 .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; }
 214 .literalblock > .content pre, .listingblock > .content pre { background: none; border-width: 1px 0; border-style: dotted; border-color: #bfbfbf; -webkit-border-radius: 4px; border-radius: 4px; padding: 0.75em 0.75em 0.5em 0.75em; word-wrap: break-word; }
 215 .literalblock > .content pre.nowrap, .listingblock > .content pre.nowrap { overflow-x: auto; white-space: pre; word-wrap: normal; }
 216 .literalblock > .content pre > code, .listingblock > .content pre > code { display: block; }
 217 @media only screen { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.8em; } }
 218 @media only screen and (min-width: 768px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.9em; } }
 219 @media only screen and (min-width: 1280px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 1em; } }
 220 .listingblock > .content { position: relative; }
 221 .listingblock:hover code[class*=" language-"]:before { text-transform: uppercase; font-size: 0.9em; color: #999; position: absolute; top: 0.375em; right: 0.375em; }
 222 .listingblock:hover code.asciidoc:before { content: "asciidoc"; }
 223 .listingblock:hover code.clojure:before { content: "clojure"; }
 224 .listingblock:hover code.css:before { content: "css"; }
 225 .listingblock:hover code.groovy:before { content: "groovy"; }
 226 .listingblock:hover code.html:before { content: "html"; }
 227 .listingblock:hover code.java:before { content: "java"; }
 228 .listingblock:hover code.javascript:before { content: "javascript"; }
 229 .listingblock:hover code.python:before { content: "python"; }
 230 .listingblock:hover code.ruby:before { content: "ruby"; }
 231 .listingblock:hover code.scss:before { content: "scss"; }
 232 .listingblock:hover code.xml:before { content: "xml"; }
 233 .listingblock:hover code.yaml:before { content: "yaml"; }
 234 .listingblock.terminal pre .command:before { content: attr(data-prompt); padding-right: 0.5em; color: #999; }
 235 .listingblock.terminal pre .command:not([data-prompt]):before { content: '$'; }
 236 table.pyhltable { border: 0; margin-bottom: 0; }
 237 table.pyhltable td { vertical-align: top; padding-top: 0; padding-bottom: 0; }
 238 table.pyhltable td.code { padding-left: .75em; padding-right: 0; }
 239 .highlight.pygments .lineno, table.pyhltable td:not(.code) { color: #999; padding-left: 0; padding-right: .5em; border-right: 1px solid #dddddd; }
 240 .highlight.pygments .lineno { display: inline-block; margin-right: .25em; }
 241 table.pyhltable .linenodiv { background-color: transparent !important; padding-right: 0 !important; }
 242 .quoteblock { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; }
 243 .quoteblock blockquote { margin: 0 0 1.25em 0; padding: 0 0 0.5625em 0; border: 0; }
 244 .quoteblock blockquote > .paragraph:last-child p { margin-bottom: 0; }
 245 .quoteblock .attribution { margin-top: -.25em; padding-bottom: 0.5625em; font-size: inherit; color: #555555; }
 246 .quoteblock .attribution br { display: none; }
 247 .quoteblock .attribution cite { display: block; margin-bottom: 0.625em; }
 248 table thead th, table tfoot th { font-weight: bold; }
 249 table.tableblock.grid-all { border-collapse: separate; border-spacing: 1px; -webkit-border-radius: 4px; border-radius: 4px; border-top: 1px solid #dddddd; border-bottom: 1px solid #dddddd; }
 250 table.tableblock.frame-topbot, table.tableblock.frame-none { border-left: 0; border-right: 0; }
 251 table.tableblock.frame-sides, table.tableblock.frame-none { border-top: 0; border-bottom: 0; }
 252 table.tableblock td .paragraph:last-child p, table.tableblock td > p:last-child { margin-bottom: 0; }
 253 th.tableblock.halign-left, td.tableblock.halign-left { text-align: left; }
 254 th.tableblock.halign-right, td.tableblock.halign-right { text-align: right; }
 255 th.tableblock.halign-center, td.tableblock.halign-center { text-align: center; }
 256 th.tableblock.valign-top, td.tableblock.valign-top { vertical-align: top; }
 257 th.tableblock.valign-bottom, td.tableblock.valign-bottom { vertical-align: bottom; }
 258 th.tableblock.valign-middle, td.tableblock.valign-middle { vertical-align: middle; }
 259 p.tableblock.header { color: #222222; font-weight: bold; }
 260 td > div.verse { white-space: pre; }
 261 ol { margin-left: 1.75em; }
 262 ul li ol { margin-left: 1.5em; }
 263 dl dd { margin-left: 1.125em; }
 264 dl dd:last-child, dl dd:last-child > :last-child { margin-bottom: 0; }
 265 ol > li p, ul > li p, ul dd, ol dd, .olist .olist, .ulist .ulist, .ulist .olist, .olist .ulist { margin-bottom: 0.625em; }
 266 ul.unstyled, ol.unnumbered, ul.checklist, ul.none { list-style-type: none; }
 267 ul.unstyled, ol.unnumbered, ul.checklist { margin-left: 0.625em; }
 268 ul.checklist li > p:first-child > i[class^="icon-check"]:first-child, ul.checklist li > p:first-child > input[type="checkbox"]:first-child { margin-right: 0.25em; }
 269 ul.checklist li > p:first-child > input[type="checkbox"]:first-child { position: relative; top: 1px; }
 270 ul.inline { margin: 0 auto 0.625em auto; margin-left: -1.375em; margin-right: 0; padding: 0; list-style: none; overflow: hidden; }
 271 ul.inline > li { list-style: none; float: left; margin-left: 1.375em; display: block; }
 272 ul.inline > li > * { display: block; }
 273 .unstyled dl dt { font-weight: normal; font-style: normal; }
 274 ol.arabic { list-style-type: decimal; }
 275 ol.decimal { list-style-type: decimal-leading-zero; }
 276 ol.loweralpha { list-style-type: lower-alpha; }
 277 ol.upperalpha { list-style-type: upper-alpha; }
 278 ol.lowerroman { list-style-type: lower-roman; }
 279 ol.upperroman { list-style-type: upper-roman; }
 280 ol.lowergreek { list-style-type: lower-greek; }
 281 .hdlist > table, .colist > table { border: 0; background: none; }
 282 .hdlist > table > tbody > tr, .colist > table > tbody > tr { background: none; }
 283 td.hdlist1 { padding-right: .8em; font-weight: bold; }
 284 td.hdlist1, td.hdlist2 { vertical-align: top; }
 285 .literalblock + .colist, .listingblock + .colist { margin-top: -0.5em; }
 286 .colist > table tr > td:first-of-type { padding: 0 .8em; line-height: 1; }
 287 .colist > table tr > td:last-of-type { padding: 0.25em 0; }
 288 .qanda > ol > li > p > em:only-child { color: #00467f; }
 289 .thumb, .th { line-height: 0; display: inline-block; border: solid 4px white; -webkit-box-shadow: 0 0 0 1px #dddddd; box-shadow: 0 0 0 1px #dddddd; }
 290 .imageblock.left, .imageblock[style*="float: left"] { margin: 0.25em 0.625em 1.25em 0; }
 291 .imageblock.right, .imageblock[style*="float: right"] { margin: 0.25em 0 1.25em 0.625em; }
 292 .imageblock > .title { margin-bottom: 0; }
 293 .imageblock.thumb, .imageblock.th { border-width: 6px; }
 294 .imageblock.thumb > .title, .imageblock.th > .title { padding: 0 0.125em; }
 295 .image.left, .image.right { margin-top: 0.25em; margin-bottom: 0.25em; display: inline-block; line-height: 0; }
 296 .image.left { margin-right: 0.625em; }
 297 .image.right { margin-left: 0.625em; }
 298 a.image { text-decoration: none; }
 299 span.footnote, span.footnoteref { vertical-align: super; font-size: 0.875em; }
 300 span.footnote a, span.footnoteref a { text-decoration: none; }
 301 #footnotes { padding-top: 0.75em; padding-bottom: 0.75em; margin-bottom: 0.625em; }
 302 #footnotes hr { width: 20%; min-width: 6.25em; margin: -.25em 0 .75em 0; border-width: 1px 0 0 0; }
 303 #footnotes .footnote { padding: 0 0.375em; line-height: 1.3; font-size: 0.875em; margin-left: 1.2em; text-indent: -1.2em; margin-bottom: .2em; }
 304 #footnotes .footnote a:first-of-type { font-weight: bold; text-decoration: none; }
 305 #footnotes .footnote:last-of-type { margin-bottom: 0; }
 306 #content #footnotes { margin-top: -0.625em; margin-bottom: 0; padding: 0.75em 0; }
 307 .gist .file-data > table { border: none; background: #fff; width: 100%; margin-bottom: 0; }
 308 .gist .file-data > table td.line-data { width: 99%; }
 309 div.unbreakable { page-break-inside: avoid; }
 310 .big { font-size: larger; }
 311 .small { font-size: smaller; }
 312 .underline { text-decoration: underline; }
 313 .overline { text-decoration: overline; }
 314 .line-through { text-decoration: line-through; }
 315 .aqua { color: #00bfbf; }
 316 .aqua-background { background-color: #00fafa; }
 317 .black { color: black; }
 318 .black-background { background-color: black; }
 319 .blue { color: #0000bf; }
 320 .blue-background { background-color: #0000fa; }
 321 .fuchsia { color: #bf00bf; }
 322 .fuchsia-background { background-color: #fa00fa; }
 323 .gray { color: #606060; }
 324 .gray-background { background-color: #7d7d7d; }
 325 .green { color: #006000; }
 326 .green-background { background-color: #007d00; }
 327 .lime { color: #00bf00; }
 328 .lime-background { background-color: #00fa00; }
 329 .maroon { color: #600000; }
 330 .maroon-background { background-color: #7d0000; }
 331 .navy { color: #000060; }
 332 .navy-background { background-color: #00007d; }
 333 .olive { color: #606000; }
 334 .olive-background { background-color: #7d7d00; }
 335 .purple { color: #600060; }
 336 .purple-background { background-color: #7d007d; }
 337 .red { color: #bf0000; }
 338 .red-background { background-color: #fa0000; }
 339 .silver { color: #909090; }
 340 .silver-background { background-color: #bcbcbc; }
 341 .teal { color: #006060; }
 342 .teal-background { background-color: #007d7d; }
 343 .white { color: #bfbfbf; }
 344 .white-background { background-color: #fafafa; }
 345 .yellow { color: #bfbf00; }
 346 .yellow-background { background-color: #fafa00; }
 347 span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
 348 .admonitionblock td.icon [class^="icon-"]:before { font-size: 2.5em; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5); cursor: default; }
 349 .admonitionblock td.icon .icon-note:before { content: "\f05a"; color: #005498; color: #003f72; }
 350 .admonitionblock td.icon .icon-tip:before { content: "\f0eb"; text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8); color: #111; }
 351 .admonitionblock td.icon .icon-warning:before { content: "\f071"; color: #bf6900; }
 352 .admonitionblock td.icon .icon-caution:before { content: "\f06d"; color: #bf3400; }
 353 .admonitionblock td.icon .icon-important:before { content: "\f06a"; color: #bf0000; }
 354 .conum { display: inline-block; color: white !important; background-color: #222222; -webkit-border-radius: 100px; border-radius: 100px; text-align: center; width: 20px; height: 20px; font-size: 12px; font-weight: bold; line-height: 20px; font-family: Arial, sans-serif; font-style: normal; position: relative; top: -2px; letter-spacing: -1px; }
 355 .conum * { color: white !important; }
 356 .conum + b { display: none; }
 357 .conum:after { content: attr(data-value); }
 358 .conum:not([data-value]):empty { display: none; }
 359 .literalblock > .content > pre, .listingblock > .content > pre { -webkit-border-radius: 0; border-radius: 0; }
 360
 361 </style>
 362 </head>
 363 <body class="book toc2 toc-left">
 364 <div id="header">
 365 <h1>DistributionAndExternalAPIs</h1>
 366 <div id="toc" class="toc2">
 367 <div id="toctitle">Table of Contents</div>
 368 <ul class="sectlevel1">
 369 <li><a href="#_overview">1. Overview</a></li>
 370 <li>
 371 <ul class="sectlevel2">
 372 <li><a href="#_version_information">1.1. Version information</a></li>
 373 <li><a href="#_uri_scheme">1.2. URI scheme</a></li>
 374 <li><a href="#_tags">1.3. Tags</a></li>
 375 </ul>
 376 </li>
 377 <li><a href="#_paths">2. Paths</a></li>
 378 <li>
 379 <ul class="sectlevel2">
 380 <li><a href="#_getvalidartifacttypes">2.1. Artifact types list</a></li>
 381 <li>
 382 <ul class="sectlevel3">
 383 <li><a href="#_description">2.1.1. Description</a></li>
 384 <li><a href="#_parameters">2.1.2. Parameters</a></li>
 385 <li><a href="#_responses">2.1.3. Responses</a></li>
 386 <li><a href="#_consumes">2.1.4. Consumes</a></li>
 387 <li><a href="#_produces">2.1.5. Produces</a></li>
 388 <li><a href="#_tags_2">2.1.6. Tags</a></li>
 389 </ul>
 390 </li>
 391 <li><a href="#_uploadinterfaceoperationartifact">2.2. uploads of artifact to VF operation workflow</a></li>
 392 <li>
 393 <ul class="sectlevel3">
 394 <li><a href="#_description_2">2.2.1. Description</a></li>
 395 <li><a href="#_parameters_2">2.2.2. Parameters</a></li>
 396 <li><a href="#_responses_2">2.2.3. Responses</a></li>
 397 <li><a href="#_produces_2">2.2.4. Produces</a></li>
 398 <li><a href="#_tags_3">2.2.5. Tags</a></li>
 399 </ul>
 400 </li>
 401 <li><a href="#_downloadserviceartifact">2.3. Download service artifact</a></li>
 402 <li>
 403 <ul class="sectlevel3">
 404 <li><a href="#_description_3">2.3.1. Description</a></li>
 405 <li><a href="#_parameters_3">2.3.2. Parameters</a></li>
 406 <li><a href="#_responses_3">2.3.3. Responses</a></li>
 407 <li><a href="#_consumes_2">2.3.4. Consumes</a></li>
 408 <li><a href="#_produces_3">2.3.5. Produces</a></li>
 409 <li><a href="#_tags_4">2.3.6. Tags</a></li>
 410 </ul>
 411 </li>
 412 <li><a href="#_downloadresourceinstanceartifactbyname">2.4. Download resource instance artifact</a></li>
 413 <li>
 414 <ul class="sectlevel3">
 415 <li><a href="#_description_4">2.4.1. Description</a></li>
 416 <li><a href="#_parameters_4">2.4.2. Parameters</a></li>
 417 <li><a href="#_responses_4">2.4.3. Responses</a></li>
 418 <li><a href="#_consumes_3">2.4.4. Consumes</a></li>
 419 <li><a href="#_produces_4">2.4.5. Produces</a></li>
 420 <li><a href="#_tags_5">2.4.6. Tags</a></li>
 421 </ul>
 422 </li>
 423 <li><a href="#_downloadresourceartifact">2.5. Download resource artifact</a></li>
 424 <li>
 425 <ul class="sectlevel3">
 426 <li><a href="#_description_5">2.5.1. Description</a></li>
 427 <li><a href="#_parameters_5">2.5.2. Parameters</a></li>
 428 <li><a href="#_responses_5">2.5.3. Responses</a></li>
 429 <li><a href="#_consumes_4">2.5.4. Consumes</a></li>
 430 <li><a href="#_produces_5">2.5.5. Produces</a></li>
 431 <li><a href="#_tags_6">2.5.6. Tags</a></li>
 432 </ul>
 433 </li>
 434 <li><a href="#_activateserviceexternal">2.6. activate a service</a></li>
 435 <li>
 436 <ul class="sectlevel3">
 437 <li><a href="#_description_6">2.6.1. Description</a></li>
 438 <li><a href="#_parameters_6">2.6.2. Parameters</a></li>
 439 <li><a href="#_responses_6">2.6.3. Responses</a></li>
 440 <li><a href="#_consumes_5">2.6.4. Consumes</a></li>
 441 <li><a href="#_produces_6">2.6.5. Produces</a></li>
 442 <li><a href="#_tags_7">2.6.6. Tags</a></li>
 443 </ul>
 444 </li>
 445 <li><a href="#_createresourceexternal">2.7. creates a resource</a></li>
 446 <li>
 447 <ul class="sectlevel3">
 448 <li><a href="#_description_7">2.7.1. Description</a></li>
 449 <li><a href="#_parameters_7">2.7.2. Parameters</a></li>
 450 <li><a href="#_responses_7">2.7.3. Responses</a></li>
 451 <li><a href="#_consumes_6">2.7.4. Consumes</a></li>
 452 <li><a href="#_produces_7">2.7.5. Produces</a></li>
 453 <li><a href="#_tags_8">2.7.6. Tags</a></li>
 454 </ul>
 455 </li>
 456 <li><a href="#_getassetlistexternal">2.8. Fetch list of assets</a></li>
 457 <li>
 458 <ul class="sectlevel3">
 459 <li><a href="#_description_8">2.8.1. Description</a></li>
 460 <li><a href="#_parameters_8">2.8.2. Parameters</a></li>
 461 <li><a href="#_responses_8">2.8.3. Responses</a></li>
 462 <li><a href="#_produces_8">2.8.4. Produces</a></li>
 463 <li><a href="#_tags_9">2.8.5. Tags</a></li>
 464 </ul>
 465 </li>
 466 <li><a href="#_uploadartifact">2.9. uploads of artifact to a resource or service</a></li>
 467 <li>
 468 <ul class="sectlevel3">
 469 <li><a href="#_description_9">2.9.1. Description</a></li>
 470 <li><a href="#_parameters_9">2.9.2. Parameters</a></li>
 471 <li><a href="#_responses_9">2.9.3. Responses</a></li>
 472 <li><a href="#_produces_9">2.9.4. Produces</a></li>
 473 <li><a href="#_tags_10">2.9.5. Tags</a></li>
 474 </ul>
 475 </li>
 476 <li><a href="#_updateartifact">2.10. updates an artifact on a resource or service</a></li>
 477 <li>
 478 <ul class="sectlevel3">
 479 <li><a href="#_description_10">2.10.1. Description</a></li>
 480 <li><a href="#_parameters_10">2.10.2. Parameters</a></li>
 481 <li><a href="#_responses_10">2.10.3. Responses</a></li>
 482 <li><a href="#_produces_10">2.10.4. Produces</a></li>
 483 <li><a href="#_tags_11">2.10.5. Tags</a></li>
 484 </ul>
 485 </li>
 486 <li><a href="#_downloadcomponentartifact">2.11. Download component artifact</a></li>
 487 <li>
 488 <ul class="sectlevel3">
 489 <li><a href="#_description_11">2.11.1. Description</a></li>
 490 <li><a href="#_parameters_11">2.11.2. Parameters</a></li>
 491 <li><a href="#_responses_11">2.11.3. Responses</a></li>
 492 <li><a href="#_produces_11">2.11.4. Produces</a></li>
 493 <li><a href="#_tags_12">2.11.5. Tags</a></li>
 494 </ul>
 495 </li>
 496 <li><a href="#_deleteartifact">2.12. deletes an artifact of a resource or service</a></li>
 497 <li>
 498 <ul class="sectlevel3">
 499 <li><a href="#_description_12">2.12.1. Description</a></li>
 500 <li><a href="#_parameters_12">2.12.2. Parameters</a></li>
 501 <li><a href="#_responses_12">2.12.3. Responses</a></li>
 502 <li><a href="#_produces_12">2.12.4. Produces</a></li>
 503 <li><a href="#_tags_13">2.12.5. Tags</a></li>
 504 </ul>
 505 </li>
 506 <li><a href="#_changeresourcestateexternal">2.13. Change Resource lifecycle State</a></li>
 507 <li>
 508 <ul class="sectlevel3">
 509 <li><a href="#_parameters_13">2.13.1. Parameters</a></li>
 510 <li><a href="#_responses_13">2.13.2. Responses</a></li>
 511 <li><a href="#_consumes_7">2.13.3. Consumes</a></li>
 512 <li><a href="#_produces_13">2.13.4. Produces</a></li>
 513 <li><a href="#_tags_14">2.13.5. Tags</a></li>
 514 </ul>
 515 </li>
 516 <li><a href="#_getassetspecificmetadatabyuuidexternal">2.14. Detailed metadata of asset by uuid</a></li>
 517 <li>
 518 <ul class="sectlevel3">
 519 <li><a href="#_description_13">2.14.1. Description</a></li>
 520 <li><a href="#_parameters_14">2.14.2. Parameters</a></li>
 521 <li><a href="#_responses_14">2.14.3. Responses</a></li>
 522 <li><a href="#_produces_14">2.14.4. Produces</a></li>
 523 <li><a href="#_tags_15">2.14.5. Tags</a></li>
 524 </ul>
 525 </li>
 526 <li><a href="#_uploadartifacttoinstance">2.15. uploads an artifact to a resource instance</a></li>
 527 <li>
 528 <ul class="sectlevel3">
 529 <li><a href="#_description_14">2.15.1. Description</a></li>
 530 <li><a href="#_parameters_15">2.15.2. Parameters</a></li>
 531 <li><a href="#_responses_15">2.15.3. Responses</a></li>
 532 <li><a href="#_produces_15">2.15.4. Produces</a></li>
 533 <li><a href="#_tags_16">2.15.5. Tags</a></li>
 534 </ul>
 535 </li>
 536 <li><a href="#_updateartifactonresourceinstance">2.16. updates an artifact on a resource instance</a></li>
 537 <li>
 538 <ul class="sectlevel3">
 539 <li><a href="#_description_15">2.16.1. Description</a></li>
 540 <li><a href="#_parameters_16">2.16.2. Parameters</a></li>
 541 <li><a href="#_responses_16">2.16.3. Responses</a></li>
 542 <li><a href="#_produces_16">2.16.4. Produces</a></li>
 543 <li><a href="#_tags_17">2.16.5. Tags</a></li>
 544 </ul>
 545 </li>
 546 <li><a href="#_downloadresourceinstanceartifact">2.17. Download resource instance artifact</a></li>
 547 <li>
 548 <ul class="sectlevel3">
 549 <li><a href="#_description_16">2.17.1. Description</a></li>
 550 <li><a href="#_parameters_17">2.17.2. Parameters</a></li>
 551 <li><a href="#_responses_17">2.17.3. Responses</a></li>
 552 <li><a href="#_produces_17">2.17.4. Produces</a></li>
 553 <li><a href="#_tags_18">2.17.5. Tags</a></li>
 554 </ul>
 555 </li>
 556 <li><a href="#_deleteartifactonresourceinstance">2.18. deletes an artifact of a resource insatnce</a></li>
 557 <li>
 558 <ul class="sectlevel3">
 559 <li><a href="#_description_17">2.18.1. Description</a></li>
 560 <li><a href="#_parameters_18">2.18.2. Parameters</a></li>
 561 <li><a href="#_responses_18">2.18.3. Responses</a></li>
 562 <li><a href="#_produces_18">2.18.4. Produces</a></li>
 563 <li><a href="#_tags_19">2.18.5. Tags</a></li>
 564 </ul>
 565 </li>
 566 <li><a href="#_gettoscamodelexternal">2.19. Fetch assets CSAR</a></li>
 567 <li>
 568 <ul class="sectlevel3">
 569 <li><a href="#_description_18">2.19.1. Description</a></li>
 570 <li><a href="#_parameters_19">2.19.2. Parameters</a></li>
 571 <li><a href="#_responses_19">2.19.3. Responses</a></li>
 572 <li><a href="#_produces_19">2.19.4. Produces</a></li>
 573 <li><a href="#_tags_20">2.19.5. Tags</a></li>
 574 </ul>
 575 </li>
 576 <li><a href="#_getuebserverlist">2.20. UEB Server List</a></li>
 577 <li>
 578 <ul class="sectlevel3">
 579 <li><a href="#_description_19">2.20.1. Description</a></li>
 580 <li><a href="#_parameters_20">2.20.2. Parameters</a></li>
 581 <li><a href="#_responses_20">2.20.3. Responses</a></li>
 582 <li><a href="#_consumes_8">2.20.4. Consumes</a></li>
 583 <li><a href="#_produces_20">2.20.5. Produces</a></li>
 584 <li><a href="#_tags_21">2.20.6. Tags</a></li>
 585 </ul>
 586 </li>
 587 <li><a href="#_registerfordistribution">2.21. Subscription status</a></li>
 588 <li>
 589 <ul class="sectlevel3">
 590 <li><a href="#_description_20">2.21.1. Description</a></li>
 591 <li><a href="#_parameters_21">2.21.2. Parameters</a></li>
 592 <li><a href="#_responses_21">2.21.3. Responses</a></li>
 593 <li><a href="#_consumes_9">2.21.4. Consumes</a></li>
 594 <li><a href="#_produces_21">2.21.5. Produces</a></li>
 595 <li><a href="#_tags_22">2.21.6. Tags</a></li>
 596 </ul>
 597 </li>
 598 <li><a href="#_unregisterfordistribution">2.22. Subscription status</a></li>
 599 <li>
 600 <ul class="sectlevel3">
 601 <li><a href="#_description_21">2.22.1. Description</a></li>
 602 <li><a href="#_parameters_22">2.22.2. Parameters</a></li>
 603 <li><a href="#_responses_22">2.22.3. Responses</a></li>
 604 <li><a href="#_consumes_10">2.22.4. Consumes</a></li>
 605 <li><a href="#_produces_22">2.22.5. Produces</a></li>
 606 <li><a href="#_tags_23">2.22.6. Tags</a></li>
 607 </ul>
 608 </li>
 609 </ul>
 610 </li>
 611 <li><a href="#_definitions">3. Definitions</a></li>
 612 <li>
 613 <ul class="sectlevel2">
 614 <li><a href="#_additionalinfoparameterinfo">3.1. AdditionalInfoParameterInfo</a></li>
 615 <li><a href="#_additionalinformationdefinition">3.2. AdditionalInformationDefinition</a></li>
 616 <li><a href="#_artifactdatadefinition">3.3. ArtifactDataDefinition</a></li>
 617 <li><a href="#_artifactdefinition">3.4. ArtifactDefinition</a></li>
 618 <li><a href="#_assetmetadata">3.5. AssetMetadata</a></li>
 619 <li><a href="#_capabilitydatadefinition">3.6. CapabilityDataDefinition</a></li>
 620 <li><a href="#_capabilitydefinition">3.7. CapabilityDefinition</a></li>
 621 <li><a href="#_capabilityrequirementrelationship">3.8. CapabilityRequirementRelationship</a></li>
 622 <li><a href="#_categorydefinition">3.9. CategoryDefinition</a></li>
 623 <li><a href="#_componentinstance">3.10. ComponentInstance</a></li>
 624 <li><a href="#_componentinstanceinput">3.11. ComponentInstanceInput</a></li>
 625 <li><a href="#_componentinstanceproperty">3.12. ComponentInstanceProperty</a></li>
 626 <li><a href="#_getinputvaluedatadefinition">3.13. GetInputValueDataDefinition</a></li>
 627 <li><a href="#_groupdefinition">3.14. GroupDefinition</a></li>
 628 <li><a href="#_groupinstance">3.15. GroupInstance</a></li>
 629 <li><a href="#_groupingdefinition">3.16. GroupingDefinition</a></li>
 630 <li><a href="#_heatparameterdatadefinition">3.17. HeatParameterDataDefinition</a></li>
 631 <li><a href="#_heatparameterdefinition">3.18. HeatParameterDefinition</a></li>
 632 <li><a href="#_inputdefinition">3.19. InputDefinition</a></li>
 633 <li><a href="#_interfacedefinition">3.20. InterfaceDefinition</a></li>
 634 <li><a href="#_interfaceoperationdatadefinition">3.21. InterfaceOperationDataDefinition</a></li>
 635 <li><a href="#_interfaceoperationparamdatadefinition">3.22. InterfaceOperationParamDataDefinition</a></li>
 636 <li><a href="#_lifecyclechangeinfowithaction">3.23. LifecycleChangeInfoWithAction</a></li>
 637 <li><a href="#_listdatadefinition">3.24. ListDataDefinition</a></li>
 638 <li><a href="#_listdatadefinitioninterfaceoperationparamdatadefinition">3.25. ListDataDefinitionInterfaceOperationParamDataDefinition</a></li>
 639 <li><a href="#_listdatadefinitionoperationinputdefinition">3.26. ListDataDefinitionOperationInputDefinition</a></li>
 640 <li><a href="#_operationdatadefinition">3.27. OperationDataDefinition</a></li>
 641 <li><a href="#_operationinputdefinition">3.28. OperationInputDefinition</a></li>
 642 <li><a href="#_policydefinition">3.29. PolicyDefinition</a></li>
 643 <li><a href="#_propertyconstraint">3.30. PropertyConstraint</a></li>
 644 <li><a href="#_propertydatadefinition">3.31. PropertyDataDefinition</a></li>
 645 <li><a href="#_propertydefinition">3.32. PropertyDefinition</a></li>
 646 <li><a href="#_propertyrule">3.33. PropertyRule</a></li>
 647 <li><a href="#_registrationrequest">3.34. RegistrationRequest</a></li>
 648 <li><a href="#_relationshipimpl">3.35. RelationshipImpl</a></li>
 649 <li><a href="#_relationshipinfo">3.36. RelationshipInfo</a></li>
 650 <li><a href="#_requirementcapabilityreldef">3.37. RequirementCapabilityRelDef</a></li>
 651 <li><a href="#_requirementdatadefinition">3.38. RequirementDataDefinition</a></li>
 652 <li><a href="#_requirementdefinition">3.39. RequirementDefinition</a></li>
 653 <li><a href="#_resource">3.40. Resource</a></li>
 654 <li><a href="#_schemadefinition">3.41. SchemaDefinition</a></li>
 655 <li><a href="#_serverlistresponse">3.42. ServerListResponse</a></li>
 656 <li><a href="#_subcategorydefinition">3.43. SubCategoryDefinition</a></li>
 657 <li><a href="#_topicregistrationresponse">3.44. TopicRegistrationResponse</a></li>
 658 <li><a href="#_topicunregistrationresponse">3.45. TopicUnregistrationResponse</a></li>
 659 <li><a href="#_toscadatadefinition">3.46. ToscaDataDefinition</a></li>
 660 </ul>
 661 </li>
 662 </ul>
 663 </div>
 664 </div>
 665 <div id="content">
 666 <div class="sect1">
 667 <h2 id="_overview"><a class="anchor" href="#_overview"></a>1. Overview</h2>
 668 <div class="sectionbody">
 669 <div class="sect2">
 670 <h3 id="_version_information"><a class="anchor" href="#_version_information"></a>1.1. Version information</h3>
 671 <div class="paragraph">
 672 <p><em>Version</em> : 1.2.0</p>
 673 </div>
 674 </div>
 675 <div class="sect2">
 676 <h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a>1.2. URI scheme</h3>
 677 <div class="paragraph">
 678 <p><em>BasePath</em> : /sdc</p>
 679 </div>
 680 </div>
 681 <div class="sect2">
 682 <h3 id="_tags"><a class="anchor" href="#_tags"></a>1.3. Tags</h3>
 683 <div class="ulist">
 684 <ul>
 685 <li>
 686 <p>Artifact External Servlet</p>
 687 </li>
 688 <li>
 689 <p>Asset Metadata External Servlet</p>
 690 </li>
 691 <li>
 692 <p>CRUD External Servlet</p>
 693 </li>
 694 <li>
 695 <p>Distribution Catalog Servlet</p>
 696 </li>
 697 <li>
 698 <p>Distribution Servlet</p>
 699 </li>
 700 <li>
 701 <p>Service Activation External Servlet</p>
 702 </li>
 703 </ul>
 704 </div>
 705 </div>
 706 </div>
 707 </div>
 708 <div class="sect1">
 709 <h2 id="_paths"><a class="anchor" href="#_paths"></a>2. Paths</h2>
 710 <div class="sectionbody">
 711 <div class="sect2">
 712 <h3 id="_getvalidartifacttypes"><a class="anchor" href="#_getvalidartifacttypes"></a>2.1. Artifact types list</h3>
 713 <div class="literalblock">
 714 <div class="content">
 715 <pre>GET /v1/artifactTypes</pre>
 716 </div>
 717 </div>
 718 <div class="sect3">
 719 <h4 id="_description"><a class="anchor" href="#_description"></a>2.1.1. Description</h4>
 720 <div class="paragraph">
 721 <p>Fetches available artifact types list</p>
 722 </div>
 723 </div>
 724 <div class="sect3">
 725 <h4 id="_parameters"><a class="anchor" href="#_parameters"></a>2.1.2. Parameters</h4>
 726 <table class="tableblock frame-all grid-all" style="width:100%; ">
 727 <colgroup>
 728 <col style="width:11%;">
 729 <col style="width:16%;">
 730 <col style="width:50%;">
 731 <col style="width:22%;">
 732 </colgroup>
 733 <thead>
 734 <tr>
 735 <th class="tableblock halign-left valign-middle">Type</th>
 736 <th class="tableblock halign-left valign-middle">Name</th>
 737 <th class="tableblock halign-left valign-middle">Description</th>
 738 <th class="tableblock halign-left valign-middle">Schema</th>
 739 </tr>
 740 </thead>
 741 <tbody>
 742 <tr>
 743 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 744 <p><strong>Header</strong></p>
 745 </div></div></td>
 746 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 747 <p><strong>Accept</strong><br>
 748 <em>required</em></p>
 749 </div></div></td>
 750 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 751 <p>The username and password</p>
 752 </div></div></td>
 753 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 754 <p>string</p>
 755 </div></div></td>
 756 </tr>
 757 <tr>
 758 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 759 <p><strong>Header</strong></p>
 760 </div></div></td>
 761 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 762 <p><strong>Authorization</strong><br>
 763 <em>required</em></p>
 764 </div></div></td>
 765 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 766 <p>The username and password</p>
 767 </div></div></td>
 768 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 769 <p>string</p>
 770 </div></div></td>
 771 </tr>
 772 <tr>
 773 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 774 <p><strong>Header</strong></p>
 775 </div></div></td>
 776 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 777 <p><strong>X-ECOMP-InstanceID</strong><br>
 778 <em>required</em></p>
 779 </div></div></td>
 780 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 781 <p>X-ECOMP-InstanceID header</p>
 782 </div></div></td>
 783 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 784 <p>string</p>
 785 </div></div></td>
 786 </tr>
 787 <tr>
 788 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 789 <p><strong>Header</strong></p>
 790 </div></div></td>
 791 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 792 <p><strong>X-ECOMP-RequestID</strong><br>
 793 <em>optional</em></p>
 794 </div></div></td>
 795 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 796 <p>X-ECOMP-RequestID header</p>
 797 </div></div></td>
 798 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 799 <p>string</p>
 800 </div></div></td>
 801 </tr>
 802 </tbody>
 803 </table>
 804
 805 </div>
 806 <div class="sect3">
 807 <h4 id="_responses"><a class="anchor" href="#_responses"></a>2.1.3. Responses</h4>
 808 <table class="tableblock frame-all grid-all" style="width:100%; ">
 809 <colgroup>
 810 <col style="width:10%;">
 811 <col style="width:70%;">
 812 <col style="width:20%;">
 813 </colgroup>
 814 <thead>
 815 <tr>
 816 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 817 <th class="tableblock halign-left valign-middle">Description</th>
 818 <th class="tableblock halign-left valign-middle">Schema</th>
 819 </tr>
 820 </thead>
 821 <tbody>
 822 <tr>
 823 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 824 <p><strong>200</strong></p>
 825 </div></div></td>
 826 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 827 <p>Artifact types list fetched successfully</p>
 828 </div></div></td>
 829 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 830 <p>string</p>
 831 </div></div></td>
 832 </tr>
 833 <tr>
 834 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 835 <p><strong>400</strong></p>
 836 </div></div></td>
 837 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 838 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
 839 </div></div></td>
 840 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 841 <p>No Content</p>
 842 </div></div></td>
 843 </tr>
 844 <tr>
 845 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 846 <p><strong>401</strong></p>
 847 </div></div></td>
 848 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 849 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
 850 </div></div></td>
 851 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 852 <p>No Content</p>
 853 </div></div></td>
 854 </tr>
 855 <tr>
 856 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 857 <p><strong>403</strong></p>
 858 </div></div></td>
 859 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 860 <p>ECOMP component is not authorized - POL5003</p>
 861 </div></div></td>
 862 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 863 <p>No Content</p>
 864 </div></div></td>
 865 </tr>
 866 <tr>
 867 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 868 <p><strong>405</strong></p>
 869 </div></div></td>
 870 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 871 <p>Method Not Allowed : Invalid HTTP method type used to register for distribution ( POST,PUT,DELETE will be rejected) - POL4050</p>
 872 </div></div></td>
 873 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 874 <p>No Content</p>
 875 </div></div></td>
 876 </tr>
 877 <tr>
 878 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 879 <p><strong>500</strong></p>
 880 </div></div></td>
 881 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 882 <p>The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000</p>
 883 </div></div></td>
 884 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 885 <p>No Content</p>
 886 </div></div></td>
 887 </tr>
 888 </tbody>
 889 </table>
 890
 891 </div>
 892 <div class="sect3">
 893 <h4 id="_consumes"><a class="anchor" href="#_consumes"></a>2.1.4. Consumes</h4>
 894 <div class="ulist">
 895 <ul>
 896 <li>
 897 <p><code>application/json</code></p>
 898 </li>
 899 </ul>
 900 </div>
 901 </div>
 902 <div class="sect3">
 903 <h4 id="_produces"><a class="anchor" href="#_produces"></a>2.1.5. Produces</h4>
 904 <div class="ulist">
 905 <ul>
 906 <li>
 907 <p><code>application/json</code></p>
 908 </li>
 909 </ul>
 910 </div>
 911 </div>
 912 <div class="sect3">
 913 <h4 id="_tags_2"><a class="anchor" href="#_tags_2"></a>2.1.6. Tags</h4>
 914 <div class="ulist">
 915 <ul>
 916 <li>
 917 <p>Distribution Servlet</p>
 918 </li>
 919 </ul>
 920 </div>
 921 </div>
 922 </div>
 923 <div class="sect2">
 924 <h3 id="_uploadinterfaceoperationartifact"><a class="anchor" href="#_uploadinterfaceoperationartifact"></a>2.2. uploads of artifact to VF operation workflow</h3>
 925 <div class="literalblock">
 926 <div class="content">
 927 <pre>POST /v1/catalog/resources/{uuid}/interfaces/{operationUUID}/artifacts/{artifactUUID}</pre>
 928 </div>
 929 </div>
 930 <div class="sect3">
 931 <h4 id="_description_2"><a class="anchor" href="#_description_2"></a>2.2.1. Description</h4>
 932 <div class="paragraph">
 933 <p>uploads of artifact to VF operation workflow</p>
 934 </div>
 935 </div>
 936 <div class="sect3">
 937 <h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a>2.2.2. Parameters</h4>
 938 <table class="tableblock frame-all grid-all" style="width:100%; ">
 939 <colgroup>
 940 <col style="width:11%;">
 941 <col style="width:16%;">
 942 <col style="width:50%;">
 943 <col style="width:22%;">
 944 </colgroup>
 945 <thead>
 946 <tr>
 947 <th class="tableblock halign-left valign-middle">Type</th>
 948 <th class="tableblock halign-left valign-middle">Name</th>
 949 <th class="tableblock halign-left valign-middle">Description</th>
 950 <th class="tableblock halign-left valign-middle">Schema</th>
 951 </tr>
 952 </thead>
 953 <tbody>
 954 <tr>
 955 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 956 <p><strong>Header</strong></p>
 957 </div></div></td>
 958 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 959 <p><strong>Accept</strong><br>
 960 <em>optional</em></p>
 961 </div></div></td>
 962 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 963 <p>Determines the format of the body of the response</p>
 964 </div></div></td>
 965 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 966 <p>string</p>
 967 </div></div></td>
 968 </tr>
 969 <tr>
 970 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 971 <p><strong>Header</strong></p>
 972 </div></div></td>
 973 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 974 <p><strong>Authorization</strong><br>
 975 <em>required</em></p>
 976 </div></div></td>
 977 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 978 <p>The username and password</p>
 979 </div></div></td>
 980 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 981 <p>string</p>
 982 </div></div></td>
 983 </tr>
 984 <tr>
 985 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 986 <p><strong>Header</strong></p>
 987 </div></div></td>
 988 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 989 <p><strong>Content-MD5</strong><br>
 990 <em>required</em></p>
 991 </div></div></td>
 992 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 993 <p>The value for this header must be the MD5 checksum over the whole json body</p>
 994 </div></div></td>
 995 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
 996 <p>string</p>
 997 </div></div></td>
 998 </tr>
 999 <tr>
1000 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1001 <p><strong>Header</strong></p>
1002 </div></div></td>
1003 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1004 <p><strong>Content-Type</strong><br>
1005 <em>required</em></p>
1006 </div></div></td>
1007 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1008 <p>Determines the format of the body of the request</p>
1009 </div></div></td>
1010 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1011 <p>string</p>
1012 </div></div></td>
1013 </tr>
1014 <tr>
1015 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1016 <p><strong>Header</strong></p>
1017 </div></div></td>
1018 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1019 <p><strong>USER_ID</strong><br>
1020 <em>required</em></p>
1021 </div></div></td>
1022 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1023 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
1024 </div></div></td>
1025 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1026 <p>string</p>
1027 </div></div></td>
1028 </tr>
1029 <tr>
1030 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1031 <p><strong>Header</strong></p>
1032 </div></div></td>
1033 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1034 <p><strong>X-ECOMP-InstanceID</strong><br>
1035 <em>required</em></p>
1036 </div></div></td>
1037 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1038 <p>X-ECOMP-InstanceID header</p>
1039 </div></div></td>
1040 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1041 <p>string</p>
1042 </div></div></td>
1043 </tr>
1044 <tr>
1045 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1046 <p><strong>Header</strong></p>
1047 </div></div></td>
1048 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1049 <p><strong>X-ECOMP-RequestID</strong><br>
1050 <em>optional</em></p>
1051 </div></div></td>
1052 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1053 <p>X-ECOMP-RequestID header</p>
1054 </div></div></td>
1055 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1056 <p>string</p>
1057 </div></div></td>
1058 </tr>
1059 <tr>
1060 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1061 <p><strong>Path</strong></p>
1062 </div></div></td>
1063 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1064 <p><strong>artifactUUID</strong><br>
1065 <em>required</em></p>
1066 </div></div></td>
1067 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1068 <p>The uuid of the artifact</p>
1069 </div></div></td>
1070 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1071 <p>string</p>
1072 </div></div></td>
1073 </tr>
1074 <tr>
1075 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1076 <p><strong>Path</strong></p>
1077 </div></div></td>
1078 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1079 <p><strong>operationUUID</strong><br>
1080 <em>required</em></p>
1081 </div></div></td>
1082 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1083 <p>The uuid of the operation</p>
1084 </div></div></td>
1085 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1086 <p>string</p>
1087 </div></div></td>
1088 </tr>
1089 <tr>
1090 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1091 <p><strong>Path</strong></p>
1092 </div></div></td>
1093 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1094 <p><strong>uuid</strong><br>
1095 <em>required</em></p>
1096 </div></div></td>
1097 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1098 <p>The uuid of the asset as published in the metadata</p>
1099 </div></div></td>
1100 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1101 <p>string</p>
1102 </div></div></td>
1103 </tr>
1104 <tr>
1105 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1106 <p><strong>Body</strong></p>
1107 </div></div></td>
1108 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1109 <p><strong>body</strong><br>
1110 <em>required</em></p>
1111 </div></div></td>
1112 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1113 <p>json describe the artifact</p>
1114 </div></div></td>
1115 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1116 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
1117 </div></div></td>
1118 </tr>
1119 </tbody>
1120 </table>
1121
1122 </div>
1123 <div class="sect3">
1124 <h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a>2.2.3. Responses</h4>
1125 <table class="tableblock frame-all grid-all" style="width:100%; ">
1126 <colgroup>
1127 <col style="width:10%;">
1128 <col style="width:70%;">
1129 <col style="width:20%;">
1130 </colgroup>
1131 <thead>
1132 <tr>
1133 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1134 <th class="tableblock halign-left valign-middle">Description</th>
1135 <th class="tableblock halign-left valign-middle">Schema</th>
1136 </tr>
1137 </thead>
1138 <tbody>
1139 <tr>
1140 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1141 <p><strong>200</strong></p>
1142 </div></div></td>
1143 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1144 <p>Artifact uploaded</p>
1145 </div></div></td>
1146 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1147 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
1148 </div></div></td>
1149 </tr>
1150 <tr>
1151 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1152 <p><strong>400</strong></p>
1153 </div></div></td>
1154 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1155 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
1156 </div></div></td>
1157 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1158 <p>No Content</p>
1159 </div></div></td>
1160 </tr>
1161 <tr>
1162 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1163 <p><strong>401</strong></p>
1164 </div></div></td>
1165 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1166 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
1167 </div></div></td>
1168 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1169 <p>No Content</p>
1170 </div></div></td>
1171 </tr>
1172 <tr>
1173 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1174 <p><strong>403</strong></p>
1175 </div></div></td>
1176 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1177 <p>ECOMP component is not authorized - POL5003</p>
1178 </div></div></td>
1179 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1180 <p>No Content</p>
1181 </div></div></td>
1182 </tr>
1183 <tr>
1184 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1185 <p><strong>404</strong></p>
1186 </div></div></td>
1187 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1188 <p>Specified resource is not found - SVC4063</p>
1189 </div></div></td>
1190 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1191 <p>No Content</p>
1192 </div></div></td>
1193 </tr>
1194 <tr>
1195 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1196 <p><strong>405</strong></p>
1197 </div></div></td>
1198 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1199 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
1200 </div></div></td>
1201 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1202 <p>No Content</p>
1203 </div></div></td>
1204 </tr>
1205 <tr>
1206 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1207 <p><strong>500</strong></p>
1208 </div></div></td>
1209 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1210 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
1211 </div></div></td>
1212 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1213 <p>No Content</p>
1214 </div></div></td>
1215 </tr>
1216 </tbody>
1217 </table>
1218
1219 </div>
1220 <div class="sect3">
1221 <h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a>2.2.4. Produces</h4>
1222 <div class="ulist">
1223 <ul>
1224 <li>
1225 <p><code>application/json</code></p>
1226 </li>
1227 </ul>
1228 </div>
1229 </div>
1230 <div class="sect3">
1231 <h4 id="_tags_3"><a class="anchor" href="#_tags_3"></a>2.2.5. Tags</h4>
1232 <div class="ulist">
1233 <ul>
1234 <li>
1235 <p>Artifact External Servlet</p>
1236 </li>
1237 </ul>
1238 </div>
1239 </div>
1240 </div>
1241 <div class="sect2">
1242 <h3 id="_downloadserviceartifact"><a class="anchor" href="#_downloadserviceartifact"></a>2.3. Download service artifact</h3>
1243 <div class="literalblock">
1244 <div class="content">
1245 <pre>GET /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}</pre>
1246 </div>
1247 </div>
1248 <div class="sect3">
1249 <h4 id="_description_3"><a class="anchor" href="#_description_3"></a>2.3.1. Description</h4>
1250 <div class="paragraph">
1251 <p>Returns downloaded artifact</p>
1252 </div>
1253 </div>
1254 <div class="sect3">
1255 <h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a>2.3.2. Parameters</h4>
1256 <table class="tableblock frame-all grid-all" style="width:100%; ">
1257 <colgroup>
1258 <col style="width:11%;">
1259 <col style="width:16%;">
1260 <col style="width:50%;">
1261 <col style="width:22%;">
1262 </colgroup>
1263 <thead>
1264 <tr>
1265 <th class="tableblock halign-left valign-middle">Type</th>
1266 <th class="tableblock halign-left valign-middle">Name</th>
1267 <th class="tableblock halign-left valign-middle">Description</th>
1268 <th class="tableblock halign-left valign-middle">Schema</th>
1269 </tr>
1270 </thead>
1271 <tbody>
1272 <tr>
1273 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1274 <p><strong>Header</strong></p>
1275 </div></div></td>
1276 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1277 <p><strong>Accept</strong><br>
1278 <em>optional</em></p>
1279 </div></div></td>
1280 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1281 <p>Determines the format of the body of the response</p>
1282 </div></div></td>
1283 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1284 <p>string</p>
1285 </div></div></td>
1286 </tr>
1287 <tr>
1288 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1289 <p><strong>Header</strong></p>
1290 </div></div></td>
1291 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1292 <p><strong>Authorization</strong><br>
1293 <em>required</em></p>
1294 </div></div></td>
1295 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1296 <p>The username and password</p>
1297 </div></div></td>
1298 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1299 <p>string</p>
1300 </div></div></td>
1301 </tr>
1302 <tr>
1303 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1304 <p><strong>Header</strong></p>
1305 </div></div></td>
1306 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1307 <p><strong>X-ECOMP-InstanceID</strong><br>
1308 <em>required</em></p>
1309 </div></div></td>
1310 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1311 <p>X-ECOMP-InstanceID header</p>
1312 </div></div></td>
1313 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1314 <p>string</p>
1315 </div></div></td>
1316 </tr>
1317 <tr>
1318 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1319 <p><strong>Header</strong></p>
1320 </div></div></td>
1321 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1322 <p><strong>X-ECOMP-RequestID</strong><br>
1323 <em>optional</em></p>
1324 </div></div></td>
1325 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1326 <p>X-ECOMP-RequestID header</p>
1327 </div></div></td>
1328 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1329 <p>string</p>
1330 </div></div></td>
1331 </tr>
1332 <tr>
1333 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1334 <p><strong>Path</strong></p>
1335 </div></div></td>
1336 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1337 <p><strong>artifactName</strong><br>
1338 <em>required</em></p>
1339 </div></div></td>
1340 <td class="tableblock halign-left valign-middle"><div></div></td>
1341 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1342 <p>string</p>
1343 </div></div></td>
1344 </tr>
1345 <tr>
1346 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1347 <p><strong>Path</strong></p>
1348 </div></div></td>
1349 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1350 <p><strong>serviceName</strong><br>
1351 <em>required</em></p>
1352 </div></div></td>
1353 <td class="tableblock halign-left valign-middle"><div></div></td>
1354 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1355 <p>string</p>
1356 </div></div></td>
1357 </tr>
1358 <tr>
1359 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1360 <p><strong>Path</strong></p>
1361 </div></div></td>
1362 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1363 <p><strong>serviceVersion</strong><br>
1364 <em>required</em></p>
1365 </div></div></td>
1366 <td class="tableblock halign-left valign-middle"><div></div></td>
1367 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1368 <p>string</p>
1369 </div></div></td>
1370 </tr>
1371 </tbody>
1372 </table>
1373
1374 </div>
1375 <div class="sect3">
1376 <h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a>2.3.3. Responses</h4>
1377 <table class="tableblock frame-all grid-all" style="width:100%; ">
1378 <colgroup>
1379 <col style="width:10%;">
1380 <col style="width:70%;">
1381 <col style="width:20%;">
1382 </colgroup>
1383 <thead>
1384 <tr>
1385 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1386 <th class="tableblock halign-left valign-middle">Description</th>
1387 <th class="tableblock halign-left valign-middle">Schema</th>
1388 </tr>
1389 </thead>
1390 <tbody>
1391 <tr>
1392 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1393 <p><strong>200</strong></p>
1394 </div></div></td>
1395 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1396 <p>The artifact is found and streamed.</p>
1397 </div></div></td>
1398 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1399 <p>string</p>
1400 </div></div></td>
1401 </tr>
1402 <tr>
1403 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1404 <p><strong>400</strong></p>
1405 </div></div></td>
1406 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1407 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
1408 </div></div></td>
1409 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1410 <p>No Content</p>
1411 </div></div></td>
1412 </tr>
1413 <tr>
1414 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1415 <p><strong>401</strong></p>
1416 </div></div></td>
1417 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1418 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
1419 </div></div></td>
1420 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1421 <p>No Content</p>
1422 </div></div></td>
1423 </tr>
1424 <tr>
1425 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1426 <p><strong>403</strong></p>
1427 </div></div></td>
1428 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1429 <p>ECOMP component is not authorized - POL5003</p>
1430 </div></div></td>
1431 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1432 <p>No Content</p>
1433 </div></div></td>
1434 </tr>
1435 <tr>
1436 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1437 <p><strong>404</strong></p>
1438 </div></div></td>
1439 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1440 <p>Specified artifact is not found - SVC4505</p>
1441 </div></div></td>
1442 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1443 <p>No Content</p>
1444 </div></div></td>
1445 </tr>
1446 <tr>
1447 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1448 <p><strong>405</strong></p>
1449 </div></div></td>
1450 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1451 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
1452 </div></div></td>
1453 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1454 <p>No Content</p>
1455 </div></div></td>
1456 </tr>
1457 <tr>
1458 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1459 <p><strong>500</strong></p>
1460 </div></div></td>
1461 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1462 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
1463 </div></div></td>
1464 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1465 <p>No Content</p>
1466 </div></div></td>
1467 </tr>
1468 </tbody>
1469 </table>
1470
1471 </div>
1472 <div class="sect3">
1473 <h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a>2.3.4. Consumes</h4>
1474 <div class="ulist">
1475 <ul>
1476 <li>
1477 <p><code>application/json</code></p>
1478 </li>
1479 </ul>
1480 </div>
1481 </div>
1482 <div class="sect3">
1483 <h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a>2.3.5. Produces</h4>
1484 <div class="ulist">
1485 <ul>
1486 <li>
1487 <p><code>application/octet-stream</code></p>
1488 </li>
1489 </ul>
1490 </div>
1491 </div>
1492 <div class="sect3">
1493 <h4 id="_tags_4"><a class="anchor" href="#_tags_4"></a>2.3.6. Tags</h4>
1494 <div class="ulist">
1495 <ul>
1496 <li>
1497 <p>Distribution Catalog Servlet</p>
1498 </li>
1499 </ul>
1500 </div>
1501 </div>
1502 </div>
1503 <div class="sect2">
1504 <h3 id="_downloadresourceinstanceartifactbyname"><a class="anchor" href="#_downloadresourceinstanceartifactbyname"></a>2.4. Download resource instance artifact</h3>
1505 <div class="literalblock">
1506 <div class="content">
1507 <pre>GET /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}</pre>
1508 </div>
1509 </div>
1510 <div class="sect3">
1511 <h4 id="_description_4"><a class="anchor" href="#_description_4"></a>2.4.1. Description</h4>
1512 <div class="paragraph">
1513 <p>Returns downloaded artifact</p>
1514 </div>
1515 </div>
1516 <div class="sect3">
1517 <h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a>2.4.2. Parameters</h4>
1518 <table class="tableblock frame-all grid-all" style="width:100%; ">
1519 <colgroup>
1520 <col style="width:11%;">
1521 <col style="width:16%;">
1522 <col style="width:50%;">
1523 <col style="width:22%;">
1524 </colgroup>
1525 <thead>
1526 <tr>
1527 <th class="tableblock halign-left valign-middle">Type</th>
1528 <th class="tableblock halign-left valign-middle">Name</th>
1529 <th class="tableblock halign-left valign-middle">Description</th>
1530 <th class="tableblock halign-left valign-middle">Schema</th>
1531 </tr>
1532 </thead>
1533 <tbody>
1534 <tr>
1535 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1536 <p><strong>Header</strong></p>
1537 </div></div></td>
1538 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1539 <p><strong>Accept</strong><br>
1540 <em>optional</em></p>
1541 </div></div></td>
1542 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1543 <p>Determines the format of the body of the response</p>
1544 </div></div></td>
1545 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1546 <p>string</p>
1547 </div></div></td>
1548 </tr>
1549 <tr>
1550 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1551 <p><strong>Header</strong></p>
1552 </div></div></td>
1553 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1554 <p><strong>Authorization</strong><br>
1555 <em>required</em></p>
1556 </div></div></td>
1557 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1558 <p>The username and password</p>
1559 </div></div></td>
1560 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1561 <p>string</p>
1562 </div></div></td>
1563 </tr>
1564 <tr>
1565 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1566 <p><strong>Header</strong></p>
1567 </div></div></td>
1568 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1569 <p><strong>X-ECOMP-InstanceID</strong><br>
1570 <em>required</em></p>
1571 </div></div></td>
1572 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1573 <p>X-ECOMP-InstanceID header</p>
1574 </div></div></td>
1575 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1576 <p>string</p>
1577 </div></div></td>
1578 </tr>
1579 <tr>
1580 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1581 <p><strong>Header</strong></p>
1582 </div></div></td>
1583 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1584 <p><strong>X-ECOMP-RequestID</strong><br>
1585 <em>optional</em></p>
1586 </div></div></td>
1587 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1588 <p>X-ECOMP-RequestID header</p>
1589 </div></div></td>
1590 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1591 <p>string</p>
1592 </div></div></td>
1593 </tr>
1594 <tr>
1595 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1596 <p><strong>Path</strong></p>
1597 </div></div></td>
1598 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1599 <p><strong>artifactName</strong><br>
1600 <em>required</em></p>
1601 </div></div></td>
1602 <td class="tableblock halign-left valign-middle"><div></div></td>
1603 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1604 <p>string</p>
1605 </div></div></td>
1606 </tr>
1607 <tr>
1608 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1609 <p><strong>Path</strong></p>
1610 </div></div></td>
1611 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1612 <p><strong>resourceInstanceName</strong><br>
1613 <em>required</em></p>
1614 </div></div></td>
1615 <td class="tableblock halign-left valign-middle"><div></div></td>
1616 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1617 <p>string</p>
1618 </div></div></td>
1619 </tr>
1620 <tr>
1621 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1622 <p><strong>Path</strong></p>
1623 </div></div></td>
1624 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1625 <p><strong>serviceName</strong><br>
1626 <em>required</em></p>
1627 </div></div></td>
1628 <td class="tableblock halign-left valign-middle"><div></div></td>
1629 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1630 <p>string</p>
1631 </div></div></td>
1632 </tr>
1633 <tr>
1634 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1635 <p><strong>Path</strong></p>
1636 </div></div></td>
1637 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1638 <p><strong>serviceVersion</strong><br>
1639 <em>required</em></p>
1640 </div></div></td>
1641 <td class="tableblock halign-left valign-middle"><div></div></td>
1642 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1643 <p>string</p>
1644 </div></div></td>
1645 </tr>
1646 </tbody>
1647 </table>
1648
1649 </div>
1650 <div class="sect3">
1651 <h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a>2.4.3. Responses</h4>
1652 <table class="tableblock frame-all grid-all" style="width:100%; ">
1653 <colgroup>
1654 <col style="width:10%;">
1655 <col style="width:70%;">
1656 <col style="width:20%;">
1657 </colgroup>
1658 <thead>
1659 <tr>
1660 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1661 <th class="tableblock halign-left valign-middle">Description</th>
1662 <th class="tableblock halign-left valign-middle">Schema</th>
1663 </tr>
1664 </thead>
1665 <tbody>
1666 <tr>
1667 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1668 <p><strong>200</strong></p>
1669 </div></div></td>
1670 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1671 <p>The artifact is found and streamed.</p>
1672 </div></div></td>
1673 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1674 <p>string</p>
1675 </div></div></td>
1676 </tr>
1677 <tr>
1678 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1679 <p><strong>400</strong></p>
1680 </div></div></td>
1681 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1682 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
1683 </div></div></td>
1684 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1685 <p>No Content</p>
1686 </div></div></td>
1687 </tr>
1688 <tr>
1689 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1690 <p><strong>401</strong></p>
1691 </div></div></td>
1692 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1693 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
1694 </div></div></td>
1695 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1696 <p>No Content</p>
1697 </div></div></td>
1698 </tr>
1699 <tr>
1700 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1701 <p><strong>403</strong></p>
1702 </div></div></td>
1703 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1704 <p>ECOMP component is not authorized - POL5003</p>
1705 </div></div></td>
1706 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1707 <p>No Content</p>
1708 </div></div></td>
1709 </tr>
1710 <tr>
1711 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1712 <p><strong>404</strong></p>
1713 </div></div></td>
1714 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1715 <p>Specified artifact is not found - SVC4505</p>
1716 </div></div></td>
1717 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1718 <p>No Content</p>
1719 </div></div></td>
1720 </tr>
1721 <tr>
1722 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1723 <p><strong>405</strong></p>
1724 </div></div></td>
1725 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1726 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
1727 </div></div></td>
1728 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1729 <p>No Content</p>
1730 </div></div></td>
1731 </tr>
1732 <tr>
1733 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1734 <p><strong>500</strong></p>
1735 </div></div></td>
1736 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1737 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
1738 </div></div></td>
1739 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1740 <p>No Content</p>
1741 </div></div></td>
1742 </tr>
1743 </tbody>
1744 </table>
1745
1746 </div>
1747 <div class="sect3">
1748 <h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a>2.4.4. Consumes</h4>
1749 <div class="ulist">
1750 <ul>
1751 <li>
1752 <p><code>application/json</code></p>
1753 </li>
1754 </ul>
1755 </div>
1756 </div>
1757 <div class="sect3">
1758 <h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a>2.4.5. Produces</h4>
1759 <div class="ulist">
1760 <ul>
1761 <li>
1762 <p><code>application/octet-stream</code></p>
1763 </li>
1764 </ul>
1765 </div>
1766 </div>
1767 <div class="sect3">
1768 <h4 id="_tags_5"><a class="anchor" href="#_tags_5"></a>2.4.6. Tags</h4>
1769 <div class="ulist">
1770 <ul>
1771 <li>
1772 <p>Distribution Catalog Servlet</p>
1773 </li>
1774 </ul>
1775 </div>
1776 </div>
1777 </div>
1778 <div class="sect2">
1779 <h3 id="_downloadresourceartifact"><a class="anchor" href="#_downloadresourceartifact"></a>2.5. Download resource artifact</h3>
1780 <div class="literalblock">
1781 <div class="content">
1782 <pre>GET /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}</pre>
1783 </div>
1784 </div>
1785 <div class="sect3">
1786 <h4 id="_description_5"><a class="anchor" href="#_description_5"></a>2.5.1. Description</h4>
1787 <div class="paragraph">
1788 <p>Returns downloaded artifact</p>
1789 </div>
1790 </div>
1791 <div class="sect3">
1792 <h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a>2.5.2. Parameters</h4>
1793 <table class="tableblock frame-all grid-all" style="width:100%; ">
1794 <colgroup>
1795 <col style="width:11%;">
1796 <col style="width:16%;">
1797 <col style="width:50%;">
1798 <col style="width:22%;">
1799 </colgroup>
1800 <thead>
1801 <tr>
1802 <th class="tableblock halign-left valign-middle">Type</th>
1803 <th class="tableblock halign-left valign-middle">Name</th>
1804 <th class="tableblock halign-left valign-middle">Description</th>
1805 <th class="tableblock halign-left valign-middle">Schema</th>
1806 </tr>
1807 </thead>
1808 <tbody>
1809 <tr>
1810 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1811 <p><strong>Header</strong></p>
1812 </div></div></td>
1813 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1814 <p><strong>Accept</strong><br>
1815 <em>optional</em></p>
1816 </div></div></td>
1817 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1818 <p>Determines the format of the body of the response</p>
1819 </div></div></td>
1820 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1821 <p>string</p>
1822 </div></div></td>
1823 </tr>
1824 <tr>
1825 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1826 <p><strong>Header</strong></p>
1827 </div></div></td>
1828 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1829 <p><strong>Authorization</strong><br>
1830 <em>required</em></p>
1831 </div></div></td>
1832 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1833 <p>The username and password</p>
1834 </div></div></td>
1835 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1836 <p>string</p>
1837 </div></div></td>
1838 </tr>
1839 <tr>
1840 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1841 <p><strong>Header</strong></p>
1842 </div></div></td>
1843 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1844 <p><strong>X-ECOMP-InstanceID</strong><br>
1845 <em>required</em></p>
1846 </div></div></td>
1847 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1848 <p>X-ECOMP-InstanceID header</p>
1849 </div></div></td>
1850 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1851 <p>string</p>
1852 </div></div></td>
1853 </tr>
1854 <tr>
1855 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1856 <p><strong>Header</strong></p>
1857 </div></div></td>
1858 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1859 <p><strong>X-ECOMP-RequestID</strong><br>
1860 <em>optional</em></p>
1861 </div></div></td>
1862 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1863 <p>X-ECOMP-RequestID header</p>
1864 </div></div></td>
1865 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1866 <p>string</p>
1867 </div></div></td>
1868 </tr>
1869 <tr>
1870 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1871 <p><strong>Path</strong></p>
1872 </div></div></td>
1873 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1874 <p><strong>artifactName</strong><br>
1875 <em>required</em></p>
1876 </div></div></td>
1877 <td class="tableblock halign-left valign-middle"><div></div></td>
1878 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1879 <p>string</p>
1880 </div></div></td>
1881 </tr>
1882 <tr>
1883 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1884 <p><strong>Path</strong></p>
1885 </div></div></td>
1886 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1887 <p><strong>resourceName</strong><br>
1888 <em>required</em></p>
1889 </div></div></td>
1890 <td class="tableblock halign-left valign-middle"><div></div></td>
1891 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1892 <p>string</p>
1893 </div></div></td>
1894 </tr>
1895 <tr>
1896 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1897 <p><strong>Path</strong></p>
1898 </div></div></td>
1899 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1900 <p><strong>resourceVersion</strong><br>
1901 <em>required</em></p>
1902 </div></div></td>
1903 <td class="tableblock halign-left valign-middle"><div></div></td>
1904 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1905 <p>string</p>
1906 </div></div></td>
1907 </tr>
1908 <tr>
1909 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1910 <p><strong>Path</strong></p>
1911 </div></div></td>
1912 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1913 <p><strong>serviceName</strong><br>
1914 <em>required</em></p>
1915 </div></div></td>
1916 <td class="tableblock halign-left valign-middle"><div></div></td>
1917 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1918 <p>string</p>
1919 </div></div></td>
1920 </tr>
1921 <tr>
1922 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1923 <p><strong>Path</strong></p>
1924 </div></div></td>
1925 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1926 <p><strong>serviceVersion</strong><br>
1927 <em>required</em></p>
1928 </div></div></td>
1929 <td class="tableblock halign-left valign-middle"><div></div></td>
1930 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1931 <p>string</p>
1932 </div></div></td>
1933 </tr>
1934 </tbody>
1935 </table>
1936
1937 </div>
1938 <div class="sect3">
1939 <h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a>2.5.3. Responses</h4>
1940 <table class="tableblock frame-all grid-all" style="width:100%; ">
1941 <colgroup>
1942 <col style="width:10%;">
1943 <col style="width:70%;">
1944 <col style="width:20%;">
1945 </colgroup>
1946 <thead>
1947 <tr>
1948 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1949 <th class="tableblock halign-left valign-middle">Description</th>
1950 <th class="tableblock halign-left valign-middle">Schema</th>
1951 </tr>
1952 </thead>
1953 <tbody>
1954 <tr>
1955 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1956 <p><strong>200</strong></p>
1957 </div></div></td>
1958 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1959 <p>The artifact is found and streamed.</p>
1960 </div></div></td>
1961 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1962 <p>string</p>
1963 </div></div></td>
1964 </tr>
1965 <tr>
1966 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1967 <p><strong>400</strong></p>
1968 </div></div></td>
1969 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1970 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
1971 </div></div></td>
1972 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1973 <p>No Content</p>
1974 </div></div></td>
1975 </tr>
1976 <tr>
1977 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1978 <p><strong>401</strong></p>
1979 </div></div></td>
1980 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1981 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
1982 </div></div></td>
1983 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1984 <p>No Content</p>
1985 </div></div></td>
1986 </tr>
1987 <tr>
1988 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1989 <p><strong>403</strong></p>
1990 </div></div></td>
1991 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1992 <p>ECOMP component is not authorized - POL5003</p>
1993 </div></div></td>
1994 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
1995 <p>No Content</p>
1996 </div></div></td>
1997 </tr>
1998 <tr>
1999 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2000 <p><strong>404</strong></p>
2001 </div></div></td>
2002 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2003 <p>Specified artifact is not found - SVC4505</p>
2004 </div></div></td>
2005 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2006 <p>No Content</p>
2007 </div></div></td>
2008 </tr>
2009 <tr>
2010 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2011 <p><strong>405</strong></p>
2012 </div></div></td>
2013 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2014 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
2015 </div></div></td>
2016 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2017 <p>No Content</p>
2018 </div></div></td>
2019 </tr>
2020 <tr>
2021 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2022 <p><strong>500</strong></p>
2023 </div></div></td>
2024 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2025 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
2026 </div></div></td>
2027 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2028 <p>No Content</p>
2029 </div></div></td>
2030 </tr>
2031 </tbody>
2032 </table>
2033
2034 </div>
2035 <div class="sect3">
2036 <h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a>2.5.4. Consumes</h4>
2037 <div class="ulist">
2038 <ul>
2039 <li>
2040 <p><code>application/json</code></p>
2041 </li>
2042 </ul>
2043 </div>
2044 </div>
2045 <div class="sect3">
2046 <h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a>2.5.5. Produces</h4>
2047 <div class="ulist">
2048 <ul>
2049 <li>
2050 <p><code>application/octet-stream</code></p>
2051 </li>
2052 </ul>
2053 </div>
2054 </div>
2055 <div class="sect3">
2056 <h4 id="_tags_6"><a class="anchor" href="#_tags_6"></a>2.5.6. Tags</h4>
2057 <div class="ulist">
2058 <ul>
2059 <li>
2060 <p>Distribution Catalog Servlet</p>
2061 </li>
2062 </ul>
2063 </div>
2064 </div>
2065 </div>
2066 <div class="sect2">
2067 <h3 id="_activateserviceexternal"><a class="anchor" href="#_activateserviceexternal"></a>2.6. activate a service</h3>
2068 <div class="literalblock">
2069 <div class="content">
2070 <pre>POST /v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate</pre>
2071 </div>
2072 </div>
2073 <div class="sect3">
2074 <h4 id="_description_6"><a class="anchor" href="#_description_6"></a>2.6.1. Description</h4>
2075 <div class="paragraph">
2076 <p>Activates a service</p>
2077 </div>
2078 </div>
2079 <div class="sect3">
2080 <h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a>2.6.2. Parameters</h4>
2081 <table class="tableblock frame-all grid-all" style="width:100%; ">
2082 <colgroup>
2083 <col style="width:11%;">
2084 <col style="width:16%;">
2085 <col style="width:50%;">
2086 <col style="width:22%;">
2087 </colgroup>
2088 <thead>
2089 <tr>
2090 <th class="tableblock halign-left valign-middle">Type</th>
2091 <th class="tableblock halign-left valign-middle">Name</th>
2092 <th class="tableblock halign-left valign-middle">Description</th>
2093 <th class="tableblock halign-left valign-middle">Schema</th>
2094 </tr>
2095 </thead>
2096 <tbody>
2097 <tr>
2098 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2099 <p><strong>Header</strong></p>
2100 </div></div></td>
2101 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2102 <p><strong>Accept</strong><br>
2103 <em>optional</em></p>
2104 </div></div></td>
2105 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2106 <p>Determines the format of the body of the response</p>
2107 </div></div></td>
2108 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2109 <p>string</p>
2110 </div></div></td>
2111 </tr>
2112 <tr>
2113 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2114 <p><strong>Header</strong></p>
2115 </div></div></td>
2116 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2117 <p><strong>Authorization</strong><br>
2118 <em>required</em></p>
2119 </div></div></td>
2120 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2121 <p>The username and password</p>
2122 </div></div></td>
2123 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2124 <p>string</p>
2125 </div></div></td>
2126 </tr>
2127 <tr>
2128 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2129 <p><strong>Header</strong></p>
2130 </div></div></td>
2131 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2132 <p><strong>Content-Type</strong><br>
2133 <em>required</em></p>
2134 </div></div></td>
2135 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2136 <p>Determines the format of the body of the request</p>
2137 </div></div></td>
2138 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2139 <p>string</p>
2140 </div></div></td>
2141 </tr>
2142 <tr>
2143 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2144 <p><strong>Header</strong></p>
2145 </div></div></td>
2146 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2147 <p><strong>USER_ID</strong><br>
2148 <em>required</em></p>
2149 </div></div></td>
2150 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2151 <p>The user id</p>
2152 </div></div></td>
2153 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2154 <p>string</p>
2155 </div></div></td>
2156 </tr>
2157 <tr>
2158 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2159 <p><strong>Header</strong></p>
2160 </div></div></td>
2161 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2162 <p><strong>X-ECOMP-InstanceID</strong><br>
2163 <em>required</em></p>
2164 </div></div></td>
2165 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2166 <p>X-ECOMP-InstanceID header</p>
2167 </div></div></td>
2168 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2169 <p>string</p>
2170 </div></div></td>
2171 </tr>
2172 <tr>
2173 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2174 <p><strong>Header</strong></p>
2175 </div></div></td>
2176 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2177 <p><strong>X-ECOMP-RequestID</strong><br>
2178 <em>optional</em></p>
2179 </div></div></td>
2180 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2181 <p>X-ECOMP-RequestID header</p>
2182 </div></div></td>
2183 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2184 <p>string</p>
2185 </div></div></td>
2186 </tr>
2187 <tr>
2188 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2189 <p><strong>Path</strong></p>
2190 </div></div></td>
2191 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2192 <p><strong>opEnvId</strong><br>
2193 <em>required</em></p>
2194 </div></div></td>
2195 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2196 <p>The operational environment on which to activate the service on</p>
2197 </div></div></td>
2198 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2199 <p>string</p>
2200 </div></div></td>
2201 </tr>
2202 <tr>
2203 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2204 <p><strong>Path</strong></p>
2205 </div></div></td>
2206 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2207 <p><strong>serviceUUID</strong><br>
2208 <em>required</em></p>
2209 </div></div></td>
2210 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2211 <p>The serviceUUid to activate</p>
2212 </div></div></td>
2213 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2214 <p>string</p>
2215 </div></div></td>
2216 </tr>
2217 <tr>
2218 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2219 <p><strong>Body</strong></p>
2220 </div></div></td>
2221 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2222 <p><strong>body</strong><br>
2223 <em>optional</em></p>
2224 </div></div></td>
2225 <td class="tableblock halign-left valign-middle"><div></div></td>
2226 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2227 <p>string</p>
2228 </div></div></td>
2229 </tr>
2230 </tbody>
2231 </table>
2232
2233 </div>
2234 <div class="sect3">
2235 <h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a>2.6.3. Responses</h4>
2236 <table class="tableblock frame-all grid-all" style="width:100%; ">
2237 <colgroup>
2238 <col style="width:10%;">
2239 <col style="width:70%;">
2240 <col style="width:20%;">
2241 </colgroup>
2242 <thead>
2243 <tr>
2244 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2245 <th class="tableblock halign-left valign-middle">Description</th>
2246 <th class="tableblock halign-left valign-middle">Schema</th>
2247 </tr>
2248 </thead>
2249 <tbody>
2250 <tr>
2251 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2252 <p><strong>202</strong></p>
2253 </div></div></td>
2254 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2255 <p>ECOMP component is authenticated and required service may be distributed</p>
2256 </div></div></td>
2257 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2258 <p>No Content</p>
2259 </div></div></td>
2260 </tr>
2261 <tr>
2262 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2263 <p><strong>400</strong></p>
2264 </div></div></td>
2265 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2266 <p>The resource name is missing in the request body - SVC4062</p>
2267 </div></div></td>
2268 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2269 <p>No Content</p>
2270 </div></div></td>
2271 </tr>
2272 <tr>
2273 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2274 <p><strong>401</strong></p>
2275 </div></div></td>
2276 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2277 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
2278 </div></div></td>
2279 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2280 <p>No Content</p>
2281 </div></div></td>
2282 </tr>
2283 <tr>
2284 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2285 <p><strong>403</strong></p>
2286 </div></div></td>
2287 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2288 <p>ECOMP component is not authorized - POL5003</p>
2289 </div></div></td>
2290 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2291 <p>No Content</p>
2292 </div></div></td>
2293 </tr>
2294 <tr>
2295 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2296 <p><strong>404</strong></p>
2297 </div></div></td>
2298 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2299 <p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p>
2300 </div></div></td>
2301 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2302 <p>No Content</p>
2303 </div></div></td>
2304 </tr>
2305 <tr>
2306 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2307 <p><strong>405</strong></p>
2308 </div></div></td>
2309 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2310 <p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
2311 </div></div></td>
2312 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2313 <p>No Content</p>
2314 </div></div></td>
2315 </tr>
2316 <tr>
2317 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2318 <p><strong>409</strong></p>
2319 </div></div></td>
2320 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2321 <p>Service state is invalid for this action</p>
2322 </div></div></td>
2323 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2324 <p>No Content</p>
2325 </div></div></td>
2326 </tr>
2327 <tr>
2328 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2329 <p><strong>500</strong></p>
2330 </div></div></td>
2331 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2332 <p>The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
2333 </div></div></td>
2334 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2335 <p>No Content</p>
2336 </div></div></td>
2337 </tr>
2338 <tr>
2339 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2340 <p><strong>502</strong></p>
2341 </div></div></td>
2342 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2343 <p>The server was acting as a gateway or proxy and received an invalid response from the upstream server</p>
2344 </div></div></td>
2345 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2346 <p>No Content</p>
2347 </div></div></td>
2348 </tr>
2349 </tbody>
2350 </table>
2351
2352 </div>
2353 <div class="sect3">
2354 <h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a>2.6.4. Consumes</h4>
2355 <div class="ulist">
2356 <ul>
2357 <li>
2358 <p><code>application/json</code></p>
2359 </li>
2360 </ul>
2361 </div>
2362 </div>
2363 <div class="sect3">
2364 <h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a>2.6.5. Produces</h4>
2365 <div class="ulist">
2366 <ul>
2367 <li>
2368 <p><code>application/json</code></p>
2369 </li>
2370 </ul>
2371 </div>
2372 </div>
2373 <div class="sect3">
2374 <h4 id="_tags_7"><a class="anchor" href="#_tags_7"></a>2.6.6. Tags</h4>
2375 <div class="ulist">
2376 <ul>
2377 <li>
2378 <p>Service Activation External Servlet</p>
2379 </li>
2380 </ul>
2381 </div>
2382 </div>
2383 </div>
2384 <div class="sect2">
2385 <h3 id="_createresourceexternal"><a class="anchor" href="#_createresourceexternal"></a>2.7. creates a resource</h3>
2386 <div class="literalblock">
2387 <div class="content">
2388 <pre>POST /v1/catalog/{assetType}</pre>
2389 </div>
2390 </div>
2391 <div class="sect3">
2392 <h4 id="_description_7"><a class="anchor" href="#_description_7"></a>2.7.1. Description</h4>
2393 <div class="paragraph">
2394 <p>Creates a resource</p>
2395 </div>
2396 </div>
2397 <div class="sect3">
2398 <h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a>2.7.2. Parameters</h4>
2399 <table class="tableblock frame-all grid-all" style="width:100%; ">
2400 <colgroup>
2401 <col style="width:11%;">
2402 <col style="width:16%;">
2403 <col style="width:50%;">
2404 <col style="width:22%;">
2405 </colgroup>
2406 <thead>
2407 <tr>
2408 <th class="tableblock halign-left valign-middle">Type</th>
2409 <th class="tableblock halign-left valign-middle">Name</th>
2410 <th class="tableblock halign-left valign-middle">Description</th>
2411 <th class="tableblock halign-left valign-middle">Schema</th>
2412 </tr>
2413 </thead>
2414 <tbody>
2415 <tr>
2416 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2417 <p><strong>Header</strong></p>
2418 </div></div></td>
2419 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2420 <p><strong>Accept</strong><br>
2421 <em>optional</em></p>
2422 </div></div></td>
2423 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2424 <p>Determines the format of the body of the response</p>
2425 </div></div></td>
2426 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2427 <p>string</p>
2428 </div></div></td>
2429 </tr>
2430 <tr>
2431 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2432 <p><strong>Header</strong></p>
2433 </div></div></td>
2434 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2435 <p><strong>Authorization</strong><br>
2436 <em>required</em></p>
2437 </div></div></td>
2438 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2439 <p>The username and password</p>
2440 </div></div></td>
2441 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2442 <p>string</p>
2443 </div></div></td>
2444 </tr>
2445 <tr>
2446 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2447 <p><strong>Header</strong></p>
2448 </div></div></td>
2449 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2450 <p><strong>Content-Type</strong><br>
2451 <em>required</em></p>
2452 </div></div></td>
2453 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2454 <p>Determines the format of the body of the request</p>
2455 </div></div></td>
2456 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2457 <p>string</p>
2458 </div></div></td>
2459 </tr>
2460 <tr>
2461 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2462 <p><strong>Header</strong></p>
2463 </div></div></td>
2464 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2465 <p><strong>USER_ID</strong><br>
2466 <em>required</em></p>
2467 </div></div></td>
2468 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2469 <p>The user id</p>
2470 </div></div></td>
2471 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2472 <p>string</p>
2473 </div></div></td>
2474 </tr>
2475 <tr>
2476 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2477 <p><strong>Header</strong></p>
2478 </div></div></td>
2479 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2480 <p><strong>X-ECOMP-InstanceID</strong><br>
2481 <em>required</em></p>
2482 </div></div></td>
2483 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2484 <p>X-ECOMP-InstanceID header</p>
2485 </div></div></td>
2486 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2487 <p>string</p>
2488 </div></div></td>
2489 </tr>
2490 <tr>
2491 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2492 <p><strong>Header</strong></p>
2493 </div></div></td>
2494 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2495 <p><strong>X-ECOMP-RequestID</strong><br>
2496 <em>optional</em></p>
2497 </div></div></td>
2498 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2499 <p>X-ECOMP-RequestID header</p>
2500 </div></div></td>
2501 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2502 <p>string</p>
2503 </div></div></td>
2504 </tr>
2505 <tr>
2506 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2507 <p><strong>Path</strong></p>
2508 </div></div></td>
2509 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2510 <p><strong>assetType</strong><br>
2511 <em>required</em></p>
2512 </div></div></td>
2513 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2514 <p>The requested asset type</p>
2515 </div></div></td>
2516 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2517 <p>enum (resources, services)</p>
2518 </div></div></td>
2519 </tr>
2520 <tr>
2521 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2522 <p><strong>Body</strong></p>
2523 </div></div></td>
2524 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2525 <p><strong>body</strong><br>
2526 <em>required</em></p>
2527 </div></div></td>
2528 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2529 <p>json describe the created resource</p>
2530 </div></div></td>
2531 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2532 <p><a href="#_resource">Resource</a></p>
2533 </div></div></td>
2534 </tr>
2535 </tbody>
2536 </table>
2537
2538 </div>
2539 <div class="sect3">
2540 <h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a>2.7.3. Responses</h4>
2541 <table class="tableblock frame-all grid-all" style="width:100%; ">
2542 <colgroup>
2543 <col style="width:10%;">
2544 <col style="width:70%;">
2545 <col style="width:20%;">
2546 </colgroup>
2547 <thead>
2548 <tr>
2549 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2550 <th class="tableblock halign-left valign-middle">Description</th>
2551 <th class="tableblock halign-left valign-middle">Schema</th>
2552 </tr>
2553 </thead>
2554 <tbody>
2555 <tr>
2556 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2557 <p><strong>200</strong></p>
2558 </div></div></td>
2559 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2560 <p>ECOMP component is authenticated and Asset created</p>
2561 </div></div></td>
2562 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2563 <p><a href="#_resource">Resource</a></p>
2564 </div></div></td>
2565 </tr>
2566 <tr>
2567 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2568 <p><strong>400</strong></p>
2569 </div></div></td>
2570 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2571 <p>Create VFCMT request: VFCMT name exceeds character limit - SVC4073</p>
2572 </div></div></td>
2573 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2574 <p>No Content</p>
2575 </div></div></td>
2576 </tr>
2577 <tr>
2578 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2579 <p><strong>401</strong></p>
2580 </div></div></td>
2581 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2582 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
2583 </div></div></td>
2584 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2585 <p>No Content</p>
2586 </div></div></td>
2587 </tr>
2588 <tr>
2589 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2590 <p><strong>403</strong></p>
2591 </div></div></td>
2592 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2593 <p>ECOMP component is not authorized - POL5003</p>
2594 </div></div></td>
2595 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2596 <p>No Content</p>
2597 </div></div></td>
2598 </tr>
2599 <tr>
2600 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2601 <p><strong>404</strong></p>
2602 </div></div></td>
2603 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2604 <p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p>
2605 </div></div></td>
2606 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2607 <p>No Content</p>
2608 </div></div></td>
2609 </tr>
2610 <tr>
2611 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2612 <p><strong>405</strong></p>
2613 </div></div></td>
2614 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2615 <p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
2616 </div></div></td>
2617 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2618 <p>No Content</p>
2619 </div></div></td>
2620 </tr>
2621 <tr>
2622 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2623 <p><strong>500</strong></p>
2624 </div></div></td>
2625 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2626 <p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
2627 </div></div></td>
2628 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2629 <p>No Content</p>
2630 </div></div></td>
2631 </tr>
2632 </tbody>
2633 </table>
2634
2635 </div>
2636 <div class="sect3">
2637 <h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a>2.7.4. Consumes</h4>
2638 <div class="ulist">
2639 <ul>
2640 <li>
2641 <p><code>application/json</code></p>
2642 </li>
2643 </ul>
2644 </div>
2645 </div>
2646 <div class="sect3">
2647 <h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a>2.7.5. Produces</h4>
2648 <div class="ulist">
2649 <ul>
2650 <li>
2651 <p><code>application/json</code></p>
2652 </li>
2653 </ul>
2654 </div>
2655 </div>
2656 <div class="sect3">
2657 <h4 id="_tags_8"><a class="anchor" href="#_tags_8"></a>2.7.6. Tags</h4>
2658 <div class="ulist">
2659 <ul>
2660 <li>
2661 <p>CRUD External Servlet</p>
2662 </li>
2663 </ul>
2664 </div>
2665 </div>
2666 </div>
2667 <div class="sect2">
2668 <h3 id="_getassetlistexternal"><a class="anchor" href="#_getassetlistexternal"></a>2.8. Fetch list of assets</h3>
2669 <div class="literalblock">
2670 <div class="content">
2671 <pre>GET /v1/catalog/{assetType}</pre>
2672 </div>
2673 </div>
2674 <div class="sect3">
2675 <h4 id="_description_8"><a class="anchor" href="#_description_8"></a>2.8.1. Description</h4>
2676 <div class="paragraph">
2677 <p>Returns list of assets</p>
2678 </div>
2679 </div>
2680 <div class="sect3">
2681 <h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a>2.8.2. Parameters</h4>
2682 <table class="tableblock frame-all grid-all" style="width:100%; ">
2683 <colgroup>
2684 <col style="width:11%;">
2685 <col style="width:16%;">
2686 <col style="width:50%;">
2687 <col style="width:22%;">
2688 </colgroup>
2689 <thead>
2690 <tr>
2691 <th class="tableblock halign-left valign-middle">Type</th>
2692 <th class="tableblock halign-left valign-middle">Name</th>
2693 <th class="tableblock halign-left valign-middle">Description</th>
2694 <th class="tableblock halign-left valign-middle">Schema</th>
2695 </tr>
2696 </thead>
2697 <tbody>
2698 <tr>
2699 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2700 <p><strong>Header</strong></p>
2701 </div></div></td>
2702 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2703 <p><strong>Accept</strong><br>
2704 <em>optional</em></p>
2705 </div></div></td>
2706 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2707 <p>Determines the format of the body of the response</p>
2708 </div></div></td>
2709 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2710 <p>string</p>
2711 </div></div></td>
2712 </tr>
2713 <tr>
2714 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2715 <p><strong>Header</strong></p>
2716 </div></div></td>
2717 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2718 <p><strong>Authorization</strong><br>
2719 <em>required</em></p>
2720 </div></div></td>
2721 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2722 <p>The username and password</p>
2723 </div></div></td>
2724 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2725 <p>string</p>
2726 </div></div></td>
2727 </tr>
2728 <tr>
2729 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2730 <p><strong>Header</strong></p>
2731 </div></div></td>
2732 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2733 <p><strong>X-ECOMP-InstanceID</strong><br>
2734 <em>required</em></p>
2735 </div></div></td>
2736 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2737 <p>X-ECOMP-InstanceID header</p>
2738 </div></div></td>
2739 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2740 <p>string</p>
2741 </div></div></td>
2742 </tr>
2743 <tr>
2744 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2745 <p><strong>Header</strong></p>
2746 </div></div></td>
2747 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2748 <p><strong>X-ECOMP-RequestID</strong><br>
2749 <em>optional</em></p>
2750 </div></div></td>
2751 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2752 <p>X-ECOMP-RequestID header</p>
2753 </div></div></td>
2754 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2755 <p>string</p>
2756 </div></div></td>
2757 </tr>
2758 <tr>
2759 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2760 <p><strong>Path</strong></p>
2761 </div></div></td>
2762 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2763 <p><strong>assetType</strong><br>
2764 <em>required</em></p>
2765 </div></div></td>
2766 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2767 <p>The requested asset type</p>
2768 </div></div></td>
2769 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2770 <p>enum (resources, services)</p>
2771 </div></div></td>
2772 </tr>
2773 <tr>
2774 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2775 <p><strong>Query</strong></p>
2776 </div></div></td>
2777 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2778 <p><strong>category</strong><br>
2779 <em>optional</em></p>
2780 </div></div></td>
2781 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2782 <p>The filter key (resourceType only for resources)</p>
2783 </div></div></td>
2784 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2785 <p>string</p>
2786 </div></div></td>
2787 </tr>
2788 <tr>
2789 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2790 <p><strong>Query</strong></p>
2791 </div></div></td>
2792 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2793 <p><strong>distributionStatus</strong><br>
2794 <em>optional</em></p>
2795 </div></div></td>
2796 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2797 <p>The filter key (resourceType only for resources)</p>
2798 </div></div></td>
2799 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2800 <p>string</p>
2801 </div></div></td>
2802 </tr>
2803 <tr>
2804 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2805 <p><strong>Query</strong></p>
2806 </div></div></td>
2807 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2808 <p><strong>resourceType</strong><br>
2809 <em>optional</em></p>
2810 </div></div></td>
2811 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2812 <p>The filter key (resourceType only for resources)</p>
2813 </div></div></td>
2814 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2815 <p>string</p>
2816 </div></div></td>
2817 </tr>
2818 <tr>
2819 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2820 <p><strong>Query</strong></p>
2821 </div></div></td>
2822 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2823 <p><strong>subCategory</strong><br>
2824 <em>optional</em></p>
2825 </div></div></td>
2826 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2827 <p>The filter key (resourceType only for resources)</p>
2828 </div></div></td>
2829 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2830 <p>string</p>
2831 </div></div></td>
2832 </tr>
2833 </tbody>
2834 </table>
2835
2836 </div>
2837 <div class="sect3">
2838 <h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a>2.8.3. Responses</h4>
2839 <table class="tableblock frame-all grid-all" style="width:100%; ">
2840 <colgroup>
2841 <col style="width:10%;">
2842 <col style="width:70%;">
2843 <col style="width:20%;">
2844 </colgroup>
2845 <thead>
2846 <tr>
2847 <th class="tableblock halign-left valign-middle">HTTP Code</th>
2848 <th class="tableblock halign-left valign-middle">Description</th>
2849 <th class="tableblock halign-left valign-middle">Schema</th>
2850 </tr>
2851 </thead>
2852 <tbody>
2853 <tr>
2854 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2855 <p><strong>200</strong></p>
2856 </div></div></td>
2857 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2858 <p>ECOMP component is authenticated and list of Catalog Assets Metadata is returned</p>
2859 </div></div></td>
2860 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2861 <p>&lt; <a href="#_assetmetadata">AssetMetadata</a> &gt; array</p>
2862 </div></div></td>
2863 </tr>
2864 <tr>
2865 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2866 <p><strong>400</strong></p>
2867 </div></div></td>
2868 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2869 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
2870 </div></div></td>
2871 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2872 <p>No Content</p>
2873 </div></div></td>
2874 </tr>
2875 <tr>
2876 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2877 <p><strong>401</strong></p>
2878 </div></div></td>
2879 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2880 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
2881 </div></div></td>
2882 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2883 <p>No Content</p>
2884 </div></div></td>
2885 </tr>
2886 <tr>
2887 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2888 <p><strong>403</strong></p>
2889 </div></div></td>
2890 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2891 <p>ECOMP component is not authorized - POL5003</p>
2892 </div></div></td>
2893 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2894 <p>No Content</p>
2895 </div></div></td>
2896 </tr>
2897 <tr>
2898 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2899 <p><strong>405</strong></p>
2900 </div></div></td>
2901 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2902 <p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
2903 </div></div></td>
2904 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2905 <p>No Content</p>
2906 </div></div></td>
2907 </tr>
2908 <tr>
2909 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2910 <p><strong>500</strong></p>
2911 </div></div></td>
2912 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2913 <p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
2914 </div></div></td>
2915 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2916 <p>No Content</p>
2917 </div></div></td>
2918 </tr>
2919 </tbody>
2920 </table>
2921
2922 </div>
2923 <div class="sect3">
2924 <h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a>2.8.4. Produces</h4>
2925 <div class="ulist">
2926 <ul>
2927 <li>
2928 <p><code>application/json</code></p>
2929 </li>
2930 </ul>
2931 </div>
2932 </div>
2933 <div class="sect3">
2934 <h4 id="_tags_9"><a class="anchor" href="#_tags_9"></a>2.8.5. Tags</h4>
2935 <div class="ulist">
2936 <ul>
2937 <li>
2938 <p>Asset Metadata External Servlet</p>
2939 </li>
2940 </ul>
2941 </div>
2942 </div>
2943 </div>
2944 <div class="sect2">
2945 <h3 id="_uploadartifact"><a class="anchor" href="#_uploadartifact"></a>2.9. uploads of artifact to a resource or service</h3>
2946 <div class="literalblock">
2947 <div class="content">
2948 <pre>POST /v1/catalog/{assetType}/{uuid}/artifacts</pre>
2949 </div>
2950 </div>
2951 <div class="sect3">
2952 <h4 id="_description_9"><a class="anchor" href="#_description_9"></a>2.9.1. Description</h4>
2953 <div class="paragraph">
2954 <p>uploads of artifact to a resource or service</p>
2955 </div>
2956 </div>
2957 <div class="sect3">
2958 <h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a>2.9.2. Parameters</h4>
2959 <table class="tableblock frame-all grid-all" style="width:100%; ">
2960 <colgroup>
2961 <col style="width:11%;">
2962 <col style="width:16%;">
2963 <col style="width:50%;">
2964 <col style="width:22%;">
2965 </colgroup>
2966 <thead>
2967 <tr>
2968 <th class="tableblock halign-left valign-middle">Type</th>
2969 <th class="tableblock halign-left valign-middle">Name</th>
2970 <th class="tableblock halign-left valign-middle">Description</th>
2971 <th class="tableblock halign-left valign-middle">Schema</th>
2972 </tr>
2973 </thead>
2974 <tbody>
2975 <tr>
2976 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2977 <p><strong>Header</strong></p>
2978 </div></div></td>
2979 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2980 <p><strong>Accept</strong><br>
2981 <em>optional</em></p>
2982 </div></div></td>
2983 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2984 <p>Determines the format of the body of the response</p>
2985 </div></div></td>
2986 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2987 <p>string</p>
2988 </div></div></td>
2989 </tr>
2990 <tr>
2991 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2992 <p><strong>Header</strong></p>
2993 </div></div></td>
2994 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2995 <p><strong>Authorization</strong><br>
2996 <em>required</em></p>
2997 </div></div></td>
2998 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
2999 <p>The username and password</p>
3000 </div></div></td>
3001 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3002 <p>string</p>
3003 </div></div></td>
3004 </tr>
3005 <tr>
3006 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3007 <p><strong>Header</strong></p>
3008 </div></div></td>
3009 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3010 <p><strong>Content-MD5</strong><br>
3011 <em>required</em></p>
3012 </div></div></td>
3013 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3014 <p>The value for this header must be the MD5 checksum over the whole json body</p>
3015 </div></div></td>
3016 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3017 <p>string</p>
3018 </div></div></td>
3019 </tr>
3020 <tr>
3021 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3022 <p><strong>Header</strong></p>
3023 </div></div></td>
3024 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3025 <p><strong>Content-Type</strong><br>
3026 <em>required</em></p>
3027 </div></div></td>
3028 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3029 <p>Determines the format of the body of the request</p>
3030 </div></div></td>
3031 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3032 <p>string</p>
3033 </div></div></td>
3034 </tr>
3035 <tr>
3036 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3037 <p><strong>Header</strong></p>
3038 </div></div></td>
3039 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3040 <p><strong>USER_ID</strong><br>
3041 <em>required</em></p>
3042 </div></div></td>
3043 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3044 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
3045 </div></div></td>
3046 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3047 <p>string</p>
3048 </div></div></td>
3049 </tr>
3050 <tr>
3051 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3052 <p><strong>Header</strong></p>
3053 </div></div></td>
3054 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3055 <p><strong>X-ECOMP-InstanceID</strong><br>
3056 <em>required</em></p>
3057 </div></div></td>
3058 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3059 <p>X-ECOMP-InstanceID header</p>
3060 </div></div></td>
3061 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3062 <p>string</p>
3063 </div></div></td>
3064 </tr>
3065 <tr>
3066 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3067 <p><strong>Header</strong></p>
3068 </div></div></td>
3069 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3070 <p><strong>X-ECOMP-RequestID</strong><br>
3071 <em>optional</em></p>
3072 </div></div></td>
3073 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3074 <p>X-ECOMP-RequestID header</p>
3075 </div></div></td>
3076 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3077 <p>string</p>
3078 </div></div></td>
3079 </tr>
3080 <tr>
3081 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3082 <p><strong>Path</strong></p>
3083 </div></div></td>
3084 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3085 <p><strong>assetType</strong><br>
3086 <em>required</em></p>
3087 </div></div></td>
3088 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3089 <p>The requested asset type</p>
3090 </div></div></td>
3091 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3092 <p>enum (resources, services)</p>
3093 </div></div></td>
3094 </tr>
3095 <tr>
3096 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3097 <p><strong>Path</strong></p>
3098 </div></div></td>
3099 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3100 <p><strong>uuid</strong><br>
3101 <em>required</em></p>
3102 </div></div></td>
3103 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3104 <p>The uuid of the asset as published in the metadata</p>
3105 </div></div></td>
3106 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3107 <p>string</p>
3108 </div></div></td>
3109 </tr>
3110 <tr>
3111 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3112 <p><strong>Body</strong></p>
3113 </div></div></td>
3114 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3115 <p><strong>body</strong><br>
3116 <em>required</em></p>
3117 </div></div></td>
3118 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3119 <p>json describe the artifact</p>
3120 </div></div></td>
3121 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3122 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
3123 </div></div></td>
3124 </tr>
3125 </tbody>
3126 </table>
3127
3128 </div>
3129 <div class="sect3">
3130 <h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a>2.9.3. Responses</h4>
3131 <table class="tableblock frame-all grid-all" style="width:100%; ">
3132 <colgroup>
3133 <col style="width:10%;">
3134 <col style="width:70%;">
3135 <col style="width:20%;">
3136 </colgroup>
3137 <thead>
3138 <tr>
3139 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3140 <th class="tableblock halign-left valign-middle">Description</th>
3141 <th class="tableblock halign-left valign-middle">Schema</th>
3142 </tr>
3143 </thead>
3144 <tbody>
3145 <tr>
3146 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3147 <p><strong>200</strong></p>
3148 </div></div></td>
3149 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3150 <p>Artifact uploaded</p>
3151 </div></div></td>
3152 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3153 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
3154 </div></div></td>
3155 </tr>
3156 <tr>
3157 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3158 <p><strong>400</strong></p>
3159 </div></div></td>
3160 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3161 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
3162 </div></div></td>
3163 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3164 <p>No Content</p>
3165 </div></div></td>
3166 </tr>
3167 <tr>
3168 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3169 <p><strong>401</strong></p>
3170 </div></div></td>
3171 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3172 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
3173 </div></div></td>
3174 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3175 <p>No Content</p>
3176 </div></div></td>
3177 </tr>
3178 <tr>
3179 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3180 <p><strong>403</strong></p>
3181 </div></div></td>
3182 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3183 <p>ECOMP component is not authorized - POL5003</p>
3184 </div></div></td>
3185 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3186 <p>No Content</p>
3187 </div></div></td>
3188 </tr>
3189 <tr>
3190 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3191 <p><strong>404</strong></p>
3192 </div></div></td>
3193 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3194 <p>Specified resource is not found - SVC4063</p>
3195 </div></div></td>
3196 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3197 <p>No Content</p>
3198 </div></div></td>
3199 </tr>
3200 <tr>
3201 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3202 <p><strong>405</strong></p>
3203 </div></div></td>
3204 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3205 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
3206 </div></div></td>
3207 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3208 <p>No Content</p>
3209 </div></div></td>
3210 </tr>
3211 <tr>
3212 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3213 <p><strong>500</strong></p>
3214 </div></div></td>
3215 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3216 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
3217 </div></div></td>
3218 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3219 <p>No Content</p>
3220 </div></div></td>
3221 </tr>
3222 </tbody>
3223 </table>
3224
3225 </div>
3226 <div class="sect3">
3227 <h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a>2.9.4. Produces</h4>
3228 <div class="ulist">
3229 <ul>
3230 <li>
3231 <p><code>application/json</code></p>
3232 </li>
3233 </ul>
3234 </div>
3235 </div>
3236 <div class="sect3">
3237 <h4 id="_tags_10"><a class="anchor" href="#_tags_10"></a>2.9.5. Tags</h4>
3238 <div class="ulist">
3239 <ul>
3240 <li>
3241 <p>Artifact External Servlet</p>
3242 </li>
3243 </ul>
3244 </div>
3245 </div>
3246 </div>
3247 <div class="sect2">
3248 <h3 id="_updateartifact"><a class="anchor" href="#_updateartifact"></a>2.10. updates an artifact on a resource or service</h3>
3249 <div class="literalblock">
3250 <div class="content">
3251 <pre>POST /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}</pre>
3252 </div>
3253 </div>
3254 <div class="sect3">
3255 <h4 id="_description_10"><a class="anchor" href="#_description_10"></a>2.10.1. Description</h4>
3256 <div class="paragraph">
3257 <p>uploads of artifact to a resource or service</p>
3258 </div>
3259 </div>
3260 <div class="sect3">
3261 <h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a>2.10.2. Parameters</h4>
3262 <table class="tableblock frame-all grid-all" style="width:100%; ">
3263 <colgroup>
3264 <col style="width:11%;">
3265 <col style="width:16%;">
3266 <col style="width:50%;">
3267 <col style="width:22%;">
3268 </colgroup>
3269 <thead>
3270 <tr>
3271 <th class="tableblock halign-left valign-middle">Type</th>
3272 <th class="tableblock halign-left valign-middle">Name</th>
3273 <th class="tableblock halign-left valign-middle">Description</th>
3274 <th class="tableblock halign-left valign-middle">Schema</th>
3275 </tr>
3276 </thead>
3277 <tbody>
3278 <tr>
3279 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3280 <p><strong>Header</strong></p>
3281 </div></div></td>
3282 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3283 <p><strong>Accept</strong><br>
3284 <em>optional</em></p>
3285 </div></div></td>
3286 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3287 <p>Determines the format of the body of the response</p>
3288 </div></div></td>
3289 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3290 <p>string</p>
3291 </div></div></td>
3292 </tr>
3293 <tr>
3294 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3295 <p><strong>Header</strong></p>
3296 </div></div></td>
3297 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3298 <p><strong>Authorization</strong><br>
3299 <em>required</em></p>
3300 </div></div></td>
3301 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3302 <p>The username and password</p>
3303 </div></div></td>
3304 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3305 <p>string</p>
3306 </div></div></td>
3307 </tr>
3308 <tr>
3309 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3310 <p><strong>Header</strong></p>
3311 </div></div></td>
3312 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3313 <p><strong>Content-MD5</strong><br>
3314 <em>required</em></p>
3315 </div></div></td>
3316 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3317 <p>The value for this header must be the MD5 checksum over the whole json body</p>
3318 </div></div></td>
3319 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3320 <p>string</p>
3321 </div></div></td>
3322 </tr>
3323 <tr>
3324 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3325 <p><strong>Header</strong></p>
3326 </div></div></td>
3327 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3328 <p><strong>Content-Type</strong><br>
3329 <em>required</em></p>
3330 </div></div></td>
3331 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3332 <p>Determines the format of the body of the request</p>
3333 </div></div></td>
3334 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3335 <p>string</p>
3336 </div></div></td>
3337 </tr>
3338 <tr>
3339 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3340 <p><strong>Header</strong></p>
3341 </div></div></td>
3342 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3343 <p><strong>USER_ID</strong><br>
3344 <em>required</em></p>
3345 </div></div></td>
3346 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3347 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
3348 </div></div></td>
3349 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3350 <p>string</p>
3351 </div></div></td>
3352 </tr>
3353 <tr>
3354 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3355 <p><strong>Header</strong></p>
3356 </div></div></td>
3357 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3358 <p><strong>X-ECOMP-InstanceID</strong><br>
3359 <em>required</em></p>
3360 </div></div></td>
3361 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3362 <p>X-ECOMP-InstanceID header</p>
3363 </div></div></td>
3364 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3365 <p>string</p>
3366 </div></div></td>
3367 </tr>
3368 <tr>
3369 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3370 <p><strong>Header</strong></p>
3371 </div></div></td>
3372 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3373 <p><strong>X-ECOMP-RequestID</strong><br>
3374 <em>optional</em></p>
3375 </div></div></td>
3376 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3377 <p>X-ECOMP-RequestID header</p>
3378 </div></div></td>
3379 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3380 <p>string</p>
3381 </div></div></td>
3382 </tr>
3383 <tr>
3384 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3385 <p><strong>Path</strong></p>
3386 </div></div></td>
3387 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3388 <p><strong>artifactUUID</strong><br>
3389 <em>required</em></p>
3390 </div></div></td>
3391 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3392 <p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p>
3393 </div></div></td>
3394 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3395 <p>string</p>
3396 </div></div></td>
3397 </tr>
3398 <tr>
3399 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3400 <p><strong>Path</strong></p>
3401 </div></div></td>
3402 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3403 <p><strong>assetType</strong><br>
3404 <em>required</em></p>
3405 </div></div></td>
3406 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3407 <p>The requested asset type</p>
3408 </div></div></td>
3409 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3410 <p>enum (resources, services)</p>
3411 </div></div></td>
3412 </tr>
3413 <tr>
3414 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3415 <p><strong>Path</strong></p>
3416 </div></div></td>
3417 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3418 <p><strong>uuid</strong><br>
3419 <em>required</em></p>
3420 </div></div></td>
3421 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3422 <p>The uuid of the asset as published in the metadata</p>
3423 </div></div></td>
3424 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3425 <p>string</p>
3426 </div></div></td>
3427 </tr>
3428 <tr>
3429 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3430 <p><strong>Body</strong></p>
3431 </div></div></td>
3432 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3433 <p><strong>body</strong><br>
3434 <em>required</em></p>
3435 </div></div></td>
3436 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3437 <p>json describe the artifact</p>
3438 </div></div></td>
3439 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3440 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
3441 </div></div></td>
3442 </tr>
3443 </tbody>
3444 </table>
3445
3446 </div>
3447 <div class="sect3">
3448 <h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a>2.10.3. Responses</h4>
3449 <table class="tableblock frame-all grid-all" style="width:100%; ">
3450 <colgroup>
3451 <col style="width:10%;">
3452 <col style="width:70%;">
3453 <col style="width:20%;">
3454 </colgroup>
3455 <thead>
3456 <tr>
3457 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3458 <th class="tableblock halign-left valign-middle">Description</th>
3459 <th class="tableblock halign-left valign-middle">Schema</th>
3460 </tr>
3461 </thead>
3462 <tbody>
3463 <tr>
3464 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3465 <p><strong>200</strong></p>
3466 </div></div></td>
3467 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3468 <p>Artifact updated</p>
3469 </div></div></td>
3470 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3471 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
3472 </div></div></td>
3473 </tr>
3474 <tr>
3475 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3476 <p><strong>400</strong></p>
3477 </div></div></td>
3478 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3479 <p>Artifact name is missing in input - SVC4128</p>
3480 </div></div></td>
3481 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3482 <p>No Content</p>
3483 </div></div></td>
3484 </tr>
3485 <tr>
3486 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3487 <p><strong>401</strong></p>
3488 </div></div></td>
3489 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3490 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
3491 </div></div></td>
3492 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3493 <p>No Content</p>
3494 </div></div></td>
3495 </tr>
3496 <tr>
3497 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3498 <p><strong>403</strong></p>
3499 </div></div></td>
3500 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3501 <p>Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086</p>
3502 </div></div></td>
3503 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3504 <p>No Content</p>
3505 </div></div></td>
3506 </tr>
3507 <tr>
3508 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3509 <p><strong>404</strong></p>
3510 </div></div></td>
3511 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3512 <p>Specified resource is not found - SVC4063</p>
3513 </div></div></td>
3514 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3515 <p>No Content</p>
3516 </div></div></td>
3517 </tr>
3518 <tr>
3519 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3520 <p><strong>405</strong></p>
3521 </div></div></td>
3522 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3523 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
3524 </div></div></td>
3525 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3526 <p>No Content</p>
3527 </div></div></td>
3528 </tr>
3529 <tr>
3530 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3531 <p><strong>409</strong></p>
3532 </div></div></td>
3533 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3534 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
3535 </div></div></td>
3536 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3537 <p>No Content</p>
3538 </div></div></td>
3539 </tr>
3540 <tr>
3541 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3542 <p><strong>500</strong></p>
3543 </div></div></td>
3544 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3545 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
3546 </div></div></td>
3547 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3548 <p>No Content</p>
3549 </div></div></td>
3550 </tr>
3551 </tbody>
3552 </table>
3553
3554 </div>
3555 <div class="sect3">
3556 <h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a>2.10.4. Produces</h4>
3557 <div class="ulist">
3558 <ul>
3559 <li>
3560 <p><code>application/json</code></p>
3561 </li>
3562 </ul>
3563 </div>
3564 </div>
3565 <div class="sect3">
3566 <h4 id="_tags_11"><a class="anchor" href="#_tags_11"></a>2.10.5. Tags</h4>
3567 <div class="ulist">
3568 <ul>
3569 <li>
3570 <p>Artifact External Servlet</p>
3571 </li>
3572 </ul>
3573 </div>
3574 </div>
3575 </div>
3576 <div class="sect2">
3577 <h3 id="_downloadcomponentartifact"><a class="anchor" href="#_downloadcomponentartifact"></a>2.11. Download component artifact</h3>
3578 <div class="literalblock">
3579 <div class="content">
3580 <pre>GET /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}</pre>
3581 </div>
3582 </div>
3583 <div class="sect3">
3584 <h4 id="_description_11"><a class="anchor" href="#_description_11"></a>2.11.1. Description</h4>
3585 <div class="paragraph">
3586 <p>Returns downloaded artifact</p>
3587 </div>
3588 </div>
3589 <div class="sect3">
3590 <h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a>2.11.2. Parameters</h4>
3591 <table class="tableblock frame-all grid-all" style="width:100%; ">
3592 <colgroup>
3593 <col style="width:11%;">
3594 <col style="width:16%;">
3595 <col style="width:50%;">
3596 <col style="width:22%;">
3597 </colgroup>
3598 <thead>
3599 <tr>
3600 <th class="tableblock halign-left valign-middle">Type</th>
3601 <th class="tableblock halign-left valign-middle">Name</th>
3602 <th class="tableblock halign-left valign-middle">Description</th>
3603 <th class="tableblock halign-left valign-middle">Schema</th>
3604 </tr>
3605 </thead>
3606 <tbody>
3607 <tr>
3608 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3609 <p><strong>Header</strong></p>
3610 </div></div></td>
3611 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3612 <p><strong>Accept</strong><br>
3613 <em>optional</em></p>
3614 </div></div></td>
3615 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3616 <p>Determines the format of the body of the response</p>
3617 </div></div></td>
3618 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3619 <p>string</p>
3620 </div></div></td>
3621 </tr>
3622 <tr>
3623 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3624 <p><strong>Header</strong></p>
3625 </div></div></td>
3626 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3627 <p><strong>Authorization</strong><br>
3628 <em>required</em></p>
3629 </div></div></td>
3630 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3631 <p>The username and password</p>
3632 </div></div></td>
3633 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3634 <p>string</p>
3635 </div></div></td>
3636 </tr>
3637 <tr>
3638 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3639 <p><strong>Header</strong></p>
3640 </div></div></td>
3641 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3642 <p><strong>USER_ID</strong><br>
3643 <em>required</em></p>
3644 </div></div></td>
3645 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3646 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
3647 </div></div></td>
3648 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3649 <p>string</p>
3650 </div></div></td>
3651 </tr>
3652 <tr>
3653 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3654 <p><strong>Header</strong></p>
3655 </div></div></td>
3656 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3657 <p><strong>X-ECOMP-InstanceID</strong><br>
3658 <em>required</em></p>
3659 </div></div></td>
3660 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3661 <p>X-ECOMP-InstanceID header</p>
3662 </div></div></td>
3663 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3664 <p>string</p>
3665 </div></div></td>
3666 </tr>
3667 <tr>
3668 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3669 <p><strong>Header</strong></p>
3670 </div></div></td>
3671 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3672 <p><strong>X-ECOMP-RequestID</strong><br>
3673 <em>optional</em></p>
3674 </div></div></td>
3675 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3676 <p>X-ECOMP-RequestID header</p>
3677 </div></div></td>
3678 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3679 <p>string</p>
3680 </div></div></td>
3681 </tr>
3682 <tr>
3683 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3684 <p><strong>Path</strong></p>
3685 </div></div></td>
3686 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3687 <p><strong>artifactUUID</strong><br>
3688 <em>required</em></p>
3689 </div></div></td>
3690 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3691 <p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p>
3692 </div></div></td>
3693 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3694 <p>string</p>
3695 </div></div></td>
3696 </tr>
3697 <tr>
3698 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3699 <p><strong>Path</strong></p>
3700 </div></div></td>
3701 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3702 <p><strong>assetType</strong><br>
3703 <em>required</em></p>
3704 </div></div></td>
3705 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3706 <p>The requested asset type</p>
3707 </div></div></td>
3708 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3709 <p>enum (resources, services)</p>
3710 </div></div></td>
3711 </tr>
3712 <tr>
3713 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3714 <p><strong>Path</strong></p>
3715 </div></div></td>
3716 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3717 <p><strong>uuid</strong><br>
3718 <em>required</em></p>
3719 </div></div></td>
3720 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3721 <p>The uuid of the asset as published in the metadata</p>
3722 </div></div></td>
3723 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3724 <p>string</p>
3725 </div></div></td>
3726 </tr>
3727 </tbody>
3728 </table>
3729
3730 </div>
3731 <div class="sect3">
3732 <h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a>2.11.3. Responses</h4>
3733 <table class="tableblock frame-all grid-all" style="width:100%; ">
3734 <colgroup>
3735 <col style="width:10%;">
3736 <col style="width:70%;">
3737 <col style="width:20%;">
3738 </colgroup>
3739 <thead>
3740 <tr>
3741 <th class="tableblock halign-left valign-middle">HTTP Code</th>
3742 <th class="tableblock halign-left valign-middle">Description</th>
3743 <th class="tableblock halign-left valign-middle">Schema</th>
3744 </tr>
3745 </thead>
3746 <tbody>
3747 <tr>
3748 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3749 <p><strong>200</strong></p>
3750 </div></div></td>
3751 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3752 <p>Artifact downloaded</p>
3753 </div></div></td>
3754 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3755 <p>string</p>
3756 </div></div></td>
3757 </tr>
3758 <tr>
3759 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3760 <p><strong>400</strong></p>
3761 </div></div></td>
3762 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3763 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
3764 </div></div></td>
3765 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3766 <p>No Content</p>
3767 </div></div></td>
3768 </tr>
3769 <tr>
3770 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3771 <p><strong>401</strong></p>
3772 </div></div></td>
3773 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3774 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
3775 </div></div></td>
3776 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3777 <p>No Content</p>
3778 </div></div></td>
3779 </tr>
3780 <tr>
3781 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3782 <p><strong>403</strong></p>
3783 </div></div></td>
3784 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3785 <p>ECOMP component is not authorized - POL5003</p>
3786 </div></div></td>
3787 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3788 <p>No Content</p>
3789 </div></div></td>
3790 </tr>
3791 <tr>
3792 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3793 <p><strong>404</strong></p>
3794 </div></div></td>
3795 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3796 <p>Artifact was not found - SVC4505</p>
3797 </div></div></td>
3798 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3799 <p>No Content</p>
3800 </div></div></td>
3801 </tr>
3802 <tr>
3803 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3804 <p><strong>405</strong></p>
3805 </div></div></td>
3806 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3807 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
3808 </div></div></td>
3809 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3810 <p>No Content</p>
3811 </div></div></td>
3812 </tr>
3813 <tr>
3814 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3815 <p><strong>500</strong></p>
3816 </div></div></td>
3817 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3818 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
3819 </div></div></td>
3820 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3821 <p>No Content</p>
3822 </div></div></td>
3823 </tr>
3824 </tbody>
3825 </table>
3826
3827 </div>
3828 <div class="sect3">
3829 <h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a>2.11.4. Produces</h4>
3830 <div class="ulist">
3831 <ul>
3832 <li>
3833 <p><code>application/octet-stream</code></p>
3834 </li>
3835 </ul>
3836 </div>
3837 </div>
3838 <div class="sect3">
3839 <h4 id="_tags_12"><a class="anchor" href="#_tags_12"></a>2.11.5. Tags</h4>
3840 <div class="ulist">
3841 <ul>
3842 <li>
3843 <p>Artifact External Servlet</p>
3844 </li>
3845 </ul>
3846 </div>
3847 </div>
3848 </div>
3849 <div class="sect2">
3850 <h3 id="_deleteartifact"><a class="anchor" href="#_deleteartifact"></a>2.12. deletes an artifact of a resource or service</h3>
3851 <div class="literalblock">
3852 <div class="content">
3853 <pre>DELETE /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}</pre>
3854 </div>
3855 </div>
3856 <div class="sect3">
3857 <h4 id="_description_12"><a class="anchor" href="#_description_12"></a>2.12.1. Description</h4>
3858 <div class="paragraph">
3859 <p>deletes an artifact of a resource or service</p>
3860 </div>
3861 </div>
3862 <div class="sect3">
3863 <h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a>2.12.2. Parameters</h4>
3864 <table class="tableblock frame-all grid-all" style="width:100%; ">
3865 <colgroup>
3866 <col style="width:11%;">
3867 <col style="width:16%;">
3868 <col style="width:50%;">
3869 <col style="width:22%;">
3870 </colgroup>
3871 <thead>
3872 <tr>
3873 <th class="tableblock halign-left valign-middle">Type</th>
3874 <th class="tableblock halign-left valign-middle">Name</th>
3875 <th class="tableblock halign-left valign-middle">Description</th>
3876 <th class="tableblock halign-left valign-middle">Schema</th>
3877 </tr>
3878 </thead>
3879 <tbody>
3880 <tr>
3881 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3882 <p><strong>Header</strong></p>
3883 </div></div></td>
3884 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3885 <p><strong>Accept</strong><br>
3886 <em>optional</em></p>
3887 </div></div></td>
3888 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3889 <p>Determines the format of the body of the response</p>
3890 </div></div></td>
3891 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3892 <p>string</p>
3893 </div></div></td>
3894 </tr>
3895 <tr>
3896 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3897 <p><strong>Header</strong></p>
3898 </div></div></td>
3899 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3900 <p><strong>Authorization</strong><br>
3901 <em>required</em></p>
3902 </div></div></td>
3903 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3904 <p>The username and password</p>
3905 </div></div></td>
3906 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3907 <p>string</p>
3908 </div></div></td>
3909 </tr>
3910 <tr>
3911 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3912 <p><strong>Header</strong></p>
3913 </div></div></td>
3914 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3915 <p><strong>USER_ID</strong><br>
3916 <em>required</em></p>
3917 </div></div></td>
3918 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3919 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
3920 </div></div></td>
3921 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3922 <p>string</p>
3923 </div></div></td>
3924 </tr>
3925 <tr>
3926 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3927 <p><strong>Header</strong></p>
3928 </div></div></td>
3929 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3930 <p><strong>X-ECOMP-InstanceID</strong><br>
3931 <em>required</em></p>
3932 </div></div></td>
3933 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3934 <p>X-ECOMP-InstanceID header</p>
3935 </div></div></td>
3936 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3937 <p>string</p>
3938 </div></div></td>
3939 </tr>
3940 <tr>
3941 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3942 <p><strong>Header</strong></p>
3943 </div></div></td>
3944 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3945 <p><strong>X-ECOMP-RequestID</strong><br>
3946 <em>optional</em></p>
3947 </div></div></td>
3948 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3949 <p>X-ECOMP-RequestID header</p>
3950 </div></div></td>
3951 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3952 <p>string</p>
3953 </div></div></td>
3954 </tr>
3955 <tr>
3956 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3957 <p><strong>Path</strong></p>
3958 </div></div></td>
3959 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3960 <p><strong>artifactUUID</strong><br>
3961 <em>required</em></p>
3962 </div></div></td>
3963 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3964 <p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p>
3965 </div></div></td>
3966 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3967 <p>string</p>
3968 </div></div></td>
3969 </tr>
3970 <tr>
3971 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3972 <p><strong>Path</strong></p>
3973 </div></div></td>
3974 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3975 <p><strong>assetType</strong><br>
3976 <em>required</em></p>
3977 </div></div></td>
3978 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3979 <p>The requested asset type</p>
3980 </div></div></td>
3981 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3982 <p>enum (resources, services)</p>
3983 </div></div></td>
3984 </tr>
3985 <tr>
3986 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3987 <p><strong>Path</strong></p>
3988 </div></div></td>
3989 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3990 <p><strong>uuid</strong><br>
3991 <em>required</em></p>
3992 </div></div></td>
3993 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3994 <p>The uuid of the asset as published in the metadata</p>
3995 </div></div></td>
3996 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
3997 <p>string</p>
3998 </div></div></td>
3999 </tr>
4000 </tbody>
4001 </table>
4002
4003 </div>
4004 <div class="sect3">
4005 <h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a>2.12.3. Responses</h4>
4006 <table class="tableblock frame-all grid-all" style="width:100%; ">
4007 <colgroup>
4008 <col style="width:10%;">
4009 <col style="width:70%;">
4010 <col style="width:20%;">
4011 </colgroup>
4012 <thead>
4013 <tr>
4014 <th class="tableblock halign-left valign-middle">HTTP Code</th>
4015 <th class="tableblock halign-left valign-middle">Description</th>
4016 <th class="tableblock halign-left valign-middle">Schema</th>
4017 </tr>
4018 </thead>
4019 <tbody>
4020 <tr>
4021 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4022 <p><strong>200</strong></p>
4023 </div></div></td>
4024 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4025 <p>Artifact deleted</p>
4026 </div></div></td>
4027 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4028 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
4029 </div></div></td>
4030 </tr>
4031 <tr>
4032 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4033 <p><strong>400</strong></p>
4034 </div></div></td>
4035 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4036 <p>Artifact name is missing in input - SVC4128</p>
4037 </div></div></td>
4038 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4039 <p>No Content</p>
4040 </div></div></td>
4041 </tr>
4042 <tr>
4043 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4044 <p><strong>401</strong></p>
4045 </div></div></td>
4046 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4047 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
4048 </div></div></td>
4049 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4050 <p>No Content</p>
4051 </div></div></td>
4052 </tr>
4053 <tr>
4054 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4055 <p><strong>403</strong></p>
4056 </div></div></td>
4057 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4058 <p>Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086</p>
4059 </div></div></td>
4060 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4061 <p>No Content</p>
4062 </div></div></td>
4063 </tr>
4064 <tr>
4065 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4066 <p><strong>404</strong></p>
4067 </div></div></td>
4068 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4069 <p>Specified resource is not found - SVC4063</p>
4070 </div></div></td>
4071 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4072 <p>No Content</p>
4073 </div></div></td>
4074 </tr>
4075 <tr>
4076 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4077 <p><strong>405</strong></p>
4078 </div></div></td>
4079 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4080 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
4081 </div></div></td>
4082 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4083 <p>No Content</p>
4084 </div></div></td>
4085 </tr>
4086 <tr>
4087 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4088 <p><strong>409</strong></p>
4089 </div></div></td>
4090 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4091 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
4092 </div></div></td>
4093 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4094 <p>No Content</p>
4095 </div></div></td>
4096 </tr>
4097 <tr>
4098 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4099 <p><strong>500</strong></p>
4100 </div></div></td>
4101 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4102 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
4103 </div></div></td>
4104 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4105 <p>No Content</p>
4106 </div></div></td>
4107 </tr>
4108 </tbody>
4109 </table>
4110
4111 </div>
4112 <div class="sect3">
4113 <h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a>2.12.4. Produces</h4>
4114 <div class="ulist">
4115 <ul>
4116 <li>
4117 <p><code>application/json</code></p>
4118 </li>
4119 </ul>
4120 </div>
4121 </div>
4122 <div class="sect3">
4123 <h4 id="_tags_13"><a class="anchor" href="#_tags_13"></a>2.12.5. Tags</h4>
4124 <div class="ulist">
4125 <ul>
4126 <li>
4127 <p>Artifact External Servlet</p>
4128 </li>
4129 </ul>
4130 </div>
4131 </div>
4132 </div>
4133 <div class="sect2">
4134 <h3 id="_changeresourcestateexternal"><a class="anchor" href="#_changeresourcestateexternal"></a>2.13. Change Resource lifecycle State</h3>
4135 <div class="literalblock">
4136 <div class="content">
4137 <pre>POST /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}</pre>
4138 </div>
4139 </div>
4140 <div class="sect3">
4141 <h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a>2.13.1. Parameters</h4>
4142 <table class="tableblock frame-all grid-all" style="width:100%; ">
4143 <colgroup>
4144 <col style="width:11%;">
4145 <col style="width:16%;">
4146 <col style="width:50%;">
4147 <col style="width:22%;">
4148 </colgroup>
4149 <thead>
4150 <tr>
4151 <th class="tableblock halign-left valign-middle">Type</th>
4152 <th class="tableblock halign-left valign-middle">Name</th>
4153 <th class="tableblock halign-left valign-middle">Description</th>
4154 <th class="tableblock halign-left valign-middle">Schema</th>
4155 </tr>
4156 </thead>
4157 <tbody>
4158 <tr>
4159 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4160 <p><strong>Header</strong></p>
4161 </div></div></td>
4162 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4163 <p><strong>Accept</strong><br>
4164 <em>optional</em></p>
4165 </div></div></td>
4166 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4167 <p>Determines the format of the body of the response</p>
4168 </div></div></td>
4169 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4170 <p>string</p>
4171 </div></div></td>
4172 </tr>
4173 <tr>
4174 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4175 <p><strong>Header</strong></p>
4176 </div></div></td>
4177 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4178 <p><strong>Authorization</strong><br>
4179 <em>required</em></p>
4180 </div></div></td>
4181 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4182 <p>The username and password</p>
4183 </div></div></td>
4184 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4185 <p>string</p>
4186 </div></div></td>
4187 </tr>
4188 <tr>
4189 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4190 <p><strong>Header</strong></p>
4191 </div></div></td>
4192 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4193 <p><strong>Content-Type</strong><br>
4194 <em>required</em></p>
4195 </div></div></td>
4196 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4197 <p>Determines the format of the body of the request</p>
4198 </div></div></td>
4199 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4200 <p>string</p>
4201 </div></div></td>
4202 </tr>
4203 <tr>
4204 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4205 <p><strong>Header</strong></p>
4206 </div></div></td>
4207 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4208 <p><strong>USER_ID</strong><br>
4209 <em>required</em></p>
4210 </div></div></td>
4211 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4212 <p>The user id</p>
4213 </div></div></td>
4214 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4215 <p>string</p>
4216 </div></div></td>
4217 </tr>
4218 <tr>
4219 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4220 <p><strong>Header</strong></p>
4221 </div></div></td>
4222 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4223 <p><strong>X-ECOMP-InstanceID</strong><br>
4224 <em>required</em></p>
4225 </div></div></td>
4226 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4227 <p>X-ECOMP-InstanceID header</p>
4228 </div></div></td>
4229 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4230 <p>string</p>
4231 </div></div></td>
4232 </tr>
4233 <tr>
4234 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4235 <p><strong>Header</strong></p>
4236 </div></div></td>
4237 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4238 <p><strong>X-ECOMP-RequestID</strong><br>
4239 <em>optional</em></p>
4240 </div></div></td>
4241 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4242 <p>X-ECOMP-RequestID header</p>
4243 </div></div></td>
4244 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4245 <p>string</p>
4246 </div></div></td>
4247 </tr>
4248 <tr>
4249 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4250 <p><strong>Path</strong></p>
4251 </div></div></td>
4252 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4253 <p><strong>assetType</strong><br>
4254 <em>required</em></p>
4255 </div></div></td>
4256 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4257 <p>validValues: resources / services</p>
4258 </div></div></td>
4259 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4260 <p>enum (resources, services)</p>
4261 </div></div></td>
4262 </tr>
4263 <tr>
4264 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4265 <p><strong>Path</strong></p>
4266 </div></div></td>
4267 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4268 <p><strong>lifecycleOperation</strong><br>
4269 <em>required</em></p>
4270 </div></div></td>
4271 <td class="tableblock halign-left valign-middle"><div></div></td>
4272 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4273 <p>enum (checkout, checkin)</p>
4274 </div></div></td>
4275 </tr>
4276 <tr>
4277 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4278 <p><strong>Path</strong></p>
4279 </div></div></td>
4280 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4281 <p><strong>uuid</strong><br>
4282 <em>required</em></p>
4283 </div></div></td>
4284 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4285 <p>id of component to be changed</p>
4286 </div></div></td>
4287 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4288 <p>string</p>
4289 </div></div></td>
4290 </tr>
4291 <tr>
4292 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4293 <p><strong>Body</strong></p>
4294 </div></div></td>
4295 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4296 <p><strong>body</strong><br>
4297 <em>required</em></p>
4298 </div></div></td>
4299 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4300 <p>userRemarks - Short description (free text) about the asset version being changed</p>
4301 </div></div></td>
4302 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4303 <p><a href="#_lifecyclechangeinfowithaction">LifecycleChangeInfoWithAction</a></p>
4304 </div></div></td>
4305 </tr>
4306 </tbody>
4307 </table>
4308
4309 </div>
4310 <div class="sect3">
4311 <h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a>2.13.2. Responses</h4>
4312 <table class="tableblock frame-all grid-all" style="width:100%; ">
4313 <colgroup>
4314 <col style="width:10%;">
4315 <col style="width:70%;">
4316 <col style="width:20%;">
4317 </colgroup>
4318 <thead>
4319 <tr>
4320 <th class="tableblock halign-left valign-middle">HTTP Code</th>
4321 <th class="tableblock halign-left valign-middle">Description</th>
4322 <th class="tableblock halign-left valign-middle">Schema</th>
4323 </tr>
4324 </thead>
4325 <tbody>
4326 <tr>
4327 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4328 <p><strong>200</strong></p>
4329 </div></div></td>
4330 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4331 <p>Resource state changed</p>
4332 </div></div></td>
4333 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4334 <p><a href="#_assetmetadata">AssetMetadata</a></p>
4335 </div></div></td>
4336 </tr>
4337 <tr>
4338 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4339 <p><strong>400</strong></p>
4340 </div></div></td>
4341 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4342 <p>Missing X-ECOMP-InstanceID HTTP header - POL5001</p>
4343 </div></div></td>
4344 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4345 <p>No Content</p>
4346 </div></div></td>
4347 </tr>
4348 <tr>
4349 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4350 <p><strong>401</strong></p>
4351 </div></div></td>
4352 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4353 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
4354 </div></div></td>
4355 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4356 <p>No Content</p>
4357 </div></div></td>
4358 </tr>
4359 <tr>
4360 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4361 <p><strong>403</strong></p>
4362 </div></div></td>
4363 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4364 <p>Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4080</p>
4365 </div></div></td>
4366 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4367 <p>No Content</p>
4368 </div></div></td>
4369 </tr>
4370 <tr>
4371 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4372 <p><strong>404</strong></p>
4373 </div></div></td>
4374 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4375 <p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p>
4376 </div></div></td>
4377 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4378 <p>No Content</p>
4379 </div></div></td>
4380 </tr>
4381 <tr>
4382 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4383 <p><strong>405</strong></p>
4384 </div></div></td>
4385 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4386 <p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
4387 </div></div></td>
4388 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4389 <p>No Content</p>
4390 </div></div></td>
4391 </tr>
4392 <tr>
4393 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4394 <p><strong>500</strong></p>
4395 </div></div></td>
4396 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4397 <p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
4398 </div></div></td>
4399 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4400 <p>No Content</p>
4401 </div></div></td>
4402 </tr>
4403 </tbody>
4404 </table>
4405
4406 </div>
4407 <div class="sect3">
4408 <h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a>2.13.3. Consumes</h4>
4409 <div class="ulist">
4410 <ul>
4411 <li>
4412 <p><code>application/json</code></p>
4413 </li>
4414 </ul>
4415 </div>
4416 </div>
4417 <div class="sect3">
4418 <h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a>2.13.4. Produces</h4>
4419 <div class="ulist">
4420 <ul>
4421 <li>
4422 <p><code>application/json</code></p>
4423 </li>
4424 </ul>
4425 </div>
4426 </div>
4427 <div class="sect3">
4428 <h4 id="_tags_14"><a class="anchor" href="#_tags_14"></a>2.13.5. Tags</h4>
4429 <div class="ulist">
4430 <ul>
4431 <li>
4432 <p>CRUD External Servlet</p>
4433 </li>
4434 </ul>
4435 </div>
4436 </div>
4437 </div>
4438 <div class="sect2">
4439 <h3 id="_getassetspecificmetadatabyuuidexternal"><a class="anchor" href="#_getassetspecificmetadatabyuuidexternal"></a>2.14. Detailed metadata of asset by uuid</h3>
4440 <div class="literalblock">
4441 <div class="content">
4442 <pre>GET /v1/catalog/{assetType}/{uuid}/metadata</pre>
4443 </div>
4444 </div>
4445 <div class="sect3">
4446 <h4 id="_description_13"><a class="anchor" href="#_description_13"></a>2.14.1. Description</h4>
4447 <div class="paragraph">
4448 <p>Returns detailed metadata of an asset by uuid</p>
4449 </div>
4450 </div>
4451 <div class="sect3">
4452 <h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a>2.14.2. Parameters</h4>
4453 <table class="tableblock frame-all grid-all" style="width:100%; ">
4454 <colgroup>
4455 <col style="width:11%;">
4456 <col style="width:16%;">
4457 <col style="width:50%;">
4458 <col style="width:22%;">
4459 </colgroup>
4460 <thead>
4461 <tr>
4462 <th class="tableblock halign-left valign-middle">Type</th>
4463 <th class="tableblock halign-left valign-middle">Name</th>
4464 <th class="tableblock halign-left valign-middle">Description</th>
4465 <th class="tableblock halign-left valign-middle">Schema</th>
4466 </tr>
4467 </thead>
4468 <tbody>
4469 <tr>
4470 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4471 <p><strong>Header</strong></p>
4472 </div></div></td>
4473 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4474 <p><strong>Accept</strong><br>
4475 <em>optional</em></p>
4476 </div></div></td>
4477 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4478 <p>Determines the format of the body of the response</p>
4479 </div></div></td>
4480 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4481 <p>string</p>
4482 </div></div></td>
4483 </tr>
4484 <tr>
4485 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4486 <p><strong>Header</strong></p>
4487 </div></div></td>
4488 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4489 <p><strong>Authorization</strong><br>
4490 <em>required</em></p>
4491 </div></div></td>
4492 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4493 <p>The username and password</p>
4494 </div></div></td>
4495 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4496 <p>string</p>
4497 </div></div></td>
4498 </tr>
4499 <tr>
4500 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4501 <p><strong>Header</strong></p>
4502 </div></div></td>
4503 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4504 <p><strong>X-ECOMP-InstanceID</strong><br>
4505 <em>required</em></p>
4506 </div></div></td>
4507 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4508 <p>X-ECOMP-InstanceID header</p>
4509 </div></div></td>
4510 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4511 <p>string</p>
4512 </div></div></td>
4513 </tr>
4514 <tr>
4515 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4516 <p><strong>Header</strong></p>
4517 </div></div></td>
4518 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4519 <p><strong>X-ECOMP-RequestID</strong><br>
4520 <em>optional</em></p>
4521 </div></div></td>
4522 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4523 <p>X-ECOMP-RequestID header</p>
4524 </div></div></td>
4525 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4526 <p>string</p>
4527 </div></div></td>
4528 </tr>
4529 <tr>
4530 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4531 <p><strong>Path</strong></p>
4532 </div></div></td>
4533 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4534 <p><strong>assetType</strong><br>
4535 <em>required</em></p>
4536 </div></div></td>
4537 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4538 <p>The requested asset type</p>
4539 </div></div></td>
4540 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4541 <p>enum (resources, services)</p>
4542 </div></div></td>
4543 </tr>
4544 <tr>
4545 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4546 <p><strong>Path</strong></p>
4547 </div></div></td>
4548 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4549 <p><strong>uuid</strong><br>
4550 <em>required</em></p>
4551 </div></div></td>
4552 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4553 <p>The requested asset uuid</p>
4554 </div></div></td>
4555 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4556 <p>string</p>
4557 </div></div></td>
4558 </tr>
4559 </tbody>
4560 </table>
4561
4562 </div>
4563 <div class="sect3">
4564 <h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a>2.14.3. Responses</h4>
4565 <table class="tableblock frame-all grid-all" style="width:100%; ">
4566 <colgroup>
4567 <col style="width:10%;">
4568 <col style="width:70%;">
4569 <col style="width:20%;">
4570 </colgroup>
4571 <thead>
4572 <tr>
4573 <th class="tableblock halign-left valign-middle">HTTP Code</th>
4574 <th class="tableblock halign-left valign-middle">Description</th>
4575 <th class="tableblock halign-left valign-middle">Schema</th>
4576 </tr>
4577 </thead>
4578 <tbody>
4579 <tr>
4580 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4581 <p><strong>200</strong></p>
4582 </div></div></td>
4583 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4584 <p>ECOMP component is authenticated and list of Catalog Assets Metadata is returned</p>
4585 </div></div></td>
4586 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4587 <p>&lt; <a href="#_assetmetadata">AssetMetadata</a> &gt; array</p>
4588 </div></div></td>
4589 </tr>
4590 <tr>
4591 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4592 <p><strong>400</strong></p>
4593 </div></div></td>
4594 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4595 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
4596 </div></div></td>
4597 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4598 <p>No Content</p>
4599 </div></div></td>
4600 </tr>
4601 <tr>
4602 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4603 <p><strong>401</strong></p>
4604 </div></div></td>
4605 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4606 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
4607 </div></div></td>
4608 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4609 <p>No Content</p>
4610 </div></div></td>
4611 </tr>
4612 <tr>
4613 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4614 <p><strong>403</strong></p>
4615 </div></div></td>
4616 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4617 <p>ECOMP component is not authorized - POL5003</p>
4618 </div></div></td>
4619 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4620 <p>No Content</p>
4621 </div></div></td>
4622 </tr>
4623 <tr>
4624 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4625 <p><strong>404</strong></p>
4626 </div></div></td>
4627 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4628 <p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p>
4629 </div></div></td>
4630 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4631 <p>No Content</p>
4632 </div></div></td>
4633 </tr>
4634 <tr>
4635 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4636 <p><strong>405</strong></p>
4637 </div></div></td>
4638 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4639 <p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
4640 </div></div></td>
4641 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4642 <p>No Content</p>
4643 </div></div></td>
4644 </tr>
4645 <tr>
4646 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4647 <p><strong>500</strong></p>
4648 </div></div></td>
4649 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4650 <p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
4651 </div></div></td>
4652 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4653 <p>No Content</p>
4654 </div></div></td>
4655 </tr>
4656 </tbody>
4657 </table>
4658
4659 </div>
4660 <div class="sect3">
4661 <h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a>2.14.4. Produces</h4>
4662 <div class="ulist">
4663 <ul>
4664 <li>
4665 <p><code>application/json</code></p>
4666 </li>
4667 </ul>
4668 </div>
4669 </div>
4670 <div class="sect3">
4671 <h4 id="_tags_15"><a class="anchor" href="#_tags_15"></a>2.14.5. Tags</h4>
4672 <div class="ulist">
4673 <ul>
4674 <li>
4675 <p>Asset Metadata External Servlet</p>
4676 </li>
4677 </ul>
4678 </div>
4679 </div>
4680 </div>
4681 <div class="sect2">
4682 <h3 id="_uploadartifacttoinstance"><a class="anchor" href="#_uploadartifacttoinstance"></a>2.15. uploads an artifact to a resource instance</h3>
4683 <div class="literalblock">
4684 <div class="content">
4685 <pre>POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts</pre>
4686 </div>
4687 </div>
4688 <div class="sect3">
4689 <h4 id="_description_14"><a class="anchor" href="#_description_14"></a>2.15.1. Description</h4>
4690 <div class="paragraph">
4691 <p>uploads an artifact to a resource instance</p>
4692 </div>
4693 </div>
4694 <div class="sect3">
4695 <h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a>2.15.2. Parameters</h4>
4696 <table class="tableblock frame-all grid-all" style="width:100%; ">
4697 <colgroup>
4698 <col style="width:11%;">
4699 <col style="width:16%;">
4700 <col style="width:50%;">
4701 <col style="width:22%;">
4702 </colgroup>
4703 <thead>
4704 <tr>
4705 <th class="tableblock halign-left valign-middle">Type</th>
4706 <th class="tableblock halign-left valign-middle">Name</th>
4707 <th class="tableblock halign-left valign-middle">Description</th>
4708 <th class="tableblock halign-left valign-middle">Schema</th>
4709 </tr>
4710 </thead>
4711 <tbody>
4712 <tr>
4713 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4714 <p><strong>Header</strong></p>
4715 </div></div></td>
4716 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4717 <p><strong>Accept</strong><br>
4718 <em>optional</em></p>
4719 </div></div></td>
4720 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4721 <p>Determines the format of the body of the response</p>
4722 </div></div></td>
4723 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4724 <p>string</p>
4725 </div></div></td>
4726 </tr>
4727 <tr>
4728 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4729 <p><strong>Header</strong></p>
4730 </div></div></td>
4731 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4732 <p><strong>Authorization</strong><br>
4733 <em>required</em></p>
4734 </div></div></td>
4735 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4736 <p>The username and password</p>
4737 </div></div></td>
4738 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4739 <p>string</p>
4740 </div></div></td>
4741 </tr>
4742 <tr>
4743 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4744 <p><strong>Header</strong></p>
4745 </div></div></td>
4746 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4747 <p><strong>Content-MD5</strong><br>
4748 <em>required</em></p>
4749 </div></div></td>
4750 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4751 <p>The value for this header must be the MD5 checksum over the whole json body</p>
4752 </div></div></td>
4753 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4754 <p>string</p>
4755 </div></div></td>
4756 </tr>
4757 <tr>
4758 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4759 <p><strong>Header</strong></p>
4760 </div></div></td>
4761 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4762 <p><strong>Content-Type</strong><br>
4763 <em>required</em></p>
4764 </div></div></td>
4765 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4766 <p>Determines the format of the body of the request</p>
4767 </div></div></td>
4768 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4769 <p>string</p>
4770 </div></div></td>
4771 </tr>
4772 <tr>
4773 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4774 <p><strong>Header</strong></p>
4775 </div></div></td>
4776 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4777 <p><strong>USER_ID</strong><br>
4778 <em>required</em></p>
4779 </div></div></td>
4780 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4781 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
4782 </div></div></td>
4783 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4784 <p>string</p>
4785 </div></div></td>
4786 </tr>
4787 <tr>
4788 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4789 <p><strong>Header</strong></p>
4790 </div></div></td>
4791 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4792 <p><strong>X-ECOMP-InstanceID</strong><br>
4793 <em>required</em></p>
4794 </div></div></td>
4795 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4796 <p>X-ECOMP-InstanceID header</p>
4797 </div></div></td>
4798 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4799 <p>string</p>
4800 </div></div></td>
4801 </tr>
4802 <tr>
4803 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4804 <p><strong>Header</strong></p>
4805 </div></div></td>
4806 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4807 <p><strong>X-ECOMP-RequestID</strong><br>
4808 <em>optional</em></p>
4809 </div></div></td>
4810 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4811 <p>X-ECOMP-RequestID header</p>
4812 </div></div></td>
4813 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4814 <p>string</p>
4815 </div></div></td>
4816 </tr>
4817 <tr>
4818 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4819 <p><strong>Path</strong></p>
4820 </div></div></td>
4821 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4822 <p><strong>assetType</strong><br>
4823 <em>required</em></p>
4824 </div></div></td>
4825 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4826 <p>The requested asset type</p>
4827 </div></div></td>
4828 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4829 <p>enum (resources, services)</p>
4830 </div></div></td>
4831 </tr>
4832 <tr>
4833 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4834 <p><strong>Path</strong></p>
4835 </div></div></td>
4836 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4837 <p><strong>resourceInstanceName</strong><br>
4838 <em>required</em></p>
4839 </div></div></td>
4840 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4841 <p>The component instance name (as publishedin the response of the detailed query)</p>
4842 </div></div></td>
4843 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4844 <p>string</p>
4845 </div></div></td>
4846 </tr>
4847 <tr>
4848 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4849 <p><strong>Path</strong></p>
4850 </div></div></td>
4851 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4852 <p><strong>uuid</strong><br>
4853 <em>required</em></p>
4854 </div></div></td>
4855 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4856 <p>The uuid of the asset as published in the metadata</p>
4857 </div></div></td>
4858 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4859 <p>string</p>
4860 </div></div></td>
4861 </tr>
4862 <tr>
4863 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4864 <p><strong>Body</strong></p>
4865 </div></div></td>
4866 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4867 <p><strong>body</strong><br>
4868 <em>required</em></p>
4869 </div></div></td>
4870 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4871 <p>json describe the artifact</p>
4872 </div></div></td>
4873 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4874 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
4875 </div></div></td>
4876 </tr>
4877 </tbody>
4878 </table>
4879
4880 </div>
4881 <div class="sect3">
4882 <h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a>2.15.3. Responses</h4>
4883 <table class="tableblock frame-all grid-all" style="width:100%; ">
4884 <colgroup>
4885 <col style="width:10%;">
4886 <col style="width:70%;">
4887 <col style="width:20%;">
4888 </colgroup>
4889 <thead>
4890 <tr>
4891 <th class="tableblock halign-left valign-middle">HTTP Code</th>
4892 <th class="tableblock halign-left valign-middle">Description</th>
4893 <th class="tableblock halign-left valign-middle">Schema</th>
4894 </tr>
4895 </thead>
4896 <tbody>
4897 <tr>
4898 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4899 <p><strong>200</strong></p>
4900 </div></div></td>
4901 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4902 <p>Artifact uploaded</p>
4903 </div></div></td>
4904 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4905 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
4906 </div></div></td>
4907 </tr>
4908 <tr>
4909 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4910 <p><strong>400</strong></p>
4911 </div></div></td>
4912 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4913 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
4914 </div></div></td>
4915 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4916 <p>No Content</p>
4917 </div></div></td>
4918 </tr>
4919 <tr>
4920 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4921 <p><strong>401</strong></p>
4922 </div></div></td>
4923 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4924 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
4925 </div></div></td>
4926 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4927 <p>No Content</p>
4928 </div></div></td>
4929 </tr>
4930 <tr>
4931 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4932 <p><strong>403</strong></p>
4933 </div></div></td>
4934 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4935 <p>ECOMP component is not authorized - POL5003</p>
4936 </div></div></td>
4937 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4938 <p>No Content</p>
4939 </div></div></td>
4940 </tr>
4941 <tr>
4942 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4943 <p><strong>404</strong></p>
4944 </div></div></td>
4945 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4946 <p>Specified resource is not found - SVC4063</p>
4947 </div></div></td>
4948 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4949 <p>No Content</p>
4950 </div></div></td>
4951 </tr>
4952 <tr>
4953 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4954 <p><strong>405</strong></p>
4955 </div></div></td>
4956 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4957 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
4958 </div></div></td>
4959 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4960 <p>No Content</p>
4961 </div></div></td>
4962 </tr>
4963 <tr>
4964 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4965 <p><strong>500</strong></p>
4966 </div></div></td>
4967 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4968 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
4969 </div></div></td>
4970 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
4971 <p>No Content</p>
4972 </div></div></td>
4973 </tr>
4974 </tbody>
4975 </table>
4976
4977 </div>
4978 <div class="sect3">
4979 <h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a>2.15.4. Produces</h4>
4980 <div class="ulist">
4981 <ul>
4982 <li>
4983 <p><code>application/json</code></p>
4984 </li>
4985 </ul>
4986 </div>
4987 </div>
4988 <div class="sect3">
4989 <h4 id="_tags_16"><a class="anchor" href="#_tags_16"></a>2.15.5. Tags</h4>
4990 <div class="ulist">
4991 <ul>
4992 <li>
4993 <p>Artifact External Servlet</p>
4994 </li>
4995 </ul>
4996 </div>
4997 </div>
4998 </div>
4999 <div class="sect2">
5000 <h3 id="_updateartifactonresourceinstance"><a class="anchor" href="#_updateartifactonresourceinstance"></a>2.16. updates an artifact on a resource instance</h3>
5001 <div class="literalblock">
5002 <div class="content">
5003 <pre>POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}</pre>
5004 </div>
5005 </div>
5006 <div class="sect3">
5007 <h4 id="_description_15"><a class="anchor" href="#_description_15"></a>2.16.1. Description</h4>
5008 <div class="paragraph">
5009 <p>uploads of artifact to a resource or service</p>
5010 </div>
5011 </div>
5012 <div class="sect3">
5013 <h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a>2.16.2. Parameters</h4>
5014 <table class="tableblock frame-all grid-all" style="width:100%; ">
5015 <colgroup>
5016 <col style="width:11%;">
5017 <col style="width:16%;">
5018 <col style="width:50%;">
5019 <col style="width:22%;">
5020 </colgroup>
5021 <thead>
5022 <tr>
5023 <th class="tableblock halign-left valign-middle">Type</th>
5024 <th class="tableblock halign-left valign-middle">Name</th>
5025 <th class="tableblock halign-left valign-middle">Description</th>
5026 <th class="tableblock halign-left valign-middle">Schema</th>
5027 </tr>
5028 </thead>
5029 <tbody>
5030 <tr>
5031 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5032 <p><strong>Header</strong></p>
5033 </div></div></td>
5034 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5035 <p><strong>Accept</strong><br>
5036 <em>optional</em></p>
5037 </div></div></td>
5038 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5039 <p>Determines the format of the body of the response</p>
5040 </div></div></td>
5041 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5042 <p>string</p>
5043 </div></div></td>
5044 </tr>
5045 <tr>
5046 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5047 <p><strong>Header</strong></p>
5048 </div></div></td>
5049 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5050 <p><strong>Authorization</strong><br>
5051 <em>required</em></p>
5052 </div></div></td>
5053 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5054 <p>The username and password</p>
5055 </div></div></td>
5056 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5057 <p>string</p>
5058 </div></div></td>
5059 </tr>
5060 <tr>
5061 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5062 <p><strong>Header</strong></p>
5063 </div></div></td>
5064 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5065 <p><strong>Content-MD5</strong><br>
5066 <em>required</em></p>
5067 </div></div></td>
5068 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5069 <p>The value for this header must be the MD5 checksum over the whole json body</p>
5070 </div></div></td>
5071 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5072 <p>string</p>
5073 </div></div></td>
5074 </tr>
5075 <tr>
5076 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5077 <p><strong>Header</strong></p>
5078 </div></div></td>
5079 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5080 <p><strong>Content-Type</strong><br>
5081 <em>required</em></p>
5082 </div></div></td>
5083 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5084 <p>Determines the format of the body of the request</p>
5085 </div></div></td>
5086 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5087 <p>string</p>
5088 </div></div></td>
5089 </tr>
5090 <tr>
5091 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5092 <p><strong>Header</strong></p>
5093 </div></div></td>
5094 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5095 <p><strong>USER_ID</strong><br>
5096 <em>required</em></p>
5097 </div></div></td>
5098 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5099 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
5100 </div></div></td>
5101 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5102 <p>string</p>
5103 </div></div></td>
5104 </tr>
5105 <tr>
5106 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5107 <p><strong>Header</strong></p>
5108 </div></div></td>
5109 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5110 <p><strong>X-ECOMP-InstanceID</strong><br>
5111 <em>required</em></p>
5112 </div></div></td>
5113 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5114 <p>X-ECOMP-InstanceID header</p>
5115 </div></div></td>
5116 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5117 <p>string</p>
5118 </div></div></td>
5119 </tr>
5120 <tr>
5121 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5122 <p><strong>Header</strong></p>
5123 </div></div></td>
5124 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5125 <p><strong>X-ECOMP-RequestID</strong><br>
5126 <em>optional</em></p>
5127 </div></div></td>
5128 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5129 <p>X-ECOMP-RequestID header</p>
5130 </div></div></td>
5131 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5132 <p>string</p>
5133 </div></div></td>
5134 </tr>
5135 <tr>
5136 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5137 <p><strong>Path</strong></p>
5138 </div></div></td>
5139 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5140 <p><strong>artifactUUID</strong><br>
5141 <em>required</em></p>
5142 </div></div></td>
5143 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5144 <p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p>
5145 </div></div></td>
5146 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5147 <p>string</p>
5148 </div></div></td>
5149 </tr>
5150 <tr>
5151 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5152 <p><strong>Path</strong></p>
5153 </div></div></td>
5154 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5155 <p><strong>assetType</strong><br>
5156 <em>required</em></p>
5157 </div></div></td>
5158 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5159 <p>The requested asset type</p>
5160 </div></div></td>
5161 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5162 <p>enum (resources, services)</p>
5163 </div></div></td>
5164 </tr>
5165 <tr>
5166 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5167 <p><strong>Path</strong></p>
5168 </div></div></td>
5169 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5170 <p><strong>resourceInstanceName</strong><br>
5171 <em>required</em></p>
5172 </div></div></td>
5173 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5174 <p>The component instance name (as publishedin the response of the detailed query)</p>
5175 </div></div></td>
5176 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5177 <p>string</p>
5178 </div></div></td>
5179 </tr>
5180 <tr>
5181 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5182 <p><strong>Path</strong></p>
5183 </div></div></td>
5184 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5185 <p><strong>uuid</strong><br>
5186 <em>required</em></p>
5187 </div></div></td>
5188 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5189 <p>The uuid of the asset as published in the metadata</p>
5190 </div></div></td>
5191 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5192 <p>string</p>
5193 </div></div></td>
5194 </tr>
5195 <tr>
5196 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5197 <p><strong>Body</strong></p>
5198 </div></div></td>
5199 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5200 <p><strong>body</strong><br>
5201 <em>required</em></p>
5202 </div></div></td>
5203 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5204 <p>json describe the artifact</p>
5205 </div></div></td>
5206 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5207 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
5208 </div></div></td>
5209 </tr>
5210 </tbody>
5211 </table>
5212
5213 </div>
5214 <div class="sect3">
5215 <h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a>2.16.3. Responses</h4>
5216 <table class="tableblock frame-all grid-all" style="width:100%; ">
5217 <colgroup>
5218 <col style="width:10%;">
5219 <col style="width:70%;">
5220 <col style="width:20%;">
5221 </colgroup>
5222 <thead>
5223 <tr>
5224 <th class="tableblock halign-left valign-middle">HTTP Code</th>
5225 <th class="tableblock halign-left valign-middle">Description</th>
5226 <th class="tableblock halign-left valign-middle">Schema</th>
5227 </tr>
5228 </thead>
5229 <tbody>
5230 <tr>
5231 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5232 <p><strong>200</strong></p>
5233 </div></div></td>
5234 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5235 <p>Artifact updated</p>
5236 </div></div></td>
5237 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5238 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
5239 </div></div></td>
5240 </tr>
5241 <tr>
5242 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5243 <p><strong>400</strong></p>
5244 </div></div></td>
5245 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5246 <p>Artifact name is missing in input - SVC4128</p>
5247 </div></div></td>
5248 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5249 <p>No Content</p>
5250 </div></div></td>
5251 </tr>
5252 <tr>
5253 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5254 <p><strong>401</strong></p>
5255 </div></div></td>
5256 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5257 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
5258 </div></div></td>
5259 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5260 <p>No Content</p>
5261 </div></div></td>
5262 </tr>
5263 <tr>
5264 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5265 <p><strong>403</strong></p>
5266 </div></div></td>
5267 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5268 <p>Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086</p>
5269 </div></div></td>
5270 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5271 <p>No Content</p>
5272 </div></div></td>
5273 </tr>
5274 <tr>
5275 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5276 <p><strong>404</strong></p>
5277 </div></div></td>
5278 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5279 <p>Specified resource is not found - SVC4063</p>
5280 </div></div></td>
5281 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5282 <p>No Content</p>
5283 </div></div></td>
5284 </tr>
5285 <tr>
5286 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5287 <p><strong>405</strong></p>
5288 </div></div></td>
5289 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5290 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
5291 </div></div></td>
5292 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5293 <p>No Content</p>
5294 </div></div></td>
5295 </tr>
5296 <tr>
5297 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5298 <p><strong>409</strong></p>
5299 </div></div></td>
5300 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5301 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
5302 </div></div></td>
5303 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5304 <p>No Content</p>
5305 </div></div></td>
5306 </tr>
5307 <tr>
5308 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5309 <p><strong>500</strong></p>
5310 </div></div></td>
5311 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5312 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
5313 </div></div></td>
5314 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5315 <p>No Content</p>
5316 </div></div></td>
5317 </tr>
5318 </tbody>
5319 </table>
5320
5321 </div>
5322 <div class="sect3">
5323 <h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a>2.16.4. Produces</h4>
5324 <div class="ulist">
5325 <ul>
5326 <li>
5327 <p><code>application/json</code></p>
5328 </li>
5329 </ul>
5330 </div>
5331 </div>
5332 <div class="sect3">
5333 <h4 id="_tags_17"><a class="anchor" href="#_tags_17"></a>2.16.5. Tags</h4>
5334 <div class="ulist">
5335 <ul>
5336 <li>
5337 <p>Artifact External Servlet</p>
5338 </li>
5339 </ul>
5340 </div>
5341 </div>
5342 </div>
5343 <div class="sect2">
5344 <h3 id="_downloadresourceinstanceartifact"><a class="anchor" href="#_downloadresourceinstanceartifact"></a>2.17. Download resource instance artifact</h3>
5345 <div class="literalblock">
5346 <div class="content">
5347 <pre>GET /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}</pre>
5348 </div>
5349 </div>
5350 <div class="sect3">
5351 <h4 id="_description_16"><a class="anchor" href="#_description_16"></a>2.17.1. Description</h4>
5352 <div class="paragraph">
5353 <p>Returns downloaded artifact</p>
5354 </div>
5355 </div>
5356 <div class="sect3">
5357 <h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a>2.17.2. Parameters</h4>
5358 <table class="tableblock frame-all grid-all" style="width:100%; ">
5359 <colgroup>
5360 <col style="width:11%;">
5361 <col style="width:16%;">
5362 <col style="width:50%;">
5363 <col style="width:22%;">
5364 </colgroup>
5365 <thead>
5366 <tr>
5367 <th class="tableblock halign-left valign-middle">Type</th>
5368 <th class="tableblock halign-left valign-middle">Name</th>
5369 <th class="tableblock halign-left valign-middle">Description</th>
5370 <th class="tableblock halign-left valign-middle">Schema</th>
5371 </tr>
5372 </thead>
5373 <tbody>
5374 <tr>
5375 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5376 <p><strong>Header</strong></p>
5377 </div></div></td>
5378 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5379 <p><strong>Accept</strong><br>
5380 <em>optional</em></p>
5381 </div></div></td>
5382 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5383 <p>Determines the format of the body of the response</p>
5384 </div></div></td>
5385 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5386 <p>string</p>
5387 </div></div></td>
5388 </tr>
5389 <tr>
5390 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5391 <p><strong>Header</strong></p>
5392 </div></div></td>
5393 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5394 <p><strong>Authorization</strong><br>
5395 <em>required</em></p>
5396 </div></div></td>
5397 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5398 <p>The username and password</p>
5399 </div></div></td>
5400 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5401 <p>string</p>
5402 </div></div></td>
5403 </tr>
5404 <tr>
5405 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5406 <p><strong>Header</strong></p>
5407 </div></div></td>
5408 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5409 <p><strong>USER_ID</strong><br>
5410 <em>required</em></p>
5411 </div></div></td>
5412 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5413 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
5414 </div></div></td>
5415 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5416 <p>string</p>
5417 </div></div></td>
5418 </tr>
5419 <tr>
5420 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5421 <p><strong>Header</strong></p>
5422 </div></div></td>
5423 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5424 <p><strong>X-ECOMP-InstanceID</strong><br>
5425 <em>required</em></p>
5426 </div></div></td>
5427 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5428 <p>X-ECOMP-InstanceID header</p>
5429 </div></div></td>
5430 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5431 <p>string</p>
5432 </div></div></td>
5433 </tr>
5434 <tr>
5435 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5436 <p><strong>Header</strong></p>
5437 </div></div></td>
5438 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5439 <p><strong>X-ECOMP-RequestID</strong><br>
5440 <em>optional</em></p>
5441 </div></div></td>
5442 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5443 <p>X-ECOMP-RequestID header</p>
5444 </div></div></td>
5445 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5446 <p>string</p>
5447 </div></div></td>
5448 </tr>
5449 <tr>
5450 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5451 <p><strong>Path</strong></p>
5452 </div></div></td>
5453 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5454 <p><strong>artifactUUID</strong><br>
5455 <em>required</em></p>
5456 </div></div></td>
5457 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5458 <p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p>
5459 </div></div></td>
5460 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5461 <p>string</p>
5462 </div></div></td>
5463 </tr>
5464 <tr>
5465 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5466 <p><strong>Path</strong></p>
5467 </div></div></td>
5468 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5469 <p><strong>assetType</strong><br>
5470 <em>required</em></p>
5471 </div></div></td>
5472 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5473 <p>The requested asset type</p>
5474 </div></div></td>
5475 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5476 <p>enum (resources, services)</p>
5477 </div></div></td>
5478 </tr>
5479 <tr>
5480 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5481 <p><strong>Path</strong></p>
5482 </div></div></td>
5483 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5484 <p><strong>resourceInstanceName</strong><br>
5485 <em>required</em></p>
5486 </div></div></td>
5487 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5488 <p>The component instance name (as publishedin the response of the detailed query)</p>
5489 </div></div></td>
5490 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5491 <p>string</p>
5492 </div></div></td>
5493 </tr>
5494 <tr>
5495 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5496 <p><strong>Path</strong></p>
5497 </div></div></td>
5498 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5499 <p><strong>uuid</strong><br>
5500 <em>required</em></p>
5501 </div></div></td>
5502 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5503 <p>The uuid of the asset as published in the metadata</p>
5504 </div></div></td>
5505 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5506 <p>string</p>
5507 </div></div></td>
5508 </tr>
5509 </tbody>
5510 </table>
5511
5512 </div>
5513 <div class="sect3">
5514 <h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a>2.17.3. Responses</h4>
5515 <table class="tableblock frame-all grid-all" style="width:100%; ">
5516 <colgroup>
5517 <col style="width:10%;">
5518 <col style="width:70%;">
5519 <col style="width:20%;">
5520 </colgroup>
5521 <thead>
5522 <tr>
5523 <th class="tableblock halign-left valign-middle">HTTP Code</th>
5524 <th class="tableblock halign-left valign-middle">Description</th>
5525 <th class="tableblock halign-left valign-middle">Schema</th>
5526 </tr>
5527 </thead>
5528 <tbody>
5529 <tr>
5530 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5531 <p><strong>200</strong></p>
5532 </div></div></td>
5533 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5534 <p>Artifact downloaded</p>
5535 </div></div></td>
5536 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5537 <p>string</p>
5538 </div></div></td>
5539 </tr>
5540 <tr>
5541 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5542 <p><strong>400</strong></p>
5543 </div></div></td>
5544 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5545 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
5546 </div></div></td>
5547 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5548 <p>No Content</p>
5549 </div></div></td>
5550 </tr>
5551 <tr>
5552 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5553 <p><strong>401</strong></p>
5554 </div></div></td>
5555 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5556 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
5557 </div></div></td>
5558 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5559 <p>No Content</p>
5560 </div></div></td>
5561 </tr>
5562 <tr>
5563 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5564 <p><strong>403</strong></p>
5565 </div></div></td>
5566 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5567 <p>ECOMP component is not authorized - POL5003</p>
5568 </div></div></td>
5569 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5570 <p>No Content</p>
5571 </div></div></td>
5572 </tr>
5573 <tr>
5574 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5575 <p><strong>404</strong></p>
5576 </div></div></td>
5577 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5578 <p>Artifact was not found - SVC4505</p>
5579 </div></div></td>
5580 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5581 <p>No Content</p>
5582 </div></div></td>
5583 </tr>
5584 <tr>
5585 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5586 <p><strong>405</strong></p>
5587 </div></div></td>
5588 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5589 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
5590 </div></div></td>
5591 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5592 <p>No Content</p>
5593 </div></div></td>
5594 </tr>
5595 <tr>
5596 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5597 <p><strong>500</strong></p>
5598 </div></div></td>
5599 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5600 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
5601 </div></div></td>
5602 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5603 <p>No Content</p>
5604 </div></div></td>
5605 </tr>
5606 </tbody>
5607 </table>
5608
5609 </div>
5610 <div class="sect3">
5611 <h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a>2.17.4. Produces</h4>
5612 <div class="ulist">
5613 <ul>
5614 <li>
5615 <p><code>application/octet-stream</code></p>
5616 </li>
5617 </ul>
5618 </div>
5619 </div>
5620 <div class="sect3">
5621 <h4 id="_tags_18"><a class="anchor" href="#_tags_18"></a>2.17.5. Tags</h4>
5622 <div class="ulist">
5623 <ul>
5624 <li>
5625 <p>Artifact External Servlet</p>
5626 </li>
5627 </ul>
5628 </div>
5629 </div>
5630 </div>
5631 <div class="sect2">
5632 <h3 id="_deleteartifactonresourceinstance"><a class="anchor" href="#_deleteartifactonresourceinstance"></a>2.18. deletes an artifact of a resource insatnce</h3>
5633 <div class="literalblock">
5634 <div class="content">
5635 <pre>DELETE /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}</pre>
5636 </div>
5637 </div>
5638 <div class="sect3">
5639 <h4 id="_description_17"><a class="anchor" href="#_description_17"></a>2.18.1. Description</h4>
5640 <div class="paragraph">
5641 <p>deletes an artifact of a resource insatnce</p>
5642 </div>
5643 </div>
5644 <div class="sect3">
5645 <h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a>2.18.2. Parameters</h4>
5646 <table class="tableblock frame-all grid-all" style="width:100%; ">
5647 <colgroup>
5648 <col style="width:11%;">
5649 <col style="width:16%;">
5650 <col style="width:50%;">
5651 <col style="width:22%;">
5652 </colgroup>
5653 <thead>
5654 <tr>
5655 <th class="tableblock halign-left valign-middle">Type</th>
5656 <th class="tableblock halign-left valign-middle">Name</th>
5657 <th class="tableblock halign-left valign-middle">Description</th>
5658 <th class="tableblock halign-left valign-middle">Schema</th>
5659 </tr>
5660 </thead>
5661 <tbody>
5662 <tr>
5663 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5664 <p><strong>Header</strong></p>
5665 </div></div></td>
5666 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5667 <p><strong>Accept</strong><br>
5668 <em>optional</em></p>
5669 </div></div></td>
5670 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5671 <p>Determines the format of the body of the response</p>
5672 </div></div></td>
5673 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5674 <p>string</p>
5675 </div></div></td>
5676 </tr>
5677 <tr>
5678 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5679 <p><strong>Header</strong></p>
5680 </div></div></td>
5681 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5682 <p><strong>Authorization</strong><br>
5683 <em>required</em></p>
5684 </div></div></td>
5685 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5686 <p>The username and password</p>
5687 </div></div></td>
5688 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5689 <p>string</p>
5690 </div></div></td>
5691 </tr>
5692 <tr>
5693 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5694 <p><strong>Header</strong></p>
5695 </div></div></td>
5696 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5697 <p><strong>USER_ID</strong><br>
5698 <em>required</em></p>
5699 </div></div></td>
5700 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5701 <p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p>
5702 </div></div></td>
5703 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5704 <p>string</p>
5705 </div></div></td>
5706 </tr>
5707 <tr>
5708 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5709 <p><strong>Header</strong></p>
5710 </div></div></td>
5711 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5712 <p><strong>X-ECOMP-InstanceID</strong><br>
5713 <em>required</em></p>
5714 </div></div></td>
5715 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5716 <p>X-ECOMP-InstanceID header</p>
5717 </div></div></td>
5718 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5719 <p>string</p>
5720 </div></div></td>
5721 </tr>
5722 <tr>
5723 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5724 <p><strong>Header</strong></p>
5725 </div></div></td>
5726 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5727 <p><strong>X-ECOMP-RequestID</strong><br>
5728 <em>optional</em></p>
5729 </div></div></td>
5730 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5731 <p>X-ECOMP-RequestID header</p>
5732 </div></div></td>
5733 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5734 <p>string</p>
5735 </div></div></td>
5736 </tr>
5737 <tr>
5738 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5739 <p><strong>Path</strong></p>
5740 </div></div></td>
5741 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5742 <p><strong>artifactUUID</strong><br>
5743 <em>required</em></p>
5744 </div></div></td>
5745 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5746 <p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p>
5747 </div></div></td>
5748 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5749 <p>string</p>
5750 </div></div></td>
5751 </tr>
5752 <tr>
5753 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5754 <p><strong>Path</strong></p>
5755 </div></div></td>
5756 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5757 <p><strong>assetType</strong><br>
5758 <em>required</em></p>
5759 </div></div></td>
5760 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5761 <p>The requested asset type</p>
5762 </div></div></td>
5763 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5764 <p>enum (resources, services)</p>
5765 </div></div></td>
5766 </tr>
5767 <tr>
5768 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5769 <p><strong>Path</strong></p>
5770 </div></div></td>
5771 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5772 <p><strong>resourceInstanceName</strong><br>
5773 <em>required</em></p>
5774 </div></div></td>
5775 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5776 <p>The component instance name (as publishedin the response of the detailed query)</p>
5777 </div></div></td>
5778 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5779 <p>string</p>
5780 </div></div></td>
5781 </tr>
5782 <tr>
5783 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5784 <p><strong>Path</strong></p>
5785 </div></div></td>
5786 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5787 <p><strong>uuid</strong><br>
5788 <em>required</em></p>
5789 </div></div></td>
5790 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5791 <p>The uuid of the asset as published in the metadata</p>
5792 </div></div></td>
5793 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5794 <p>string</p>
5795 </div></div></td>
5796 </tr>
5797 </tbody>
5798 </table>
5799
5800 </div>
5801 <div class="sect3">
5802 <h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a>2.18.3. Responses</h4>
5803 <table class="tableblock frame-all grid-all" style="width:100%; ">
5804 <colgroup>
5805 <col style="width:10%;">
5806 <col style="width:70%;">
5807 <col style="width:20%;">
5808 </colgroup>
5809 <thead>
5810 <tr>
5811 <th class="tableblock halign-left valign-middle">HTTP Code</th>
5812 <th class="tableblock halign-left valign-middle">Description</th>
5813 <th class="tableblock halign-left valign-middle">Schema</th>
5814 </tr>
5815 </thead>
5816 <tbody>
5817 <tr>
5818 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5819 <p><strong>200</strong></p>
5820 </div></div></td>
5821 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5822 <p>Artifact deleted</p>
5823 </div></div></td>
5824 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5825 <p><a href="#_artifactdefinition">ArtifactDefinition</a></p>
5826 </div></div></td>
5827 </tr>
5828 <tr>
5829 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5830 <p><strong>400</strong></p>
5831 </div></div></td>
5832 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5833 <p>Artifact name is missing in input - SVC4128</p>
5834 </div></div></td>
5835 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5836 <p>No Content</p>
5837 </div></div></td>
5838 </tr>
5839 <tr>
5840 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5841 <p><strong>401</strong></p>
5842 </div></div></td>
5843 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5844 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
5845 </div></div></td>
5846 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5847 <p>No Content</p>
5848 </div></div></td>
5849 </tr>
5850 <tr>
5851 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5852 <p><strong>403</strong></p>
5853 </div></div></td>
5854 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5855 <p>Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086</p>
5856 </div></div></td>
5857 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5858 <p>No Content</p>
5859 </div></div></td>
5860 </tr>
5861 <tr>
5862 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5863 <p><strong>404</strong></p>
5864 </div></div></td>
5865 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5866 <p>Specified resource is not found - SVC4063</p>
5867 </div></div></td>
5868 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5869 <p>No Content</p>
5870 </div></div></td>
5871 </tr>
5872 <tr>
5873 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5874 <p><strong>405</strong></p>
5875 </div></div></td>
5876 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5877 <p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p>
5878 </div></div></td>
5879 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5880 <p>No Content</p>
5881 </div></div></td>
5882 </tr>
5883 <tr>
5884 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5885 <p><strong>409</strong></p>
5886 </div></div></td>
5887 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5888 <p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p>
5889 </div></div></td>
5890 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5891 <p>No Content</p>
5892 </div></div></td>
5893 </tr>
5894 <tr>
5895 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5896 <p><strong>500</strong></p>
5897 </div></div></td>
5898 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5899 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
5900 </div></div></td>
5901 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5902 <p>No Content</p>
5903 </div></div></td>
5904 </tr>
5905 </tbody>
5906 </table>
5907
5908 </div>
5909 <div class="sect3">
5910 <h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a>2.18.4. Produces</h4>
5911 <div class="ulist">
5912 <ul>
5913 <li>
5914 <p><code>application/json</code></p>
5915 </li>
5916 </ul>
5917 </div>
5918 </div>
5919 <div class="sect3">
5920 <h4 id="_tags_19"><a class="anchor" href="#_tags_19"></a>2.18.5. Tags</h4>
5921 <div class="ulist">
5922 <ul>
5923 <li>
5924 <p>Artifact External Servlet</p>
5925 </li>
5926 </ul>
5927 </div>
5928 </div>
5929 </div>
5930 <div class="sect2">
5931 <h3 id="_gettoscamodelexternal"><a class="anchor" href="#_gettoscamodelexternal"></a>2.19. Fetch assets CSAR</h3>
5932 <div class="literalblock">
5933 <div class="content">
5934 <pre>GET /v1/catalog/{assetType}/{uuid}/toscaModel</pre>
5935 </div>
5936 </div>
5937 <div class="sect3">
5938 <h4 id="_description_18"><a class="anchor" href="#_description_18"></a>2.19.1. Description</h4>
5939 <div class="paragraph">
5940 <p>Returns asset csar</p>
5941 </div>
5942 </div>
5943 <div class="sect3">
5944 <h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a>2.19.2. Parameters</h4>
5945 <table class="tableblock frame-all grid-all" style="width:100%; ">
5946 <colgroup>
5947 <col style="width:11%;">
5948 <col style="width:16%;">
5949 <col style="width:50%;">
5950 <col style="width:22%;">
5951 </colgroup>
5952 <thead>
5953 <tr>
5954 <th class="tableblock halign-left valign-middle">Type</th>
5955 <th class="tableblock halign-left valign-middle">Name</th>
5956 <th class="tableblock halign-left valign-middle">Description</th>
5957 <th class="tableblock halign-left valign-middle">Schema</th>
5958 </tr>
5959 </thead>
5960 <tbody>
5961 <tr>
5962 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5963 <p><strong>Header</strong></p>
5964 </div></div></td>
5965 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5966 <p><strong>Accept</strong><br>
5967 <em>optional</em></p>
5968 </div></div></td>
5969 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5970 <p>Determines the format of the body of the response</p>
5971 </div></div></td>
5972 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5973 <p>string</p>
5974 </div></div></td>
5975 </tr>
5976 <tr>
5977 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5978 <p><strong>Header</strong></p>
5979 </div></div></td>
5980 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5981 <p><strong>Authorization</strong><br>
5982 <em>required</em></p>
5983 </div></div></td>
5984 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5985 <p>The username and password</p>
5986 </div></div></td>
5987 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5988 <p>string</p>
5989 </div></div></td>
5990 </tr>
5991 <tr>
5992 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5993 <p><strong>Header</strong></p>
5994 </div></div></td>
5995 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
5996 <p><strong>X-ECOMP-InstanceID</strong><br>
5997 <em>required</em></p>
5998 </div></div></td>
5999 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6000 <p>X-ECOMP-InstanceID header</p>
6001 </div></div></td>
6002 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6003 <p>string</p>
6004 </div></div></td>
6005 </tr>
6006 <tr>
6007 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6008 <p><strong>Header</strong></p>
6009 </div></div></td>
6010 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6011 <p><strong>X-ECOMP-RequestID</strong><br>
6012 <em>optional</em></p>
6013 </div></div></td>
6014 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6015 <p>X-ECOMP-RequestID header</p>
6016 </div></div></td>
6017 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6018 <p>string</p>
6019 </div></div></td>
6020 </tr>
6021 <tr>
6022 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6023 <p><strong>Path</strong></p>
6024 </div></div></td>
6025 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6026 <p><strong>assetType</strong><br>
6027 <em>required</em></p>
6028 </div></div></td>
6029 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6030 <p>The requested asset type</p>
6031 </div></div></td>
6032 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6033 <p>enum (resources, services)</p>
6034 </div></div></td>
6035 </tr>
6036 <tr>
6037 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6038 <p><strong>Path</strong></p>
6039 </div></div></td>
6040 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6041 <p><strong>uuid</strong><br>
6042 <em>required</em></p>
6043 </div></div></td>
6044 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6045 <p>The requested asset uuid</p>
6046 </div></div></td>
6047 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6048 <p>string</p>
6049 </div></div></td>
6050 </tr>
6051 </tbody>
6052 </table>
6053
6054 </div>
6055 <div class="sect3">
6056 <h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a>2.19.3. Responses</h4>
6057 <table class="tableblock frame-all grid-all" style="width:100%; ">
6058 <colgroup>
6059 <col style="width:10%;">
6060 <col style="width:70%;">
6061 <col style="width:20%;">
6062 </colgroup>
6063 <thead>
6064 <tr>
6065 <th class="tableblock halign-left valign-middle">HTTP Code</th>
6066 <th class="tableblock halign-left valign-middle">Description</th>
6067 <th class="tableblock halign-left valign-middle">Schema</th>
6068 </tr>
6069 </thead>
6070 <tbody>
6071 <tr>
6072 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6073 <p><strong>200</strong></p>
6074 </div></div></td>
6075 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6076 <p>ECOMP component is authenticated and list of Catalog Assets Metadata is returned</p>
6077 </div></div></td>
6078 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6079 <p>string</p>
6080 </div></div></td>
6081 </tr>
6082 <tr>
6083 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6084 <p><strong>400</strong></p>
6085 </div></div></td>
6086 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6087 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
6088 </div></div></td>
6089 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6090 <p>No Content</p>
6091 </div></div></td>
6092 </tr>
6093 <tr>
6094 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6095 <p><strong>401</strong></p>
6096 </div></div></td>
6097 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6098 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
6099 </div></div></td>
6100 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6101 <p>No Content</p>
6102 </div></div></td>
6103 </tr>
6104 <tr>
6105 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6106 <p><strong>403</strong></p>
6107 </div></div></td>
6108 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6109 <p>ECOMP component is not authorized - POL5003</p>
6110 </div></div></td>
6111 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6112 <p>No Content</p>
6113 </div></div></td>
6114 </tr>
6115 <tr>
6116 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6117 <p><strong>404</strong></p>
6118 </div></div></td>
6119 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6120 <p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p>
6121 </div></div></td>
6122 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6123 <p>No Content</p>
6124 </div></div></td>
6125 </tr>
6126 <tr>
6127 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6128 <p><strong>405</strong></p>
6129 </div></div></td>
6130 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6131 <p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
6132 </div></div></td>
6133 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6134 <p>No Content</p>
6135 </div></div></td>
6136 </tr>
6137 <tr>
6138 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6139 <p><strong>500</strong></p>
6140 </div></div></td>
6141 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6142 <p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
6143 </div></div></td>
6144 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6145 <p>No Content</p>
6146 </div></div></td>
6147 </tr>
6148 </tbody>
6149 </table>
6150
6151 </div>
6152 <div class="sect3">
6153 <h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a>2.19.4. Produces</h4>
6154 <div class="ulist">
6155 <ul>
6156 <li>
6157 <p><code>application/octet-stream</code></p>
6158 </li>
6159 </ul>
6160 </div>
6161 </div>
6162 <div class="sect3">
6163 <h4 id="_tags_20"><a class="anchor" href="#_tags_20"></a>2.19.5. Tags</h4>
6164 <div class="ulist">
6165 <ul>
6166 <li>
6167 <p>Asset Metadata External Servlet</p>
6168 </li>
6169 </ul>
6170 </div>
6171 </div>
6172 </div>
6173 <div class="sect2">
6174 <h3 id="_getuebserverlist"><a class="anchor" href="#_getuebserverlist"></a>2.20. UEB Server List</h3>
6175 <div class="literalblock">
6176 <div class="content">
6177 <pre>GET /v1/distributionUebCluster</pre>
6178 </div>
6179 </div>
6180 <div class="sect3">
6181 <h4 id="_description_19"><a class="anchor" href="#_description_19"></a>2.20.1. Description</h4>
6182 <div class="paragraph">
6183 <p>return the available UEB Server List</p>
6184 </div>
6185 </div>
6186 <div class="sect3">
6187 <h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a>2.20.2. Parameters</h4>
6188 <table class="tableblock frame-all grid-all" style="width:100%; ">
6189 <colgroup>
6190 <col style="width:11%;">
6191 <col style="width:16%;">
6192 <col style="width:50%;">
6193 <col style="width:22%;">
6194 </colgroup>
6195 <thead>
6196 <tr>
6197 <th class="tableblock halign-left valign-middle">Type</th>
6198 <th class="tableblock halign-left valign-middle">Name</th>
6199 <th class="tableblock halign-left valign-middle">Description</th>
6200 <th class="tableblock halign-left valign-middle">Schema</th>
6201 </tr>
6202 </thead>
6203 <tbody>
6204 <tr>
6205 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6206 <p><strong>Header</strong></p>
6207 </div></div></td>
6208 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6209 <p><strong>Accept</strong><br>
6210 <em>optional</em></p>
6211 </div></div></td>
6212 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6213 <p>Determines the format of the body of the response</p>
6214 </div></div></td>
6215 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6216 <p>string</p>
6217 </div></div></td>
6218 </tr>
6219 <tr>
6220 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6221 <p><strong>Header</strong></p>
6222 </div></div></td>
6223 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6224 <p><strong>Authorization</strong><br>
6225 <em>required</em></p>
6226 </div></div></td>
6227 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6228 <p>The username and password</p>
6229 </div></div></td>
6230 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6231 <p>string</p>
6232 </div></div></td>
6233 </tr>
6234 <tr>
6235 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6236 <p><strong>Header</strong></p>
6237 </div></div></td>
6238 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6239 <p><strong>X-ECOMP-InstanceID</strong><br>
6240 <em>required</em></p>
6241 </div></div></td>
6242 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6243 <p>X-ECOMP-InstanceID header</p>
6244 </div></div></td>
6245 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6246 <p>string</p>
6247 </div></div></td>
6248 </tr>
6249 <tr>
6250 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6251 <p><strong>Header</strong></p>
6252 </div></div></td>
6253 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6254 <p><strong>X-ECOMP-RequestID</strong><br>
6255 <em>optional</em></p>
6256 </div></div></td>
6257 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6258 <p>X-ECOMP-RequestID header</p>
6259 </div></div></td>
6260 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6261 <p>string</p>
6262 </div></div></td>
6263 </tr>
6264 </tbody>
6265 </table>
6266
6267 </div>
6268 <div class="sect3">
6269 <h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a>2.20.3. Responses</h4>
6270 <table class="tableblock frame-all grid-all" style="width:100%; ">
6271 <colgroup>
6272 <col style="width:10%;">
6273 <col style="width:70%;">
6274 <col style="width:20%;">
6275 </colgroup>
6276 <thead>
6277 <tr>
6278 <th class="tableblock halign-left valign-middle">HTTP Code</th>
6279 <th class="tableblock halign-left valign-middle">Description</th>
6280 <th class="tableblock halign-left valign-middle">Schema</th>
6281 </tr>
6282 </thead>
6283 <tbody>
6284 <tr>
6285 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6286 <p><strong>200</strong></p>
6287 </div></div></td>
6288 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6289 <p>ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned</p>
6290 </div></div></td>
6291 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6292 <p><a href="#_serverlistresponse">ServerListResponse</a></p>
6293 </div></div></td>
6294 </tr>
6295 <tr>
6296 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6297 <p><strong>400</strong></p>
6298 </div></div></td>
6299 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6300 <p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p>
6301 </div></div></td>
6302 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6303 <p>No Content</p>
6304 </div></div></td>
6305 </tr>
6306 <tr>
6307 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6308 <p><strong>401</strong></p>
6309 </div></div></td>
6310 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6311 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002</p>
6312 </div></div></td>
6313 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6314 <p>No Content</p>
6315 </div></div></td>
6316 </tr>
6317 <tr>
6318 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6319 <p><strong>403</strong></p>
6320 </div></div></td>
6321 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6322 <p>ECOMP component is not authorized - POL5003</p>
6323 </div></div></td>
6324 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6325 <p>No Content</p>
6326 </div></div></td>
6327 </tr>
6328 <tr>
6329 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6330 <p><strong>405</strong></p>
6331 </div></div></td>
6332 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6333 <p>Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p>
6334 </div></div></td>
6335 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6336 <p>No Content</p>
6337 </div></div></td>
6338 </tr>
6339 <tr>
6340 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6341 <p><strong>500</strong></p>
6342 </div></div></td>
6343 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6344 <p>The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000</p>
6345 </div></div></td>
6346 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6347 <p>No Content</p>
6348 </div></div></td>
6349 </tr>
6350 </tbody>
6351 </table>
6352
6353 </div>
6354 <div class="sect3">
6355 <h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a>2.20.4. Consumes</h4>
6356 <div class="ulist">
6357 <ul>
6358 <li>
6359 <p><code>application/json</code></p>
6360 </li>
6361 </ul>
6362 </div>
6363 </div>
6364 <div class="sect3">
6365 <h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a>2.20.5. Produces</h4>
6366 <div class="ulist">
6367 <ul>
6368 <li>
6369 <p><code>application/json</code></p>
6370 </li>
6371 </ul>
6372 </div>
6373 </div>
6374 <div class="sect3">
6375 <h4 id="_tags_21"><a class="anchor" href="#_tags_21"></a>2.20.6. Tags</h4>
6376 <div class="ulist">
6377 <ul>
6378 <li>
6379 <p>Distribution Servlet</p>
6380 </li>
6381 </ul>
6382 </div>
6383 </div>
6384 </div>
6385 <div class="sect2">
6386 <h3 id="_registerfordistribution"><a class="anchor" href="#_registerfordistribution"></a>2.21. Subscription status</h3>
6387 <div class="literalblock">
6388 <div class="content">
6389 <pre>POST /v1/registerForDistribution</pre>
6390 </div>
6391 </div>
6392 <div class="sect3">
6393 <h4 id="_description_20"><a class="anchor" href="#_description_20"></a>2.21.1. Description</h4>
6394 <div class="paragraph">
6395 <p>Subscribes for distribution notifications</p>
6396 </div>
6397 </div>
6398 <div class="sect3">
6399 <h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a>2.21.2. Parameters</h4>
6400 <table class="tableblock frame-all grid-all" style="width:100%; ">
6401 <colgroup>
6402 <col style="width:11%;">
6403 <col style="width:16%;">
6404 <col style="width:50%;">
6405 <col style="width:22%;">
6406 </colgroup>
6407 <thead>
6408 <tr>
6409 <th class="tableblock halign-left valign-middle">Type</th>
6410 <th class="tableblock halign-left valign-middle">Name</th>
6411 <th class="tableblock halign-left valign-middle">Description</th>
6412 <th class="tableblock halign-left valign-middle">Schema</th>
6413 </tr>
6414 </thead>
6415 <tbody>
6416 <tr>
6417 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6418 <p><strong>Header</strong></p>
6419 </div></div></td>
6420 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6421 <p><strong>Accept</strong><br>
6422 <em>optional</em></p>
6423 </div></div></td>
6424 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6425 <p>Determines the format of the body of the response</p>
6426 </div></div></td>
6427 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6428 <p>string</p>
6429 </div></div></td>
6430 </tr>
6431 <tr>
6432 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6433 <p><strong>Header</strong></p>
6434 </div></div></td>
6435 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6436 <p><strong>Authorization</strong><br>
6437 <em>required</em></p>
6438 </div></div></td>
6439 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6440 <p>The username and password</p>
6441 </div></div></td>
6442 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6443 <p>string</p>
6444 </div></div></td>
6445 </tr>
6446 <tr>
6447 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6448 <p><strong>Header</strong></p>
6449 </div></div></td>
6450 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6451 <p><strong>Content-Length</strong><br>
6452 <em>required</em></p>
6453 </div></div></td>
6454 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6455 <p>Length of the request body</p>
6456 </div></div></td>
6457 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6458 <p>string</p>
6459 </div></div></td>
6460 </tr>
6461 <tr>
6462 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6463 <p><strong>Header</strong></p>
6464 </div></div></td>
6465 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6466 <p><strong>Content-Type</strong><br>
6467 <em>required</em></p>
6468 </div></div></td>
6469 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6470 <p>Determines the format of the body of the request</p>
6471 </div></div></td>
6472 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6473 <p>string</p>
6474 </div></div></td>
6475 </tr>
6476 <tr>
6477 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6478 <p><strong>Header</strong></p>
6479 </div></div></td>
6480 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6481 <p><strong>X-ECOMP-InstanceID</strong><br>
6482 <em>required</em></p>
6483 </div></div></td>
6484 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6485 <p>X-ECOMP-InstanceID header</p>
6486 </div></div></td>
6487 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6488 <p>string</p>
6489 </div></div></td>
6490 </tr>
6491 <tr>
6492 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6493 <p><strong>Header</strong></p>
6494 </div></div></td>
6495 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6496 <p><strong>X-ECOMP-RequestID</strong><br>
6497 <em>optional</em></p>
6498 </div></div></td>
6499 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6500 <p>X-ECOMP-RequestID header</p>
6501 </div></div></td>
6502 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6503 <p>string</p>
6504 </div></div></td>
6505 </tr>
6506 <tr>
6507 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6508 <p><strong>Body</strong></p>
6509 </div></div></td>
6510 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6511 <p><strong>requestJson</strong><br>
6512 <em>required</em></p>
6513 </div></div></td>
6514 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6515 <p>json describe the artifact</p>
6516 </div></div></td>
6517 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6518 <p><a href="#_registrationrequest">RegistrationRequest</a></p>
6519 </div></div></td>
6520 </tr>
6521 </tbody>
6522 </table>
6523
6524 </div>
6525 <div class="sect3">
6526 <h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a>2.21.3. Responses</h4>
6527 <table class="tableblock frame-all grid-all" style="width:100%; ">
6528 <colgroup>
6529 <col style="width:10%;">
6530 <col style="width:70%;">
6531 <col style="width:20%;">
6532 </colgroup>
6533 <thead>
6534 <tr>
6535 <th class="tableblock halign-left valign-middle">HTTP Code</th>
6536 <th class="tableblock halign-left valign-middle">Description</th>
6537 <th class="tableblock halign-left valign-middle">Schema</th>
6538 </tr>
6539 </thead>
6540 <tbody>
6541 <tr>
6542 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6543 <p><strong>200</strong></p>
6544 </div></div></td>
6545 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6546 <p>ECOMP component is successfully registered for distribution</p>
6547 </div></div></td>
6548 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6549 <p><a href="#_topicregistrationresponse">TopicRegistrationResponse</a></p>
6550 </div></div></td>
6551 </tr>
6552 <tr>
6553 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6554 <p><strong>400</strong></p>
6555 </div></div></td>
6556 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6557 <p>Invalid Body : Specified <em>distrEnvName</em> doesn’t exist - POL4137</p>
6558 </div></div></td>
6559 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6560 <p>No Content</p>
6561 </div></div></td>
6562 </tr>
6563 <tr>
6564 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6565 <p><strong>401</strong></p>
6566 </div></div></td>
6567 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6568 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
6569 </div></div></td>
6570 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6571 <p>No Content</p>
6572 </div></div></td>
6573 </tr>
6574 <tr>
6575 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6576 <p><strong>403</strong></p>
6577 </div></div></td>
6578 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6579 <p>ECOMP component is not authorized - POL5003</p>
6580 </div></div></td>
6581 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6582 <p>No Content</p>
6583 </div></div></td>
6584 </tr>
6585 <tr>
6586 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6587 <p><strong>405</strong></p>
6588 </div></div></td>
6589 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6590 <p>Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050</p>
6591 </div></div></td>
6592 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6593 <p>No Content</p>
6594 </div></div></td>
6595 </tr>
6596 <tr>
6597 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6598 <p><strong>500</strong></p>
6599 </div></div></td>
6600 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6601 <p>The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000</p>
6602 </div></div></td>
6603 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6604 <p>No Content</p>
6605 </div></div></td>
6606 </tr>
6607 </tbody>
6608 </table>
6609
6610 </div>
6611 <div class="sect3">
6612 <h4 id="_consumes_9"><a class="anchor" href="#_consumes_9"></a>2.21.4. Consumes</h4>
6613 <div class="ulist">
6614 <ul>
6615 <li>
6616 <p><code>application/json</code></p>
6617 </li>
6618 </ul>
6619 </div>
6620 </div>
6621 <div class="sect3">
6622 <h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a>2.21.5. Produces</h4>
6623 <div class="ulist">
6624 <ul>
6625 <li>
6626 <p><code>application/json</code></p>
6627 </li>
6628 </ul>
6629 </div>
6630 </div>
6631 <div class="sect3">
6632 <h4 id="_tags_22"><a class="anchor" href="#_tags_22"></a>2.21.6. Tags</h4>
6633 <div class="ulist">
6634 <ul>
6635 <li>
6636 <p>Distribution Servlet</p>
6637 </li>
6638 </ul>
6639 </div>
6640 </div>
6641 </div>
6642 <div class="sect2">
6643 <h3 id="_unregisterfordistribution"><a class="anchor" href="#_unregisterfordistribution"></a>2.22. Subscription status</h3>
6644 <div class="literalblock">
6645 <div class="content">
6646 <pre>POST /v1/unRegisterForDistribution</pre>
6647 </div>
6648 </div>
6649 <div class="sect3">
6650 <h4 id="_description_21"><a class="anchor" href="#_description_21"></a>2.22.1. Description</h4>
6651 <div class="paragraph">
6652 <p>Removes from subscription for distribution notifications</p>
6653 </div>
6654 </div>
6655 <div class="sect3">
6656 <h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a>2.22.2. Parameters</h4>
6657 <table class="tableblock frame-all grid-all" style="width:100%; ">
6658 <colgroup>
6659 <col style="width:11%;">
6660 <col style="width:16%;">
6661 <col style="width:50%;">
6662 <col style="width:22%;">
6663 </colgroup>
6664 <thead>
6665 <tr>
6666 <th class="tableblock halign-left valign-middle">Type</th>
6667 <th class="tableblock halign-left valign-middle">Name</th>
6668 <th class="tableblock halign-left valign-middle">Description</th>
6669 <th class="tableblock halign-left valign-middle">Schema</th>
6670 </tr>
6671 </thead>
6672 <tbody>
6673 <tr>
6674 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6675 <p><strong>Header</strong></p>
6676 </div></div></td>
6677 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6678 <p><strong>Accept</strong><br>
6679 <em>optional</em></p>
6680 </div></div></td>
6681 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6682 <p>Determines the format of the body of the response</p>
6683 </div></div></td>
6684 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6685 <p>string</p>
6686 </div></div></td>
6687 </tr>
6688 <tr>
6689 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6690 <p><strong>Header</strong></p>
6691 </div></div></td>
6692 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6693 <p><strong>Authorization</strong><br>
6694 <em>required</em></p>
6695 </div></div></td>
6696 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6697 <p>The username and password</p>
6698 </div></div></td>
6699 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6700 <p>string</p>
6701 </div></div></td>
6702 </tr>
6703 <tr>
6704 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6705 <p><strong>Header</strong></p>
6706 </div></div></td>
6707 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6708 <p><strong>Content-Length</strong><br>
6709 <em>required</em></p>
6710 </div></div></td>
6711 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6712 <p>Length of the request body</p>
6713 </div></div></td>
6714 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6715 <p>string</p>
6716 </div></div></td>
6717 </tr>
6718 <tr>
6719 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6720 <p><strong>Header</strong></p>
6721 </div></div></td>
6722 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6723 <p><strong>Content-Type</strong><br>
6724 <em>required</em></p>
6725 </div></div></td>
6726 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6727 <p>Determines the format of the body of the request</p>
6728 </div></div></td>
6729 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6730 <p>string</p>
6731 </div></div></td>
6732 </tr>
6733 <tr>
6734 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6735 <p><strong>Header</strong></p>
6736 </div></div></td>
6737 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6738 <p><strong>X-ECOMP-InstanceID</strong><br>
6739 <em>required</em></p>
6740 </div></div></td>
6741 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6742 <p>X-ECOMP-InstanceID header</p>
6743 </div></div></td>
6744 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6745 <p>string</p>
6746 </div></div></td>
6747 </tr>
6748 <tr>
6749 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6750 <p><strong>Header</strong></p>
6751 </div></div></td>
6752 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6753 <p><strong>X-ECOMP-RequestID</strong><br>
6754 <em>optional</em></p>
6755 </div></div></td>
6756 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6757 <p>X-ECOMP-RequestID header</p>
6758 </div></div></td>
6759 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6760 <p>string</p>
6761 </div></div></td>
6762 </tr>
6763 <tr>
6764 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6765 <p><strong>Body</strong></p>
6766 </div></div></td>
6767 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6768 <p><strong>requestJson</strong><br>
6769 <em>required</em></p>
6770 </div></div></td>
6771 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6772 <p>json describe the artifact</p>
6773 </div></div></td>
6774 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6775 <p><a href="#_registrationrequest">RegistrationRequest</a></p>
6776 </div></div></td>
6777 </tr>
6778 </tbody>
6779 </table>
6780
6781 </div>
6782 <div class="sect3">
6783 <h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a>2.22.3. Responses</h4>
6784 <table class="tableblock frame-all grid-all" style="width:100%; ">
6785 <colgroup>
6786 <col style="width:10%;">
6787 <col style="width:70%;">
6788 <col style="width:20%;">
6789 </colgroup>
6790 <thead>
6791 <tr>
6792 <th class="tableblock halign-left valign-middle">HTTP Code</th>
6793 <th class="tableblock halign-left valign-middle">Description</th>
6794 <th class="tableblock halign-left valign-middle">Schema</th>
6795 </tr>
6796 </thead>
6797 <tbody>
6798 <tr>
6799 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6800 <p><strong>204</strong></p>
6801 </div></div></td>
6802 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6803 <p>ECOMP component is successfully unregistered</p>
6804 </div></div></td>
6805 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6806 <p><a href="#_topicunregistrationresponse">TopicUnregistrationResponse</a></p>
6807 </div></div></td>
6808 </tr>
6809 <tr>
6810 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6811 <p><strong>400</strong></p>
6812 </div></div></td>
6813 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6814 <p>Invalid Body : Specified <em>distrEnvName</em> doesn’t exist - POL4137</p>
6815 </div></div></td>
6816 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6817 <p>No Content</p>
6818 </div></div></td>
6819 </tr>
6820 <tr>
6821 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6822 <p><strong>401</strong></p>
6823 </div></div></td>
6824 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6825 <p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p>
6826 </div></div></td>
6827 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6828 <p>No Content</p>
6829 </div></div></td>
6830 </tr>
6831 <tr>
6832 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6833 <p><strong>403</strong></p>
6834 </div></div></td>
6835 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6836 <p>ECOMP component is not authorized - POL5003</p>
6837 </div></div></td>
6838 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6839 <p>No Content</p>
6840 </div></div></td>
6841 </tr>
6842 <tr>
6843 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6844 <p><strong>405</strong></p>
6845 </div></div></td>
6846 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6847 <p>Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050</p>
6848 </div></div></td>
6849 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6850 <p>No Content</p>
6851 </div></div></td>
6852 </tr>
6853 <tr>
6854 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6855 <p><strong>500</strong></p>
6856 </div></div></td>
6857 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6858 <p>The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000</p>
6859 </div></div></td>
6860 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6861 <p>No Content</p>
6862 </div></div></td>
6863 </tr>
6864 </tbody>
6865 </table>
6866
6867 </div>
6868 <div class="sect3">
6869 <h4 id="_consumes_10"><a class="anchor" href="#_consumes_10"></a>2.22.4. Consumes</h4>
6870 <div class="ulist">
6871 <ul>
6872 <li>
6873 <p><code>application/json</code></p>
6874 </li>
6875 </ul>
6876 </div>
6877 </div>
6878 <div class="sect3">
6879 <h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a>2.22.5. Produces</h4>
6880 <div class="ulist">
6881 <ul>
6882 <li>
6883 <p><code>application/json</code></p>
6884 </li>
6885 </ul>
6886 </div>
6887 </div>
6888 <div class="sect3">
6889 <h4 id="_tags_23"><a class="anchor" href="#_tags_23"></a>2.22.6. Tags</h4>
6890 <div class="ulist">
6891 <ul>
6892 <li>
6893 <p>Distribution Servlet</p>
6894 </li>
6895 </ul>
6896 </div>
6897 </div>
6898 </div>
6899 </div>
6900 </div>
6901 <div class="sect1">
6902 <h2 id="_definitions"><a class="anchor" href="#_definitions"></a>3. Definitions</h2>
6903 <div class="sectionbody">
6904 <div class="sect2">
6905 <h3 id="_additionalinfoparameterinfo"><a class="anchor" href="#_additionalinfoparameterinfo"></a>3.1. AdditionalInfoParameterInfo</h3>
6906 <table class="tableblock frame-all grid-all" style="width:100%; ">
6907 <colgroup>
6908 <col style="width:42%;">
6909 <col style="width:57%;">
6910 </colgroup>
6911 <thead>
6912 <tr>
6913 <th class="tableblock halign-left valign-middle">Name</th>
6914 <th class="tableblock halign-left valign-middle">Schema</th>
6915 </tr>
6916 </thead>
6917 <tbody>
6918 <tr>
6919 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6920 <p><strong>empty</strong><br>
6921 <em>optional</em></p>
6922 </div></div></td>
6923 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6924 <p>boolean</p>
6925 </div></div></td>
6926 </tr>
6927 <tr>
6928 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6929 <p><strong>key</strong><br>
6930 <em>optional</em></p>
6931 </div></div></td>
6932 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6933 <p>string</p>
6934 </div></div></td>
6935 </tr>
6936 <tr>
6937 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6938 <p><strong>ownerId</strong><br>
6939 <em>optional</em></p>
6940 </div></div></td>
6941 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6942 <p>string</p>
6943 </div></div></td>
6944 </tr>
6945 <tr>
6946 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6947 <p><strong>uniqueId</strong><br>
6948 <em>optional</em></p>
6949 </div></div></td>
6950 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6951 <p>string</p>
6952 </div></div></td>
6953 </tr>
6954 <tr>
6955 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6956 <p><strong>value</strong><br>
6957 <em>optional</em></p>
6958 </div></div></td>
6959 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6960 <p>string</p>
6961 </div></div></td>
6962 </tr>
6963 </tbody>
6964 </table>
6965
6966 </div>
6967 <div class="sect2">
6968 <h3 id="_additionalinformationdefinition"><a class="anchor" href="#_additionalinformationdefinition"></a>3.2. AdditionalInformationDefinition</h3>
6969 <table class="tableblock frame-all grid-all" style="width:100%; ">
6970 <colgroup>
6971 <col style="width:42%;">
6972 <col style="width:57%;">
6973 </colgroup>
6974 <thead>
6975 <tr>
6976 <th class="tableblock halign-left valign-middle">Name</th>
6977 <th class="tableblock halign-left valign-middle">Schema</th>
6978 </tr>
6979 </thead>
6980 <tbody>
6981 <tr>
6982 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6983 <p><strong>creationTime</strong><br>
6984 <em>optional</em></p>
6985 </div></div></td>
6986 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6987 <p>integer (int64)</p>
6988 </div></div></td>
6989 </tr>
6990 <tr>
6991 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6992 <p><strong>empty</strong><br>
6993 <em>optional</em></p>
6994 </div></div></td>
6995 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
6996 <p>boolean</p>
6997 </div></div></td>
6998 </tr>
6999 <tr>
7000 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7001 <p><strong>lastCreatedCounter</strong><br>
7002 <em>optional</em></p>
7003 </div></div></td>
7004 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7005 <p>integer (int32)</p>
7006 </div></div></td>
7007 </tr>
7008 <tr>
7009 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7010 <p><strong>modificationTime</strong><br>
7011 <em>optional</em></p>
7012 </div></div></td>
7013 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7014 <p>integer (int64)</p>
7015 </div></div></td>
7016 </tr>
7017 <tr>
7018 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7019 <p><strong>ownerId</strong><br>
7020 <em>optional</em></p>
7021 </div></div></td>
7022 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7023 <p>string</p>
7024 </div></div></td>
7025 </tr>
7026 <tr>
7027 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7028 <p><strong>parameters</strong><br>
7029 <em>optional</em></p>
7030 </div></div></td>
7031 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7032 <p>&lt; <a href="#_additionalinfoparameterinfo">AdditionalInfoParameterInfo</a> &gt; array</p>
7033 </div></div></td>
7034 </tr>
7035 <tr>
7036 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7037 <p><strong>parentUniqueId</strong><br>
7038 <em>optional</em></p>
7039 </div></div></td>
7040 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7041 <p>string</p>
7042 </div></div></td>
7043 </tr>
7044 <tr>
7045 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7046 <p><strong>uniqueId</strong><br>
7047 <em>optional</em></p>
7048 </div></div></td>
7049 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7050 <p>string</p>
7051 </div></div></td>
7052 </tr>
7053 </tbody>
7054 </table>
7055
7056 </div>
7057 <div class="sect2">
7058 <h3 id="_artifactdatadefinition"><a class="anchor" href="#_artifactdatadefinition"></a>3.3. ArtifactDataDefinition</h3>
7059 <table class="tableblock frame-all grid-all" style="width:100%; ">
7060 <colgroup>
7061 <col style="width:42%;">
7062 <col style="width:57%;">
7063 </colgroup>
7064 <thead>
7065 <tr>
7066 <th class="tableblock halign-left valign-middle">Name</th>
7067 <th class="tableblock halign-left valign-middle">Schema</th>
7068 </tr>
7069 </thead>
7070 <tbody>
7071 <tr>
7072 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7073 <p><strong>apiUrl</strong><br>
7074 <em>optional</em></p>
7075 </div></div></td>
7076 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7077 <p>string</p>
7078 </div></div></td>
7079 </tr>
7080 <tr>
7081 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7082 <p><strong>artifactChecksum</strong><br>
7083 <em>optional</em></p>
7084 </div></div></td>
7085 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7086 <p>string</p>
7087 </div></div></td>
7088 </tr>
7089 <tr>
7090 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7091 <p><strong>artifactCreator</strong><br>
7092 <em>optional</em></p>
7093 </div></div></td>
7094 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7095 <p>string</p>
7096 </div></div></td>
7097 </tr>
7098 <tr>
7099 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7100 <p><strong>artifactDisplayName</strong><br>
7101 <em>optional</em></p>
7102 </div></div></td>
7103 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7104 <p>string</p>
7105 </div></div></td>
7106 </tr>
7107 <tr>
7108 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7109 <p><strong>artifactGroupType</strong><br>
7110 <em>optional</em></p>
7111 </div></div></td>
7112 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7113 <p>enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER)</p>
7114 </div></div></td>
7115 </tr>
7116 <tr>
7117 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7118 <p><strong>artifactLabel</strong><br>
7119 <em>optional</em></p>
7120 </div></div></td>
7121 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7122 <p>string</p>
7123 </div></div></td>
7124 </tr>
7125 <tr>
7126 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7127 <p><strong>artifactName</strong><br>
7128 <em>optional</em></p>
7129 </div></div></td>
7130 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7131 <p>string</p>
7132 </div></div></td>
7133 </tr>
7134 <tr>
7135 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7136 <p><strong>artifactRef</strong><br>
7137 <em>optional</em></p>
7138 </div></div></td>
7139 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7140 <p>string</p>
7141 </div></div></td>
7142 </tr>
7143 <tr>
7144 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7145 <p><strong>artifactRepository</strong><br>
7146 <em>optional</em></p>
7147 </div></div></td>
7148 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7149 <p>string</p>
7150 </div></div></td>
7151 </tr>
7152 <tr>
7153 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7154 <p><strong>artifactType</strong><br>
7155 <em>optional</em></p>
7156 </div></div></td>
7157 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7158 <p>string</p>
7159 </div></div></td>
7160 </tr>
7161 <tr>
7162 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7163 <p><strong>artifactUUID</strong><br>
7164 <em>optional</em></p>
7165 </div></div></td>
7166 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7167 <p>string</p>
7168 </div></div></td>
7169 </tr>
7170 <tr>
7171 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7172 <p><strong>artifactVersion</strong><br>
7173 <em>optional</em></p>
7174 </div></div></td>
7175 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7176 <p>string</p>
7177 </div></div></td>
7178 </tr>
7179 <tr>
7180 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7181 <p><strong>creationDate</strong><br>
7182 <em>optional</em></p>
7183 </div></div></td>
7184 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7185 <p>integer (int64)</p>
7186 </div></div></td>
7187 </tr>
7188 <tr>
7189 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7190 <p><strong>creatorFullName</strong><br>
7191 <em>optional</em></p>
7192 </div></div></td>
7193 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7194 <p>string</p>
7195 </div></div></td>
7196 </tr>
7197 <tr>
7198 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7199 <p><strong>description</strong><br>
7200 <em>optional</em></p>
7201 </div></div></td>
7202 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7203 <p>string</p>
7204 </div></div></td>
7205 </tr>
7206 <tr>
7207 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7208 <p><strong>duplicated</strong><br>
7209 <em>optional</em></p>
7210 </div></div></td>
7211 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7212 <p>boolean</p>
7213 </div></div></td>
7214 </tr>
7215 <tr>
7216 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7217 <p><strong>empty</strong><br>
7218 <em>optional</em></p>
7219 </div></div></td>
7220 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7221 <p>boolean</p>
7222 </div></div></td>
7223 </tr>
7224 <tr>
7225 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7226 <p><strong>esId</strong><br>
7227 <em>optional</em></p>
7228 </div></div></td>
7229 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7230 <p>string</p>
7231 </div></div></td>
7232 </tr>
7233 <tr>
7234 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7235 <p><strong>generated</strong><br>
7236 <em>optional</em></p>
7237 </div></div></td>
7238 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7239 <p>boolean</p>
7240 </div></div></td>
7241 </tr>
7242 <tr>
7243 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7244 <p><strong>generatedFromId</strong><br>
7245 <em>optional</em></p>
7246 </div></div></td>
7247 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7248 <p>string</p>
7249 </div></div></td>
7250 </tr>
7251 <tr>
7252 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7253 <p><strong>heatParameters</strong><br>
7254 <em>optional</em></p>
7255 </div></div></td>
7256 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7257 <p>&lt; <a href="#_heatparameterdatadefinition">HeatParameterDataDefinition</a> &gt; array</p>
7258 </div></div></td>
7259 </tr>
7260 <tr>
7261 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7262 <p><strong>heatParamsUpdateDate</strong><br>
7263 <em>optional</em></p>
7264 </div></div></td>
7265 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7266 <p>integer (int64)</p>
7267 </div></div></td>
7268 </tr>
7269 <tr>
7270 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7271 <p><strong>isFromCsar</strong><br>
7272 <em>optional</em></p>
7273 </div></div></td>
7274 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7275 <p>boolean</p>
7276 </div></div></td>
7277 </tr>
7278 <tr>
7279 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7280 <p><strong>lastUpdateDate</strong><br>
7281 <em>optional</em></p>
7282 </div></div></td>
7283 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7284 <p>integer (int64)</p>
7285 </div></div></td>
7286 </tr>
7287 <tr>
7288 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7289 <p><strong>mandatory</strong><br>
7290 <em>optional</em></p>
7291 </div></div></td>
7292 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7293 <p>boolean</p>
7294 </div></div></td>
7295 </tr>
7296 <tr>
7297 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7298 <p><strong>ownerId</strong><br>
7299 <em>optional</em></p>
7300 </div></div></td>
7301 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7302 <p>string</p>
7303 </div></div></td>
7304 </tr>
7305 <tr>
7306 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7307 <p><strong>payloadUpdateDate</strong><br>
7308 <em>optional</em></p>
7309 </div></div></td>
7310 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7311 <p>integer (int64)</p>
7312 </div></div></td>
7313 </tr>
7314 <tr>
7315 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7316 <p><strong>requiredArtifacts</strong><br>
7317 <em>optional</em></p>
7318 </div></div></td>
7319 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7320 <p>&lt; string &gt; array</p>
7321 </div></div></td>
7322 </tr>
7323 <tr>
7324 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7325 <p><strong>serviceApi</strong><br>
7326 <em>optional</em></p>
7327 </div></div></td>
7328 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7329 <p>boolean</p>
7330 </div></div></td>
7331 </tr>
7332 <tr>
7333 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7334 <p><strong>timeout</strong><br>
7335 <em>optional</em></p>
7336 </div></div></td>
7337 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7338 <p>integer (int32)</p>
7339 </div></div></td>
7340 </tr>
7341 <tr>
7342 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7343 <p><strong>uniqueId</strong><br>
7344 <em>optional</em></p>
7345 </div></div></td>
7346 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7347 <p>string</p>
7348 </div></div></td>
7349 </tr>
7350 <tr>
7351 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7352 <p><strong>updaterFullName</strong><br>
7353 <em>optional</em></p>
7354 </div></div></td>
7355 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7356 <p>string</p>
7357 </div></div></td>
7358 </tr>
7359 <tr>
7360 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7361 <p><strong>userIdCreator</strong><br>
7362 <em>optional</em></p>
7363 </div></div></td>
7364 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7365 <p>string</p>
7366 </div></div></td>
7367 </tr>
7368 <tr>
7369 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7370 <p><strong>userIdLastUpdater</strong><br>
7371 <em>optional</em></p>
7372 </div></div></td>
7373 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7374 <p>string</p>
7375 </div></div></td>
7376 </tr>
7377 </tbody>
7378 </table>
7379
7380 </div>
7381 <div class="sect2">
7382 <h3 id="_artifactdefinition"><a class="anchor" href="#_artifactdefinition"></a>3.4. ArtifactDefinition</h3>
7383 <table class="tableblock frame-all grid-all" style="width:100%; ">
7384 <colgroup>
7385 <col style="width:42%;">
7386 <col style="width:57%;">
7387 </colgroup>
7388 <thead>
7389 <tr>
7390 <th class="tableblock halign-left valign-middle">Name</th>
7391 <th class="tableblock halign-left valign-middle">Schema</th>
7392 </tr>
7393 </thead>
7394 <tbody>
7395 <tr>
7396 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7397 <p><strong>apiUrl</strong><br>
7398 <em>optional</em></p>
7399 </div></div></td>
7400 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7401 <p>string</p>
7402 </div></div></td>
7403 </tr>
7404 <tr>
7405 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7406 <p><strong>artifactChecksum</strong><br>
7407 <em>optional</em></p>
7408 </div></div></td>
7409 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7410 <p>string</p>
7411 </div></div></td>
7412 </tr>
7413 <tr>
7414 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7415 <p><strong>artifactCreator</strong><br>
7416 <em>optional</em></p>
7417 </div></div></td>
7418 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7419 <p>string</p>
7420 </div></div></td>
7421 </tr>
7422 <tr>
7423 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7424 <p><strong>artifactDisplayName</strong><br>
7425 <em>optional</em></p>
7426 </div></div></td>
7427 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7428 <p>string</p>
7429 </div></div></td>
7430 </tr>
7431 <tr>
7432 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7433 <p><strong>artifactGroupType</strong><br>
7434 <em>optional</em></p>
7435 </div></div></td>
7436 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7437 <p>enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER)</p>
7438 </div></div></td>
7439 </tr>
7440 <tr>
7441 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7442 <p><strong>artifactLabel</strong><br>
7443 <em>optional</em></p>
7444 </div></div></td>
7445 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7446 <p>string</p>
7447 </div></div></td>
7448 </tr>
7449 <tr>
7450 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7451 <p><strong>artifactName</strong><br>
7452 <em>optional</em></p>
7453 </div></div></td>
7454 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7455 <p>string</p>
7456 </div></div></td>
7457 </tr>
7458 <tr>
7459 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7460 <p><strong>artifactRef</strong><br>
7461 <em>optional</em></p>
7462 </div></div></td>
7463 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7464 <p>string</p>
7465 </div></div></td>
7466 </tr>
7467 <tr>
7468 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7469 <p><strong>artifactRepository</strong><br>
7470 <em>optional</em></p>
7471 </div></div></td>
7472 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7473 <p>string</p>
7474 </div></div></td>
7475 </tr>
7476 <tr>
7477 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7478 <p><strong>artifactType</strong><br>
7479 <em>optional</em></p>
7480 </div></div></td>
7481 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7482 <p>string</p>
7483 </div></div></td>
7484 </tr>
7485 <tr>
7486 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7487 <p><strong>artifactUUID</strong><br>
7488 <em>optional</em></p>
7489 </div></div></td>
7490 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7491 <p>string</p>
7492 </div></div></td>
7493 </tr>
7494 <tr>
7495 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7496 <p><strong>artifactVersion</strong><br>
7497 <em>optional</em></p>
7498 </div></div></td>
7499 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7500 <p>string</p>
7501 </div></div></td>
7502 </tr>
7503 <tr>
7504 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7505 <p><strong>creationDate</strong><br>
7506 <em>optional</em></p>
7507 </div></div></td>
7508 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7509 <p>integer (int64)</p>
7510 </div></div></td>
7511 </tr>
7512 <tr>
7513 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7514 <p><strong>creatorFullName</strong><br>
7515 <em>optional</em></p>
7516 </div></div></td>
7517 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7518 <p>string</p>
7519 </div></div></td>
7520 </tr>
7521 <tr>
7522 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7523 <p><strong>description</strong><br>
7524 <em>optional</em></p>
7525 </div></div></td>
7526 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7527 <p>string</p>
7528 </div></div></td>
7529 </tr>
7530 <tr>
7531 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7532 <p><strong>duplicated</strong><br>
7533 <em>optional</em></p>
7534 </div></div></td>
7535 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7536 <p>boolean</p>
7537 </div></div></td>
7538 </tr>
7539 <tr>
7540 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7541 <p><strong>empty</strong><br>
7542 <em>optional</em></p>
7543 </div></div></td>
7544 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7545 <p>boolean</p>
7546 </div></div></td>
7547 </tr>
7548 <tr>
7549 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7550 <p><strong>esId</strong><br>
7551 <em>optional</em></p>
7552 </div></div></td>
7553 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7554 <p>string</p>
7555 </div></div></td>
7556 </tr>
7557 <tr>
7558 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7559 <p><strong>generated</strong><br>
7560 <em>optional</em></p>
7561 </div></div></td>
7562 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7563 <p>boolean</p>
7564 </div></div></td>
7565 </tr>
7566 <tr>
7567 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7568 <p><strong>generatedFromId</strong><br>
7569 <em>optional</em></p>
7570 </div></div></td>
7571 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7572 <p>string</p>
7573 </div></div></td>
7574 </tr>
7575 <tr>
7576 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7577 <p><strong>heatParameters</strong><br>
7578 <em>optional</em></p>
7579 </div></div></td>
7580 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7581 <p>&lt; <a href="#_heatparameterdatadefinition">HeatParameterDataDefinition</a> &gt; array</p>
7582 </div></div></td>
7583 </tr>
7584 <tr>
7585 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7586 <p><strong>heatParamsUpdateDate</strong><br>
7587 <em>optional</em></p>
7588 </div></div></td>
7589 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7590 <p>integer (int64)</p>
7591 </div></div></td>
7592 </tr>
7593 <tr>
7594 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7595 <p><strong>isFromCsar</strong><br>
7596 <em>optional</em></p>
7597 </div></div></td>
7598 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7599 <p>boolean</p>
7600 </div></div></td>
7601 </tr>
7602 <tr>
7603 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7604 <p><strong>lastUpdateDate</strong><br>
7605 <em>optional</em></p>
7606 </div></div></td>
7607 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7608 <p>integer (int64)</p>
7609 </div></div></td>
7610 </tr>
7611 <tr>
7612 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7613 <p><strong>listHeatParameters</strong><br>
7614 <em>optional</em></p>
7615 </div></div></td>
7616 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7617 <p>&lt; <a href="#_heatparameterdefinition">HeatParameterDefinition</a> &gt; array</p>
7618 </div></div></td>
7619 </tr>
7620 <tr>
7621 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7622 <p><strong>mandatory</strong><br>
7623 <em>optional</em></p>
7624 </div></div></td>
7625 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7626 <p>boolean</p>
7627 </div></div></td>
7628 </tr>
7629 <tr>
7630 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7631 <p><strong>ownerId</strong><br>
7632 <em>optional</em></p>
7633 </div></div></td>
7634 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7635 <p>string</p>
7636 </div></div></td>
7637 </tr>
7638 <tr>
7639 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7640 <p><strong>payloadData</strong><br>
7641 <em>optional</em></p>
7642 </div></div></td>
7643 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7644 <p>&lt; string (byte) &gt; array</p>
7645 </div></div></td>
7646 </tr>
7647 <tr>
7648 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7649 <p><strong>payloadUpdateDate</strong><br>
7650 <em>optional</em></p>
7651 </div></div></td>
7652 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7653 <p>integer (int64)</p>
7654 </div></div></td>
7655 </tr>
7656 <tr>
7657 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7658 <p><strong>requiredArtifacts</strong><br>
7659 <em>optional</em></p>
7660 </div></div></td>
7661 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7662 <p>&lt; string &gt; array</p>
7663 </div></div></td>
7664 </tr>
7665 <tr>
7666 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7667 <p><strong>serviceApi</strong><br>
7668 <em>optional</em></p>
7669 </div></div></td>
7670 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7671 <p>boolean</p>
7672 </div></div></td>
7673 </tr>
7674 <tr>
7675 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7676 <p><strong>timeout</strong><br>
7677 <em>optional</em></p>
7678 </div></div></td>
7679 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7680 <p>integer (int32)</p>
7681 </div></div></td>
7682 </tr>
7683 <tr>
7684 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7685 <p><strong>uniqueId</strong><br>
7686 <em>optional</em></p>
7687 </div></div></td>
7688 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7689 <p>string</p>
7690 </div></div></td>
7691 </tr>
7692 <tr>
7693 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7694 <p><strong>updaterFullName</strong><br>
7695 <em>optional</em></p>
7696 </div></div></td>
7697 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7698 <p>string</p>
7699 </div></div></td>
7700 </tr>
7701 <tr>
7702 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7703 <p><strong>userIdCreator</strong><br>
7704 <em>optional</em></p>
7705 </div></div></td>
7706 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7707 <p>string</p>
7708 </div></div></td>
7709 </tr>
7710 <tr>
7711 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7712 <p><strong>userIdLastUpdater</strong><br>
7713 <em>optional</em></p>
7714 </div></div></td>
7715 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7716 <p>string</p>
7717 </div></div></td>
7718 </tr>
7719 </tbody>
7720 </table>
7721
7722 </div>
7723 <div class="sect2">
7724 <h3 id="_assetmetadata"><a class="anchor" href="#_assetmetadata"></a>3.5. AssetMetadata</h3>
7725 <table class="tableblock frame-all grid-all" style="width:100%; ">
7726 <colgroup>
7727 <col style="width:42%;">
7728 <col style="width:57%;">
7729 </colgroup>
7730 <thead>
7731 <tr>
7732 <th class="tableblock halign-left valign-middle">Name</th>
7733 <th class="tableblock halign-left valign-middle">Schema</th>
7734 </tr>
7735 </thead>
7736 <tbody>
7737 <tr>
7738 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7739 <p><strong>invariantUUID</strong><br>
7740 <em>optional</em></p>
7741 </div></div></td>
7742 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7743 <p>string</p>
7744 </div></div></td>
7745 </tr>
7746 <tr>
7747 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7748 <p><strong>name</strong><br>
7749 <em>optional</em></p>
7750 </div></div></td>
7751 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7752 <p>string</p>
7753 </div></div></td>
7754 </tr>
7755 <tr>
7756 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7757 <p><strong>toscaModelURL</strong><br>
7758 <em>optional</em></p>
7759 </div></div></td>
7760 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7761 <p>string</p>
7762 </div></div></td>
7763 </tr>
7764 <tr>
7765 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7766 <p><strong>uuid</strong><br>
7767 <em>optional</em></p>
7768 </div></div></td>
7769 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7770 <p>string</p>
7771 </div></div></td>
7772 </tr>
7773 <tr>
7774 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7775 <p><strong>version</strong><br>
7776 <em>optional</em></p>
7777 </div></div></td>
7778 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7779 <p>string</p>
7780 </div></div></td>
7781 </tr>
7782 </tbody>
7783 </table>
7784
7785 </div>
7786 <div class="sect2">
7787 <h3 id="_capabilitydatadefinition"><a class="anchor" href="#_capabilitydatadefinition"></a>3.6. CapabilityDataDefinition</h3>
7788 <table class="tableblock frame-all grid-all" style="width:100%; ">
7789 <colgroup>
7790 <col style="width:42%;">
7791 <col style="width:57%;">
7792 </colgroup>
7793 <thead>
7794 <tr>
7795 <th class="tableblock halign-left valign-middle">Name</th>
7796 <th class="tableblock halign-left valign-middle">Schema</th>
7797 </tr>
7798 </thead>
7799 <tbody>
7800 <tr>
7801 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7802 <p><strong>capabilitySources</strong><br>
7803 <em>optional</em></p>
7804 </div></div></td>
7805 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7806 <p>&lt; string &gt; array</p>
7807 </div></div></td>
7808 </tr>
7809 <tr>
7810 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7811 <p><strong>description</strong><br>
7812 <em>optional</em></p>
7813 </div></div></td>
7814 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7815 <p>string</p>
7816 </div></div></td>
7817 </tr>
7818 <tr>
7819 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7820 <p><strong>empty</strong><br>
7821 <em>optional</em></p>
7822 </div></div></td>
7823 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7824 <p>boolean</p>
7825 </div></div></td>
7826 </tr>
7827 <tr>
7828 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7829 <p><strong>leftOccurrences</strong><br>
7830 <em>optional</em></p>
7831 </div></div></td>
7832 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7833 <p>string</p>
7834 </div></div></td>
7835 </tr>
7836 <tr>
7837 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7838 <p><strong>maxOccurrences</strong><br>
7839 <em>optional</em></p>
7840 </div></div></td>
7841 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7842 <p>string</p>
7843 </div></div></td>
7844 </tr>
7845 <tr>
7846 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7847 <p><strong>minOccurrences</strong><br>
7848 <em>optional</em></p>
7849 </div></div></td>
7850 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7851 <p>string</p>
7852 </div></div></td>
7853 </tr>
7854 <tr>
7855 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7856 <p><strong>name</strong><br>
7857 <em>optional</em></p>
7858 </div></div></td>
7859 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7860 <p>string</p>
7861 </div></div></td>
7862 </tr>
7863 <tr>
7864 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7865 <p><strong>ownerId</strong><br>
7866 <em>optional</em></p>
7867 </div></div></td>
7868 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7869 <p>string</p>
7870 </div></div></td>
7871 </tr>
7872 <tr>
7873 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7874 <p><strong>ownerName</strong><br>
7875 <em>optional</em></p>
7876 </div></div></td>
7877 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7878 <p>string</p>
7879 </div></div></td>
7880 </tr>
7881 <tr>
7882 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7883 <p><strong>parentName</strong><br>
7884 <em>optional</em></p>
7885 </div></div></td>
7886 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7887 <p>string</p>
7888 </div></div></td>
7889 </tr>
7890 <tr>
7891 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7892 <p><strong>path</strong><br>
7893 <em>optional</em></p>
7894 </div></div></td>
7895 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7896 <p>&lt; string &gt; array</p>
7897 </div></div></td>
7898 </tr>
7899 <tr>
7900 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7901 <p><strong>source</strong><br>
7902 <em>optional</em></p>
7903 </div></div></td>
7904 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7905 <p>string</p>
7906 </div></div></td>
7907 </tr>
7908 <tr>
7909 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7910 <p><strong>type</strong><br>
7911 <em>optional</em></p>
7912 </div></div></td>
7913 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7914 <p>string</p>
7915 </div></div></td>
7916 </tr>
7917 <tr>
7918 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7919 <p><strong>uniqueId</strong><br>
7920 <em>optional</em></p>
7921 </div></div></td>
7922 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7923 <p>string</p>
7924 </div></div></td>
7925 </tr>
7926 <tr>
7927 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7928 <p><strong>validSourceTypes</strong><br>
7929 <em>optional</em></p>
7930 </div></div></td>
7931 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7932 <p>&lt; string &gt; array</p>
7933 </div></div></td>
7934 </tr>
7935 </tbody>
7936 </table>
7937
7938 </div>
7939 <div class="sect2">
7940 <h3 id="_capabilitydefinition"><a class="anchor" href="#_capabilitydefinition"></a>3.7. CapabilityDefinition</h3>
7941 <table class="tableblock frame-all grid-all" style="width:100%; ">
7942 <colgroup>
7943 <col style="width:42%;">
7944 <col style="width:57%;">
7945 </colgroup>
7946 <thead>
7947 <tr>
7948 <th class="tableblock halign-left valign-middle">Name</th>
7949 <th class="tableblock halign-left valign-middle">Schema</th>
7950 </tr>
7951 </thead>
7952 <tbody>
7953 <tr>
7954 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7955 <p><strong>capabilitySources</strong><br>
7956 <em>optional</em></p>
7957 </div></div></td>
7958 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7959 <p>&lt; string &gt; array</p>
7960 </div></div></td>
7961 </tr>
7962 <tr>
7963 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7964 <p><strong>description</strong><br>
7965 <em>optional</em></p>
7966 </div></div></td>
7967 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7968 <p>string</p>
7969 </div></div></td>
7970 </tr>
7971 <tr>
7972 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7973 <p><strong>empty</strong><br>
7974 <em>optional</em></p>
7975 </div></div></td>
7976 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7977 <p>boolean</p>
7978 </div></div></td>
7979 </tr>
7980 <tr>
7981 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7982 <p><strong>leftOccurrences</strong><br>
7983 <em>optional</em></p>
7984 </div></div></td>
7985 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7986 <p>string</p>
7987 </div></div></td>
7988 </tr>
7989 <tr>
7990 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7991 <p><strong>maxOccurrences</strong><br>
7992 <em>optional</em></p>
7993 </div></div></td>
7994 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
7995 <p>string</p>
7996 </div></div></td>
7997 </tr>
7998 <tr>
7999 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8000 <p><strong>minOccurrences</strong><br>
8001 <em>optional</em></p>
8002 </div></div></td>
8003 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8004 <p>string</p>
8005 </div></div></td>
8006 </tr>
8007 <tr>
8008 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8009 <p><strong>name</strong><br>
8010 <em>optional</em></p>
8011 </div></div></td>
8012 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8013 <p>string</p>
8014 </div></div></td>
8015 </tr>
8016 <tr>
8017 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8018 <p><strong>ownerId</strong><br>
8019 <em>optional</em></p>
8020 </div></div></td>
8021 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8022 <p>string</p>
8023 </div></div></td>
8024 </tr>
8025 <tr>
8026 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8027 <p><strong>ownerName</strong><br>
8028 <em>optional</em></p>
8029 </div></div></td>
8030 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8031 <p>string</p>
8032 </div></div></td>
8033 </tr>
8034 <tr>
8035 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8036 <p><strong>parentName</strong><br>
8037 <em>optional</em></p>
8038 </div></div></td>
8039 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8040 <p>string</p>
8041 </div></div></td>
8042 </tr>
8043 <tr>
8044 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8045 <p><strong>path</strong><br>
8046 <em>optional</em></p>
8047 </div></div></td>
8048 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8049 <p>&lt; string &gt; array</p>
8050 </div></div></td>
8051 </tr>
8052 <tr>
8053 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8054 <p><strong>properties</strong><br>
8055 <em>optional</em></p>
8056 </div></div></td>
8057 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8058 <p>&lt; <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> &gt; array</p>
8059 </div></div></td>
8060 </tr>
8061 <tr>
8062 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8063 <p><strong>source</strong><br>
8064 <em>optional</em></p>
8065 </div></div></td>
8066 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8067 <p>string</p>
8068 </div></div></td>
8069 </tr>
8070 <tr>
8071 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8072 <p><strong>type</strong><br>
8073 <em>optional</em></p>
8074 </div></div></td>
8075 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8076 <p>string</p>
8077 </div></div></td>
8078 </tr>
8079 <tr>
8080 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8081 <p><strong>uniqueId</strong><br>
8082 <em>optional</em></p>
8083 </div></div></td>
8084 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8085 <p>string</p>
8086 </div></div></td>
8087 </tr>
8088 <tr>
8089 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8090 <p><strong>validSourceTypes</strong><br>
8091 <em>optional</em></p>
8092 </div></div></td>
8093 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8094 <p>&lt; string &gt; array</p>
8095 </div></div></td>
8096 </tr>
8097 </tbody>
8098 </table>
8099
8100 </div>
8101 <div class="sect2">
8102 <h3 id="_capabilityrequirementrelationship"><a class="anchor" href="#_capabilityrequirementrelationship"></a>3.8. CapabilityRequirementRelationship</h3>
8103 <table class="tableblock frame-all grid-all" style="width:100%; ">
8104 <colgroup>
8105 <col style="width:42%;">
8106 <col style="width:57%;">
8107 </colgroup>
8108 <thead>
8109 <tr>
8110 <th class="tableblock halign-left valign-middle">Name</th>
8111 <th class="tableblock halign-left valign-middle">Schema</th>
8112 </tr>
8113 </thead>
8114 <tbody>
8115 <tr>
8116 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8117 <p><strong>capability</strong><br>
8118 <em>optional</em></p>
8119 </div></div></td>
8120 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8121 <p><a href="#_capabilitydatadefinition">CapabilityDataDefinition</a></p>
8122 </div></div></td>
8123 </tr>
8124 <tr>
8125 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8126 <p><strong>relation</strong><br>
8127 <em>optional</em></p>
8128 </div></div></td>
8129 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8130 <p><a href="#_relationshipinfo">RelationshipInfo</a></p>
8131 </div></div></td>
8132 </tr>
8133 <tr>
8134 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8135 <p><strong>requirement</strong><br>
8136 <em>optional</em></p>
8137 </div></div></td>
8138 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8139 <p><a href="#_requirementdatadefinition">RequirementDataDefinition</a></p>
8140 </div></div></td>
8141 </tr>
8142 </tbody>
8143 </table>
8144
8145 </div>
8146 <div class="sect2">
8147 <h3 id="_categorydefinition"><a class="anchor" href="#_categorydefinition"></a>3.9. CategoryDefinition</h3>
8148 <table class="tableblock frame-all grid-all" style="width:100%; ">
8149 <colgroup>
8150 <col style="width:42%;">
8151 <col style="width:57%;">
8152 </colgroup>
8153 <thead>
8154 <tr>
8155 <th class="tableblock halign-left valign-middle">Name</th>
8156 <th class="tableblock halign-left valign-middle">Schema</th>
8157 </tr>
8158 </thead>
8159 <tbody>
8160 <tr>
8161 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8162 <p><strong>empty</strong><br>
8163 <em>optional</em></p>
8164 </div></div></td>
8165 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8166 <p>boolean</p>
8167 </div></div></td>
8168 </tr>
8169 <tr>
8170 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8171 <p><strong>icons</strong><br>
8172 <em>optional</em></p>
8173 </div></div></td>
8174 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8175 <p>&lt; string &gt; array</p>
8176 </div></div></td>
8177 </tr>
8178 <tr>
8179 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8180 <p><strong>name</strong><br>
8181 <em>optional</em></p>
8182 </div></div></td>
8183 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8184 <p>string</p>
8185 </div></div></td>
8186 </tr>
8187 <tr>
8188 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8189 <p><strong>normalizedName</strong><br>
8190 <em>optional</em></p>
8191 </div></div></td>
8192 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8193 <p>string</p>
8194 </div></div></td>
8195 </tr>
8196 <tr>
8197 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8198 <p><strong>ownerId</strong><br>
8199 <em>optional</em></p>
8200 </div></div></td>
8201 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8202 <p>string</p>
8203 </div></div></td>
8204 </tr>
8205 <tr>
8206 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8207 <p><strong>subcategories</strong><br>
8208 <em>optional</em></p>
8209 </div></div></td>
8210 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8211 <p>&lt; <a href="#_subcategorydefinition">SubCategoryDefinition</a> &gt; array</p>
8212 </div></div></td>
8213 </tr>
8214 <tr>
8215 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8216 <p><strong>uniqueId</strong><br>
8217 <em>optional</em></p>
8218 </div></div></td>
8219 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8220 <p>string</p>
8221 </div></div></td>
8222 </tr>
8223 </tbody>
8224 </table>
8225
8226 </div>
8227 <div class="sect2">
8228 <h3 id="_componentinstance"><a class="anchor" href="#_componentinstance"></a>3.10. ComponentInstance</h3>
8229 <table class="tableblock frame-all grid-all" style="width:100%; ">
8230 <colgroup>
8231 <col style="width:42%;">
8232 <col style="width:57%;">
8233 </colgroup>
8234 <thead>
8235 <tr>
8236 <th class="tableblock halign-left valign-middle">Name</th>
8237 <th class="tableblock halign-left valign-middle">Schema</th>
8238 </tr>
8239 </thead>
8240 <tbody>
8241 <tr>
8242 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8243 <p><strong>actualComponentUid</strong><br>
8244 <em>optional</em></p>
8245 </div></div></td>
8246 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8247 <p>string</p>
8248 </div></div></td>
8249 </tr>
8250 <tr>
8251 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8252 <p><strong>artifacts</strong><br>
8253 <em>optional</em></p>
8254 </div></div></td>
8255 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8256 <p>&lt; string, <a href="#_artifactdefinition">ArtifactDefinition</a> &gt; map</p>
8257 </div></div></td>
8258 </tr>
8259 <tr>
8260 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8261 <p><strong>attributeValueCounter</strong><br>
8262 <em>optional</em></p>
8263 </div></div></td>
8264 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8265 <p>integer (int32)</p>
8266 </div></div></td>
8267 </tr>
8268 <tr>
8269 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8270 <p><strong>capabilities</strong><br>
8271 <em>optional</em></p>
8272 </div></div></td>
8273 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8274 <p>&lt; string, &lt; <a href="#_capabilitydefinition">CapabilityDefinition</a> &gt; array &gt; map</p>
8275 </div></div></td>
8276 </tr>
8277 <tr>
8278 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8279 <p><strong>componentName</strong><br>
8280 <em>optional</em></p>
8281 </div></div></td>
8282 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8283 <p>string</p>
8284 </div></div></td>
8285 </tr>
8286 <tr>
8287 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8288 <p><strong>componentUid</strong><br>
8289 <em>optional</em></p>
8290 </div></div></td>
8291 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8292 <p>string</p>
8293 </div></div></td>
8294 </tr>
8295 <tr>
8296 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8297 <p><strong>componentVersion</strong><br>
8298 <em>optional</em></p>
8299 </div></div></td>
8300 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8301 <p>string</p>
8302 </div></div></td>
8303 </tr>
8304 <tr>
8305 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8306 <p><strong>creationTime</strong><br>
8307 <em>optional</em></p>
8308 </div></div></td>
8309 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8310 <p>integer (int64)</p>
8311 </div></div></td>
8312 </tr>
8313 <tr>
8314 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8315 <p><strong>customizationUUID</strong><br>
8316 <em>optional</em></p>
8317 </div></div></td>
8318 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8319 <p>string</p>
8320 </div></div></td>
8321 </tr>
8322 <tr>
8323 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8324 <p><strong>deploymentArtifacts</strong><br>
8325 <em>optional</em></p>
8326 </div></div></td>
8327 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8328 <p>&lt; string, <a href="#_artifactdefinition">ArtifactDefinition</a> &gt; map</p>
8329 </div></div></td>
8330 </tr>
8331 <tr>
8332 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8333 <p><strong>description</strong><br>
8334 <em>optional</em></p>
8335 </div></div></td>
8336 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8337 <p>string</p>
8338 </div></div></td>
8339 </tr>
8340 <tr>
8341 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8342 <p><strong>empty</strong><br>
8343 <em>optional</em></p>
8344 </div></div></td>
8345 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8346 <p>boolean</p>
8347 </div></div></td>
8348 </tr>
8349 <tr>
8350 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8351 <p><strong>groupInstances</strong><br>
8352 <em>optional</em></p>
8353 </div></div></td>
8354 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8355 <p>&lt; <a href="#_groupinstance">GroupInstance</a> &gt; array</p>
8356 </div></div></td>
8357 </tr>
8358 <tr>
8359 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8360 <p><strong>icon</strong><br>
8361 <em>optional</em></p>
8362 </div></div></td>
8363 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8364 <p>string</p>
8365 </div></div></td>
8366 </tr>
8367 <tr>
8368 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8369 <p><strong>inputValueCounter</strong><br>
8370 <em>optional</em></p>
8371 </div></div></td>
8372 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8373 <p>integer (int32)</p>
8374 </div></div></td>
8375 </tr>
8376 <tr>
8377 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8378 <p><strong>invariantName</strong><br>
8379 <em>optional</em></p>
8380 </div></div></td>
8381 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8382 <p>string</p>
8383 </div></div></td>
8384 </tr>
8385 <tr>
8386 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8387 <p><strong>isProxy</strong><br>
8388 <em>optional</em></p>
8389 </div></div></td>
8390 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8391 <p>boolean</p>
8392 </div></div></td>
8393 </tr>
8394 <tr>
8395 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8396 <p><strong>modificationTime</strong><br>
8397 <em>optional</em></p>
8398 </div></div></td>
8399 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8400 <p>integer (int64)</p>
8401 </div></div></td>
8402 </tr>
8403 <tr>
8404 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8405 <p><strong>name</strong><br>
8406 <em>optional</em></p>
8407 </div></div></td>
8408 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8409 <p>string</p>
8410 </div></div></td>
8411 </tr>
8412 <tr>
8413 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8414 <p><strong>normalizedName</strong><br>
8415 <em>optional</em></p>
8416 </div></div></td>
8417 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8418 <p>string</p>
8419 </div></div></td>
8420 </tr>
8421 <tr>
8422 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8423 <p><strong>originType</strong><br>
8424 <em>optional</em></p>
8425 </div></div></td>
8426 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8427 <p>enum (PRODUCT, SERVICE, VF, VFC, CP, VL, Configuration, VFCMT, CVFC, PNF, CR, ServiceProxy)</p>
8428 </div></div></td>
8429 </tr>
8430 <tr>
8431 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8432 <p><strong>ownerId</strong><br>
8433 <em>optional</em></p>
8434 </div></div></td>
8435 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8436 <p>string</p>
8437 </div></div></td>
8438 </tr>
8439 <tr>
8440 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8441 <p><strong>posX</strong><br>
8442 <em>optional</em></p>
8443 </div></div></td>
8444 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8445 <p>string</p>
8446 </div></div></td>
8447 </tr>
8448 <tr>
8449 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8450 <p><strong>posY</strong><br>
8451 <em>optional</em></p>
8452 </div></div></td>
8453 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8454 <p>string</p>
8455 </div></div></td>
8456 </tr>
8457 <tr>
8458 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8459 <p><strong>propertyValueCounter</strong><br>
8460 <em>optional</em></p>
8461 </div></div></td>
8462 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8463 <p>integer (int32)</p>
8464 </div></div></td>
8465 </tr>
8466 <tr>
8467 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8468 <p><strong>requirements</strong><br>
8469 <em>optional</em></p>
8470 </div></div></td>
8471 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8472 <p>&lt; string, &lt; <a href="#_requirementdefinition">RequirementDefinition</a> &gt; array &gt; map</p>
8473 </div></div></td>
8474 </tr>
8475 <tr>
8476 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8477 <p><strong>sourceModelInvariant</strong><br>
8478 <em>optional</em></p>
8479 </div></div></td>
8480 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8481 <p>string</p>
8482 </div></div></td>
8483 </tr>
8484 <tr>
8485 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8486 <p><strong>sourceModelName</strong><br>
8487 <em>optional</em></p>
8488 </div></div></td>
8489 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8490 <p>string</p>
8491 </div></div></td>
8492 </tr>
8493 <tr>
8494 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8495 <p><strong>sourceModelUid</strong><br>
8496 <em>optional</em></p>
8497 </div></div></td>
8498 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8499 <p>string</p>
8500 </div></div></td>
8501 </tr>
8502 <tr>
8503 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8504 <p><strong>sourceModelUuid</strong><br>
8505 <em>optional</em></p>
8506 </div></div></td>
8507 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8508 <p>string</p>
8509 </div></div></td>
8510 </tr>
8511 <tr>
8512 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8513 <p><strong>toscaComponentName</strong><br>
8514 <em>optional</em></p>
8515 </div></div></td>
8516 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8517 <p>string</p>
8518 </div></div></td>
8519 </tr>
8520 <tr>
8521 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8522 <p><strong>uniqueId</strong><br>
8523 <em>optional</em></p>
8524 </div></div></td>
8525 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8526 <p>string</p>
8527 </div></div></td>
8528 </tr>
8529 </tbody>
8530 </table>
8531
8532 </div>
8533 <div class="sect2">
8534 <h3 id="_componentinstanceinput"><a class="anchor" href="#_componentinstanceinput"></a>3.11. ComponentInstanceInput</h3>
8535 <table class="tableblock frame-all grid-all" style="width:100%; ">
8536 <colgroup>
8537 <col style="width:42%;">
8538 <col style="width:57%;">
8539 </colgroup>
8540 <thead>
8541 <tr>
8542 <th class="tableblock halign-left valign-middle">Name</th>
8543 <th class="tableblock halign-left valign-middle">Schema</th>
8544 </tr>
8545 </thead>
8546 <tbody>
8547 <tr>
8548 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8549 <p><strong>componentInstanceId</strong><br>
8550 <em>optional</em></p>
8551 </div></div></td>
8552 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8553 <p>string</p>
8554 </div></div></td>
8555 </tr>
8556 <tr>
8557 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8558 <p><strong>componentInstanceName</strong><br>
8559 <em>optional</em></p>
8560 </div></div></td>
8561 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8562 <p>string</p>
8563 </div></div></td>
8564 </tr>
8565 <tr>
8566 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8567 <p><strong>constraints</strong><br>
8568 <em>optional</em></p>
8569 </div></div></td>
8570 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8571 <p>&lt; <a href="#_propertyconstraint">PropertyConstraint</a> &gt; array</p>
8572 </div></div></td>
8573 </tr>
8574 <tr>
8575 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8576 <p><strong>defaultValue</strong><br>
8577 <em>optional</em></p>
8578 </div></div></td>
8579 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8580 <p>string</p>
8581 </div></div></td>
8582 </tr>
8583 <tr>
8584 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8585 <p><strong>definition</strong><br>
8586 <em>optional</em></p>
8587 </div></div></td>
8588 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8589 <p>boolean</p>
8590 </div></div></td>
8591 </tr>
8592 <tr>
8593 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8594 <p><strong>description</strong><br>
8595 <em>optional</em></p>
8596 </div></div></td>
8597 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8598 <p>string</p>
8599 </div></div></td>
8600 </tr>
8601 <tr>
8602 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8603 <p><strong>empty</strong><br>
8604 <em>optional</em></p>
8605 </div></div></td>
8606 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8607 <p>boolean</p>
8608 </div></div></td>
8609 </tr>
8610 <tr>
8611 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8612 <p><strong>getInputProperty</strong><br>
8613 <em>optional</em></p>
8614 </div></div></td>
8615 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8616 <p>boolean</p>
8617 </div></div></td>
8618 </tr>
8619 <tr>
8620 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8621 <p><strong>getInputValues</strong><br>
8622 <em>optional</em></p>
8623 </div></div></td>
8624 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8625 <p>&lt; <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> &gt; array</p>
8626 </div></div></td>
8627 </tr>
8628 <tr>
8629 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8630 <p><strong>hidden</strong><br>
8631 <em>optional</em></p>
8632 </div></div></td>
8633 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8634 <p>boolean</p>
8635 </div></div></td>
8636 </tr>
8637 <tr>
8638 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8639 <p><strong>immutable</strong><br>
8640 <em>optional</em></p>
8641 </div></div></td>
8642 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8643 <p>boolean</p>
8644 </div></div></td>
8645 </tr>
8646 <tr>
8647 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8648 <p><strong>inputId</strong><br>
8649 <em>optional</em></p>
8650 </div></div></td>
8651 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8652 <p>string</p>
8653 </div></div></td>
8654 </tr>
8655 <tr>
8656 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8657 <p><strong>inputPath</strong><br>
8658 <em>optional</em></p>
8659 </div></div></td>
8660 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8661 <p>string</p>
8662 </div></div></td>
8663 </tr>
8664 <tr>
8665 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8666 <p><strong>inputs</strong><br>
8667 <em>optional</em></p>
8668 </div></div></td>
8669 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8670 <p>&lt; <a href="#_componentinstanceinput">ComponentInstanceInput</a> &gt; array</p>
8671 </div></div></td>
8672 </tr>
8673 <tr>
8674 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8675 <p><strong>instanceUniqueId</strong><br>
8676 <em>optional</em></p>
8677 </div></div></td>
8678 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8679 <p>string</p>
8680 </div></div></td>
8681 </tr>
8682 <tr>
8683 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8684 <p><strong>label</strong><br>
8685 <em>optional</em></p>
8686 </div></div></td>
8687 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8688 <p>string</p>
8689 </div></div></td>
8690 </tr>
8691 <tr>
8692 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8693 <p><strong>name</strong><br>
8694 <em>optional</em></p>
8695 </div></div></td>
8696 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8697 <p>string</p>
8698 </div></div></td>
8699 </tr>
8700 <tr>
8701 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8702 <p><strong>ownerId</strong><br>
8703 <em>optional</em></p>
8704 </div></div></td>
8705 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8706 <p>string</p>
8707 </div></div></td>
8708 </tr>
8709 <tr>
8710 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8711 <p><strong>parentUniqueId</strong><br>
8712 <em>optional</em></p>
8713 </div></div></td>
8714 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8715 <p>string</p>
8716 </div></div></td>
8717 </tr>
8718 <tr>
8719 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8720 <p><strong>password</strong><br>
8721 <em>optional</em></p>
8722 </div></div></td>
8723 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8724 <p>boolean</p>
8725 </div></div></td>
8726 </tr>
8727 <tr>
8728 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8729 <p><strong>path</strong><br>
8730 <em>optional</em></p>
8731 </div></div></td>
8732 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8733 <p>&lt; string &gt; array</p>
8734 </div></div></td>
8735 </tr>
8736 <tr>
8737 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8738 <p><strong>properties</strong><br>
8739 <em>optional</em></p>
8740 </div></div></td>
8741 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8742 <p>&lt; <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> &gt; array</p>
8743 </div></div></td>
8744 </tr>
8745 <tr>
8746 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8747 <p><strong>propertyId</strong><br>
8748 <em>optional</em></p>
8749 </div></div></td>
8750 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8751 <p>string</p>
8752 </div></div></td>
8753 </tr>
8754 <tr>
8755 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8756 <p><strong>required</strong><br>
8757 <em>optional</em></p>
8758 </div></div></td>
8759 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8760 <p>boolean</p>
8761 </div></div></td>
8762 </tr>
8763 <tr>
8764 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8765 <p><strong>rules</strong><br>
8766 <em>optional</em></p>
8767 </div></div></td>
8768 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8769 <p>&lt; <a href="#_propertyrule">PropertyRule</a> &gt; array</p>
8770 </div></div></td>
8771 </tr>
8772 <tr>
8773 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8774 <p><strong>schema</strong><br>
8775 <em>optional</em></p>
8776 </div></div></td>
8777 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8778 <p><a href="#_schemadefinition">SchemaDefinition</a></p>
8779 </div></div></td>
8780 </tr>
8781 <tr>
8782 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8783 <p><strong>schemaType</strong><br>
8784 <em>optional</em></p>
8785 </div></div></td>
8786 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8787 <p>string</p>
8788 </div></div></td>
8789 </tr>
8790 <tr>
8791 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8792 <p><strong>status</strong><br>
8793 <em>optional</em></p>
8794 </div></div></td>
8795 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8796 <p>string</p>
8797 </div></div></td>
8798 </tr>
8799 <tr>
8800 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8801 <p><strong>type</strong><br>
8802 <em>optional</em></p>
8803 </div></div></td>
8804 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8805 <p>string</p>
8806 </div></div></td>
8807 </tr>
8808 <tr>
8809 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8810 <p><strong>uniqueId</strong><br>
8811 <em>optional</em></p>
8812 </div></div></td>
8813 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8814 <p>string</p>
8815 </div></div></td>
8816 </tr>
8817 <tr>
8818 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8819 <p><strong>value</strong><br>
8820 <em>optional</em></p>
8821 </div></div></td>
8822 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8823 <p>string</p>
8824 </div></div></td>
8825 </tr>
8826 <tr>
8827 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8828 <p><strong>valueUniqueUid</strong><br>
8829 <em>optional</em></p>
8830 </div></div></td>
8831 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8832 <p>string</p>
8833 </div></div></td>
8834 </tr>
8835 </tbody>
8836 </table>
8837
8838 </div>
8839 <div class="sect2">
8840 <h3 id="_componentinstanceproperty"><a class="anchor" href="#_componentinstanceproperty"></a>3.12. ComponentInstanceProperty</h3>
8841 <table class="tableblock frame-all grid-all" style="width:100%; ">
8842 <colgroup>
8843 <col style="width:42%;">
8844 <col style="width:57%;">
8845 </colgroup>
8846 <thead>
8847 <tr>
8848 <th class="tableblock halign-left valign-middle">Name</th>
8849 <th class="tableblock halign-left valign-middle">Schema</th>
8850 </tr>
8851 </thead>
8852 <tbody>
8853 <tr>
8854 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8855 <p><strong>componentInstanceId</strong><br>
8856 <em>optional</em></p>
8857 </div></div></td>
8858 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8859 <p>string</p>
8860 </div></div></td>
8861 </tr>
8862 <tr>
8863 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8864 <p><strong>componentInstanceName</strong><br>
8865 <em>optional</em></p>
8866 </div></div></td>
8867 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8868 <p>string</p>
8869 </div></div></td>
8870 </tr>
8871 <tr>
8872 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8873 <p><strong>constraints</strong><br>
8874 <em>optional</em></p>
8875 </div></div></td>
8876 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8877 <p>&lt; <a href="#_propertyconstraint">PropertyConstraint</a> &gt; array</p>
8878 </div></div></td>
8879 </tr>
8880 <tr>
8881 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8882 <p><strong>defaultValue</strong><br>
8883 <em>optional</em></p>
8884 </div></div></td>
8885 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8886 <p>string</p>
8887 </div></div></td>
8888 </tr>
8889 <tr>
8890 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8891 <p><strong>definition</strong><br>
8892 <em>optional</em></p>
8893 </div></div></td>
8894 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8895 <p>boolean</p>
8896 </div></div></td>
8897 </tr>
8898 <tr>
8899 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8900 <p><strong>description</strong><br>
8901 <em>optional</em></p>
8902 </div></div></td>
8903 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8904 <p>string</p>
8905 </div></div></td>
8906 </tr>
8907 <tr>
8908 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8909 <p><strong>empty</strong><br>
8910 <em>optional</em></p>
8911 </div></div></td>
8912 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8913 <p>boolean</p>
8914 </div></div></td>
8915 </tr>
8916 <tr>
8917 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8918 <p><strong>getInputProperty</strong><br>
8919 <em>optional</em></p>
8920 </div></div></td>
8921 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8922 <p>boolean</p>
8923 </div></div></td>
8924 </tr>
8925 <tr>
8926 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8927 <p><strong>getInputValues</strong><br>
8928 <em>optional</em></p>
8929 </div></div></td>
8930 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8931 <p>&lt; <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> &gt; array</p>
8932 </div></div></td>
8933 </tr>
8934 <tr>
8935 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8936 <p><strong>hidden</strong><br>
8937 <em>optional</em></p>
8938 </div></div></td>
8939 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8940 <p>boolean</p>
8941 </div></div></td>
8942 </tr>
8943 <tr>
8944 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8945 <p><strong>immutable</strong><br>
8946 <em>optional</em></p>
8947 </div></div></td>
8948 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8949 <p>boolean</p>
8950 </div></div></td>
8951 </tr>
8952 <tr>
8953 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8954 <p><strong>inputId</strong><br>
8955 <em>optional</em></p>
8956 </div></div></td>
8957 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8958 <p>string</p>
8959 </div></div></td>
8960 </tr>
8961 <tr>
8962 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8963 <p><strong>inputPath</strong><br>
8964 <em>optional</em></p>
8965 </div></div></td>
8966 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8967 <p>string</p>
8968 </div></div></td>
8969 </tr>
8970 <tr>
8971 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8972 <p><strong>instanceUniqueId</strong><br>
8973 <em>optional</em></p>
8974 </div></div></td>
8975 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8976 <p>string</p>
8977 </div></div></td>
8978 </tr>
8979 <tr>
8980 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8981 <p><strong>label</strong><br>
8982 <em>optional</em></p>
8983 </div></div></td>
8984 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8985 <p>string</p>
8986 </div></div></td>
8987 </tr>
8988 <tr>
8989 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8990 <p><strong>name</strong><br>
8991 <em>optional</em></p>
8992 </div></div></td>
8993 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8994 <p>string</p>
8995 </div></div></td>
8996 </tr>
8997 <tr>
8998 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
8999 <p><strong>ownerId</strong><br>
9000 <em>optional</em></p>
9001 </div></div></td>
9002 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9003 <p>string</p>
9004 </div></div></td>
9005 </tr>
9006 <tr>
9007 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9008 <p><strong>parentUniqueId</strong><br>
9009 <em>optional</em></p>
9010 </div></div></td>
9011 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9012 <p>string</p>
9013 </div></div></td>
9014 </tr>
9015 <tr>
9016 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9017 <p><strong>password</strong><br>
9018 <em>optional</em></p>
9019 </div></div></td>
9020 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9021 <p>boolean</p>
9022 </div></div></td>
9023 </tr>
9024 <tr>
9025 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9026 <p><strong>path</strong><br>
9027 <em>optional</em></p>
9028 </div></div></td>
9029 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9030 <p>&lt; string &gt; array</p>
9031 </div></div></td>
9032 </tr>
9033 <tr>
9034 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9035 <p><strong>propertyId</strong><br>
9036 <em>optional</em></p>
9037 </div></div></td>
9038 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9039 <p>string</p>
9040 </div></div></td>
9041 </tr>
9042 <tr>
9043 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9044 <p><strong>required</strong><br>
9045 <em>optional</em></p>
9046 </div></div></td>
9047 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9048 <p>boolean</p>
9049 </div></div></td>
9050 </tr>
9051 <tr>
9052 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9053 <p><strong>rules</strong><br>
9054 <em>optional</em></p>
9055 </div></div></td>
9056 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9057 <p>&lt; <a href="#_propertyrule">PropertyRule</a> &gt; array</p>
9058 </div></div></td>
9059 </tr>
9060 <tr>
9061 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9062 <p><strong>schema</strong><br>
9063 <em>optional</em></p>
9064 </div></div></td>
9065 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9066 <p><a href="#_schemadefinition">SchemaDefinition</a></p>
9067 </div></div></td>
9068 </tr>
9069 <tr>
9070 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9071 <p><strong>schemaType</strong><br>
9072 <em>optional</em></p>
9073 </div></div></td>
9074 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9075 <p>string</p>
9076 </div></div></td>
9077 </tr>
9078 <tr>
9079 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9080 <p><strong>status</strong><br>
9081 <em>optional</em></p>
9082 </div></div></td>
9083 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9084 <p>string</p>
9085 </div></div></td>
9086 </tr>
9087 <tr>
9088 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9089 <p><strong>type</strong><br>
9090 <em>optional</em></p>
9091 </div></div></td>
9092 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9093 <p>string</p>
9094 </div></div></td>
9095 </tr>
9096 <tr>
9097 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9098 <p><strong>uniqueId</strong><br>
9099 <em>optional</em></p>
9100 </div></div></td>
9101 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9102 <p>string</p>
9103 </div></div></td>
9104 </tr>
9105 <tr>
9106 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9107 <p><strong>value</strong><br>
9108 <em>optional</em></p>
9109 </div></div></td>
9110 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9111 <p>string</p>
9112 </div></div></td>
9113 </tr>
9114 <tr>
9115 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9116 <p><strong>valueUniqueUid</strong><br>
9117 <em>optional</em></p>
9118 </div></div></td>
9119 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9120 <p>string</p>
9121 </div></div></td>
9122 </tr>
9123 </tbody>
9124 </table>
9125
9126 </div>
9127 <div class="sect2">
9128 <h3 id="_getinputvaluedatadefinition"><a class="anchor" href="#_getinputvaluedatadefinition"></a>3.13. GetInputValueDataDefinition</h3>
9129 <table class="tableblock frame-all grid-all" style="width:100%; ">
9130 <colgroup>
9131 <col style="width:42%;">
9132 <col style="width:57%;">
9133 </colgroup>
9134 <thead>
9135 <tr>
9136 <th class="tableblock halign-left valign-middle">Name</th>
9137 <th class="tableblock halign-left valign-middle">Schema</th>
9138 </tr>
9139 </thead>
9140 <tbody>
9141 <tr>
9142 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9143 <p><strong>empty</strong><br>
9144 <em>optional</em></p>
9145 </div></div></td>
9146 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9147 <p>boolean</p>
9148 </div></div></td>
9149 </tr>
9150 <tr>
9151 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9152 <p><strong>getInputIndex</strong><br>
9153 <em>optional</em></p>
9154 </div></div></td>
9155 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9156 <p><a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a></p>
9157 </div></div></td>
9158 </tr>
9159 <tr>
9160 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9161 <p><strong>indexValue</strong><br>
9162 <em>optional</em></p>
9163 </div></div></td>
9164 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9165 <p>integer (int32)</p>
9166 </div></div></td>
9167 </tr>
9168 <tr>
9169 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9170 <p><strong>inputId</strong><br>
9171 <em>optional</em></p>
9172 </div></div></td>
9173 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9174 <p>string</p>
9175 </div></div></td>
9176 </tr>
9177 <tr>
9178 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9179 <p><strong>inputName</strong><br>
9180 <em>optional</em></p>
9181 </div></div></td>
9182 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9183 <p>string</p>
9184 </div></div></td>
9185 </tr>
9186 <tr>
9187 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9188 <p><strong>list</strong><br>
9189 <em>optional</em></p>
9190 </div></div></td>
9191 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9192 <p>boolean</p>
9193 </div></div></td>
9194 </tr>
9195 <tr>
9196 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9197 <p><strong>ownerId</strong><br>
9198 <em>optional</em></p>
9199 </div></div></td>
9200 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9201 <p>string</p>
9202 </div></div></td>
9203 </tr>
9204 <tr>
9205 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9206 <p><strong>propName</strong><br>
9207 <em>optional</em></p>
9208 </div></div></td>
9209 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9210 <p>string</p>
9211 </div></div></td>
9212 </tr>
9213 </tbody>
9214 </table>
9215
9216 </div>
9217 <div class="sect2">
9218 <h3 id="_groupdefinition"><a class="anchor" href="#_groupdefinition"></a>3.14. GroupDefinition</h3>
9219 <table class="tableblock frame-all grid-all" style="width:100%; ">
9220 <colgroup>
9221 <col style="width:42%;">
9222 <col style="width:57%;">
9223 </colgroup>
9224 <thead>
9225 <tr>
9226 <th class="tableblock halign-left valign-middle">Name</th>
9227 <th class="tableblock halign-left valign-middle">Schema</th>
9228 </tr>
9229 </thead>
9230 <tbody>
9231 <tr>
9232 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9233 <p><strong>artifacts</strong><br>
9234 <em>optional</em></p>
9235 </div></div></td>
9236 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9237 <p>&lt; string &gt; array</p>
9238 </div></div></td>
9239 </tr>
9240 <tr>
9241 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9242 <p><strong>artifactsUuid</strong><br>
9243 <em>optional</em></p>
9244 </div></div></td>
9245 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9246 <p>&lt; string &gt; array</p>
9247 </div></div></td>
9248 </tr>
9249 <tr>
9250 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9251 <p><strong>description</strong><br>
9252 <em>optional</em></p>
9253 </div></div></td>
9254 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9255 <p>string</p>
9256 </div></div></td>
9257 </tr>
9258 <tr>
9259 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9260 <p><strong>empty</strong><br>
9261 <em>optional</em></p>
9262 </div></div></td>
9263 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9264 <p>boolean</p>
9265 </div></div></td>
9266 </tr>
9267 <tr>
9268 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9269 <p><strong>groupUUID</strong><br>
9270 <em>optional</em></p>
9271 </div></div></td>
9272 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9273 <p>string</p>
9274 </div></div></td>
9275 </tr>
9276 <tr>
9277 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9278 <p><strong>invariantUUID</strong><br>
9279 <em>optional</em></p>
9280 </div></div></td>
9281 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9282 <p>string</p>
9283 </div></div></td>
9284 </tr>
9285 <tr>
9286 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9287 <p><strong>members</strong><br>
9288 <em>optional</em></p>
9289 </div></div></td>
9290 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9291 <p>&lt; string, string &gt; map</p>
9292 </div></div></td>
9293 </tr>
9294 <tr>
9295 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9296 <p><strong>name</strong><br>
9297 <em>optional</em></p>
9298 </div></div></td>
9299 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9300 <p>string</p>
9301 </div></div></td>
9302 </tr>
9303 <tr>
9304 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9305 <p><strong>ownerId</strong><br>
9306 <em>optional</em></p>
9307 </div></div></td>
9308 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9309 <p>string</p>
9310 </div></div></td>
9311 </tr>
9312 <tr>
9313 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9314 <p><strong>properties</strong><br>
9315 <em>optional</em></p>
9316 </div></div></td>
9317 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9318 <p>&lt; <a href="#_propertydatadefinition">PropertyDataDefinition</a> &gt; array</p>
9319 </div></div></td>
9320 </tr>
9321 <tr>
9322 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9323 <p><strong>propertyValueCounter</strong><br>
9324 <em>optional</em></p>
9325 </div></div></td>
9326 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9327 <p>integer (int32)</p>
9328 </div></div></td>
9329 </tr>
9330 <tr>
9331 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9332 <p><strong>type</strong><br>
9333 <em>optional</em></p>
9334 </div></div></td>
9335 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9336 <p>string</p>
9337 </div></div></td>
9338 </tr>
9339 <tr>
9340 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9341 <p><strong>typeUid</strong><br>
9342 <em>optional</em></p>
9343 </div></div></td>
9344 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9345 <p>string</p>
9346 </div></div></td>
9347 </tr>
9348 <tr>
9349 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9350 <p><strong>uniqueId</strong><br>
9351 <em>optional</em></p>
9352 </div></div></td>
9353 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9354 <p>string</p>
9355 </div></div></td>
9356 </tr>
9357 <tr>
9358 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9359 <p><strong>version</strong><br>
9360 <em>optional</em></p>
9361 </div></div></td>
9362 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9363 <p>string</p>
9364 </div></div></td>
9365 </tr>
9366 </tbody>
9367 </table>
9368
9369 </div>
9370 <div class="sect2">
9371 <h3 id="_groupinstance"><a class="anchor" href="#_groupinstance"></a>3.15. GroupInstance</h3>
9372 <table class="tableblock frame-all grid-all" style="width:100%; ">
9373 <colgroup>
9374 <col style="width:42%;">
9375 <col style="width:57%;">
9376 </colgroup>
9377 <thead>
9378 <tr>
9379 <th class="tableblock halign-left valign-middle">Name</th>
9380 <th class="tableblock halign-left valign-middle">Schema</th>
9381 </tr>
9382 </thead>
9383 <tbody>
9384 <tr>
9385 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9386 <p><strong>artifacts</strong><br>
9387 <em>optional</em></p>
9388 </div></div></td>
9389 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9390 <p>&lt; string &gt; array</p>
9391 </div></div></td>
9392 </tr>
9393 <tr>
9394 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9395 <p><strong>artifactsUuid</strong><br>
9396 <em>optional</em></p>
9397 </div></div></td>
9398 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9399 <p>&lt; string &gt; array</p>
9400 </div></div></td>
9401 </tr>
9402 <tr>
9403 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9404 <p><strong>creationTime</strong><br>
9405 <em>optional</em></p>
9406 </div></div></td>
9407 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9408 <p>integer (int64)</p>
9409 </div></div></td>
9410 </tr>
9411 <tr>
9412 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9413 <p><strong>customizationUUID</strong><br>
9414 <em>optional</em></p>
9415 </div></div></td>
9416 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9417 <p>string</p>
9418 </div></div></td>
9419 </tr>
9420 <tr>
9421 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9422 <p><strong>description</strong><br>
9423 <em>optional</em></p>
9424 </div></div></td>
9425 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9426 <p>string</p>
9427 </div></div></td>
9428 </tr>
9429 <tr>
9430 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9431 <p><strong>empty</strong><br>
9432 <em>optional</em></p>
9433 </div></div></td>
9434 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9435 <p>boolean</p>
9436 </div></div></td>
9437 </tr>
9438 <tr>
9439 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9440 <p><strong>groupInstanceArtifacts</strong><br>
9441 <em>optional</em></p>
9442 </div></div></td>
9443 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9444 <p>&lt; string &gt; array</p>
9445 </div></div></td>
9446 </tr>
9447 <tr>
9448 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9449 <p><strong>groupInstanceArtifactsUuid</strong><br>
9450 <em>optional</em></p>
9451 </div></div></td>
9452 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9453 <p>&lt; string &gt; array</p>
9454 </div></div></td>
9455 </tr>
9456 <tr>
9457 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9458 <p><strong>groupName</strong><br>
9459 <em>optional</em></p>
9460 </div></div></td>
9461 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9462 <p>string</p>
9463 </div></div></td>
9464 </tr>
9465 <tr>
9466 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9467 <p><strong>groupUUID</strong><br>
9468 <em>optional</em></p>
9469 </div></div></td>
9470 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9471 <p>string</p>
9472 </div></div></td>
9473 </tr>
9474 <tr>
9475 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9476 <p><strong>groupUid</strong><br>
9477 <em>optional</em></p>
9478 </div></div></td>
9479 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9480 <p>string</p>
9481 </div></div></td>
9482 </tr>
9483 <tr>
9484 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9485 <p><strong>invariantUUID</strong><br>
9486 <em>optional</em></p>
9487 </div></div></td>
9488 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9489 <p>string</p>
9490 </div></div></td>
9491 </tr>
9492 <tr>
9493 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9494 <p><strong>modificationTime</strong><br>
9495 <em>optional</em></p>
9496 </div></div></td>
9497 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9498 <p>integer (int64)</p>
9499 </div></div></td>
9500 </tr>
9501 <tr>
9502 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9503 <p><strong>name</strong><br>
9504 <em>optional</em></p>
9505 </div></div></td>
9506 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9507 <p>string</p>
9508 </div></div></td>
9509 </tr>
9510 <tr>
9511 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9512 <p><strong>normalizedName</strong><br>
9513 <em>optional</em></p>
9514 </div></div></td>
9515 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9516 <p>string</p>
9517 </div></div></td>
9518 </tr>
9519 <tr>
9520 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9521 <p><strong>ownerId</strong><br>
9522 <em>optional</em></p>
9523 </div></div></td>
9524 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9525 <p>string</p>
9526 </div></div></td>
9527 </tr>
9528 <tr>
9529 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9530 <p><strong>posX</strong><br>
9531 <em>optional</em></p>
9532 </div></div></td>
9533 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9534 <p>string</p>
9535 </div></div></td>
9536 </tr>
9537 <tr>
9538 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9539 <p><strong>posY</strong><br>
9540 <em>optional</em></p>
9541 </div></div></td>
9542 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9543 <p>string</p>
9544 </div></div></td>
9545 </tr>
9546 <tr>
9547 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9548 <p><strong>properties</strong><br>
9549 <em>optional</em></p>
9550 </div></div></td>
9551 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9552 <p>&lt; <a href="#_propertydatadefinition">PropertyDataDefinition</a> &gt; array</p>
9553 </div></div></td>
9554 </tr>
9555 <tr>
9556 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9557 <p><strong>propertyValueCounter</strong><br>
9558 <em>optional</em></p>
9559 </div></div></td>
9560 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9561 <p>integer (int32)</p>
9562 </div></div></td>
9563 </tr>
9564 <tr>
9565 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9566 <p><strong>type</strong><br>
9567 <em>optional</em></p>
9568 </div></div></td>
9569 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9570 <p>string</p>
9571 </div></div></td>
9572 </tr>
9573 <tr>
9574 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9575 <p><strong>uniqueId</strong><br>
9576 <em>optional</em></p>
9577 </div></div></td>
9578 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9579 <p>string</p>
9580 </div></div></td>
9581 </tr>
9582 <tr>
9583 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9584 <p><strong>version</strong><br>
9585 <em>optional</em></p>
9586 </div></div></td>
9587 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9588 <p>string</p>
9589 </div></div></td>
9590 </tr>
9591 </tbody>
9592 </table>
9593
9594 </div>
9595 <div class="sect2">
9596 <h3 id="_groupingdefinition"><a class="anchor" href="#_groupingdefinition"></a>3.16. GroupingDefinition</h3>
9597 <table class="tableblock frame-all grid-all" style="width:100%; ">
9598 <colgroup>
9599 <col style="width:42%;">
9600 <col style="width:57%;">
9601 </colgroup>
9602 <thead>
9603 <tr>
9604 <th class="tableblock halign-left valign-middle">Name</th>
9605 <th class="tableblock halign-left valign-middle">Schema</th>
9606 </tr>
9607 </thead>
9608 <tbody>
9609 <tr>
9610 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9611 <p><strong>empty</strong><br>
9612 <em>optional</em></p>
9613 </div></div></td>
9614 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9615 <p>boolean</p>
9616 </div></div></td>
9617 </tr>
9618 <tr>
9619 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9620 <p><strong>name</strong><br>
9621 <em>optional</em></p>
9622 </div></div></td>
9623 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9624 <p>string</p>
9625 </div></div></td>
9626 </tr>
9627 <tr>
9628 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9629 <p><strong>normalizedName</strong><br>
9630 <em>optional</em></p>
9631 </div></div></td>
9632 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9633 <p>string</p>
9634 </div></div></td>
9635 </tr>
9636 <tr>
9637 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9638 <p><strong>ownerId</strong><br>
9639 <em>optional</em></p>
9640 </div></div></td>
9641 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9642 <p>string</p>
9643 </div></div></td>
9644 </tr>
9645 <tr>
9646 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9647 <p><strong>uniqueId</strong><br>
9648 <em>optional</em></p>
9649 </div></div></td>
9650 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9651 <p>string</p>
9652 </div></div></td>
9653 </tr>
9654 </tbody>
9655 </table>
9656
9657 </div>
9658 <div class="sect2">
9659 <h3 id="_heatparameterdatadefinition"><a class="anchor" href="#_heatparameterdatadefinition"></a>3.17. HeatParameterDataDefinition</h3>
9660 <table class="tableblock frame-all grid-all" style="width:100%; ">
9661 <colgroup>
9662 <col style="width:42%;">
9663 <col style="width:57%;">
9664 </colgroup>
9665 <thead>
9666 <tr>
9667 <th class="tableblock halign-left valign-middle">Name</th>
9668 <th class="tableblock halign-left valign-middle">Schema</th>
9669 </tr>
9670 </thead>
9671 <tbody>
9672 <tr>
9673 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9674 <p><strong>currentValue</strong><br>
9675 <em>optional</em></p>
9676 </div></div></td>
9677 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9678 <p>string</p>
9679 </div></div></td>
9680 </tr>
9681 <tr>
9682 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9683 <p><strong>defaultValue</strong><br>
9684 <em>optional</em></p>
9685 </div></div></td>
9686 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9687 <p>string</p>
9688 </div></div></td>
9689 </tr>
9690 <tr>
9691 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9692 <p><strong>description</strong><br>
9693 <em>optional</em></p>
9694 </div></div></td>
9695 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9696 <p>string</p>
9697 </div></div></td>
9698 </tr>
9699 <tr>
9700 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9701 <p><strong>empty</strong><br>
9702 <em>optional</em></p>
9703 </div></div></td>
9704 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9705 <p>boolean</p>
9706 </div></div></td>
9707 </tr>
9708 <tr>
9709 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9710 <p><strong>name</strong><br>
9711 <em>optional</em></p>
9712 </div></div></td>
9713 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9714 <p>string</p>
9715 </div></div></td>
9716 </tr>
9717 <tr>
9718 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9719 <p><strong>ownerId</strong><br>
9720 <em>optional</em></p>
9721 </div></div></td>
9722 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9723 <p>string</p>
9724 </div></div></td>
9725 </tr>
9726 <tr>
9727 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9728 <p><strong>type</strong><br>
9729 <em>optional</em></p>
9730 </div></div></td>
9731 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9732 <p>string</p>
9733 </div></div></td>
9734 </tr>
9735 <tr>
9736 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9737 <p><strong>uniqueId</strong><br>
9738 <em>optional</em></p>
9739 </div></div></td>
9740 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9741 <p>string</p>
9742 </div></div></td>
9743 </tr>
9744 </tbody>
9745 </table>
9746
9747 </div>
9748 <div class="sect2">
9749 <h3 id="_heatparameterdefinition"><a class="anchor" href="#_heatparameterdefinition"></a>3.18. HeatParameterDefinition</h3>
9750 <table class="tableblock frame-all grid-all" style="width:100%; ">
9751 <colgroup>
9752 <col style="width:42%;">
9753 <col style="width:57%;">
9754 </colgroup>
9755 <thead>
9756 <tr>
9757 <th class="tableblock halign-left valign-middle">Name</th>
9758 <th class="tableblock halign-left valign-middle">Schema</th>
9759 </tr>
9760 </thead>
9761 <tbody>
9762 <tr>
9763 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9764 <p><strong>currentValue</strong><br>
9765 <em>optional</em></p>
9766 </div></div></td>
9767 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9768 <p>string</p>
9769 </div></div></td>
9770 </tr>
9771 <tr>
9772 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9773 <p><strong>defaultValue</strong><br>
9774 <em>optional</em></p>
9775 </div></div></td>
9776 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9777 <p>string</p>
9778 </div></div></td>
9779 </tr>
9780 <tr>
9781 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9782 <p><strong>description</strong><br>
9783 <em>optional</em></p>
9784 </div></div></td>
9785 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9786 <p>string</p>
9787 </div></div></td>
9788 </tr>
9789 <tr>
9790 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9791 <p><strong>empty</strong><br>
9792 <em>optional</em></p>
9793 </div></div></td>
9794 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9795 <p>boolean</p>
9796 </div></div></td>
9797 </tr>
9798 <tr>
9799 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9800 <p><strong>name</strong><br>
9801 <em>optional</em></p>
9802 </div></div></td>
9803 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9804 <p>string</p>
9805 </div></div></td>
9806 </tr>
9807 <tr>
9808 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9809 <p><strong>ownerId</strong><br>
9810 <em>optional</em></p>
9811 </div></div></td>
9812 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9813 <p>string</p>
9814 </div></div></td>
9815 </tr>
9816 <tr>
9817 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9818 <p><strong>type</strong><br>
9819 <em>optional</em></p>
9820 </div></div></td>
9821 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9822 <p>string</p>
9823 </div></div></td>
9824 </tr>
9825 <tr>
9826 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9827 <p><strong>uniqueId</strong><br>
9828 <em>optional</em></p>
9829 </div></div></td>
9830 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9831 <p>string</p>
9832 </div></div></td>
9833 </tr>
9834 </tbody>
9835 </table>
9836
9837 </div>
9838 <div class="sect2">
9839 <h3 id="_inputdefinition"><a class="anchor" href="#_inputdefinition"></a>3.19. InputDefinition</h3>
9840 <table class="tableblock frame-all grid-all" style="width:100%; ">
9841 <colgroup>
9842 <col style="width:42%;">
9843 <col style="width:57%;">
9844 </colgroup>
9845 <thead>
9846 <tr>
9847 <th class="tableblock halign-left valign-middle">Name</th>
9848 <th class="tableblock halign-left valign-middle">Schema</th>
9849 </tr>
9850 </thead>
9851 <tbody>
9852 <tr>
9853 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9854 <p><strong>constraints</strong><br>
9855 <em>optional</em></p>
9856 </div></div></td>
9857 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9858 <p>&lt; <a href="#_propertyconstraint">PropertyConstraint</a> &gt; array</p>
9859 </div></div></td>
9860 </tr>
9861 <tr>
9862 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9863 <p><strong>defaultValue</strong><br>
9864 <em>optional</em></p>
9865 </div></div></td>
9866 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9867 <p>string</p>
9868 </div></div></td>
9869 </tr>
9870 <tr>
9871 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9872 <p><strong>definition</strong><br>
9873 <em>optional</em></p>
9874 </div></div></td>
9875 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9876 <p>boolean</p>
9877 </div></div></td>
9878 </tr>
9879 <tr>
9880 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9881 <p><strong>description</strong><br>
9882 <em>optional</em></p>
9883 </div></div></td>
9884 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9885 <p>string</p>
9886 </div></div></td>
9887 </tr>
9888 <tr>
9889 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9890 <p><strong>empty</strong><br>
9891 <em>optional</em></p>
9892 </div></div></td>
9893 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9894 <p>boolean</p>
9895 </div></div></td>
9896 </tr>
9897 <tr>
9898 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9899 <p><strong>getInputProperty</strong><br>
9900 <em>optional</em></p>
9901 </div></div></td>
9902 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9903 <p>boolean</p>
9904 </div></div></td>
9905 </tr>
9906 <tr>
9907 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9908 <p><strong>getInputValues</strong><br>
9909 <em>optional</em></p>
9910 </div></div></td>
9911 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9912 <p>&lt; <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> &gt; array</p>
9913 </div></div></td>
9914 </tr>
9915 <tr>
9916 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9917 <p><strong>hidden</strong><br>
9918 <em>optional</em></p>
9919 </div></div></td>
9920 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9921 <p>boolean</p>
9922 </div></div></td>
9923 </tr>
9924 <tr>
9925 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9926 <p><strong>immutable</strong><br>
9927 <em>optional</em></p>
9928 </div></div></td>
9929 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9930 <p>boolean</p>
9931 </div></div></td>
9932 </tr>
9933 <tr>
9934 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9935 <p><strong>inputId</strong><br>
9936 <em>optional</em></p>
9937 </div></div></td>
9938 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9939 <p>string</p>
9940 </div></div></td>
9941 </tr>
9942 <tr>
9943 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9944 <p><strong>inputPath</strong><br>
9945 <em>optional</em></p>
9946 </div></div></td>
9947 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9948 <p>string</p>
9949 </div></div></td>
9950 </tr>
9951 <tr>
9952 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9953 <p><strong>inputs</strong><br>
9954 <em>optional</em></p>
9955 </div></div></td>
9956 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9957 <p>&lt; <a href="#_componentinstanceinput">ComponentInstanceInput</a> &gt; array</p>
9958 </div></div></td>
9959 </tr>
9960 <tr>
9961 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9962 <p><strong>instanceUniqueId</strong><br>
9963 <em>optional</em></p>
9964 </div></div></td>
9965 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9966 <p>string</p>
9967 </div></div></td>
9968 </tr>
9969 <tr>
9970 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9971 <p><strong>label</strong><br>
9972 <em>optional</em></p>
9973 </div></div></td>
9974 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9975 <p>string</p>
9976 </div></div></td>
9977 </tr>
9978 <tr>
9979 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9980 <p><strong>name</strong><br>
9981 <em>optional</em></p>
9982 </div></div></td>
9983 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9984 <p>string</p>
9985 </div></div></td>
9986 </tr>
9987 <tr>
9988 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9989 <p><strong>ownerId</strong><br>
9990 <em>optional</em></p>
9991 </div></div></td>
9992 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9993 <p>string</p>
9994 </div></div></td>
9995 </tr>
9996 <tr>
9997 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
9998 <p><strong>parentUniqueId</strong><br>
9999 <em>optional</em></p>
10000 </div></div></td>
10001 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10002 <p>string</p>
10003 </div></div></td>
10004 </tr>
10005 <tr>
10006 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10007 <p><strong>password</strong><br>
10008 <em>optional</em></p>
10009 </div></div></td>
10010 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10011 <p>boolean</p>
10012 </div></div></td>
10013 </tr>
10014 <tr>
10015 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10016 <p><strong>properties</strong><br>
10017 <em>optional</em></p>
10018 </div></div></td>
10019 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10020 <p>&lt; <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> &gt; array</p>
10021 </div></div></td>
10022 </tr>
10023 <tr>
10024 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10025 <p><strong>propertyId</strong><br>
10026 <em>optional</em></p>
10027 </div></div></td>
10028 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10029 <p>string</p>
10030 </div></div></td>
10031 </tr>
10032 <tr>
10033 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10034 <p><strong>required</strong><br>
10035 <em>optional</em></p>
10036 </div></div></td>
10037 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10038 <p>boolean</p>
10039 </div></div></td>
10040 </tr>
10041 <tr>
10042 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10043 <p><strong>schema</strong><br>
10044 <em>optional</em></p>
10045 </div></div></td>
10046 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10047 <p><a href="#_schemadefinition">SchemaDefinition</a></p>
10048 </div></div></td>
10049 </tr>
10050 <tr>
10051 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10052 <p><strong>schemaType</strong><br>
10053 <em>optional</em></p>
10054 </div></div></td>
10055 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10056 <p>string</p>
10057 </div></div></td>
10058 </tr>
10059 <tr>
10060 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10061 <p><strong>status</strong><br>
10062 <em>optional</em></p>
10063 </div></div></td>
10064 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10065 <p>string</p>
10066 </div></div></td>
10067 </tr>
10068 <tr>
10069 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10070 <p><strong>type</strong><br>
10071 <em>optional</em></p>
10072 </div></div></td>
10073 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10074 <p>string</p>
10075 </div></div></td>
10076 </tr>
10077 <tr>
10078 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10079 <p><strong>uniqueId</strong><br>
10080 <em>optional</em></p>
10081 </div></div></td>
10082 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10083 <p>string</p>
10084 </div></div></td>
10085 </tr>
10086 <tr>
10087 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10088 <p><strong>value</strong><br>
10089 <em>optional</em></p>
10090 </div></div></td>
10091 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10092 <p>string</p>
10093 </div></div></td>
10094 </tr>
10095 </tbody>
10096 </table>
10097
10098 </div>
10099 <div class="sect2">
10100 <h3 id="_interfacedefinition"><a class="anchor" href="#_interfacedefinition"></a>3.20. InterfaceDefinition</h3>
10101 <table class="tableblock frame-all grid-all" style="width:100%; ">
10102 <colgroup>
10103 <col style="width:42%;">
10104 <col style="width:57%;">
10105 </colgroup>
10106 <thead>
10107 <tr>
10108 <th class="tableblock halign-left valign-middle">Name</th>
10109 <th class="tableblock halign-left valign-middle">Schema</th>
10110 </tr>
10111 </thead>
10112 <tbody>
10113 <tr>
10114 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10115 <p><strong>creationDate</strong><br>
10116 <em>optional</em></p>
10117 </div></div></td>
10118 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10119 <p>integer (int64)</p>
10120 </div></div></td>
10121 </tr>
10122 <tr>
10123 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10124 <p><strong>definition</strong><br>
10125 <em>optional</em></p>
10126 </div></div></td>
10127 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10128 <p>boolean</p>
10129 </div></div></td>
10130 </tr>
10131 <tr>
10132 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10133 <p><strong>description</strong><br>
10134 <em>optional</em></p>
10135 </div></div></td>
10136 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10137 <p>string</p>
10138 </div></div></td>
10139 </tr>
10140 <tr>
10141 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10142 <p><strong>empty</strong><br>
10143 <em>optional</em></p>
10144 </div></div></td>
10145 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10146 <p>boolean</p>
10147 </div></div></td>
10148 </tr>
10149 <tr>
10150 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10151 <p><strong>lastUpdateDate</strong><br>
10152 <em>optional</em></p>
10153 </div></div></td>
10154 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10155 <p>integer (int64)</p>
10156 </div></div></td>
10157 </tr>
10158 <tr>
10159 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10160 <p><strong>operations</strong><br>
10161 <em>optional</em></p>
10162 </div></div></td>
10163 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10164 <p>&lt; string, <a href="#_operationdatadefinition">OperationDataDefinition</a> &gt; map</p>
10165 </div></div></td>
10166 </tr>
10167 <tr>
10168 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10169 <p><strong>ownerId</strong><br>
10170 <em>optional</em></p>
10171 </div></div></td>
10172 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10173 <p>string</p>
10174 </div></div></td>
10175 </tr>
10176 <tr>
10177 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10178 <p><strong>toscaResourceName</strong><br>
10179 <em>optional</em></p>
10180 </div></div></td>
10181 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10182 <p>string</p>
10183 </div></div></td>
10184 </tr>
10185 <tr>
10186 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10187 <p><strong>type</strong><br>
10188 <em>optional</em></p>
10189 </div></div></td>
10190 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10191 <p>string</p>
10192 </div></div></td>
10193 </tr>
10194 <tr>
10195 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10196 <p><strong>uniqueId</strong><br>
10197 <em>optional</em></p>
10198 </div></div></td>
10199 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10200 <p>string</p>
10201 </div></div></td>
10202 </tr>
10203 </tbody>
10204 </table>
10205
10206 </div>
10207 <div class="sect2">
10208 <h3 id="_interfaceoperationdatadefinition"><a class="anchor" href="#_interfaceoperationdatadefinition"></a>3.21. InterfaceOperationDataDefinition</h3>
10209 <table class="tableblock frame-all grid-all" style="width:100%; ">
10210 <colgroup>
10211 <col style="width:42%;">
10212 <col style="width:57%;">
10213 </colgroup>
10214 <thead>
10215 <tr>
10216 <th class="tableblock halign-left valign-middle">Name</th>
10217 <th class="tableblock halign-left valign-middle">Schema</th>
10218 </tr>
10219 </thead>
10220 <tbody>
10221 <tr>
10222 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10223 <p><strong>artifactUUID</strong><br>
10224 <em>optional</em></p>
10225 </div></div></td>
10226 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10227 <p>string</p>
10228 </div></div></td>
10229 </tr>
10230 <tr>
10231 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10232 <p><strong>description</strong><br>
10233 <em>optional</em></p>
10234 </div></div></td>
10235 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10236 <p>string</p>
10237 </div></div></td>
10238 </tr>
10239 <tr>
10240 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10241 <p><strong>empty</strong><br>
10242 <em>optional</em></p>
10243 </div></div></td>
10244 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10245 <p>boolean</p>
10246 </div></div></td>
10247 </tr>
10248 <tr>
10249 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10250 <p><strong>inputParams</strong><br>
10251 <em>optional</em></p>
10252 </div></div></td>
10253 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10254 <p><a href="#_listdatadefinitioninterfaceoperationparamdatadefinition">ListDataDefinitionInterfaceOperationParamDataDefinition</a></p>
10255 </div></div></td>
10256 </tr>
10257 <tr>
10258 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10259 <p><strong>operationType</strong><br>
10260 <em>optional</em></p>
10261 </div></div></td>
10262 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10263 <p>string</p>
10264 </div></div></td>
10265 </tr>
10266 <tr>
10267 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10268 <p><strong>outputParams</strong><br>
10269 <em>optional</em></p>
10270 </div></div></td>
10271 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10272 <p><a href="#_listdatadefinitioninterfaceoperationparamdatadefinition">ListDataDefinitionInterfaceOperationParamDataDefinition</a></p>
10273 </div></div></td>
10274 </tr>
10275 <tr>
10276 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10277 <p><strong>ownerId</strong><br>
10278 <em>optional</em></p>
10279 </div></div></td>
10280 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10281 <p>string</p>
10282 </div></div></td>
10283 </tr>
10284 <tr>
10285 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10286 <p><strong>toscaResourceName</strong><br>
10287 <em>optional</em></p>
10288 </div></div></td>
10289 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10290 <p>string</p>
10291 </div></div></td>
10292 </tr>
10293 <tr>
10294 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10295 <p><strong>uniqueId</strong><br>
10296 <em>optional</em></p>
10297 </div></div></td>
10298 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10299 <p>string</p>
10300 </div></div></td>
10301 </tr>
10302 </tbody>
10303 </table>
10304
10305 </div>
10306 <div class="sect2">
10307 <h3 id="_interfaceoperationparamdatadefinition"><a class="anchor" href="#_interfaceoperationparamdatadefinition"></a>3.22. InterfaceOperationParamDataDefinition</h3>
10308 <table class="tableblock frame-all grid-all" style="width:100%; ">
10309 <colgroup>
10310 <col style="width:42%;">
10311 <col style="width:57%;">
10312 </colgroup>
10313 <thead>
10314 <tr>
10315 <th class="tableblock halign-left valign-middle">Name</th>
10316 <th class="tableblock halign-left valign-middle">Schema</th>
10317 </tr>
10318 </thead>
10319 <tbody>
10320 <tr>
10321 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10322 <p><strong>empty</strong><br>
10323 <em>optional</em></p>
10324 </div></div></td>
10325 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10326 <p>boolean</p>
10327 </div></div></td>
10328 </tr>
10329 <tr>
10330 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10331 <p><strong>ownerId</strong><br>
10332 <em>optional</em></p>
10333 </div></div></td>
10334 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10335 <p>string</p>
10336 </div></div></td>
10337 </tr>
10338 <tr>
10339 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10340 <p><strong>paramId</strong><br>
10341 <em>optional</em></p>
10342 </div></div></td>
10343 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10344 <p>string</p>
10345 </div></div></td>
10346 </tr>
10347 <tr>
10348 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10349 <p><strong>paramName</strong><br>
10350 <em>optional</em></p>
10351 </div></div></td>
10352 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10353 <p>string</p>
10354 </div></div></td>
10355 </tr>
10356 </tbody>
10357 </table>
10358
10359 </div>
10360 <div class="sect2">
10361 <h3 id="_lifecyclechangeinfowithaction"><a class="anchor" href="#_lifecyclechangeinfowithaction"></a>3.23. LifecycleChangeInfoWithAction</h3>
10362 <table class="tableblock frame-all grid-all" style="width:100%; ">
10363 <colgroup>
10364 <col style="width:42%;">
10365 <col style="width:57%;">
10366 </colgroup>
10367 <thead>
10368 <tr>
10369 <th class="tableblock halign-left valign-middle">Name</th>
10370 <th class="tableblock halign-left valign-middle">Schema</th>
10371 </tr>
10372 </thead>
10373 <tbody>
10374 <tr>
10375 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10376 <p><strong>action</strong><br>
10377 <em>optional</em></p>
10378 </div></div></td>
10379 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10380 <p>enum (CREATE_FROM_CSAR, UPDATE_FROM_EXTERNAL_API, UPGRADE_MIGRATION)</p>
10381 </div></div></td>
10382 </tr>
10383 <tr>
10384 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10385 <p><strong>userRemarks</strong><br>
10386 <em>optional</em></p>
10387 </div></div></td>
10388 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10389 <p>string</p>
10390 </div></div></td>
10391 </tr>
10392 </tbody>
10393 </table>
10394
10395 </div>
10396 <div class="sect2">
10397 <h3 id="_listdatadefinition"><a class="anchor" href="#_listdatadefinition"></a>3.24. ListDataDefinition</h3>
10398 <table class="tableblock frame-all grid-all" style="width:100%; ">
10399 <colgroup>
10400 <col style="width:42%;">
10401 <col style="width:57%;">
10402 </colgroup>
10403 <thead>
10404 <tr>
10405 <th class="tableblock halign-left valign-middle">Name</th>
10406 <th class="tableblock halign-left valign-middle">Schema</th>
10407 </tr>
10408 </thead>
10409 <tbody>
10410 <tr>
10411 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10412 <p><strong>empty</strong><br>
10413 <em>optional</em></p>
10414 </div></div></td>
10415 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10416 <p>boolean</p>
10417 </div></div></td>
10418 </tr>
10419 <tr>
10420 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10421 <p><strong>listToscaDataDefinition</strong><br>
10422 <em>optional</em></p>
10423 </div></div></td>
10424 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10425 <p>&lt; <a href="#_toscadatadefinition">ToscaDataDefinition</a> &gt; array</p>
10426 </div></div></td>
10427 </tr>
10428 <tr>
10429 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10430 <p><strong>ownerId</strong><br>
10431 <em>optional</em></p>
10432 </div></div></td>
10433 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10434 <p>string</p>
10435 </div></div></td>
10436 </tr>
10437 </tbody>
10438 </table>
10439
10440 </div>
10441 <div class="sect2">
10442 <h3 id="_listdatadefinitioninterfaceoperationparamdatadefinition"><a class="anchor" href="#_listdatadefinitioninterfaceoperationparamdatadefinition"></a>3.25. ListDataDefinitionInterfaceOperationParamDataDefinition</h3>
10443 <table class="tableblock frame-all grid-all" style="width:100%; ">
10444 <colgroup>
10445 <col style="width:42%;">
10446 <col style="width:57%;">
10447 </colgroup>
10448 <thead>
10449 <tr>
10450 <th class="tableblock halign-left valign-middle">Name</th>
10451 <th class="tableblock halign-left valign-middle">Schema</th>
10452 </tr>
10453 </thead>
10454 <tbody>
10455 <tr>
10456 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10457 <p><strong>empty</strong><br>
10458 <em>optional</em></p>
10459 </div></div></td>
10460 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10461 <p>boolean</p>
10462 </div></div></td>
10463 </tr>
10464 <tr>
10465 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10466 <p><strong>listToscaDataDefinition</strong><br>
10467 <em>optional</em></p>
10468 </div></div></td>
10469 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10470 <p>&lt; <a href="#_interfaceoperationparamdatadefinition">InterfaceOperationParamDataDefinition</a> &gt; array</p>
10471 </div></div></td>
10472 </tr>
10473 <tr>
10474 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10475 <p><strong>ownerId</strong><br>
10476 <em>optional</em></p>
10477 </div></div></td>
10478 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10479 <p>string</p>
10480 </div></div></td>
10481 </tr>
10482 </tbody>
10483 </table>
10484
10485 </div>
10486 <div class="sect2">
10487 <h3 id="_listdatadefinitionoperationinputdefinition"><a class="anchor" href="#_listdatadefinitionoperationinputdefinition"></a>3.26. ListDataDefinitionOperationInputDefinition</h3>
10488 <table class="tableblock frame-all grid-all" style="width:100%; ">
10489 <colgroup>
10490 <col style="width:42%;">
10491 <col style="width:57%;">
10492 </colgroup>
10493 <thead>
10494 <tr>
10495 <th class="tableblock halign-left valign-middle">Name</th>
10496 <th class="tableblock halign-left valign-middle">Schema</th>
10497 </tr>
10498 </thead>
10499 <tbody>
10500 <tr>
10501 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10502 <p><strong>empty</strong><br>
10503 <em>optional</em></p>
10504 </div></div></td>
10505 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10506 <p>boolean</p>
10507 </div></div></td>
10508 </tr>
10509 <tr>
10510 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10511 <p><strong>listToscaDataDefinition</strong><br>
10512 <em>optional</em></p>
10513 </div></div></td>
10514 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10515 <p>&lt; <a href="#_operationinputdefinition">OperationInputDefinition</a> &gt; array</p>
10516 </div></div></td>
10517 </tr>
10518 <tr>
10519 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10520 <p><strong>ownerId</strong><br>
10521 <em>optional</em></p>
10522 </div></div></td>
10523 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10524 <p>string</p>
10525 </div></div></td>
10526 </tr>
10527 </tbody>
10528 </table>
10529
10530 </div>
10531 <div class="sect2">
10532 <h3 id="_operationdatadefinition"><a class="anchor" href="#_operationdatadefinition"></a>3.27. OperationDataDefinition</h3>
10533 <table class="tableblock frame-all grid-all" style="width:100%; ">
10534 <colgroup>
10535 <col style="width:42%;">
10536 <col style="width:57%;">
10537 </colgroup>
10538 <thead>
10539 <tr>
10540 <th class="tableblock halign-left valign-middle">Name</th>
10541 <th class="tableblock halign-left valign-middle">Schema</th>
10542 </tr>
10543 </thead>
10544 <tbody>
10545 <tr>
10546 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10547 <p><strong>creationDate</strong><br>
10548 <em>optional</em></p>
10549 </div></div></td>
10550 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10551 <p>integer (int64)</p>
10552 </div></div></td>
10553 </tr>
10554 <tr>
10555 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10556 <p><strong>description</strong><br>
10557 <em>optional</em></p>
10558 </div></div></td>
10559 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10560 <p>string</p>
10561 </div></div></td>
10562 </tr>
10563 <tr>
10564 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10565 <p><strong>empty</strong><br>
10566 <em>optional</em></p>
10567 </div></div></td>
10568 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10569 <p>boolean</p>
10570 </div></div></td>
10571 </tr>
10572 <tr>
10573 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10574 <p><strong>implementation</strong><br>
10575 <em>optional</em></p>
10576 </div></div></td>
10577 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10578 <p><a href="#_artifactdatadefinition">ArtifactDataDefinition</a></p>
10579 </div></div></td>
10580 </tr>
10581 <tr>
10582 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10583 <p><strong>inputs</strong><br>
10584 <em>optional</em></p>
10585 </div></div></td>
10586 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10587 <p><a href="#_listdatadefinitionoperationinputdefinition">ListDataDefinitionOperationInputDefinition</a></p>
10588 </div></div></td>
10589 </tr>
10590 <tr>
10591 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10592 <p><strong>lastUpdateDate</strong><br>
10593 <em>optional</em></p>
10594 </div></div></td>
10595 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10596 <p>integer (int64)</p>
10597 </div></div></td>
10598 </tr>
10599 <tr>
10600 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10601 <p><strong>name</strong><br>
10602 <em>optional</em></p>
10603 </div></div></td>
10604 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10605 <p>string</p>
10606 </div></div></td>
10607 </tr>
10608 <tr>
10609 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10610 <p><strong>ownerId</strong><br>
10611 <em>optional</em></p>
10612 </div></div></td>
10613 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10614 <p>string</p>
10615 </div></div></td>
10616 </tr>
10617 <tr>
10618 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10619 <p><strong>uniqueId</strong><br>
10620 <em>optional</em></p>
10621 </div></div></td>
10622 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10623 <p>string</p>
10624 </div></div></td>
10625 </tr>
10626 </tbody>
10627 </table>
10628
10629 </div>
10630 <div class="sect2">
10631 <h3 id="_operationinputdefinition"><a class="anchor" href="#_operationinputdefinition"></a>3.28. OperationInputDefinition</h3>
10632 <table class="tableblock frame-all grid-all" style="width:100%; ">
10633 <colgroup>
10634 <col style="width:42%;">
10635 <col style="width:57%;">
10636 </colgroup>
10637 <thead>
10638 <tr>
10639 <th class="tableblock halign-left valign-middle">Name</th>
10640 <th class="tableblock halign-left valign-middle">Schema</th>
10641 </tr>
10642 </thead>
10643 <tbody>
10644 <tr>
10645 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10646 <p><strong>defaultValue</strong><br>
10647 <em>optional</em></p>
10648 </div></div></td>
10649 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10650 <p>string</p>
10651 </div></div></td>
10652 </tr>
10653 <tr>
10654 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10655 <p><strong>definition</strong><br>
10656 <em>optional</em></p>
10657 </div></div></td>
10658 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10659 <p>boolean</p>
10660 </div></div></td>
10661 </tr>
10662 <tr>
10663 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10664 <p><strong>description</strong><br>
10665 <em>optional</em></p>
10666 </div></div></td>
10667 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10668 <p>string</p>
10669 </div></div></td>
10670 </tr>
10671 <tr>
10672 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10673 <p><strong>empty</strong><br>
10674 <em>optional</em></p>
10675 </div></div></td>
10676 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10677 <p>boolean</p>
10678 </div></div></td>
10679 </tr>
10680 <tr>
10681 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10682 <p><strong>getInputProperty</strong><br>
10683 <em>optional</em></p>
10684 </div></div></td>
10685 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10686 <p>boolean</p>
10687 </div></div></td>
10688 </tr>
10689 <tr>
10690 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10691 <p><strong>getInputValues</strong><br>
10692 <em>optional</em></p>
10693 </div></div></td>
10694 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10695 <p>&lt; <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> &gt; array</p>
10696 </div></div></td>
10697 </tr>
10698 <tr>
10699 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10700 <p><strong>hidden</strong><br>
10701 <em>optional</em></p>
10702 </div></div></td>
10703 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10704 <p>boolean</p>
10705 </div></div></td>
10706 </tr>
10707 <tr>
10708 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10709 <p><strong>immutable</strong><br>
10710 <em>optional</em></p>
10711 </div></div></td>
10712 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10713 <p>boolean</p>
10714 </div></div></td>
10715 </tr>
10716 <tr>
10717 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10718 <p><strong>inputId</strong><br>
10719 <em>optional</em></p>
10720 </div></div></td>
10721 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10722 <p>string</p>
10723 </div></div></td>
10724 </tr>
10725 <tr>
10726 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10727 <p><strong>inputPath</strong><br>
10728 <em>optional</em></p>
10729 </div></div></td>
10730 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10731 <p>string</p>
10732 </div></div></td>
10733 </tr>
10734 <tr>
10735 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10736 <p><strong>instanceUniqueId</strong><br>
10737 <em>optional</em></p>
10738 </div></div></td>
10739 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10740 <p>string</p>
10741 </div></div></td>
10742 </tr>
10743 <tr>
10744 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10745 <p><strong>label</strong><br>
10746 <em>optional</em></p>
10747 </div></div></td>
10748 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10749 <p>string</p>
10750 </div></div></td>
10751 </tr>
10752 <tr>
10753 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10754 <p><strong>name</strong><br>
10755 <em>optional</em></p>
10756 </div></div></td>
10757 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10758 <p>string</p>
10759 </div></div></td>
10760 </tr>
10761 <tr>
10762 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10763 <p><strong>ownerId</strong><br>
10764 <em>optional</em></p>
10765 </div></div></td>
10766 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10767 <p>string</p>
10768 </div></div></td>
10769 </tr>
10770 <tr>
10771 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10772 <p><strong>parentUniqueId</strong><br>
10773 <em>optional</em></p>
10774 </div></div></td>
10775 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10776 <p>string</p>
10777 </div></div></td>
10778 </tr>
10779 <tr>
10780 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10781 <p><strong>password</strong><br>
10782 <em>optional</em></p>
10783 </div></div></td>
10784 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10785 <p>boolean</p>
10786 </div></div></td>
10787 </tr>
10788 <tr>
10789 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10790 <p><strong>propertyId</strong><br>
10791 <em>optional</em></p>
10792 </div></div></td>
10793 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10794 <p>string</p>
10795 </div></div></td>
10796 </tr>
10797 <tr>
10798 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10799 <p><strong>required</strong><br>
10800 <em>optional</em></p>
10801 </div></div></td>
10802 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10803 <p>boolean</p>
10804 </div></div></td>
10805 </tr>
10806 <tr>
10807 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10808 <p><strong>schema</strong><br>
10809 <em>optional</em></p>
10810 </div></div></td>
10811 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10812 <p><a href="#_schemadefinition">SchemaDefinition</a></p>
10813 </div></div></td>
10814 </tr>
10815 <tr>
10816 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10817 <p><strong>schemaType</strong><br>
10818 <em>optional</em></p>
10819 </div></div></td>
10820 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10821 <p>string</p>
10822 </div></div></td>
10823 </tr>
10824 <tr>
10825 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10826 <p><strong>status</strong><br>
10827 <em>optional</em></p>
10828 </div></div></td>
10829 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10830 <p>string</p>
10831 </div></div></td>
10832 </tr>
10833 <tr>
10834 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10835 <p><strong>type</strong><br>
10836 <em>optional</em></p>
10837 </div></div></td>
10838 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10839 <p>string</p>
10840 </div></div></td>
10841 </tr>
10842 <tr>
10843 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10844 <p><strong>uniqueId</strong><br>
10845 <em>optional</em></p>
10846 </div></div></td>
10847 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10848 <p>string</p>
10849 </div></div></td>
10850 </tr>
10851 <tr>
10852 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10853 <p><strong>value</strong><br>
10854 <em>optional</em></p>
10855 </div></div></td>
10856 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10857 <p>string</p>
10858 </div></div></td>
10859 </tr>
10860 </tbody>
10861 </table>
10862
10863 </div>
10864 <div class="sect2">
10865 <h3 id="_policydefinition"><a class="anchor" href="#_policydefinition"></a>3.29. PolicyDefinition</h3>
10866 <table class="tableblock frame-all grid-all" style="width:100%; ">
10867 <colgroup>
10868 <col style="width:42%;">
10869 <col style="width:57%;">
10870 </colgroup>
10871 <thead>
10872 <tr>
10873 <th class="tableblock halign-left valign-middle">Name</th>
10874 <th class="tableblock halign-left valign-middle">Schema</th>
10875 </tr>
10876 </thead>
10877 <tbody>
10878 <tr>
10879 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10880 <p><strong>componentName</strong><br>
10881 <em>optional</em></p>
10882 </div></div></td>
10883 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10884 <p>string</p>
10885 </div></div></td>
10886 </tr>
10887 <tr>
10888 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10889 <p><strong>derivedFrom</strong><br>
10890 <em>optional</em></p>
10891 </div></div></td>
10892 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10893 <p>string</p>
10894 </div></div></td>
10895 </tr>
10896 <tr>
10897 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10898 <p><strong>description</strong><br>
10899 <em>optional</em></p>
10900 </div></div></td>
10901 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10902 <p>string</p>
10903 </div></div></td>
10904 </tr>
10905 <tr>
10906 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10907 <p><strong>empty</strong><br>
10908 <em>optional</em></p>
10909 </div></div></td>
10910 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10911 <p>boolean</p>
10912 </div></div></td>
10913 </tr>
10914 <tr>
10915 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10916 <p><strong>invariantName</strong><br>
10917 <em>optional</em></p>
10918 </div></div></td>
10919 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10920 <p>string</p>
10921 </div></div></td>
10922 </tr>
10923 <tr>
10924 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10925 <p><strong>invariantUUID</strong><br>
10926 <em>optional</em></p>
10927 </div></div></td>
10928 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10929 <p>string</p>
10930 </div></div></td>
10931 </tr>
10932 <tr>
10933 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10934 <p><strong>isFromCsar</strong><br>
10935 <em>optional</em></p>
10936 </div></div></td>
10937 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10938 <p>boolean</p>
10939 </div></div></td>
10940 </tr>
10941 <tr>
10942 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10943 <p><strong>name</strong><br>
10944 <em>optional</em></p>
10945 </div></div></td>
10946 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10947 <p>string</p>
10948 </div></div></td>
10949 </tr>
10950 <tr>
10951 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10952 <p><strong>normalizedName</strong><br>
10953 <em>optional</em></p>
10954 </div></div></td>
10955 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10956 <p>string</p>
10957 </div></div></td>
10958 </tr>
10959 <tr>
10960 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10961 <p><strong>ownerId</strong><br>
10962 <em>optional</em></p>
10963 </div></div></td>
10964 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10965 <p>string</p>
10966 </div></div></td>
10967 </tr>
10968 <tr>
10969 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10970 <p><strong>policyTypeName</strong><br>
10971 <em>optional</em></p>
10972 </div></div></td>
10973 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10974 <p>string</p>
10975 </div></div></td>
10976 </tr>
10977 <tr>
10978 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10979 <p><strong>policyTypeUid</strong><br>
10980 <em>optional</em></p>
10981 </div></div></td>
10982 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10983 <p>string</p>
10984 </div></div></td>
10985 </tr>
10986 <tr>
10987 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10988 <p><strong>policyUUID</strong><br>
10989 <em>optional</em></p>
10990 </div></div></td>
10991 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10992 <p>string</p>
10993 </div></div></td>
10994 </tr>
10995 <tr>
10996 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
10997 <p><strong>properties</strong><br>
10998 <em>optional</em></p>
10999 </div></div></td>
11000 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11001 <p>&lt; <a href="#_propertydatadefinition">PropertyDataDefinition</a> &gt; array</p>
11002 </div></div></td>
11003 </tr>
11004 <tr>
11005 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11006 <p><strong>targets</strong><br>
11007 <em>optional</em></p>
11008 </div></div></td>
11009 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11010 <p>&lt; string, &lt; string &gt; array &gt; map</p>
11011 </div></div></td>
11012 </tr>
11013 <tr>
11014 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11015 <p><strong>uniqueId</strong><br>
11016 <em>optional</em></p>
11017 </div></div></td>
11018 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11019 <p>string</p>
11020 </div></div></td>
11021 </tr>
11022 <tr>
11023 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11024 <p><strong>version</strong><br>
11025 <em>optional</em></p>
11026 </div></div></td>
11027 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11028 <p>string</p>
11029 </div></div></td>
11030 </tr>
11031 </tbody>
11032 </table>
11033
11034 </div>
11035 <div class="sect2">
11036 <h3 id="_propertyconstraint"><a class="anchor" href="#_propertyconstraint"></a>3.30. PropertyConstraint</h3>
11037 <div class="paragraph">
11038 <p><em>Type</em> : object</p>
11039 </div>
11040 </div>
11041 <div class="sect2">
11042 <h3 id="_propertydatadefinition"><a class="anchor" href="#_propertydatadefinition"></a>3.31. PropertyDataDefinition</h3>
11043 <table class="tableblock frame-all grid-all" style="width:100%; ">
11044 <colgroup>
11045 <col style="width:42%;">
11046 <col style="width:57%;">
11047 </colgroup>
11048 <thead>
11049 <tr>
11050 <th class="tableblock halign-left valign-middle">Name</th>
11051 <th class="tableblock halign-left valign-middle">Schema</th>
11052 </tr>
11053 </thead>
11054 <tbody>
11055 <tr>
11056 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11057 <p><strong>defaultValue</strong><br>
11058 <em>optional</em></p>
11059 </div></div></td>
11060 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11061 <p>string</p>
11062 </div></div></td>
11063 </tr>
11064 <tr>
11065 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11066 <p><strong>definition</strong><br>
11067 <em>optional</em></p>
11068 </div></div></td>
11069 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11070 <p>boolean</p>
11071 </div></div></td>
11072 </tr>
11073 <tr>
11074 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11075 <p><strong>description</strong><br>
11076 <em>optional</em></p>
11077 </div></div></td>
11078 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11079 <p>string</p>
11080 </div></div></td>
11081 </tr>
11082 <tr>
11083 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11084 <p><strong>empty</strong><br>
11085 <em>optional</em></p>
11086 </div></div></td>
11087 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11088 <p>boolean</p>
11089 </div></div></td>
11090 </tr>
11091 <tr>
11092 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11093 <p><strong>getInputProperty</strong><br>
11094 <em>optional</em></p>
11095 </div></div></td>
11096 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11097 <p>boolean</p>
11098 </div></div></td>
11099 </tr>
11100 <tr>
11101 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11102 <p><strong>getInputValues</strong><br>
11103 <em>optional</em></p>
11104 </div></div></td>
11105 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11106 <p>&lt; <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> &gt; array</p>
11107 </div></div></td>
11108 </tr>
11109 <tr>
11110 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11111 <p><strong>hidden</strong><br>
11112 <em>optional</em></p>
11113 </div></div></td>
11114 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11115 <p>boolean</p>
11116 </div></div></td>
11117 </tr>
11118 <tr>
11119 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11120 <p><strong>immutable</strong><br>
11121 <em>optional</em></p>
11122 </div></div></td>
11123 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11124 <p>boolean</p>
11125 </div></div></td>
11126 </tr>
11127 <tr>
11128 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11129 <p><strong>inputId</strong><br>
11130 <em>optional</em></p>
11131 </div></div></td>
11132 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11133 <p>string</p>
11134 </div></div></td>
11135 </tr>
11136 <tr>
11137 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11138 <p><strong>inputPath</strong><br>
11139 <em>optional</em></p>
11140 </div></div></td>
11141 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11142 <p>string</p>
11143 </div></div></td>
11144 </tr>
11145 <tr>
11146 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11147 <p><strong>instanceUniqueId</strong><br>
11148 <em>optional</em></p>
11149 </div></div></td>
11150 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11151 <p>string</p>
11152 </div></div></td>
11153 </tr>
11154 <tr>
11155 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11156 <p><strong>label</strong><br>
11157 <em>optional</em></p>
11158 </div></div></td>
11159 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11160 <p>string</p>
11161 </div></div></td>
11162 </tr>
11163 <tr>
11164 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11165 <p><strong>name</strong><br>
11166 <em>optional</em></p>
11167 </div></div></td>
11168 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11169 <p>string</p>
11170 </div></div></td>
11171 </tr>
11172 <tr>
11173 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11174 <p><strong>ownerId</strong><br>
11175 <em>optional</em></p>
11176 </div></div></td>
11177 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11178 <p>string</p>
11179 </div></div></td>
11180 </tr>
11181 <tr>
11182 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11183 <p><strong>parentUniqueId</strong><br>
11184 <em>optional</em></p>
11185 </div></div></td>
11186 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11187 <p>string</p>
11188 </div></div></td>
11189 </tr>
11190 <tr>
11191 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11192 <p><strong>password</strong><br>
11193 <em>optional</em></p>
11194 </div></div></td>
11195 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11196 <p>boolean</p>
11197 </div></div></td>
11198 </tr>
11199 <tr>
11200 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11201 <p><strong>propertyId</strong><br>
11202 <em>optional</em></p>
11203 </div></div></td>
11204 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11205 <p>string</p>
11206 </div></div></td>
11207 </tr>
11208 <tr>
11209 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11210 <p><strong>required</strong><br>
11211 <em>optional</em></p>
11212 </div></div></td>
11213 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11214 <p>boolean</p>
11215 </div></div></td>
11216 </tr>
11217 <tr>
11218 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11219 <p><strong>schema</strong><br>
11220 <em>optional</em></p>
11221 </div></div></td>
11222 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11223 <p><a href="#_schemadefinition">SchemaDefinition</a></p>
11224 </div></div></td>
11225 </tr>
11226 <tr>
11227 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11228 <p><strong>schemaType</strong><br>
11229 <em>optional</em></p>
11230 </div></div></td>
11231 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11232 <p>string</p>
11233 </div></div></td>
11234 </tr>
11235 <tr>
11236 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11237 <p><strong>status</strong><br>
11238 <em>optional</em></p>
11239 </div></div></td>
11240 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11241 <p>string</p>
11242 </div></div></td>
11243 </tr>
11244 <tr>
11245 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11246 <p><strong>type</strong><br>
11247 <em>optional</em></p>
11248 </div></div></td>
11249 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11250 <p>string</p>
11251 </div></div></td>
11252 </tr>
11253 <tr>
11254 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11255 <p><strong>uniqueId</strong><br>
11256 <em>optional</em></p>
11257 </div></div></td>
11258 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11259 <p>string</p>
11260 </div></div></td>
11261 </tr>
11262 <tr>
11263 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11264 <p><strong>value</strong><br>
11265 <em>optional</em></p>
11266 </div></div></td>
11267 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11268 <p>string</p>
11269 </div></div></td>
11270 </tr>
11271 </tbody>
11272 </table>
11273
11274 </div>
11275 <div class="sect2">
11276 <h3 id="_propertydefinition"><a class="anchor" href="#_propertydefinition"></a>3.32. PropertyDefinition</h3>
11277 <table class="tableblock frame-all grid-all" style="width:100%; ">
11278 <colgroup>
11279 <col style="width:42%;">
11280 <col style="width:57%;">
11281 </colgroup>
11282 <thead>
11283 <tr>
11284 <th class="tableblock halign-left valign-middle">Name</th>
11285 <th class="tableblock halign-left valign-middle">Schema</th>
11286 </tr>
11287 </thead>
11288 <tbody>
11289 <tr>
11290 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11291 <p><strong>constraints</strong><br>
11292 <em>optional</em></p>
11293 </div></div></td>
11294 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11295 <p>&lt; <a href="#_propertyconstraint">PropertyConstraint</a> &gt; array</p>
11296 </div></div></td>
11297 </tr>
11298 <tr>
11299 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11300 <p><strong>defaultValue</strong><br>
11301 <em>optional</em></p>
11302 </div></div></td>
11303 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11304 <p>string</p>
11305 </div></div></td>
11306 </tr>
11307 <tr>
11308 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11309 <p><strong>definition</strong><br>
11310 <em>optional</em></p>
11311 </div></div></td>
11312 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11313 <p>boolean</p>
11314 </div></div></td>
11315 </tr>
11316 <tr>
11317 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11318 <p><strong>description</strong><br>
11319 <em>optional</em></p>
11320 </div></div></td>
11321 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11322 <p>string</p>
11323 </div></div></td>
11324 </tr>
11325 <tr>
11326 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11327 <p><strong>empty</strong><br>
11328 <em>optional</em></p>
11329 </div></div></td>
11330 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11331 <p>boolean</p>
11332 </div></div></td>
11333 </tr>
11334 <tr>
11335 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11336 <p><strong>getInputProperty</strong><br>
11337 <em>optional</em></p>
11338 </div></div></td>
11339 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11340 <p>boolean</p>
11341 </div></div></td>
11342 </tr>
11343 <tr>
11344 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11345 <p><strong>getInputValues</strong><br>
11346 <em>optional</em></p>
11347 </div></div></td>
11348 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11349 <p>&lt; <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> &gt; array</p>
11350 </div></div></td>
11351 </tr>
11352 <tr>
11353 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11354 <p><strong>hidden</strong><br>
11355 <em>optional</em></p>
11356 </div></div></td>
11357 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11358 <p>boolean</p>
11359 </div></div></td>
11360 </tr>
11361 <tr>
11362 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11363 <p><strong>immutable</strong><br>
11364 <em>optional</em></p>
11365 </div></div></td>
11366 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11367 <p>boolean</p>
11368 </div></div></td>
11369 </tr>
11370 <tr>
11371 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11372 <p><strong>inputId</strong><br>
11373 <em>optional</em></p>
11374 </div></div></td>
11375 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11376 <p>string</p>
11377 </div></div></td>
11378 </tr>
11379 <tr>
11380 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11381 <p><strong>inputPath</strong><br>
11382 <em>optional</em></p>
11383 </div></div></td>
11384 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11385 <p>string</p>
11386 </div></div></td>
11387 </tr>
11388 <tr>
11389 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11390 <p><strong>instanceUniqueId</strong><br>
11391 <em>optional</em></p>
11392 </div></div></td>
11393 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11394 <p>string</p>
11395 </div></div></td>
11396 </tr>
11397 <tr>
11398 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11399 <p><strong>label</strong><br>
11400 <em>optional</em></p>
11401 </div></div></td>
11402 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11403 <p>string</p>
11404 </div></div></td>
11405 </tr>
11406 <tr>
11407 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11408 <p><strong>name</strong><br>
11409 <em>optional</em></p>
11410 </div></div></td>
11411 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11412 <p>string</p>
11413 </div></div></td>
11414 </tr>
11415 <tr>
11416 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11417 <p><strong>ownerId</strong><br>
11418 <em>optional</em></p>
11419 </div></div></td>
11420 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11421 <p>string</p>
11422 </div></div></td>
11423 </tr>
11424 <tr>
11425 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11426 <p><strong>parentUniqueId</strong><br>
11427 <em>optional</em></p>
11428 </div></div></td>
11429 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11430 <p>string</p>
11431 </div></div></td>
11432 </tr>
11433 <tr>
11434 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11435 <p><strong>password</strong><br>
11436 <em>optional</em></p>
11437 </div></div></td>
11438 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11439 <p>boolean</p>
11440 </div></div></td>
11441 </tr>
11442 <tr>
11443 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11444 <p><strong>propertyId</strong><br>
11445 <em>optional</em></p>
11446 </div></div></td>
11447 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11448 <p>string</p>
11449 </div></div></td>
11450 </tr>
11451 <tr>
11452 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11453 <p><strong>required</strong><br>
11454 <em>optional</em></p>
11455 </div></div></td>
11456 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11457 <p>boolean</p>
11458 </div></div></td>
11459 </tr>
11460 <tr>
11461 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11462 <p><strong>schema</strong><br>
11463 <em>optional</em></p>
11464 </div></div></td>
11465 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11466 <p><a href="#_schemadefinition">SchemaDefinition</a></p>
11467 </div></div></td>
11468 </tr>
11469 <tr>
11470 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11471 <p><strong>schemaType</strong><br>
11472 <em>optional</em></p>
11473 </div></div></td>
11474 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11475 <p>string</p>
11476 </div></div></td>
11477 </tr>
11478 <tr>
11479 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11480 <p><strong>status</strong><br>
11481 <em>optional</em></p>
11482 </div></div></td>
11483 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11484 <p>string</p>
11485 </div></div></td>
11486 </tr>
11487 <tr>
11488 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11489 <p><strong>type</strong><br>
11490 <em>optional</em></p>
11491 </div></div></td>
11492 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11493 <p>string</p>
11494 </div></div></td>
11495 </tr>
11496 <tr>
11497 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11498 <p><strong>uniqueId</strong><br>
11499 <em>optional</em></p>
11500 </div></div></td>
11501 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11502 <p>string</p>
11503 </div></div></td>
11504 </tr>
11505 <tr>
11506 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11507 <p><strong>value</strong><br>
11508 <em>optional</em></p>
11509 </div></div></td>
11510 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11511 <p>string</p>
11512 </div></div></td>
11513 </tr>
11514 </tbody>
11515 </table>
11516
11517 </div>
11518 <div class="sect2">
11519 <h3 id="_propertyrule"><a class="anchor" href="#_propertyrule"></a>3.33. PropertyRule</h3>
11520 <table class="tableblock frame-all grid-all" style="width:100%; ">
11521 <colgroup>
11522 <col style="width:42%;">
11523 <col style="width:57%;">
11524 </colgroup>
11525 <thead>
11526 <tr>
11527 <th class="tableblock halign-left valign-middle">Name</th>
11528 <th class="tableblock halign-left valign-middle">Schema</th>
11529 </tr>
11530 </thead>
11531 <tbody>
11532 <tr>
11533 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11534 <p><strong>empty</strong><br>
11535 <em>optional</em></p>
11536 </div></div></td>
11537 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11538 <p>boolean</p>
11539 </div></div></td>
11540 </tr>
11541 <tr>
11542 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11543 <p><strong>ownerId</strong><br>
11544 <em>optional</em></p>
11545 </div></div></td>
11546 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11547 <p>string</p>
11548 </div></div></td>
11549 </tr>
11550 <tr>
11551 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11552 <p><strong>rule</strong><br>
11553 <em>optional</em></p>
11554 </div></div></td>
11555 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11556 <p>&lt; string &gt; array</p>
11557 </div></div></td>
11558 </tr>
11559 <tr>
11560 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11561 <p><strong>value</strong><br>
11562 <em>optional</em></p>
11563 </div></div></td>
11564 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11565 <p>string</p>
11566 </div></div></td>
11567 </tr>
11568 </tbody>
11569 </table>
11570
11571 </div>
11572 <div class="sect2">
11573 <h3 id="_registrationrequest"><a class="anchor" href="#_registrationrequest"></a>3.34. RegistrationRequest</h3>
11574 <table class="tableblock frame-all grid-all" style="width:100%; ">
11575 <colgroup>
11576 <col style="width:42%;">
11577 <col style="width:57%;">
11578 </colgroup>
11579 <thead>
11580 <tr>
11581 <th class="tableblock halign-left valign-middle">Name</th>
11582 <th class="tableblock halign-left valign-middle">Schema</th>
11583 </tr>
11584 </thead>
11585 <tbody>
11586 <tr>
11587 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11588 <p><strong>apiPublicKey</strong><br>
11589 <em>optional</em></p>
11590 </div></div></td>
11591 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11592 <p>string</p>
11593 </div></div></td>
11594 </tr>
11595 <tr>
11596 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11597 <p><strong>distEnvEndPoints</strong><br>
11598 <em>optional</em></p>
11599 </div></div></td>
11600 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11601 <p>&lt; string &gt; array</p>
11602 </div></div></td>
11603 </tr>
11604 <tr>
11605 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11606 <p><strong>distrEnvName</strong><br>
11607 <em>optional</em></p>
11608 </div></div></td>
11609 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11610 <p>string</p>
11611 </div></div></td>
11612 </tr>
11613 <tr>
11614 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11615 <p><strong>isConsumerToSdcDistrStatusTopic</strong><br>
11616 <em>optional</em></p>
11617 </div></div></td>
11618 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11619 <p>boolean</p>
11620 </div></div></td>
11621 </tr>
11622 </tbody>
11623 </table>
11624
11625 </div>
11626 <div class="sect2">
11627 <h3 id="_relationshipimpl"><a class="anchor" href="#_relationshipimpl"></a>3.35. RelationshipImpl</h3>
11628 <table class="tableblock frame-all grid-all" style="width:100%; ">
11629 <colgroup>
11630 <col style="width:42%;">
11631 <col style="width:57%;">
11632 </colgroup>
11633 <thead>
11634 <tr>
11635 <th class="tableblock halign-left valign-middle">Name</th>
11636 <th class="tableblock halign-left valign-middle">Schema</th>
11637 </tr>
11638 </thead>
11639 <tbody>
11640 <tr>
11641 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11642 <p><strong>type</strong><br>
11643 <em>optional</em></p>
11644 </div></div></td>
11645 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11646 <p>string</p>
11647 </div></div></td>
11648 </tr>
11649 </tbody>
11650 </table>
11651
11652 </div>
11653 <div class="sect2">
11654 <h3 id="_relationshipinfo"><a class="anchor" href="#_relationshipinfo"></a>3.36. RelationshipInfo</h3>
11655 <table class="tableblock frame-all grid-all" style="width:100%; ">
11656 <colgroup>
11657 <col style="width:42%;">
11658 <col style="width:57%;">
11659 </colgroup>
11660 <thead>
11661 <tr>
11662 <th class="tableblock halign-left valign-middle">Name</th>
11663 <th class="tableblock halign-left valign-middle">Schema</th>
11664 </tr>
11665 </thead>
11666 <tbody>
11667 <tr>
11668 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11669 <p><strong>capability</strong><br>
11670 <em>optional</em></p>
11671 </div></div></td>
11672 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11673 <p>string</p>
11674 </div></div></td>
11675 </tr>
11676 <tr>
11677 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11678 <p><strong>capabilityOwnerId</strong><br>
11679 <em>optional</em></p>
11680 </div></div></td>
11681 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11682 <p>string</p>
11683 </div></div></td>
11684 </tr>
11685 <tr>
11686 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11687 <p><strong>capabilityUid</strong><br>
11688 <em>optional</em></p>
11689 </div></div></td>
11690 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11691 <p>string</p>
11692 </div></div></td>
11693 </tr>
11694 <tr>
11695 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11696 <p><strong>id</strong><br>
11697 <em>optional</em></p>
11698 </div></div></td>
11699 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11700 <p>string</p>
11701 </div></div></td>
11702 </tr>
11703 <tr>
11704 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11705 <p><strong>relationship</strong><br>
11706 <em>optional</em></p>
11707 </div></div></td>
11708 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11709 <p><a href="#_relationshipimpl">RelationshipImpl</a></p>
11710 </div></div></td>
11711 </tr>
11712 <tr>
11713 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11714 <p><strong>requirement</strong><br>
11715 <em>optional</em></p>
11716 </div></div></td>
11717 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11718 <p>string</p>
11719 </div></div></td>
11720 </tr>
11721 <tr>
11722 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11723 <p><strong>requirementOwnerId</strong><br>
11724 <em>optional</em></p>
11725 </div></div></td>
11726 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11727 <p>string</p>
11728 </div></div></td>
11729 </tr>
11730 <tr>
11731 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11732 <p><strong>requirementUid</strong><br>
11733 <em>optional</em></p>
11734 </div></div></td>
11735 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11736 <p>string</p>
11737 </div></div></td>
11738 </tr>
11739 </tbody>
11740 </table>
11741
11742 </div>
11743 <div class="sect2">
11744 <h3 id="_requirementcapabilityreldef"><a class="anchor" href="#_requirementcapabilityreldef"></a>3.37. RequirementCapabilityRelDef</h3>
11745 <table class="tableblock frame-all grid-all" style="width:100%; ">
11746 <colgroup>
11747 <col style="width:42%;">
11748 <col style="width:57%;">
11749 </colgroup>
11750 <thead>
11751 <tr>
11752 <th class="tableblock halign-left valign-middle">Name</th>
11753 <th class="tableblock halign-left valign-middle">Schema</th>
11754 </tr>
11755 </thead>
11756 <tbody>
11757 <tr>
11758 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11759 <p><strong>fromNode</strong><br>
11760 <em>optional</em></p>
11761 </div></div></td>
11762 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11763 <p>string</p>
11764 </div></div></td>
11765 </tr>
11766 <tr>
11767 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11768 <p><strong>relationships</strong><br>
11769 <em>optional</em></p>
11770 </div></div></td>
11771 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11772 <p>&lt; <a href="#_capabilityrequirementrelationship">CapabilityRequirementRelationship</a> &gt; array</p>
11773 </div></div></td>
11774 </tr>
11775 <tr>
11776 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11777 <p><strong>toNode</strong><br>
11778 <em>optional</em></p>
11779 </div></div></td>
11780 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11781 <p>string</p>
11782 </div></div></td>
11783 </tr>
11784 <tr>
11785 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11786 <p><strong>uid</strong><br>
11787 <em>optional</em></p>
11788 </div></div></td>
11789 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11790 <p>string</p>
11791 </div></div></td>
11792 </tr>
11793 </tbody>
11794 </table>
11795
11796 </div>
11797 <div class="sect2">
11798 <h3 id="_requirementdatadefinition"><a class="anchor" href="#_requirementdatadefinition"></a>3.38. RequirementDataDefinition</h3>
11799 <table class="tableblock frame-all grid-all" style="width:100%; ">
11800 <colgroup>
11801 <col style="width:42%;">
11802 <col style="width:57%;">
11803 </colgroup>
11804 <thead>
11805 <tr>
11806 <th class="tableblock halign-left valign-middle">Name</th>
11807 <th class="tableblock halign-left valign-middle">Schema</th>
11808 </tr>
11809 </thead>
11810 <tbody>
11811 <tr>
11812 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11813 <p><strong>capability</strong><br>
11814 <em>optional</em></p>
11815 </div></div></td>
11816 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11817 <p>string</p>
11818 </div></div></td>
11819 </tr>
11820 <tr>
11821 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11822 <p><strong>empty</strong><br>
11823 <em>optional</em></p>
11824 </div></div></td>
11825 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11826 <p>boolean</p>
11827 </div></div></td>
11828 </tr>
11829 <tr>
11830 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11831 <p><strong>leftOccurrences</strong><br>
11832 <em>optional</em></p>
11833 </div></div></td>
11834 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11835 <p>string</p>
11836 </div></div></td>
11837 </tr>
11838 <tr>
11839 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11840 <p><strong>maxOccurrences</strong><br>
11841 <em>optional</em></p>
11842 </div></div></td>
11843 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11844 <p>string</p>
11845 </div></div></td>
11846 </tr>
11847 <tr>
11848 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11849 <p><strong>minOccurrences</strong><br>
11850 <em>optional</em></p>
11851 </div></div></td>
11852 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11853 <p>string</p>
11854 </div></div></td>
11855 </tr>
11856 <tr>
11857 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11858 <p><strong>name</strong><br>
11859 <em>optional</em></p>
11860 </div></div></td>
11861 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11862 <p>string</p>
11863 </div></div></td>
11864 </tr>
11865 <tr>
11866 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11867 <p><strong>node</strong><br>
11868 <em>optional</em></p>
11869 </div></div></td>
11870 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11871 <p>string</p>
11872 </div></div></td>
11873 </tr>
11874 <tr>
11875 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11876 <p><strong>ownerId</strong><br>
11877 <em>optional</em></p>
11878 </div></div></td>
11879 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11880 <p>string</p>
11881 </div></div></td>
11882 </tr>
11883 <tr>
11884 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11885 <p><strong>ownerName</strong><br>
11886 <em>optional</em></p>
11887 </div></div></td>
11888 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11889 <p>string</p>
11890 </div></div></td>
11891 </tr>
11892 <tr>
11893 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11894 <p><strong>parentName</strong><br>
11895 <em>optional</em></p>
11896 </div></div></td>
11897 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11898 <p>string</p>
11899 </div></div></td>
11900 </tr>
11901 <tr>
11902 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11903 <p><strong>path</strong><br>
11904 <em>optional</em></p>
11905 </div></div></td>
11906 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11907 <p>&lt; string &gt; array</p>
11908 </div></div></td>
11909 </tr>
11910 <tr>
11911 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11912 <p><strong>relationship</strong><br>
11913 <em>optional</em></p>
11914 </div></div></td>
11915 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11916 <p>string</p>
11917 </div></div></td>
11918 </tr>
11919 <tr>
11920 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11921 <p><strong>source</strong><br>
11922 <em>optional</em></p>
11923 </div></div></td>
11924 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11925 <p>string</p>
11926 </div></div></td>
11927 </tr>
11928 <tr>
11929 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11930 <p><strong>uniqueId</strong><br>
11931 <em>optional</em></p>
11932 </div></div></td>
11933 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11934 <p>string</p>
11935 </div></div></td>
11936 </tr>
11937 </tbody>
11938 </table>
11939
11940 </div>
11941 <div class="sect2">
11942 <h3 id="_requirementdefinition"><a class="anchor" href="#_requirementdefinition"></a>3.39. RequirementDefinition</h3>
11943 <table class="tableblock frame-all grid-all" style="width:100%; ">
11944 <colgroup>
11945 <col style="width:42%;">
11946 <col style="width:57%;">
11947 </colgroup>
11948 <thead>
11949 <tr>
11950 <th class="tableblock halign-left valign-middle">Name</th>
11951 <th class="tableblock halign-left valign-middle">Schema</th>
11952 </tr>
11953 </thead>
11954 <tbody>
11955 <tr>
11956 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11957 <p><strong>capability</strong><br>
11958 <em>optional</em></p>
11959 </div></div></td>
11960 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11961 <p>string</p>
11962 </div></div></td>
11963 </tr>
11964 <tr>
11965 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11966 <p><strong>empty</strong><br>
11967 <em>optional</em></p>
11968 </div></div></td>
11969 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11970 <p>boolean</p>
11971 </div></div></td>
11972 </tr>
11973 <tr>
11974 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11975 <p><strong>leftOccurrences</strong><br>
11976 <em>optional</em></p>
11977 </div></div></td>
11978 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11979 <p>string</p>
11980 </div></div></td>
11981 </tr>
11982 <tr>
11983 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11984 <p><strong>maxOccurrences</strong><br>
11985 <em>optional</em></p>
11986 </div></div></td>
11987 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11988 <p>string</p>
11989 </div></div></td>
11990 </tr>
11991 <tr>
11992 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11993 <p><strong>minOccurrences</strong><br>
11994 <em>optional</em></p>
11995 </div></div></td>
11996 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
11997 <p>string</p>
11998 </div></div></td>
11999 </tr>
12000 <tr>
12001 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12002 <p><strong>name</strong><br>
12003 <em>optional</em></p>
12004 </div></div></td>
12005 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12006 <p>string</p>
12007 </div></div></td>
12008 </tr>
12009 <tr>
12010 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12011 <p><strong>node</strong><br>
12012 <em>optional</em></p>
12013 </div></div></td>
12014 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12015 <p>string</p>
12016 </div></div></td>
12017 </tr>
12018 <tr>
12019 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12020 <p><strong>ownerId</strong><br>
12021 <em>optional</em></p>
12022 </div></div></td>
12023 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12024 <p>string</p>
12025 </div></div></td>
12026 </tr>
12027 <tr>
12028 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12029 <p><strong>ownerName</strong><br>
12030 <em>optional</em></p>
12031 </div></div></td>
12032 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12033 <p>string</p>
12034 </div></div></td>
12035 </tr>
12036 <tr>
12037 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12038 <p><strong>parentName</strong><br>
12039 <em>optional</em></p>
12040 </div></div></td>
12041 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12042 <p>string</p>
12043 </div></div></td>
12044 </tr>
12045 <tr>
12046 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12047 <p><strong>path</strong><br>
12048 <em>optional</em></p>
12049 </div></div></td>
12050 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12051 <p>&lt; string &gt; array</p>
12052 </div></div></td>
12053 </tr>
12054 <tr>
12055 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12056 <p><strong>relationship</strong><br>
12057 <em>optional</em></p>
12058 </div></div></td>
12059 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12060 <p>string</p>
12061 </div></div></td>
12062 </tr>
12063 <tr>
12064 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12065 <p><strong>source</strong><br>
12066 <em>optional</em></p>
12067 </div></div></td>
12068 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12069 <p>string</p>
12070 </div></div></td>
12071 </tr>
12072 <tr>
12073 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12074 <p><strong>uniqueId</strong><br>
12075 <em>optional</em></p>
12076 </div></div></td>
12077 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12078 <p>string</p>
12079 </div></div></td>
12080 </tr>
12081 </tbody>
12082 </table>
12083
12084 </div>
12085 <div class="sect2">
12086 <h3 id="_resource"><a class="anchor" href="#_resource"></a>3.40. Resource</h3>
12087 <table class="tableblock frame-all grid-all" style="width:100%; ">
12088 <colgroup>
12089 <col style="width:42%;">
12090 <col style="width:57%;">
12091 </colgroup>
12092 <thead>
12093 <tr>
12094 <th class="tableblock halign-left valign-middle">Name</th>
12095 <th class="tableblock halign-left valign-middle">Schema</th>
12096 </tr>
12097 </thead>
12098 <tbody>
12099 <tr>
12100 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12101 <p><strong>abstract</strong><br>
12102 <em>optional</em></p>
12103 </div></div></td>
12104 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12105 <p>boolean</p>
12106 </div></div></td>
12107 </tr>
12108 <tr>
12109 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12110 <p><strong>additionalInformation</strong><br>
12111 <em>optional</em></p>
12112 </div></div></td>
12113 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12114 <p>&lt; <a href="#_additionalinformationdefinition">AdditionalInformationDefinition</a> &gt; array</p>
12115 </div></div></td>
12116 </tr>
12117 <tr>
12118 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12119 <p><strong>allArtifacts</strong><br>
12120 <em>optional</em></p>
12121 </div></div></td>
12122 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12123 <p>&lt; string, <a href="#_artifactdefinition">ArtifactDefinition</a> &gt; map</p>
12124 </div></div></td>
12125 </tr>
12126 <tr>
12127 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12128 <p><strong>allVersions</strong><br>
12129 <em>optional</em></p>
12130 </div></div></td>
12131 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12132 <p>&lt; string, string &gt; map</p>
12133 </div></div></td>
12134 </tr>
12135 <tr>
12136 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12137 <p><strong>artifacts</strong><br>
12138 <em>optional</em></p>
12139 </div></div></td>
12140 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12141 <p>&lt; string, <a href="#_artifactdefinition">ArtifactDefinition</a> &gt; map</p>
12142 </div></div></td>
12143 </tr>
12144 <tr>
12145 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12146 <p><strong>attributes</strong><br>
12147 <em>optional</em></p>
12148 </div></div></td>
12149 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12150 <p>&lt; <a href="#_propertydefinition">PropertyDefinition</a> &gt; array</p>
12151 </div></div></td>
12152 </tr>
12153 <tr>
12154 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12155 <p><strong>capabilities</strong><br>
12156 <em>optional</em></p>
12157 </div></div></td>
12158 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12159 <p>&lt; string, &lt; <a href="#_capabilitydefinition">CapabilityDefinition</a> &gt; array &gt; map</p>
12160 </div></div></td>
12161 </tr>
12162 <tr>
12163 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12164 <p><strong>categories</strong><br>
12165 <em>optional</em></p>
12166 </div></div></td>
12167 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12168 <p>&lt; <a href="#_categorydefinition">CategoryDefinition</a> &gt; array</p>
12169 </div></div></td>
12170 </tr>
12171 <tr>
12172 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12173 <p><strong>componentInstances</strong><br>
12174 <em>optional</em></p>
12175 </div></div></td>
12176 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12177 <p>&lt; <a href="#_componentinstance">ComponentInstance</a> &gt; array</p>
12178 </div></div></td>
12179 </tr>
12180 <tr>
12181 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12182 <p><strong>componentInstancesAttributes</strong><br>
12183 <em>optional</em></p>
12184 </div></div></td>
12185 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12186 <p>&lt; string, &lt; <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> &gt; array &gt; map</p>
12187 </div></div></td>
12188 </tr>
12189 <tr>
12190 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12191 <p><strong>componentInstancesInputs</strong><br>
12192 <em>optional</em></p>
12193 </div></div></td>
12194 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12195 <p>&lt; string, &lt; <a href="#_componentinstanceinput">ComponentInstanceInput</a> &gt; array &gt; map</p>
12196 </div></div></td>
12197 </tr>
12198 <tr>
12199 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12200 <p><strong>componentInstancesProperties</strong><br>
12201 <em>optional</em></p>
12202 </div></div></td>
12203 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12204 <p>&lt; string, &lt; <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> &gt; array &gt; map</p>
12205 </div></div></td>
12206 </tr>
12207 <tr>
12208 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12209 <p><strong>componentInstancesRelations</strong><br>
12210 <em>optional</em></p>
12211 </div></div></td>
12212 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12213 <p>&lt; <a href="#_requirementcapabilityreldef">RequirementCapabilityRelDef</a> &gt; array</p>
12214 </div></div></td>
12215 </tr>
12216 <tr>
12217 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12218 <p><strong>componentType</strong><br>
12219 <em>optional</em></p>
12220 </div></div></td>
12221 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12222 <p>enum (RESOURCE, SERVICE, RESOURCE_INSTANCE, PRODUCT, SERVICE_INSTANCE)</p>
12223 </div></div></td>
12224 </tr>
12225 <tr>
12226 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12227 <p><strong>conformanceLevel</strong><br>
12228 <em>optional</em></p>
12229 </div></div></td>
12230 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12231 <p>string</p>
12232 </div></div></td>
12233 </tr>
12234 <tr>
12235 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12236 <p><strong>contactId</strong><br>
12237 <em>optional</em></p>
12238 </div></div></td>
12239 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12240 <p>string</p>
12241 </div></div></td>
12242 </tr>
12243 <tr>
12244 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12245 <p><strong>cost</strong><br>
12246 <em>optional</em></p>
12247 </div></div></td>
12248 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12249 <p>string</p>
12250 </div></div></td>
12251 </tr>
12252 <tr>
12253 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12254 <p><strong>creationDate</strong><br>
12255 <em>optional</em></p>
12256 </div></div></td>
12257 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12258 <p>integer (int64)</p>
12259 </div></div></td>
12260 </tr>
12261 <tr>
12262 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12263 <p><strong>creatorFullName</strong><br>
12264 <em>optional</em></p>
12265 </div></div></td>
12266 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12267 <p>string</p>
12268 </div></div></td>
12269 </tr>
12270 <tr>
12271 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12272 <p><strong>creatorUserId</strong><br>
12273 <em>optional</em></p>
12274 </div></div></td>
12275 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12276 <p>string</p>
12277 </div></div></td>
12278 </tr>
12279 <tr>
12280 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12281 <p><strong>csarUUID</strong><br>
12282 <em>optional</em></p>
12283 </div></div></td>
12284 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12285 <p>string</p>
12286 </div></div></td>
12287 </tr>
12288 <tr>
12289 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12290 <p><strong>csarVersion</strong><br>
12291 <em>optional</em></p>
12292 </div></div></td>
12293 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12294 <p>string</p>
12295 </div></div></td>
12296 </tr>
12297 <tr>
12298 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12299 <p><strong>defaultCapabilities</strong><br>
12300 <em>optional</em></p>
12301 </div></div></td>
12302 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12303 <p>&lt; string &gt; array</p>
12304 </div></div></td>
12305 </tr>
12306 <tr>
12307 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12308 <p><strong>deploymentArtifacts</strong><br>
12309 <em>optional</em></p>
12310 </div></div></td>
12311 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12312 <p>&lt; string, <a href="#_artifactdefinition">ArtifactDefinition</a> &gt; map</p>
12313 </div></div></td>
12314 </tr>
12315 <tr>
12316 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12317 <p><strong>derivedFrom</strong><br>
12318 <em>optional</em></p>
12319 </div></div></td>
12320 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12321 <p>&lt; string &gt; array</p>
12322 </div></div></td>
12323 </tr>
12324 <tr>
12325 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12326 <p><strong>derivedFromGenericType</strong><br>
12327 <em>optional</em></p>
12328 </div></div></td>
12329 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12330 <p>string</p>
12331 </div></div></td>
12332 </tr>
12333 <tr>
12334 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12335 <p><strong>derivedFromGenericVersion</strong><br>
12336 <em>optional</em></p>
12337 </div></div></td>
12338 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12339 <p>string</p>
12340 </div></div></td>
12341 </tr>
12342 <tr>
12343 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12344 <p><strong>derivedList</strong><br>
12345 <em>optional</em></p>
12346 </div></div></td>
12347 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12348 <p>&lt; string &gt; array</p>
12349 </div></div></td>
12350 </tr>
12351 <tr>
12352 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12353 <p><strong>description</strong><br>
12354 <em>optional</em></p>
12355 </div></div></td>
12356 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12357 <p>string</p>
12358 </div></div></td>
12359 </tr>
12360 <tr>
12361 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12362 <p><strong>groups</strong><br>
12363 <em>optional</em></p>
12364 </div></div></td>
12365 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12366 <p>&lt; <a href="#_groupdefinition">GroupDefinition</a> &gt; array</p>
12367 </div></div></td>
12368 </tr>
12369 <tr>
12370 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12371 <p><strong>highestVersion</strong><br>
12372 <em>optional</em></p>
12373 </div></div></td>
12374 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12375 <p>boolean</p>
12376 </div></div></td>
12377 </tr>
12378 <tr>
12379 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12380 <p><strong>icon</strong><br>
12381 <em>optional</em></p>
12382 </div></div></td>
12383 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12384 <p>string</p>
12385 </div></div></td>
12386 </tr>
12387 <tr>
12388 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12389 <p><strong>importedToscaChecksum</strong><br>
12390 <em>optional</em></p>
12391 </div></div></td>
12392 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12393 <p>string</p>
12394 </div></div></td>
12395 </tr>
12396 <tr>
12397 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12398 <p><strong>inputs</strong><br>
12399 <em>optional</em></p>
12400 </div></div></td>
12401 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12402 <p>&lt; <a href="#_inputdefinition">InputDefinition</a> &gt; array</p>
12403 </div></div></td>
12404 </tr>
12405 <tr>
12406 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12407 <p><strong>interfaceOperations</strong><br>
12408 <em>optional</em></p>
12409 </div></div></td>
12410 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12411 <p>&lt; string, <a href="#_interfaceoperationdatadefinition">InterfaceOperationDataDefinition</a> &gt; map</p>
12412 </div></div></td>
12413 </tr>
12414 <tr>
12415 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12416 <p><strong>interfaces</strong><br>
12417 <em>optional</em></p>
12418 </div></div></td>
12419 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12420 <p>&lt; string, <a href="#_interfacedefinition">InterfaceDefinition</a> &gt; map</p>
12421 </div></div></td>
12422 </tr>
12423 <tr>
12424 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12425 <p><strong>invariantUUID</strong><br>
12426 <em>optional</em></p>
12427 </div></div></td>
12428 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12429 <p>string</p>
12430 </div></div></td>
12431 </tr>
12432 <tr>
12433 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12434 <p><strong>isDeleted</strong><br>
12435 <em>optional</em></p>
12436 </div></div></td>
12437 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12438 <p>boolean</p>
12439 </div></div></td>
12440 </tr>
12441 <tr>
12442 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12443 <p><strong>lastUpdateDate</strong><br>
12444 <em>optional</em></p>
12445 </div></div></td>
12446 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12447 <p>integer (int64)</p>
12448 </div></div></td>
12449 </tr>
12450 <tr>
12451 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12452 <p><strong>lastUpdaterFullName</strong><br>
12453 <em>optional</em></p>
12454 </div></div></td>
12455 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12456 <p>string</p>
12457 </div></div></td>
12458 </tr>
12459 <tr>
12460 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12461 <p><strong>lastUpdaterUserId</strong><br>
12462 <em>optional</em></p>
12463 </div></div></td>
12464 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12465 <p>string</p>
12466 </div></div></td>
12467 </tr>
12468 <tr>
12469 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12470 <p><strong>licenseType</strong><br>
12471 <em>optional</em></p>
12472 </div></div></td>
12473 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12474 <p>string</p>
12475 </div></div></td>
12476 </tr>
12477 <tr>
12478 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12479 <p><strong>lifecycleState</strong><br>
12480 <em>optional</em></p>
12481 </div></div></td>
12482 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12483 <p>enum (READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED, NOT_CERTIFIED_CHECKIN, NOT_CERTIFIED_CHECKOUT)</p>
12484 </div></div></td>
12485 </tr>
12486 <tr>
12487 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12488 <p><strong>name</strong><br>
12489 <em>optional</em></p>
12490 </div></div></td>
12491 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12492 <p>string</p>
12493 </div></div></td>
12494 </tr>
12495 <tr>
12496 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12497 <p><strong>normalizedName</strong><br>
12498 <em>optional</em></p>
12499 </div></div></td>
12500 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12501 <p>string</p>
12502 </div></div></td>
12503 </tr>
12504 <tr>
12505 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12506 <p><strong>policies</strong><br>
12507 <em>optional</em></p>
12508 </div></div></td>
12509 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12510 <p>&lt; string, <a href="#_policydefinition">PolicyDefinition</a> &gt; map</p>
12511 </div></div></td>
12512 </tr>
12513 <tr>
12514 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12515 <p><strong>projectCode</strong><br>
12516 <em>optional</em></p>
12517 </div></div></td>
12518 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12519 <p>string</p>
12520 </div></div></td>
12521 </tr>
12522 <tr>
12523 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12524 <p><strong>properties</strong><br>
12525 <em>optional</em></p>
12526 </div></div></td>
12527 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12528 <p>&lt; <a href="#_propertydefinition">PropertyDefinition</a> &gt; array</p>
12529 </div></div></td>
12530 </tr>
12531 <tr>
12532 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12533 <p><strong>requirements</strong><br>
12534 <em>optional</em></p>
12535 </div></div></td>
12536 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12537 <p>&lt; string, &lt; <a href="#_requirementdefinition">RequirementDefinition</a> &gt; array &gt; map</p>
12538 </div></div></td>
12539 </tr>
12540 <tr>
12541 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12542 <p><strong>resourceType</strong><br>
12543 <em>optional</em></p>
12544 </div></div></td>
12545 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12546 <p>enum (VFC, VF, CR, CP, PNF, CVFC, VL, VFCMT, Configuration, ServiceProxy, ABSTRACT)</p>
12547 </div></div></td>
12548 </tr>
12549 <tr>
12550 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12551 <p><strong>resourceVendorModelNumber</strong><br>
12552 <em>optional</em></p>
12553 </div></div></td>
12554 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12555 <p>string</p>
12556 </div></div></td>
12557 </tr>
12558 <tr>
12559 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12560 <p><strong>systemName</strong><br>
12561 <em>optional</em></p>
12562 </div></div></td>
12563 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12564 <p>string</p>
12565 </div></div></td>
12566 </tr>
12567 <tr>
12568 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12569 <p><strong>tags</strong><br>
12570 <em>optional</em></p>
12571 </div></div></td>
12572 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12573 <p>&lt; string &gt; array</p>
12574 </div></div></td>
12575 </tr>
12576 <tr>
12577 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12578 <p><strong>topologyTemplate</strong><br>
12579 <em>optional</em></p>
12580 </div></div></td>
12581 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12582 <p>boolean</p>
12583 </div></div></td>
12584 </tr>
12585 <tr>
12586 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12587 <p><strong>toscaArtifacts</strong><br>
12588 <em>optional</em></p>
12589 </div></div></td>
12590 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12591 <p>&lt; string, <a href="#_artifactdefinition">ArtifactDefinition</a> &gt; map</p>
12592 </div></div></td>
12593 </tr>
12594 <tr>
12595 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12596 <p><strong>toscaResourceName</strong><br>
12597 <em>optional</em></p>
12598 </div></div></td>
12599 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12600 <p>string</p>
12601 </div></div></td>
12602 </tr>
12603 <tr>
12604 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12605 <p><strong>toscaType</strong><br>
12606 <em>optional</em></p>
12607 </div></div></td>
12608 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12609 <p>string</p>
12610 </div></div></td>
12611 </tr>
12612 <tr>
12613 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12614 <p><strong>uniqueId</strong><br>
12615 <em>optional</em></p>
12616 </div></div></td>
12617 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12618 <p>string</p>
12619 </div></div></td>
12620 </tr>
12621 <tr>
12622 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12623 <p><strong>uuid</strong><br>
12624 <em>optional</em></p>
12625 </div></div></td>
12626 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12627 <p>string</p>
12628 </div></div></td>
12629 </tr>
12630 <tr>
12631 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12632 <p><strong>vendorName</strong><br>
12633 <em>optional</em></p>
12634 </div></div></td>
12635 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12636 <p>string</p>
12637 </div></div></td>
12638 </tr>
12639 <tr>
12640 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12641 <p><strong>vendorRelease</strong><br>
12642 <em>optional</em></p>
12643 </div></div></td>
12644 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12645 <p>string</p>
12646 </div></div></td>
12647 </tr>
12648 <tr>
12649 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12650 <p><strong>version</strong><br>
12651 <em>optional</em></p>
12652 </div></div></td>
12653 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12654 <p>string</p>
12655 </div></div></td>
12656 </tr>
12657 </tbody>
12658 </table>
12659
12660 </div>
12661 <div class="sect2">
12662 <h3 id="_schemadefinition"><a class="anchor" href="#_schemadefinition"></a>3.41. SchemaDefinition</h3>
12663 <table class="tableblock frame-all grid-all" style="width:100%; ">
12664 <colgroup>
12665 <col style="width:42%;">
12666 <col style="width:57%;">
12667 </colgroup>
12668 <thead>
12669 <tr>
12670 <th class="tableblock halign-left valign-middle">Name</th>
12671 <th class="tableblock halign-left valign-middle">Schema</th>
12672 </tr>
12673 </thead>
12674 <tbody>
12675 <tr>
12676 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12677 <p><strong>constraints</strong><br>
12678 <em>optional</em></p>
12679 </div></div></td>
12680 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12681 <p>&lt; string &gt; array</p>
12682 </div></div></td>
12683 </tr>
12684 <tr>
12685 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12686 <p><strong>derivedFrom</strong><br>
12687 <em>optional</em></p>
12688 </div></div></td>
12689 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12690 <p>string</p>
12691 </div></div></td>
12692 </tr>
12693 <tr>
12694 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12695 <p><strong>empty</strong><br>
12696 <em>optional</em></p>
12697 </div></div></td>
12698 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12699 <p>boolean</p>
12700 </div></div></td>
12701 </tr>
12702 <tr>
12703 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12704 <p><strong>ownerId</strong><br>
12705 <em>optional</em></p>
12706 </div></div></td>
12707 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12708 <p>string</p>
12709 </div></div></td>
12710 </tr>
12711 <tr>
12712 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12713 <p><strong>properties</strong><br>
12714 <em>optional</em></p>
12715 </div></div></td>
12716 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12717 <p>&lt; string, <a href="#_propertydatadefinition">PropertyDataDefinition</a> &gt; map</p>
12718 </div></div></td>
12719 </tr>
12720 <tr>
12721 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12722 <p><strong>property</strong><br>
12723 <em>optional</em></p>
12724 </div></div></td>
12725 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12726 <p><a href="#_propertydatadefinition">PropertyDataDefinition</a></p>
12727 </div></div></td>
12728 </tr>
12729 </tbody>
12730 </table>
12731
12732 </div>
12733 <div class="sect2">
12734 <h3 id="_serverlistresponse"><a class="anchor" href="#_serverlistresponse"></a>3.42. ServerListResponse</h3>
12735 <table class="tableblock frame-all grid-all" style="width:100%; ">
12736 <colgroup>
12737 <col style="width:42%;">
12738 <col style="width:57%;">
12739 </colgroup>
12740 <thead>
12741 <tr>
12742 <th class="tableblock halign-left valign-middle">Name</th>
12743 <th class="tableblock halign-left valign-middle">Schema</th>
12744 </tr>
12745 </thead>
12746 <tbody>
12747 <tr>
12748 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12749 <p><strong>uebServerList</strong><br>
12750 <em>optional</em></p>
12751 </div></div></td>
12752 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12753 <p>&lt; string &gt; array</p>
12754 </div></div></td>
12755 </tr>
12756 </tbody>
12757 </table>
12758
12759 </div>
12760 <div class="sect2">
12761 <h3 id="_subcategorydefinition"><a class="anchor" href="#_subcategorydefinition"></a>3.43. SubCategoryDefinition</h3>
12762 <table class="tableblock frame-all grid-all" style="width:100%; ">
12763 <colgroup>
12764 <col style="width:42%;">
12765 <col style="width:57%;">
12766 </colgroup>
12767 <thead>
12768 <tr>
12769 <th class="tableblock halign-left valign-middle">Name</th>
12770 <th class="tableblock halign-left valign-middle">Schema</th>
12771 </tr>
12772 </thead>
12773 <tbody>
12774 <tr>
12775 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12776 <p><strong>empty</strong><br>
12777 <em>optional</em></p>
12778 </div></div></td>
12779 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12780 <p>boolean</p>
12781 </div></div></td>
12782 </tr>
12783 <tr>
12784 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12785 <p><strong>groupings</strong><br>
12786 <em>optional</em></p>
12787 </div></div></td>
12788 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12789 <p>&lt; <a href="#_groupingdefinition">GroupingDefinition</a> &gt; array</p>
12790 </div></div></td>
12791 </tr>
12792 <tr>
12793 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12794 <p><strong>icons</strong><br>
12795 <em>optional</em></p>
12796 </div></div></td>
12797 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12798 <p>&lt; string &gt; array</p>
12799 </div></div></td>
12800 </tr>
12801 <tr>
12802 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12803 <p><strong>name</strong><br>
12804 <em>optional</em></p>
12805 </div></div></td>
12806 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12807 <p>string</p>
12808 </div></div></td>
12809 </tr>
12810 <tr>
12811 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12812 <p><strong>normalizedName</strong><br>
12813 <em>optional</em></p>
12814 </div></div></td>
12815 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12816 <p>string</p>
12817 </div></div></td>
12818 </tr>
12819 <tr>
12820 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12821 <p><strong>ownerId</strong><br>
12822 <em>optional</em></p>
12823 </div></div></td>
12824 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12825 <p>string</p>
12826 </div></div></td>
12827 </tr>
12828 <tr>
12829 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12830 <p><strong>uniqueId</strong><br>
12831 <em>optional</em></p>
12832 </div></div></td>
12833 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12834 <p>string</p>
12835 </div></div></td>
12836 </tr>
12837 </tbody>
12838 </table>
12839
12840 </div>
12841 <div class="sect2">
12842 <h3 id="_topicregistrationresponse"><a class="anchor" href="#_topicregistrationresponse"></a>3.44. TopicRegistrationResponse</h3>
12843 <table class="tableblock frame-all grid-all" style="width:100%; ">
12844 <colgroup>
12845 <col style="width:42%;">
12846 <col style="width:57%;">
12847 </colgroup>
12848 <thead>
12849 <tr>
12850 <th class="tableblock halign-left valign-middle">Name</th>
12851 <th class="tableblock halign-left valign-middle">Schema</th>
12852 </tr>
12853 </thead>
12854 <tbody>
12855 <tr>
12856 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12857 <p><strong>distrNotificationTopicName</strong><br>
12858 <em>optional</em></p>
12859 </div></div></td>
12860 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12861 <p>string</p>
12862 </div></div></td>
12863 </tr>
12864 <tr>
12865 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12866 <p><strong>distrStatusTopicName</strong><br>
12867 <em>optional</em></p>
12868 </div></div></td>
12869 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12870 <p>string</p>
12871 </div></div></td>
12872 </tr>
12873 </tbody>
12874 </table>
12875
12876 </div>
12877 <div class="sect2">
12878 <h3 id="_topicunregistrationresponse"><a class="anchor" href="#_topicunregistrationresponse"></a>3.45. TopicUnregistrationResponse</h3>
12879 <table class="tableblock frame-all grid-all" style="width:100%; ">
12880 <colgroup>
12881 <col style="width:42%;">
12882 <col style="width:57%;">
12883 </colgroup>
12884 <thead>
12885 <tr>
12886 <th class="tableblock halign-left valign-middle">Name</th>
12887 <th class="tableblock halign-left valign-middle">Schema</th>
12888 </tr>
12889 </thead>
12890 <tbody>
12891 <tr>
12892 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12893 <p><strong>distrNotificationTopicName</strong><br>
12894 <em>optional</em></p>
12895 </div></div></td>
12896 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12897 <p>string</p>
12898 </div></div></td>
12899 </tr>
12900 <tr>
12901 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12902 <p><strong>distrStatusTopicName</strong><br>
12903 <em>optional</em></p>
12904 </div></div></td>
12905 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12906 <p>string</p>
12907 </div></div></td>
12908 </tr>
12909 <tr>
12910 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12911 <p><strong>notificationUnregisterResult</strong><br>
12912 <em>optional</em></p>
12913 </div></div></td>
12914 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12915 <p>enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR)</p>
12916 </div></div></td>
12917 </tr>
12918 <tr>
12919 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12920 <p><strong>statusUnregisterResult</strong><br>
12921 <em>optional</em></p>
12922 </div></div></td>
12923 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12924 <p>enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR)</p>
12925 </div></div></td>
12926 </tr>
12927 </tbody>
12928 </table>
12929
12930 </div>
12931 <div class="sect2">
12932 <h3 id="_toscadatadefinition"><a class="anchor" href="#_toscadatadefinition"></a>3.46. ToscaDataDefinition</h3>
12933 <table class="tableblock frame-all grid-all" style="width:100%; ">
12934 <colgroup>
12935 <col style="width:42%;">
12936 <col style="width:57%;">
12937 </colgroup>
12938 <thead>
12939 <tr>
12940 <th class="tableblock halign-left valign-middle">Name</th>
12941 <th class="tableblock halign-left valign-middle">Schema</th>
12942 </tr>
12943 </thead>
12944 <tbody>
12945 <tr>
12946 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12947 <p><strong>empty</strong><br>
12948 <em>optional</em></p>
12949 </div></div></td>
12950 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12951 <p>boolean</p>
12952 </div></div></td>
12953 </tr>
12954 <tr>
12955 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12956 <p><strong>ownerId</strong><br>
12957 <em>optional</em></p>
12958 </div></div></td>
12959 <td class="tableblock halign-left valign-middle"><div><div class="paragraph">
12960 <p>string</p>
12961 </div></div></td>
12962 </tr>
12963 </tbody>
12964 </table>
12965
12966 </div>
12967 </div>
12968 </div>
12969 </div>
12970 <div id="footer">
12971 <div id="footer-text">
12972 Last updated 2018-06-04 20:26:24 UTC
12973 </div>
12974 </div>
12975 </body>
12976 </html>