diff options
Diffstat (limited to 'docs/swagger/swagger.html')
| -rw-r--r-- | docs/swagger/swagger.html | 12976 |
1 files changed, 12976 insertions, 0 deletions
diff --git a/docs/swagger/swagger.html b/docs/swagger/swagger.html new file mode 100644 index 0000000000..cb09cfb40b --- /dev/null +++ b/docs/swagger/swagger.html @@ -0,0 +1,12976 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="generator" content="Asciidoctor 0.1.4"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title>DistributionAndExternalAPIs</title> +<style> +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; } +audio, canvas, video { display: inline-block; } +audio:not([controls]) { display: none; height: 0; } +[hidden] { display: none; } +html { background: #fff; color: #000; font-family: sans-serif; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%; } +body { margin: 0; } +a:focus { outline: thin dotted; } +a:active, a:hover { outline: 0; } +h1 { font-size: 2em; margin: 0.67em 0; } +abbr[title] { border-bottom: 1px dotted; } +b, strong { font-weight: bold; } +dfn { font-style: italic; } +hr { -moz-box-sizing: content-box; box-sizing: content-box; height: 0; } +mark { background: #ff0; color: #000; } +code, kbd, pre, samp { font-family: monospace, serif; font-size: 1em; } +pre { white-space: pre-wrap; } +q { quotes: "\201C" "\201D" "\2018" "\2019"; } +small { font-size: 80%; } +sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; } +sup { top: -0.5em; } +sub { bottom: -0.25em; } +img { border: 0; } +svg:not(:root) { overflow: hidden; } +figure { margin: 0; } +fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; } +legend { border: 0; padding: 0; } +button, input, select, textarea { font-family: inherit; font-size: 100%; margin: 0; } +button, input { line-height: normal; } +button, select { text-transform: none; } +button, html input[type="button"], input[type="reset"], input[type="submit"] { -webkit-appearance: button; cursor: pointer; } +button[disabled], html input[disabled] { cursor: default; } +input[type="checkbox"], input[type="radio"] { box-sizing: border-box; padding: 0; } +input[type="search"] { -webkit-appearance: textfield; -moz-box-sizing: content-box; -webkit-box-sizing: content-box; box-sizing: content-box; } +input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; } +button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; } +textarea { overflow: auto; vertical-align: top; } +table { border-collapse: collapse; border-spacing: 0; } +*, *:before, *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; } +html, body { font-size: 100%; } +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; } +a:hover { cursor: pointer; } +a:focus { outline: none; } +img, object, embed { max-width: 100%; height: auto; } +object, embed { height: 100%; } +img { -ms-interpolation-mode: bicubic; } +#map_canvas img, #map_canvas embed, #map_canvas object, .map_canvas img, .map_canvas embed, .map_canvas object { max-width: none !important; } +.left { float: left !important; } +.right { float: right !important; } +.text-left { text-align: left !important; } +.text-right { text-align: right !important; } +.text-center { text-align: center !important; } +.text-justify { text-align: justify !important; } +.hide { display: none; } +.antialiased, body { -webkit-font-smoothing: antialiased; } +img { display: inline-block; vertical-align: middle; } +textarea { height: auto; min-height: 50px; } +select { width: 100%; } +p.lead, .paragraph.lead > p, #preamble > .sectionbody > .paragraph:first-of-type p { font-size: 1.21875em; line-height: 1.6; } +.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; } +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; } +a { color: #005498; text-decoration: underline; line-height: inherit; } +a:hover, a:focus { color: #00467f; } +a img { border: none; } +p { font-family: inherit; font-weight: normal; font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; text-rendering: optimizeLegibility; } +p aside { font-size: 0.875em; line-height: 1.35; font-style: italic; } +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; } +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; } +h1 { font-size: 2.125em; } +h2 { font-size: 1.6875em; } +h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.375em; } +h4 { font-size: 1.125em; } +h5 { font-size: 1.125em; } +h6 { font-size: 1em; } +hr { border: solid #dddddd; border-width: 1px 0 0; clear: both; margin: 1.25em 0 1.1875em; height: 0; } +em, i { font-style: italic; line-height: inherit; } +strong, b { font-weight: bold; line-height: inherit; } +small { font-size: 60%; line-height: inherit; } +code { font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; color: #6d180b; } +ul, ol, dl { font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; list-style-position: outside; font-family: inherit; } +ul, ol { margin-left: 1.5em; } +ul li ul, ul li ol { margin-left: 1.25em; margin-bottom: 0; font-size: 1em; } +ul.square li ul, ul.circle li ul, ul.disc li ul { list-style: inherit; } +ul.square { list-style-type: square; } +ul.circle { list-style-type: circle; } +ul.disc { list-style-type: disc; } +ul.no-bullet { list-style: none; } +ol li ul, ol li ol { margin-left: 1.25em; margin-bottom: 0; } +dl dt { margin-bottom: 0.3125em; font-weight: bold; } +dl dd { margin-bottom: 1.25em; } +abbr, acronym { text-transform: uppercase; font-size: 90%; color: #222222; border-bottom: 1px dotted #dddddd; cursor: help; } +abbr { text-transform: none; } +blockquote { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; } +blockquote cite { display: block; font-size: inherit; color: #555555; } +blockquote cite:before { content: "\2014 \0020"; } +blockquote cite a, blockquote cite a:visited { color: #555555; } +blockquote, blockquote p { line-height: 1.6; color: #6f6f6f; } +.vcard { display: inline-block; margin: 0 0 1.25em 0; border: 1px solid #dddddd; padding: 0.625em 0.75em; } +.vcard li { margin: 0; display: block; } +.vcard .fn { font-weight: bold; font-size: 0.9375em; } +.vevent .summary { font-weight: bold; } +.vevent abbr { cursor: auto; text-decoration: none; font-weight: bold; border: none; padding: 0 0.0625em; } +@media only screen and (min-width: 768px) { h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { line-height: 1.4; } + h1 { font-size: 2.75em; } + h2 { font-size: 2.3125em; } + h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.6875em; } + h4 { font-size: 1.4375em; } } +.print-only { display: none !important; } +@media print { * { background: transparent !important; color: #000 !important; box-shadow: none !important; text-shadow: none !important; } + a, a:visited { text-decoration: underline; } + a[href]:after { content: " (" attr(href) ")"; } + abbr[title]:after { content: " (" attr(title) ")"; } + .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; } + pre, blockquote { border: 1px solid #999; page-break-inside: avoid; } + thead { display: table-header-group; } + tr, img { page-break-inside: avoid; } + img { max-width: 100% !important; } + @page { margin: 0.5cm; } + p, h2, h3, #toctitle, .sidebarblock > .content > .title { orphans: 3; widows: 3; } + h2, h3, #toctitle, .sidebarblock > .content > .title { page-break-after: avoid; } + .hide-on-print { display: none !important; } + .print-only { display: block !important; } + .hide-for-print { display: none !important; } + .show-for-print { display: inherit !important; } } +table { background: white; margin-bottom: 1.25em; border: solid 1px #dddddd; } +table thead, table tfoot { background: whitesmoke; font-weight: bold; } +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; } +table tr th, table tr td { padding: 0.5625em 0.625em; font-size: inherit; color: #222222; } +table tr.even, table tr.alt, table tr:nth-of-type(even) { background: #f9f9f9; } +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; } +.clearfix:before, .clearfix:after, .float-group:before, .float-group:after { content: " "; display: table; } +.clearfix:after, .float-group:after { clear: both; } +*: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; } +pre, pre > code { line-height: 1.4; color: inherit; font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; } +kbd.keyseq { color: #555555; } +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; } +kbd kbd:first-child { margin-left: 0; } +kbd kbd:last-child { margin-right: 0; } +.menuseq, .menu { color: #090909; } +p a > code:hover { color: #561309; } +#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; } +#header:before, #header:after, #content:before, #content:after, #footnotes:before, #footnotes:after, #footer:before, #footer:after { content: " "; display: table; } +#header:after, #content:after, #footnotes:after, #footer:after { clear: both; } +#header { margin-bottom: 2.5em; } +#header > h1 { color: black; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; } +#header span { color: #6f6f6f; } +#header #revnumber { text-transform: capitalize; } +#header br { display: none; } +#header br + span { padding-left: 3px; } +#header br + span:before { content: "\2013 \0020"; } +#header br + span.author { padding-left: 0; } +#header br + span.author:before { content: ", "; } +#toc { border-bottom: 3px double #ebebeb; padding-bottom: 1.25em; } +#toc > ul { margin-left: 0.25em; } +#toc ul.sectlevel0 > li > a { font-style: italic; } +#toc ul.sectlevel0 ul.sectlevel1 { margin-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; } +#toc ul { list-style-type: none; } +#toctitle { color: #7a2518; } +@media only screen and (min-width: 1280px) { body.toc2 { padding-left: 20em; } + #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; } + #toc.toc2 #toctitle { margin-top: 0; } + #toc.toc2 > ul { font-size: .95em; } + #toc.toc2 ul ul { margin-left: 0; padding-left: 1.25em; } + #toc.toc2 ul.sectlevel0 ul.sectlevel1 { padding-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; } + body.toc2.toc-right { padding-left: 0; padding-right: 20em; } + body.toc2.toc-right #toc.toc2 { border-right: 0; border-left: 1px solid #ebebeb; left: auto; right: 0; } } +#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; } +#content #toc > :first-child { margin-top: 0; } +#content #toc > :last-child { margin-bottom: 0; } +#content #toc a { text-decoration: none; } +#content #toctitle { font-weight: bold; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-size: 1em; padding-left: 0.125em; } +#footer { max-width: 100%; background-color: #222222; padding: 1.25em; } +#footer-text { color: #dddddd; line-height: 1.44; } +.sect1 { padding-bottom: 1.25em; } +.sect1 + .sect1 { border-top: 3px double #ebebeb; } +#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; } +#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; } +#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; } +#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; } +#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; } +.imageblock, .literalblock, .listingblock, .verseblock, .videoblock { margin-bottom: 1.25em; } +.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; } +.tableblock > caption { text-align: left; font-weight: bold; white-space: nowrap; overflow: visible; max-width: 0; } +table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; } +.admonitionblock > table { border: 0; background: none; width: 100%; } +.admonitionblock > table td.icon { text-align: center; width: 80px; } +.admonitionblock > table td.icon img { max-width: none; } +.admonitionblock > table td.icon .title { font-weight: bold; text-transform: uppercase; } +.admonitionblock > table td.content { padding-left: 1.125em; padding-right: 1.25em; border-left: 1px solid #dddddd; color: #6f6f6f; } +.admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; } +.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; } +.exampleblock > .content > :first-child { margin-top: 0; } +.exampleblock > .content > :last-child { margin-bottom: 0; } +.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; } +.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; } +.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; } +.exampleblock.result > .content { -webkit-box-shadow: 0 1px 8px #d9d9d9; box-shadow: 0 1px 8px #d9d9d9; } +.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; } +.sidebarblock > :first-child { margin-top: 0; } +.sidebarblock > :last-child { margin-bottom: 0; } +.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6, .sidebarblock p { color: #333333; } +.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6 { line-height: 1; margin-bottom: 0.625em; } +.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; } +.sidebarblock > .content > .title { color: #7a2518; margin-top: 0; line-height: 1.6; } +.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; } +.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; } +.literalblock > .content pre.nowrap, .listingblock > .content pre.nowrap { overflow-x: auto; white-space: pre; word-wrap: normal; } +.literalblock > .content pre > code, .listingblock > .content pre > code { display: block; } +@media only screen { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.8em; } } +@media only screen and (min-width: 768px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.9em; } } +@media only screen and (min-width: 1280px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 1em; } } +.listingblock > .content { position: relative; } +.listingblock:hover code[class*=" language-"]:before { text-transform: uppercase; font-size: 0.9em; color: #999; position: absolute; top: 0.375em; right: 0.375em; } +.listingblock:hover code.asciidoc:before { content: "asciidoc"; } +.listingblock:hover code.clojure:before { content: "clojure"; } +.listingblock:hover code.css:before { content: "css"; } +.listingblock:hover code.groovy:before { content: "groovy"; } +.listingblock:hover code.html:before { content: "html"; } +.listingblock:hover code.java:before { content: "java"; } +.listingblock:hover code.javascript:before { content: "javascript"; } +.listingblock:hover code.python:before { content: "python"; } +.listingblock:hover code.ruby:before { content: "ruby"; } +.listingblock:hover code.scss:before { content: "scss"; } +.listingblock:hover code.xml:before { content: "xml"; } +.listingblock:hover code.yaml:before { content: "yaml"; } +.listingblock.terminal pre .command:before { content: attr(data-prompt); padding-right: 0.5em; color: #999; } +.listingblock.terminal pre .command:not([data-prompt]):before { content: '$'; } +table.pyhltable { border: 0; margin-bottom: 0; } +table.pyhltable td { vertical-align: top; padding-top: 0; padding-bottom: 0; } +table.pyhltable td.code { padding-left: .75em; padding-right: 0; } +.highlight.pygments .lineno, table.pyhltable td:not(.code) { color: #999; padding-left: 0; padding-right: .5em; border-right: 1px solid #dddddd; } +.highlight.pygments .lineno { display: inline-block; margin-right: .25em; } +table.pyhltable .linenodiv { background-color: transparent !important; padding-right: 0 !important; } +.quoteblock { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; } +.quoteblock blockquote { margin: 0 0 1.25em 0; padding: 0 0 0.5625em 0; border: 0; } +.quoteblock blockquote > .paragraph:last-child p { margin-bottom: 0; } +.quoteblock .attribution { margin-top: -.25em; padding-bottom: 0.5625em; font-size: inherit; color: #555555; } +.quoteblock .attribution br { display: none; } +.quoteblock .attribution cite { display: block; margin-bottom: 0.625em; } +table thead th, table tfoot th { font-weight: bold; } +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; } +table.tableblock.frame-topbot, table.tableblock.frame-none { border-left: 0; border-right: 0; } +table.tableblock.frame-sides, table.tableblock.frame-none { border-top: 0; border-bottom: 0; } +table.tableblock td .paragraph:last-child p, table.tableblock td > p:last-child { margin-bottom: 0; } +th.tableblock.halign-left, td.tableblock.halign-left { text-align: left; } +th.tableblock.halign-right, td.tableblock.halign-right { text-align: right; } +th.tableblock.halign-center, td.tableblock.halign-center { text-align: center; } +th.tableblock.valign-top, td.tableblock.valign-top { vertical-align: top; } +th.tableblock.valign-bottom, td.tableblock.valign-bottom { vertical-align: bottom; } +th.tableblock.valign-middle, td.tableblock.valign-middle { vertical-align: middle; } +p.tableblock.header { color: #222222; font-weight: bold; } +td > div.verse { white-space: pre; } +ol { margin-left: 1.75em; } +ul li ol { margin-left: 1.5em; } +dl dd { margin-left: 1.125em; } +dl dd:last-child, dl dd:last-child > :last-child { margin-bottom: 0; } +ol > li p, ul > li p, ul dd, ol dd, .olist .olist, .ulist .ulist, .ulist .olist, .olist .ulist { margin-bottom: 0.625em; } +ul.unstyled, ol.unnumbered, ul.checklist, ul.none { list-style-type: none; } +ul.unstyled, ol.unnumbered, ul.checklist { margin-left: 0.625em; } +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; } +ul.checklist li > p:first-child > input[type="checkbox"]:first-child { position: relative; top: 1px; } +ul.inline { margin: 0 auto 0.625em auto; margin-left: -1.375em; margin-right: 0; padding: 0; list-style: none; overflow: hidden; } +ul.inline > li { list-style: none; float: left; margin-left: 1.375em; display: block; } +ul.inline > li > * { display: block; } +.unstyled dl dt { font-weight: normal; font-style: normal; } +ol.arabic { list-style-type: decimal; } +ol.decimal { list-style-type: decimal-leading-zero; } +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { list-style-type: upper-alpha; } +ol.lowerroman { list-style-type: lower-roman; } +ol.upperroman { list-style-type: upper-roman; } +ol.lowergreek { list-style-type: lower-greek; } +.hdlist > table, .colist > table { border: 0; background: none; } +.hdlist > table > tbody > tr, .colist > table > tbody > tr { background: none; } +td.hdlist1 { padding-right: .8em; font-weight: bold; } +td.hdlist1, td.hdlist2 { vertical-align: top; } +.literalblock + .colist, .listingblock + .colist { margin-top: -0.5em; } +.colist > table tr > td:first-of-type { padding: 0 .8em; line-height: 1; } +.colist > table tr > td:last-of-type { padding: 0.25em 0; } +.qanda > ol > li > p > em:only-child { color: #00467f; } +.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; } +.imageblock.left, .imageblock[style*="float: left"] { margin: 0.25em 0.625em 1.25em 0; } +.imageblock.right, .imageblock[style*="float: right"] { margin: 0.25em 0 1.25em 0.625em; } +.imageblock > .title { margin-bottom: 0; } +.imageblock.thumb, .imageblock.th { border-width: 6px; } +.imageblock.thumb > .title, .imageblock.th > .title { padding: 0 0.125em; } +.image.left, .image.right { margin-top: 0.25em; margin-bottom: 0.25em; display: inline-block; line-height: 0; } +.image.left { margin-right: 0.625em; } +.image.right { margin-left: 0.625em; } +a.image { text-decoration: none; } +span.footnote, span.footnoteref { vertical-align: super; font-size: 0.875em; } +span.footnote a, span.footnoteref a { text-decoration: none; } +#footnotes { padding-top: 0.75em; padding-bottom: 0.75em; margin-bottom: 0.625em; } +#footnotes hr { width: 20%; min-width: 6.25em; margin: -.25em 0 .75em 0; border-width: 1px 0 0 0; } +#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; } +#footnotes .footnote a:first-of-type { font-weight: bold; text-decoration: none; } +#footnotes .footnote:last-of-type { margin-bottom: 0; } +#content #footnotes { margin-top: -0.625em; margin-bottom: 0; padding: 0.75em 0; } +.gist .file-data > table { border: none; background: #fff; width: 100%; margin-bottom: 0; } +.gist .file-data > table td.line-data { width: 99%; } +div.unbreakable { page-break-inside: avoid; } +.big { font-size: larger; } +.small { font-size: smaller; } +.underline { text-decoration: underline; } +.overline { text-decoration: overline; } +.line-through { text-decoration: line-through; } +.aqua { color: #00bfbf; } +.aqua-background { background-color: #00fafa; } +.black { color: black; } +.black-background { background-color: black; } +.blue { color: #0000bf; } +.blue-background { background-color: #0000fa; } +.fuchsia { color: #bf00bf; } +.fuchsia-background { background-color: #fa00fa; } +.gray { color: #606060; } +.gray-background { background-color: #7d7d7d; } +.green { color: #006000; } +.green-background { background-color: #007d00; } +.lime { color: #00bf00; } +.lime-background { background-color: #00fa00; } +.maroon { color: #600000; } +.maroon-background { background-color: #7d0000; } +.navy { color: #000060; } +.navy-background { background-color: #00007d; } +.olive { color: #606000; } +.olive-background { background-color: #7d7d00; } +.purple { color: #600060; } +.purple-background { background-color: #7d007d; } +.red { color: #bf0000; } +.red-background { background-color: #fa0000; } +.silver { color: #909090; } +.silver-background { background-color: #bcbcbc; } +.teal { color: #006060; } +.teal-background { background-color: #007d7d; } +.white { color: #bfbfbf; } +.white-background { background-color: #fafafa; } +.yellow { color: #bfbf00; } +.yellow-background { background-color: #fafa00; } +span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +.admonitionblock td.icon [class^="icon-"]:before { font-size: 2.5em; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5); cursor: default; } +.admonitionblock td.icon .icon-note:before { content: "\f05a"; color: #005498; color: #003f72; } +.admonitionblock td.icon .icon-tip:before { content: "\f0eb"; text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8); color: #111; } +.admonitionblock td.icon .icon-warning:before { content: "\f071"; color: #bf6900; } +.admonitionblock td.icon .icon-caution:before { content: "\f06d"; color: #bf3400; } +.admonitionblock td.icon .icon-important:before { content: "\f06a"; color: #bf0000; } +.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; } +.conum * { color: white !important; } +.conum + b { display: none; } +.conum:after { content: attr(data-value); } +.conum:not([data-value]):empty { display: none; } +.literalblock > .content > pre, .listingblock > .content > pre { -webkit-border-radius: 0; border-radius: 0; } + +</style> +</head> +<body class="book toc2 toc-left"> +<div id="header"> +<h1>DistributionAndExternalAPIs</h1> +<div id="toc" class="toc2"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_overview">1. Overview</a></li> +<li> +<ul class="sectlevel2"> +<li><a href="#_version_information">1.1. Version information</a></li> +<li><a href="#_uri_scheme">1.2. URI scheme</a></li> +<li><a href="#_tags">1.3. Tags</a></li> +</ul> +</li> +<li><a href="#_paths">2. Paths</a></li> +<li> +<ul class="sectlevel2"> +<li><a href="#_getvalidartifacttypes">2.1. Artifact types list</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description">2.1.1. Description</a></li> +<li><a href="#_parameters">2.1.2. Parameters</a></li> +<li><a href="#_responses">2.1.3. Responses</a></li> +<li><a href="#_consumes">2.1.4. Consumes</a></li> +<li><a href="#_produces">2.1.5. Produces</a></li> +<li><a href="#_tags_2">2.1.6. Tags</a></li> +</ul> +</li> +<li><a href="#_uploadinterfaceoperationartifact">2.2. uploads of artifact to VF operation workflow</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_2">2.2.1. Description</a></li> +<li><a href="#_parameters_2">2.2.2. Parameters</a></li> +<li><a href="#_responses_2">2.2.3. Responses</a></li> +<li><a href="#_produces_2">2.2.4. Produces</a></li> +<li><a href="#_tags_3">2.2.5. Tags</a></li> +</ul> +</li> +<li><a href="#_downloadserviceartifact">2.3. Download service artifact</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_3">2.3.1. Description</a></li> +<li><a href="#_parameters_3">2.3.2. Parameters</a></li> +<li><a href="#_responses_3">2.3.3. Responses</a></li> +<li><a href="#_consumes_2">2.3.4. Consumes</a></li> +<li><a href="#_produces_3">2.3.5. Produces</a></li> +<li><a href="#_tags_4">2.3.6. Tags</a></li> +</ul> +</li> +<li><a href="#_downloadresourceinstanceartifactbyname">2.4. Download resource instance artifact</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_4">2.4.1. Description</a></li> +<li><a href="#_parameters_4">2.4.2. Parameters</a></li> +<li><a href="#_responses_4">2.4.3. Responses</a></li> +<li><a href="#_consumes_3">2.4.4. Consumes</a></li> +<li><a href="#_produces_4">2.4.5. Produces</a></li> +<li><a href="#_tags_5">2.4.6. Tags</a></li> +</ul> +</li> +<li><a href="#_downloadresourceartifact">2.5. Download resource artifact</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_5">2.5.1. Description</a></li> +<li><a href="#_parameters_5">2.5.2. Parameters</a></li> +<li><a href="#_responses_5">2.5.3. Responses</a></li> +<li><a href="#_consumes_4">2.5.4. Consumes</a></li> +<li><a href="#_produces_5">2.5.5. Produces</a></li> +<li><a href="#_tags_6">2.5.6. Tags</a></li> +</ul> +</li> +<li><a href="#_activateserviceexternal">2.6. activate a service</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_6">2.6.1. Description</a></li> +<li><a href="#_parameters_6">2.6.2. Parameters</a></li> +<li><a href="#_responses_6">2.6.3. Responses</a></li> +<li><a href="#_consumes_5">2.6.4. Consumes</a></li> +<li><a href="#_produces_6">2.6.5. Produces</a></li> +<li><a href="#_tags_7">2.6.6. Tags</a></li> +</ul> +</li> +<li><a href="#_createresourceexternal">2.7. creates a resource</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_7">2.7.1. Description</a></li> +<li><a href="#_parameters_7">2.7.2. Parameters</a></li> +<li><a href="#_responses_7">2.7.3. Responses</a></li> +<li><a href="#_consumes_6">2.7.4. Consumes</a></li> +<li><a href="#_produces_7">2.7.5. Produces</a></li> +<li><a href="#_tags_8">2.7.6. Tags</a></li> +</ul> +</li> +<li><a href="#_getassetlistexternal">2.8. Fetch list of assets</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_8">2.8.1. Description</a></li> +<li><a href="#_parameters_8">2.8.2. Parameters</a></li> +<li><a href="#_responses_8">2.8.3. Responses</a></li> +<li><a href="#_produces_8">2.8.4. Produces</a></li> +<li><a href="#_tags_9">2.8.5. Tags</a></li> +</ul> +</li> +<li><a href="#_uploadartifact">2.9. uploads of artifact to a resource or service</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_9">2.9.1. Description</a></li> +<li><a href="#_parameters_9">2.9.2. Parameters</a></li> +<li><a href="#_responses_9">2.9.3. Responses</a></li> +<li><a href="#_produces_9">2.9.4. Produces</a></li> +<li><a href="#_tags_10">2.9.5. Tags</a></li> +</ul> +</li> +<li><a href="#_updateartifact">2.10. updates an artifact on a resource or service</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_10">2.10.1. Description</a></li> +<li><a href="#_parameters_10">2.10.2. Parameters</a></li> +<li><a href="#_responses_10">2.10.3. Responses</a></li> +<li><a href="#_produces_10">2.10.4. Produces</a></li> +<li><a href="#_tags_11">2.10.5. Tags</a></li> +</ul> +</li> +<li><a href="#_downloadcomponentartifact">2.11. Download component artifact</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_11">2.11.1. Description</a></li> +<li><a href="#_parameters_11">2.11.2. Parameters</a></li> +<li><a href="#_responses_11">2.11.3. Responses</a></li> +<li><a href="#_produces_11">2.11.4. Produces</a></li> +<li><a href="#_tags_12">2.11.5. Tags</a></li> +</ul> +</li> +<li><a href="#_deleteartifact">2.12. deletes an artifact of a resource or service</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_12">2.12.1. Description</a></li> +<li><a href="#_parameters_12">2.12.2. Parameters</a></li> +<li><a href="#_responses_12">2.12.3. Responses</a></li> +<li><a href="#_produces_12">2.12.4. Produces</a></li> +<li><a href="#_tags_13">2.12.5. Tags</a></li> +</ul> +</li> +<li><a href="#_changeresourcestateexternal">2.13. Change Resource lifecycle State</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_parameters_13">2.13.1. Parameters</a></li> +<li><a href="#_responses_13">2.13.2. Responses</a></li> +<li><a href="#_consumes_7">2.13.3. Consumes</a></li> +<li><a href="#_produces_13">2.13.4. Produces</a></li> +<li><a href="#_tags_14">2.13.5. Tags</a></li> +</ul> +</li> +<li><a href="#_getassetspecificmetadatabyuuidexternal">2.14. Detailed metadata of asset by uuid</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_13">2.14.1. Description</a></li> +<li><a href="#_parameters_14">2.14.2. Parameters</a></li> +<li><a href="#_responses_14">2.14.3. Responses</a></li> +<li><a href="#_produces_14">2.14.4. Produces</a></li> +<li><a href="#_tags_15">2.14.5. Tags</a></li> +</ul> +</li> +<li><a href="#_uploadartifacttoinstance">2.15. uploads an artifact to a resource instance</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_14">2.15.1. Description</a></li> +<li><a href="#_parameters_15">2.15.2. Parameters</a></li> +<li><a href="#_responses_15">2.15.3. Responses</a></li> +<li><a href="#_produces_15">2.15.4. Produces</a></li> +<li><a href="#_tags_16">2.15.5. Tags</a></li> +</ul> +</li> +<li><a href="#_updateartifactonresourceinstance">2.16. updates an artifact on a resource instance</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_15">2.16.1. Description</a></li> +<li><a href="#_parameters_16">2.16.2. Parameters</a></li> +<li><a href="#_responses_16">2.16.3. Responses</a></li> +<li><a href="#_produces_16">2.16.4. Produces</a></li> +<li><a href="#_tags_17">2.16.5. Tags</a></li> +</ul> +</li> +<li><a href="#_downloadresourceinstanceartifact">2.17. Download resource instance artifact</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_16">2.17.1. Description</a></li> +<li><a href="#_parameters_17">2.17.2. Parameters</a></li> +<li><a href="#_responses_17">2.17.3. Responses</a></li> +<li><a href="#_produces_17">2.17.4. Produces</a></li> +<li><a href="#_tags_18">2.17.5. Tags</a></li> +</ul> +</li> +<li><a href="#_deleteartifactonresourceinstance">2.18. deletes an artifact of a resource insatnce</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_17">2.18.1. Description</a></li> +<li><a href="#_parameters_18">2.18.2. Parameters</a></li> +<li><a href="#_responses_18">2.18.3. Responses</a></li> +<li><a href="#_produces_18">2.18.4. Produces</a></li> +<li><a href="#_tags_19">2.18.5. Tags</a></li> +</ul> +</li> +<li><a href="#_gettoscamodelexternal">2.19. Fetch assets CSAR</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_18">2.19.1. Description</a></li> +<li><a href="#_parameters_19">2.19.2. Parameters</a></li> +<li><a href="#_responses_19">2.19.3. Responses</a></li> +<li><a href="#_produces_19">2.19.4. Produces</a></li> +<li><a href="#_tags_20">2.19.5. Tags</a></li> +</ul> +</li> +<li><a href="#_getuebserverlist">2.20. UEB Server List</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_19">2.20.1. Description</a></li> +<li><a href="#_parameters_20">2.20.2. Parameters</a></li> +<li><a href="#_responses_20">2.20.3. Responses</a></li> +<li><a href="#_consumes_8">2.20.4. Consumes</a></li> +<li><a href="#_produces_20">2.20.5. Produces</a></li> +<li><a href="#_tags_21">2.20.6. Tags</a></li> +</ul> +</li> +<li><a href="#_registerfordistribution">2.21. Subscription status</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_20">2.21.1. Description</a></li> +<li><a href="#_parameters_21">2.21.2. Parameters</a></li> +<li><a href="#_responses_21">2.21.3. Responses</a></li> +<li><a href="#_consumes_9">2.21.4. Consumes</a></li> +<li><a href="#_produces_21">2.21.5. Produces</a></li> +<li><a href="#_tags_22">2.21.6. Tags</a></li> +</ul> +</li> +<li><a href="#_unregisterfordistribution">2.22. Subscription status</a></li> +<li> +<ul class="sectlevel3"> +<li><a href="#_description_21">2.22.1. Description</a></li> +<li><a href="#_parameters_22">2.22.2. Parameters</a></li> +<li><a href="#_responses_22">2.22.3. Responses</a></li> +<li><a href="#_consumes_10">2.22.4. Consumes</a></li> +<li><a href="#_produces_22">2.22.5. Produces</a></li> +<li><a href="#_tags_23">2.22.6. Tags</a></li> +</ul> +</li> +</ul> +</li> +<li><a href="#_definitions">3. Definitions</a></li> +<li> +<ul class="sectlevel2"> +<li><a href="#_additionalinfoparameterinfo">3.1. AdditionalInfoParameterInfo</a></li> +<li><a href="#_additionalinformationdefinition">3.2. AdditionalInformationDefinition</a></li> +<li><a href="#_artifactdatadefinition">3.3. ArtifactDataDefinition</a></li> +<li><a href="#_artifactdefinition">3.4. ArtifactDefinition</a></li> +<li><a href="#_assetmetadata">3.5. AssetMetadata</a></li> +<li><a href="#_capabilitydatadefinition">3.6. CapabilityDataDefinition</a></li> +<li><a href="#_capabilitydefinition">3.7. CapabilityDefinition</a></li> +<li><a href="#_capabilityrequirementrelationship">3.8. CapabilityRequirementRelationship</a></li> +<li><a href="#_categorydefinition">3.9. CategoryDefinition</a></li> +<li><a href="#_componentinstance">3.10. ComponentInstance</a></li> +<li><a href="#_componentinstanceinput">3.11. ComponentInstanceInput</a></li> +<li><a href="#_componentinstanceproperty">3.12. ComponentInstanceProperty</a></li> +<li><a href="#_getinputvaluedatadefinition">3.13. GetInputValueDataDefinition</a></li> +<li><a href="#_groupdefinition">3.14. GroupDefinition</a></li> +<li><a href="#_groupinstance">3.15. GroupInstance</a></li> +<li><a href="#_groupingdefinition">3.16. GroupingDefinition</a></li> +<li><a href="#_heatparameterdatadefinition">3.17. HeatParameterDataDefinition</a></li> +<li><a href="#_heatparameterdefinition">3.18. HeatParameterDefinition</a></li> +<li><a href="#_inputdefinition">3.19. InputDefinition</a></li> +<li><a href="#_interfacedefinition">3.20. InterfaceDefinition</a></li> +<li><a href="#_interfaceoperationdatadefinition">3.21. InterfaceOperationDataDefinition</a></li> +<li><a href="#_interfaceoperationparamdatadefinition">3.22. InterfaceOperationParamDataDefinition</a></li> +<li><a href="#_lifecyclechangeinfowithaction">3.23. LifecycleChangeInfoWithAction</a></li> +<li><a href="#_listdatadefinition">3.24. ListDataDefinition</a></li> +<li><a href="#_listdatadefinitioninterfaceoperationparamdatadefinition">3.25. ListDataDefinitionInterfaceOperationParamDataDefinition</a></li> +<li><a href="#_listdatadefinitionoperationinputdefinition">3.26. ListDataDefinitionOperationInputDefinition</a></li> +<li><a href="#_operationdatadefinition">3.27. OperationDataDefinition</a></li> +<li><a href="#_operationinputdefinition">3.28. OperationInputDefinition</a></li> +<li><a href="#_policydefinition">3.29. PolicyDefinition</a></li> +<li><a href="#_propertyconstraint">3.30. PropertyConstraint</a></li> +<li><a href="#_propertydatadefinition">3.31. PropertyDataDefinition</a></li> +<li><a href="#_propertydefinition">3.32. PropertyDefinition</a></li> +<li><a href="#_propertyrule">3.33. PropertyRule</a></li> +<li><a href="#_registrationrequest">3.34. RegistrationRequest</a></li> +<li><a href="#_relationshipimpl">3.35. RelationshipImpl</a></li> +<li><a href="#_relationshipinfo">3.36. RelationshipInfo</a></li> +<li><a href="#_requirementcapabilityreldef">3.37. RequirementCapabilityRelDef</a></li> +<li><a href="#_requirementdatadefinition">3.38. RequirementDataDefinition</a></li> +<li><a href="#_requirementdefinition">3.39. RequirementDefinition</a></li> +<li><a href="#_resource">3.40. Resource</a></li> +<li><a href="#_schemadefinition">3.41. SchemaDefinition</a></li> +<li><a href="#_serverlistresponse">3.42. ServerListResponse</a></li> +<li><a href="#_subcategorydefinition">3.43. SubCategoryDefinition</a></li> +<li><a href="#_topicregistrationresponse">3.44. TopicRegistrationResponse</a></li> +<li><a href="#_topicunregistrationresponse">3.45. TopicUnregistrationResponse</a></li> +<li><a href="#_toscadatadefinition">3.46. ToscaDataDefinition</a></li> +</ul> +</li> +</ul> +</div> +</div> +<div id="content"> +<div class="sect1"> +<h2 id="_overview"><a class="anchor" href="#_overview"></a>1. Overview</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_version_information"><a class="anchor" href="#_version_information"></a>1.1. Version information</h3> +<div class="paragraph"> +<p><em>Version</em> : 1.2.0</p> +</div> +</div> +<div class="sect2"> +<h3 id="_uri_scheme"><a class="anchor" href="#_uri_scheme"></a>1.2. URI scheme</h3> +<div class="paragraph"> +<p><em>BasePath</em> : /sdc</p> +</div> +</div> +<div class="sect2"> +<h3 id="_tags"><a class="anchor" href="#_tags"></a>1.3. Tags</h3> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +<li> +<p>Asset Metadata External Servlet</p> +</li> +<li> +<p>CRUD External Servlet</p> +</li> +<li> +<p>Distribution Catalog Servlet</p> +</li> +<li> +<p>Distribution Servlet</p> +</li> +<li> +<p>Service Activation External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_paths"><a class="anchor" href="#_paths"></a>2. Paths</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_getvalidartifacttypes"><a class="anchor" href="#_getvalidartifacttypes"></a>2.1. Artifact types list</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/artifactTypes</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description"><a class="anchor" href="#_description"></a>2.1.1. Description</h4> +<div class="paragraph"> +<p>Fetches available artifact types list</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters"><a class="anchor" href="#_parameters"></a>2.1.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses"><a class="anchor" href="#_responses"></a>2.1.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact types list fetched successfully</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used to register for distribution ( POST,PUT,DELETE will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes"><a class="anchor" href="#_consumes"></a>2.1.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces"><a class="anchor" href="#_produces"></a>2.1.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_2"><a class="anchor" href="#_tags_2"></a>2.1.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_uploadinterfaceoperationartifact"><a class="anchor" href="#_uploadinterfaceoperationartifact"></a>2.2. uploads of artifact to VF operation workflow</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/resources/{uuid}/interfaces/{operationUUID}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_2"><a class="anchor" href="#_description_2"></a>2.2.1. Description</h4> +<div class="paragraph"> +<p>uploads of artifact to VF operation workflow</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_2"><a class="anchor" href="#_parameters_2"></a>2.2.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-MD5</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The value for this header must be the MD5 checksum over the whole json body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>operationUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_2"><a class="anchor" href="#_responses_2"></a>2.2.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact uploaded</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_2"><a class="anchor" href="#_produces_2"></a>2.2.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_3"><a class="anchor" href="#_tags_3"></a>2.2.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_downloadserviceartifact"><a class="anchor" href="#_downloadserviceartifact"></a>2.3. Download service artifact</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_3"><a class="anchor" href="#_description_3"></a>2.3.1. Description</h4> +<div class="paragraph"> +<p>Returns downloaded artifact</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_3"><a class="anchor" href="#_parameters_3"></a>2.3.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceVersion</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_3"><a class="anchor" href="#_responses_3"></a>2.3.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The artifact is found and streamed.</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified artifact is not found - SVC4505</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_2"><a class="anchor" href="#_consumes_2"></a>2.3.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_3"><a class="anchor" href="#_produces_3"></a>2.3.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/octet-stream</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_4"><a class="anchor" href="#_tags_4"></a>2.3.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Catalog Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_downloadresourceinstanceartifactbyname"><a class="anchor" href="#_downloadresourceinstanceartifactbyname"></a>2.4. Download resource instance artifact</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_4"><a class="anchor" href="#_description_4"></a>2.4.1. Description</h4> +<div class="paragraph"> +<p>Returns downloaded artifact</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_4"><a class="anchor" href="#_parameters_4"></a>2.4.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceInstanceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceVersion</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_4"><a class="anchor" href="#_responses_4"></a>2.4.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The artifact is found and streamed.</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified artifact is not found - SVC4505</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_3"><a class="anchor" href="#_consumes_3"></a>2.4.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_4"><a class="anchor" href="#_produces_4"></a>2.4.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/octet-stream</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_5"><a class="anchor" href="#_tags_5"></a>2.4.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Catalog Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_downloadresourceartifact"><a class="anchor" href="#_downloadresourceartifact"></a>2.5. Download resource artifact</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_5"><a class="anchor" href="#_description_5"></a>2.5.1. Description</h4> +<div class="paragraph"> +<p>Returns downloaded artifact</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_5"><a class="anchor" href="#_parameters_5"></a>2.5.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceVersion</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceVersion</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_5"><a class="anchor" href="#_responses_5"></a>2.5.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The artifact is found and streamed.</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified artifact is not found - SVC4505</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_4"><a class="anchor" href="#_consumes_4"></a>2.5.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_5"><a class="anchor" href="#_produces_5"></a>2.5.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/octet-stream</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_6"><a class="anchor" href="#_tags_6"></a>2.5.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Catalog Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_activateserviceexternal"><a class="anchor" href="#_activateserviceexternal"></a>2.6. activate a service</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_6"><a class="anchor" href="#_description_6"></a>2.6.1. Description</h4> +<div class="paragraph"> +<p>Activates a service</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_6"><a class="anchor" href="#_parameters_6"></a>2.6.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user id</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>opEnvId</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The operational environment on which to activate the service on</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The serviceUUid to activate</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_6"><a class="anchor" href="#_responses_6"></a>2.6.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>202</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is authenticated and required service may be distributed</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The resource name is missing in the request body - SVC4062</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>409</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Service state is invalid for this action</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>502</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The server was acting as a gateway or proxy and received an invalid response from the upstream server</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_5"><a class="anchor" href="#_consumes_5"></a>2.6.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_6"><a class="anchor" href="#_produces_6"></a>2.6.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_7"><a class="anchor" href="#_tags_7"></a>2.6.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Service Activation External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_createresourceexternal"><a class="anchor" href="#_createresourceexternal"></a>2.7. creates a resource</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/{assetType}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_7"><a class="anchor" href="#_description_7"></a>2.7.1. Description</h4> +<div class="paragraph"> +<p>Creates a resource</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_7"><a class="anchor" href="#_parameters_7"></a>2.7.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user id</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the created resource</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_resource">Resource</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_7"><a class="anchor" href="#_responses_7"></a>2.7.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is authenticated and Asset created</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_resource">Resource</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Create VFCMT request: VFCMT name exceeds character limit - SVC4073</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_6"><a class="anchor" href="#_consumes_6"></a>2.7.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_7"><a class="anchor" href="#_produces_7"></a>2.7.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_8"><a class="anchor" href="#_tags_8"></a>2.7.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>CRUD External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_getassetlistexternal"><a class="anchor" href="#_getassetlistexternal"></a>2.8. Fetch list of assets</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/{assetType}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_8"><a class="anchor" href="#_description_8"></a>2.8.1. Description</h4> +<div class="paragraph"> +<p>Returns list of assets</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_8"><a class="anchor" href="#_parameters_8"></a>2.8.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Query</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>category</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The filter key (resourceType only for resources)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Query</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distributionStatus</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The filter key (resourceType only for resources)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Query</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The filter key (resourceType only for resources)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Query</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>subCategory</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The filter key (resourceType only for resources)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_8"><a class="anchor" href="#_responses_8"></a>2.8.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is authenticated and list of Catalog Assets Metadata is returned</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_assetmetadata">AssetMetadata</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_8"><a class="anchor" href="#_produces_8"></a>2.8.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_9"><a class="anchor" href="#_tags_9"></a>2.8.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Asset Metadata External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_uploadartifact"><a class="anchor" href="#_uploadartifact"></a>2.9. uploads of artifact to a resource or service</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/{assetType}/{uuid}/artifacts</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_9"><a class="anchor" href="#_description_9"></a>2.9.1. Description</h4> +<div class="paragraph"> +<p>uploads of artifact to a resource or service</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_9"><a class="anchor" href="#_parameters_9"></a>2.9.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-MD5</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The value for this header must be the MD5 checksum over the whole json body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_9"><a class="anchor" href="#_responses_9"></a>2.9.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact uploaded</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_9"><a class="anchor" href="#_produces_9"></a>2.9.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_10"><a class="anchor" href="#_tags_10"></a>2.9.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_updateartifact"><a class="anchor" href="#_updateartifact"></a>2.10. updates an artifact on a resource or service</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_10"><a class="anchor" href="#_description_10"></a>2.10.1. Description</h4> +<div class="paragraph"> +<p>uploads of artifact to a resource or service</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_10"><a class="anchor" href="#_parameters_10"></a>2.10.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-MD5</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The value for this header must be the MD5 checksum over the whole json body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_10"><a class="anchor" href="#_responses_10"></a>2.10.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact updated</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact name is missing in input - SVC4128</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>409</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_10"><a class="anchor" href="#_produces_10"></a>2.10.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_11"><a class="anchor" href="#_tags_11"></a>2.10.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_downloadcomponentartifact"><a class="anchor" href="#_downloadcomponentartifact"></a>2.11. Download component artifact</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_11"><a class="anchor" href="#_description_11"></a>2.11.1. Description</h4> +<div class="paragraph"> +<p>Returns downloaded artifact</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_11"><a class="anchor" href="#_parameters_11"></a>2.11.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_11"><a class="anchor" href="#_responses_11"></a>2.11.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact downloaded</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact was not found - SVC4505</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_11"><a class="anchor" href="#_produces_11"></a>2.11.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/octet-stream</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_12"><a class="anchor" href="#_tags_12"></a>2.11.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_deleteartifact"><a class="anchor" href="#_deleteartifact"></a>2.12. deletes an artifact of a resource or service</h3> +<div class="literalblock"> +<div class="content"> +<pre>DELETE /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_12"><a class="anchor" href="#_description_12"></a>2.12.1. Description</h4> +<div class="paragraph"> +<p>deletes an artifact of a resource or service</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_12"><a class="anchor" href="#_parameters_12"></a>2.12.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_12"><a class="anchor" href="#_responses_12"></a>2.12.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact deleted</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact name is missing in input - SVC4128</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>409</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_12"><a class="anchor" href="#_produces_12"></a>2.12.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_13"><a class="anchor" href="#_tags_13"></a>2.12.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_changeresourcestateexternal"><a class="anchor" href="#_changeresourcestateexternal"></a>2.13. Change Resource lifecycle State</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_13"><a class="anchor" href="#_parameters_13"></a>2.13.1. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user id</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>validValues: resources / services</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lifecycleOperation</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (checkout, checkin)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>id of component to be changed</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>userRemarks - Short description (free text) about the asset version being changed</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_lifecyclechangeinfowithaction">LifecycleChangeInfoWithAction</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_13"><a class="anchor" href="#_responses_13"></a>2.13.2. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Resource state changed</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_assetmetadata">AssetMetadata</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing X-ECOMP-InstanceID HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_7"><a class="anchor" href="#_consumes_7"></a>2.13.3. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_13"><a class="anchor" href="#_produces_13"></a>2.13.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_14"><a class="anchor" href="#_tags_14"></a>2.13.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>CRUD External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_getassetspecificmetadatabyuuidexternal"><a class="anchor" href="#_getassetspecificmetadatabyuuidexternal"></a>2.14. Detailed metadata of asset by uuid</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/{assetType}/{uuid}/metadata</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_13"><a class="anchor" href="#_description_13"></a>2.14.1. Description</h4> +<div class="paragraph"> +<p>Returns detailed metadata of an asset by uuid</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_14"><a class="anchor" href="#_parameters_14"></a>2.14.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset uuid</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_14"><a class="anchor" href="#_responses_14"></a>2.14.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is authenticated and list of Catalog Assets Metadata is returned</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_assetmetadata">AssetMetadata</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_14"><a class="anchor" href="#_produces_14"></a>2.14.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_15"><a class="anchor" href="#_tags_15"></a>2.14.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Asset Metadata External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_uploadartifacttoinstance"><a class="anchor" href="#_uploadartifacttoinstance"></a>2.15. uploads an artifact to a resource instance</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_14"><a class="anchor" href="#_description_14"></a>2.15.1. Description</h4> +<div class="paragraph"> +<p>uploads an artifact to a resource instance</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_15"><a class="anchor" href="#_parameters_15"></a>2.15.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-MD5</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The value for this header must be the MD5 checksum over the whole json body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceInstanceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The component instance name (as publishedin the response of the detailed query)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_15"><a class="anchor" href="#_responses_15"></a>2.15.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact uploaded</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_15"><a class="anchor" href="#_produces_15"></a>2.15.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_16"><a class="anchor" href="#_tags_16"></a>2.15.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_updateartifactonresourceinstance"><a class="anchor" href="#_updateartifactonresourceinstance"></a>2.16. updates an artifact on a resource instance</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_15"><a class="anchor" href="#_description_15"></a>2.16.1. Description</h4> +<div class="paragraph"> +<p>uploads of artifact to a resource or service</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_16"><a class="anchor" href="#_parameters_16"></a>2.16.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-MD5</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The value for this header must be the MD5 checksum over the whole json body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceInstanceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The component instance name (as publishedin the response of the detailed query)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>body</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_16"><a class="anchor" href="#_responses_16"></a>2.16.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact updated</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact name is missing in input - SVC4128</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>409</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_16"><a class="anchor" href="#_produces_16"></a>2.16.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_17"><a class="anchor" href="#_tags_17"></a>2.16.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_downloadresourceinstanceartifact"><a class="anchor" href="#_downloadresourceinstanceartifact"></a>2.17. Download resource instance artifact</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_16"><a class="anchor" href="#_description_16"></a>2.17.1. Description</h4> +<div class="paragraph"> +<p>Returns downloaded artifact</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_17"><a class="anchor" href="#_parameters_17"></a>2.17.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceInstanceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The component instance name (as publishedin the response of the detailed query)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_17"><a class="anchor" href="#_responses_17"></a>2.17.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact downloaded</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact was not found - SVC4505</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_17"><a class="anchor" href="#_produces_17"></a>2.17.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/octet-stream</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_18"><a class="anchor" href="#_tags_18"></a>2.17.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_deleteartifactonresourceinstance"><a class="anchor" href="#_deleteartifactonresourceinstance"></a>2.18. deletes an artifact of a resource insatnce</h3> +<div class="literalblock"> +<div class="content"> +<pre>DELETE /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_17"><a class="anchor" href="#_description_17"></a>2.18.1. Description</h4> +<div class="paragraph"> +<p>deletes an artifact of a resource insatnce</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_18"><a class="anchor" href="#_parameters_18"></a>2.18.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>USER_ID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The user ID of the DCAE Designer. This user must also have Designer role in SDC</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceInstanceName</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The component instance name (as publishedin the response of the detailed query)</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The uuid of the asset as published in the metadata</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_18"><a class="anchor" href="#_responses_18"></a>2.18.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact deleted</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdefinition">ArtifactDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Artifact name is missing in input - SVC4128</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Specified resource is not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>409</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_18"><a class="anchor" href="#_produces_18"></a>2.18.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_19"><a class="anchor" href="#_tags_19"></a>2.18.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Artifact External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_gettoscamodelexternal"><a class="anchor" href="#_gettoscamodelexternal"></a>2.19. Fetch assets CSAR</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/catalog/{assetType}/{uuid}/toscaModel</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_18"><a class="anchor" href="#_description_18"></a>2.19.1. Description</h4> +<div class="paragraph"> +<p>Returns asset csar</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_19"><a class="anchor" href="#_parameters_19"></a>2.19.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>assetType</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset type</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (resources, services)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Path</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The requested asset uuid</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_19"><a class="anchor" href="#_responses_19"></a>2.19.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is authenticated and list of Catalog Assets Metadata is returned</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>404</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Error: Requested <em>%1</em> (uuid) resource was not found - SVC4063</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_produces_19"><a class="anchor" href="#_produces_19"></a>2.19.4. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/octet-stream</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_20"><a class="anchor" href="#_tags_20"></a>2.19.5. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Asset Metadata External Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_getuebserverlist"><a class="anchor" href="#_getuebserverlist"></a>2.20. UEB Server List</h3> +<div class="literalblock"> +<div class="content"> +<pre>GET /v1/distributionUebCluster</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_19"><a class="anchor" href="#_description_19"></a>2.20.1. Description</h4> +<div class="paragraph"> +<p>return the available UEB Server List</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_20"><a class="anchor" href="#_parameters_20"></a>2.20.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_20"><a class="anchor" href="#_responses_20"></a>2.20.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_serverlistresponse">ServerListResponse</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Missing <em>X-ECOMP-InstanceID</em> HTTP header - POL5001</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_8"><a class="anchor" href="#_consumes_8"></a>2.20.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_20"><a class="anchor" href="#_produces_20"></a>2.20.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_21"><a class="anchor" href="#_tags_21"></a>2.20.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_registerfordistribution"><a class="anchor" href="#_registerfordistribution"></a>2.21. Subscription status</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/registerForDistribution</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_20"><a class="anchor" href="#_description_20"></a>2.21.1. Description</h4> +<div class="paragraph"> +<p>Subscribes for distribution notifications</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_21"><a class="anchor" href="#_parameters_21"></a>2.21.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Length</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Length of the request body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requestJson</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_registrationrequest">RegistrationRequest</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_21"><a class="anchor" href="#_responses_21"></a>2.21.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>200</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is successfully registered for distribution</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_topicregistrationresponse">TopicRegistrationResponse</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Invalid Body : Specified <em>distrEnvName</em> doesn’t exist - POL4137</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_9"><a class="anchor" href="#_consumes_9"></a>2.21.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_21"><a class="anchor" href="#_produces_21"></a>2.21.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_22"><a class="anchor" href="#_tags_22"></a>2.21.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Servlet</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_unregisterfordistribution"><a class="anchor" href="#_unregisterfordistribution"></a>2.22. Subscription status</h3> +<div class="literalblock"> +<div class="content"> +<pre>POST /v1/unRegisterForDistribution</pre> +</div> +</div> +<div class="sect3"> +<h4 id="_description_21"><a class="anchor" href="#_description_21"></a>2.22.1. Description</h4> +<div class="paragraph"> +<p>Removes from subscription for distribution notifications</p> +</div> +</div> +<div class="sect3"> +<h4 id="_parameters_22"><a class="anchor" href="#_parameters_22"></a>2.22.2. Parameters</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:11%;"> +<col style="width:16%;"> +<col style="width:50%;"> +<col style="width:22%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Type</th> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Accept</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the response</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Authorization</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>The username and password</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Length</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Length of the request body</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Content-Type</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Determines the format of the body of the request</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-InstanceID</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-InstanceID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Header</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>X-ECOMP-RequestID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>X-ECOMP-RequestID header</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>Body</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requestJson</strong><br> +<em>required</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>json describe the artifact</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_registrationrequest">RegistrationRequest</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_responses_22"><a class="anchor" href="#_responses_22"></a>2.22.3. Responses</h4> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:10%;"> +<col style="width:70%;"> +<col style="width:20%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">HTTP Code</th> +<th class="tableblock halign-left valign-middle">Description</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>204</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is successfully unregistered</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_topicunregistrationresponse">TopicUnregistrationResponse</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>400</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Invalid Body : Specified <em>distrEnvName</em> doesn’t exist - POL4137</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>401</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>403</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>ECOMP component is not authorized - POL5003</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>405</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050</p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>500</strong></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<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> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>No Content</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect3"> +<h4 id="_consumes_10"><a class="anchor" href="#_consumes_10"></a>2.22.4. Consumes</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_produces_22"><a class="anchor" href="#_produces_22"></a>2.22.5. Produces</h4> +<div class="ulist"> +<ul> +<li> +<p><code>application/json</code></p> +</li> +</ul> +</div> +</div> +<div class="sect3"> +<h4 id="_tags_23"><a class="anchor" href="#_tags_23"></a>2.22.6. Tags</h4> +<div class="ulist"> +<ul> +<li> +<p>Distribution Servlet</p> +</li> +</ul> +</div> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_definitions"><a class="anchor" href="#_definitions"></a>3. Definitions</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_additionalinfoparameterinfo"><a class="anchor" href="#_additionalinfoparameterinfo"></a>3.1. AdditionalInfoParameterInfo</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>key</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_additionalinformationdefinition"><a class="anchor" href="#_additionalinformationdefinition"></a>3.2. AdditionalInformationDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationTime</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastCreatedCounter</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>modificationTime</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parameters</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_additionalinfoparameterinfo">AdditionalInfoParameterInfo</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_artifactdatadefinition"><a class="anchor" href="#_artifactdatadefinition"></a>3.3. ArtifactDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>apiUrl</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactChecksum</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactCreator</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactDisplayName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactGroupType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactLabel</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactRef</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactRepository</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactVersion</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creatorFullName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>duplicated</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>esId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>generated</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>generatedFromId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>heatParameters</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_heatparameterdatadefinition">HeatParameterDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>heatParamsUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>isFromCsar</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>mandatory</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>payloadUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requiredArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceApi</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>timeout</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>updaterFullName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>userIdCreator</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>userIdLastUpdater</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_artifactdefinition"><a class="anchor" href="#_artifactdefinition"></a>3.4. ArtifactDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>apiUrl</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactChecksum</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactCreator</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactDisplayName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactGroupType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactLabel</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactRef</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactRepository</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactVersion</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creatorFullName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>duplicated</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>esId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>generated</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>generatedFromId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>heatParameters</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_heatparameterdatadefinition">HeatParameterDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>heatParamsUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>isFromCsar</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>listHeatParameters</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_heatparameterdefinition">HeatParameterDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>mandatory</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>payloadData</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string (byte) > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>payloadUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requiredArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>serviceApi</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>timeout</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>updaterFullName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>userIdCreator</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>userIdLastUpdater</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_assetmetadata"><a class="anchor" href="#_assetmetadata"></a>3.5. AssetMetadata</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaModelURL</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>version</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_capabilitydatadefinition"><a class="anchor" href="#_capabilitydatadefinition"></a>3.6. CapabilityDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capabilitySources</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>leftOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>maxOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>minOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>path</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>source</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>validSourceTypes</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_capabilitydefinition"><a class="anchor" href="#_capabilitydefinition"></a>3.7. CapabilityDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capabilitySources</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>leftOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>maxOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>minOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>path</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>source</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>validSourceTypes</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_capabilityrequirementrelationship"><a class="anchor" href="#_capabilityrequirementrelationship"></a>3.8. CapabilityRequirementRelationship</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capability</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_capabilitydatadefinition">CapabilityDataDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>relation</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_relationshipinfo">RelationshipInfo</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requirement</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_requirementdatadefinition">RequirementDataDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_categorydefinition"><a class="anchor" href="#_categorydefinition"></a>3.9. CategoryDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>icons</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>subcategories</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_subcategorydefinition">SubCategoryDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_componentinstance"><a class="anchor" href="#_componentinstance"></a>3.10. ComponentInstance</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>actualComponentUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_artifactdefinition">ArtifactDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>attributeValueCounter</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capabilities</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_capabilitydefinition">CapabilityDefinition</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentVersion</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationTime</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>customizationUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>deploymentArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_artifactdefinition">ArtifactDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupInstances</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_groupinstance">GroupInstance</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>icon</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputValueCounter</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>isProxy</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>modificationTime</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>originType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (PRODUCT, SERVICE, VF, VFC, CP, VL, Configuration, VFCMT, CVFC, PNF, CR, ServiceProxy)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>posX</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>posY</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyValueCounter</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requirements</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_requirementdefinition">RequirementDefinition</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>sourceModelInvariant</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>sourceModelName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>sourceModelUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>sourceModelUuid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaComponentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_componentinstanceinput"><a class="anchor" href="#_componentinstanceinput"></a>3.11. ComponentInstanceInput</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstanceId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstanceName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>constraints</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertyconstraint">PropertyConstraint</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputProperty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputValues</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>hidden</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>immutable</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputPath</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputs</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_componentinstanceinput">ComponentInstanceInput</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>instanceUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>label</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>password</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>path</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>required</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>rules</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertyrule">PropertyRule</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schema</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_schemadefinition">SchemaDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schemaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>status</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>valueUniqueUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_componentinstanceproperty"><a class="anchor" href="#_componentinstanceproperty"></a>3.12. ComponentInstanceProperty</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstanceId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstanceName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>constraints</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertyconstraint">PropertyConstraint</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputProperty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputValues</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>hidden</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>immutable</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputPath</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>instanceUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>label</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>password</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>path</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>required</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>rules</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertyrule">PropertyRule</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schema</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_schemadefinition">SchemaDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schemaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>status</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>valueUniqueUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_getinputvaluedatadefinition"><a class="anchor" href="#_getinputvaluedatadefinition"></a>3.13. GetInputValueDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputIndex</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>indexValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>list</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_groupdefinition"><a class="anchor" href="#_groupdefinition"></a>3.14. GroupDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactsUuid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>members</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, string > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertydatadefinition">PropertyDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyValueCounter</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>typeUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>version</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_groupinstance"><a class="anchor" href="#_groupinstance"></a>3.15. GroupInstance</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactsUuid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationTime</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>customizationUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupInstanceArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupInstanceArtifactsUuid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>modificationTime</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>posX</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>posY</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertydatadefinition">PropertyDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyValueCounter</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int32)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>version</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_groupingdefinition"><a class="anchor" href="#_groupingdefinition"></a>3.16. GroupingDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_heatparameterdatadefinition"><a class="anchor" href="#_heatparameterdatadefinition"></a>3.17. HeatParameterDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>currentValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_heatparameterdefinition"><a class="anchor" href="#_heatparameterdefinition"></a>3.18. HeatParameterDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>currentValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_inputdefinition"><a class="anchor" href="#_inputdefinition"></a>3.19. InputDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>constraints</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertyconstraint">PropertyConstraint</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputProperty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputValues</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>hidden</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>immutable</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputPath</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputs</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_componentinstanceinput">ComponentInstanceInput</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>instanceUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>label</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>password</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>required</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schema</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_schemadefinition">SchemaDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schemaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>status</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_interfacedefinition"><a class="anchor" href="#_interfacedefinition"></a>3.20. InterfaceDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>operations</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_operationdatadefinition">OperationDataDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaResourceName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_interfaceoperationdatadefinition"><a class="anchor" href="#_interfaceoperationdatadefinition"></a>3.21. InterfaceOperationDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifactUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputParams</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_listdatadefinitioninterfaceoperationparamdatadefinition">ListDataDefinitionInterfaceOperationParamDataDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>operationType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>outputParams</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_listdatadefinitioninterfaceoperationparamdatadefinition">ListDataDefinitionInterfaceOperationParamDataDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaResourceName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_interfaceoperationparamdatadefinition"><a class="anchor" href="#_interfaceoperationparamdatadefinition"></a>3.22. InterfaceOperationParamDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>paramId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>paramName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_lifecyclechangeinfowithaction"><a class="anchor" href="#_lifecyclechangeinfowithaction"></a>3.23. LifecycleChangeInfoWithAction</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>action</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (CREATE_FROM_CSAR, UPDATE_FROM_EXTERNAL_API, UPGRADE_MIGRATION)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>userRemarks</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_listdatadefinition"><a class="anchor" href="#_listdatadefinition"></a>3.24. ListDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>listToscaDataDefinition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_toscadatadefinition">ToscaDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_listdatadefinitioninterfaceoperationparamdatadefinition"><a class="anchor" href="#_listdatadefinitioninterfaceoperationparamdatadefinition"></a>3.25. ListDataDefinitionInterfaceOperationParamDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>listToscaDataDefinition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_interfaceoperationparamdatadefinition">InterfaceOperationParamDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_listdatadefinitionoperationinputdefinition"><a class="anchor" href="#_listdatadefinitionoperationinputdefinition"></a>3.26. ListDataDefinitionOperationInputDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>listToscaDataDefinition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_operationinputdefinition">OperationInputDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_operationdatadefinition"><a class="anchor" href="#_operationdatadefinition"></a>3.27. OperationDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>implementation</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_artifactdatadefinition">ArtifactDataDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputs</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_listdatadefinitionoperationinputdefinition">ListDataDefinitionOperationInputDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_operationinputdefinition"><a class="anchor" href="#_operationinputdefinition"></a>3.28. OperationInputDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputProperty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputValues</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>hidden</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>immutable</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputPath</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>instanceUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>label</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>password</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>required</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schema</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_schemadefinition">SchemaDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schemaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>status</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_policydefinition"><a class="anchor" href="#_policydefinition"></a>3.29. PolicyDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>derivedFrom</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>isFromCsar</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>policyTypeName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>policyTypeUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>policyUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertydatadefinition">PropertyDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>targets</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < string > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>version</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_propertyconstraint"><a class="anchor" href="#_propertyconstraint"></a>3.30. PropertyConstraint</h3> +<div class="paragraph"> +<p><em>Type</em> : object</p> +</div> +</div> +<div class="sect2"> +<h3 id="_propertydatadefinition"><a class="anchor" href="#_propertydatadefinition"></a>3.31. PropertyDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputProperty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputValues</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>hidden</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>immutable</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputPath</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>instanceUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>label</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>password</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>required</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schema</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_schemadefinition">SchemaDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schemaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>status</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_propertydefinition"><a class="anchor" href="#_propertydefinition"></a>3.32. PropertyDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>constraints</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertyconstraint">PropertyConstraint</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultValue</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>definition</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputProperty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>getInputValues</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_getinputvaluedatadefinition">GetInputValueDataDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>hidden</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>immutable</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputPath</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>instanceUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>label</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentUniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>password</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>propertyId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>required</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schema</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_schemadefinition">SchemaDefinition</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>schemaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>status</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_propertyrule"><a class="anchor" href="#_propertyrule"></a>3.33. PropertyRule</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>rule</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>value</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_registrationrequest"><a class="anchor" href="#_registrationrequest"></a>3.34. RegistrationRequest</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>apiPublicKey</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distEnvEndPoints</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distrEnvName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>isConsumerToSdcDistrStatusTopic</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_relationshipimpl"><a class="anchor" href="#_relationshipimpl"></a>3.35. RelationshipImpl</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>type</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_relationshipinfo"><a class="anchor" href="#_relationshipinfo"></a>3.36. RelationshipInfo</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capability</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capabilityOwnerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capabilityUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>id</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>relationship</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_relationshipimpl">RelationshipImpl</a></p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requirement</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requirementOwnerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requirementUid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_requirementcapabilityreldef"><a class="anchor" href="#_requirementcapabilityreldef"></a>3.37. RequirementCapabilityRelDef</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>fromNode</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>relationships</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_capabilityrequirementrelationship">CapabilityRequirementRelationship</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toNode</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_requirementdatadefinition"><a class="anchor" href="#_requirementdatadefinition"></a>3.38. RequirementDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capability</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>leftOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>maxOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>minOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>node</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>path</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>relationship</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>source</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_requirementdefinition"><a class="anchor" href="#_requirementdefinition"></a>3.39. RequirementDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capability</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>leftOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>maxOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>minOccurrences</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>node</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>parentName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>path</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>relationship</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>source</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_resource"><a class="anchor" href="#_resource"></a>3.40. Resource</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>abstract</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>additionalInformation</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_additionalinformationdefinition">AdditionalInformationDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>allArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_artifactdefinition">ArtifactDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>allVersions</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, string > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>artifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_artifactdefinition">ArtifactDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>attributes</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertydefinition">PropertyDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>capabilities</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_capabilitydefinition">CapabilityDefinition</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>categories</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_categorydefinition">CategoryDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstances</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_componentinstance">ComponentInstance</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstancesAttributes</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstancesInputs</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_componentinstanceinput">ComponentInstanceInput</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstancesProperties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_componentinstanceproperty">ComponentInstanceProperty</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentInstancesRelations</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_requirementcapabilityreldef">RequirementCapabilityRelDef</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>componentType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (RESOURCE, SERVICE, RESOURCE_INSTANCE, PRODUCT, SERVICE_INSTANCE)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>conformanceLevel</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>contactId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>cost</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creationDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creatorFullName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>creatorUserId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>csarUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>csarVersion</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>defaultCapabilities</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>deploymentArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_artifactdefinition">ArtifactDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>derivedFrom</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>derivedFromGenericType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>derivedFromGenericVersion</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>derivedList</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>description</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groups</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_groupdefinition">GroupDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>highestVersion</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>icon</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>importedToscaChecksum</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>inputs</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_inputdefinition">InputDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>interfaceOperations</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_interfaceoperationdatadefinition">InterfaceOperationDataDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>interfaces</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_interfacedefinition">InterfaceDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>invariantUUID</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>isDeleted</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdateDate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>integer (int64)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdaterFullName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lastUpdaterUserId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>licenseType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>lifecycleState</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED, NOT_CERTIFIED_CHECKIN, NOT_CERTIFIED_CHECKOUT)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>policies</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_policydefinition">PolicyDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>projectCode</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_propertydefinition">PropertyDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>requirements</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, < <a href="#_requirementdefinition">RequirementDefinition</a> > array > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (VFC, VF, CR, CP, PNF, CVFC, VL, VFCMT, Configuration, ServiceProxy, ABSTRACT)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>resourceVendorModelNumber</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>systemName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>tags</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>topologyTemplate</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaArtifacts</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_artifactdefinition">ArtifactDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaResourceName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>toscaType</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uuid</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>vendorName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>vendorRelease</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>version</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_schemadefinition"><a class="anchor" href="#_schemadefinition"></a>3.41. SchemaDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>constraints</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>derivedFrom</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>properties</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string, <a href="#_propertydatadefinition">PropertyDataDefinition</a> > map</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>property</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><a href="#_propertydatadefinition">PropertyDataDefinition</a></p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_serverlistresponse"><a class="anchor" href="#_serverlistresponse"></a>3.42. ServerListResponse</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uebServerList</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_subcategorydefinition"><a class="anchor" href="#_subcategorydefinition"></a>3.43. SubCategoryDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>groupings</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< <a href="#_groupingdefinition">GroupingDefinition</a> > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>icons</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>< string > array</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>name</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>normalizedName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>uniqueId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_topicregistrationresponse"><a class="anchor" href="#_topicregistrationresponse"></a>3.44. TopicRegistrationResponse</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distrNotificationTopicName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distrStatusTopicName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_topicunregistrationresponse"><a class="anchor" href="#_topicunregistrationresponse"></a>3.45. TopicUnregistrationResponse</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distrNotificationTopicName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>distrStatusTopicName</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>notificationUnregisterResult</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>statusUnregisterResult</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR)</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +<div class="sect2"> +<h3 id="_toscadatadefinition"><a class="anchor" href="#_toscadatadefinition"></a>3.46. ToscaDataDefinition</h3> +<table class="tableblock frame-all grid-all" style="width:100%; "> +<colgroup> +<col style="width:42%;"> +<col style="width:57%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-middle">Name</th> +<th class="tableblock halign-left valign-middle">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>empty</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>boolean</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p><strong>ownerId</strong><br> +<em>optional</em></p> +</div></div></td> +<td class="tableblock halign-left valign-middle"><div><div class="paragraph"> +<p>string</p> +</div></div></td> +</tr> +</tbody> +</table> + +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer-text"> +Last updated 2018-06-04 20:26:24 UTC +</div> +</div> +</body> +</html>
\ No newline at end of file |