| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="generator" content="Asciidoctor 1.5.2"> |
| <title>Software Modules</title> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400"> |
| <style> |
| |
| |
| |
| 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],template{display:none} |
| script{display:none!important} |
| html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} |
| body{margin:0} |
| a{background:transparent} |
| a:focus{outline:thin dotted} |
| a:active,a:hover{outline:0} |
| h1{font-size:2em;margin:.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;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:-.5em} |
| sub{bottom:-.25em} |
| img{border:0} |
| svg:not(:root){overflow:hidden} |
| figure{margin:0} |
| fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .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:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} |
| a:hover{cursor:pointer} |
| 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,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} |
| 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:#2156a5;text-decoration:underline;line-height:inherit} |
| a:hover,a:focus{color:#1d4b8f} |
| a img{border:none} |
| p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} |
| p aside{font-size:.875em;line-height:1.35;font-style:italic} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} |
| 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,h5{font-size:1.125em} |
| h6{font-size:1em} |
| hr{border:solid #ddddd8;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:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} |
| ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} |
| ul,ol,ul.no-bullet,ol.no-bullet{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:.3125em;font-weight:bold} |
| dl dd{margin-bottom:1.25em} |
| abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} |
| abbr{text-transform:none} |
| blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} |
| blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} |
| blockquote cite:before{content:"\2014 \0020"} |
| blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} |
| blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} |
| @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} |
| h1{font-size:2.75em} |
| h2{font-size:2.3125em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} |
| h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} |
| table thead,table tfoot{background:#f7f8f7;font-weight:bold} |
| table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} |
| table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} |
| table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} |
| 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} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} |
| h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} |
| .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:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} |
| pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} |
| .keyseq{color:rgba(51,51,51,.8)} |
| kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.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,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} |
| .keyseq kbd:first-child{margin-left:0} |
| .keyseq kbd:last-child{margin-right:0} |
| .menuseq,.menu{color:rgba(0,0,0,.8)} |
| b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} |
| b.button:before{content:"[";padding:0 3px 0 2px} |
| b.button:after{content:"]";padding:0 2px 0 3px} |
| p a>code:hover{color:rgba(0,0,0,.9)} |
| #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} |
| #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} |
| #content{margin-top:1.25em} |
| #content:before{content:none} |
| #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} |
| #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} |
| #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} |
| #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} |
| #header .details span:first-child{margin-left:-.125em} |
| #header .details span.email a{color:rgba(0,0,0,.85)} |
| #header .details br{display:none} |
| #header .details br+span:before{content:"\00a0\2013\00a0"} |
| #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} |
| #header .details br+span#revremark:before{content:"\00a0|\00a0"} |
| #header #revnumber{text-transform:capitalize} |
| #header #revnumber:after{content:"\00a0"} |
| #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} |
| #toc{border-bottom:1px solid #efefed;padding-bottom:.5em} |
| #toc>ul{margin-left:.125em} |
| #toc ul.sectlevel0>li>a{font-style:italic} |
| #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} |
| #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} |
| #toc a{text-decoration:none} |
| #toc a:active{text-decoration:underline} |
| #toctitle{color:#7a2518;font-size:1.2em} |
| @media only screen and (min-width:768px){#toctitle{font-size:1.375em} |
| body.toc2{padding-left:15em;padding-right:0} |
| #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} |
| #toc.toc2 #toctitle{margin-top:0;font-size:1.2em} |
| #toc.toc2>ul{font-size:.9em;margin-bottom:0} |
| #toc.toc2 ul ul{margin-left:0;padding-left:1em} |
| #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} |
| body.toc2.toc-right{padding-left:0;padding-right:15em} |
| body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} |
| #toc.toc2{width:20em} |
| #toc.toc2 #toctitle{font-size:1.375em} |
| #toc.toc2>ul{font-size:.95em} |
| #toc.toc2 ul ul{padding-left:1.25em} |
| body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} |
| #content #toc>:first-child{margin-top:0} |
| #content #toc>:last-child{margin-bottom:0} |
| #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} |
| #footer-text{color:rgba(255,255,255,.8);line-height:1.44} |
| .sect1{padding-bottom:.625em} |
| @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} |
| #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} |
| #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} |
| #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} |
| .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} |
| .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} |
| table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} |
| .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} |
| table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} |
| .admonitionblock>table{border-collapse:separate;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;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} |
| .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} |
| .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:#fff;-webkit-border-radius:4px;border-radius:4px} |
| .exampleblock>.content>:first-child{margin-top:0} |
| .exampleblock>.content>:last-child{margin-bottom:0} |
| .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} |
| .sidebarblock>:first-child{margin-top:0} |
| .sidebarblock>:last-child{margin-bottom:0} |
| .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} |
| .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 pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} |
| .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} |
| .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} |
| .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} |
| @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} |
| .listingblock pre.highlightjs{padding:0} |
| .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} |
| .listingblock pre.prettyprint{border-width:0} |
| .listingblock>.content{position:relative} |
| .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} |
| .listingblock:hover code[data-lang]:before{display:block} |
| .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} |
| .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} |
| table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} |
| table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} |
| table.pyhltable td.code{padding-left:.75em;padding-right:0} |
| pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} |
| pre.pygments .lineno{display:inline-block;margin-right:.25em} |
| table.pyhltable .linenodiv{background:none!important;padding-right:0!important} |
| .quoteblock{margin:0 1em 1.25em 1.5em;display:table} |
| .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} |
| .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} |
| .quoteblock blockquote{margin:0;padding:0;border:0} |
| .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} |
| .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} |
| .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} |
| .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} |
| .quoteblock .quoteblock blockquote{padding:0 0 0 .75em} |
| .quoteblock .quoteblock blockquote:before{display:none} |
| .verseblock{margin:0 1em 1.25em 1em} |
| .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} |
| .verseblock pre strong{font-weight:400} |
| .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} |
| .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} |
| .quoteblock .attribution br,.verseblock .attribution br{display:none} |
| .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} |
| .quoteblock.abstract{margin:0 0 1.25em 0;display:block} |
| .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} |
| .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} |
| table.tableblock{max-width:100%;border-collapse:separate} |
| table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} |
| table.spread{width:100%} |
| table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} |
| table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} |
| table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} |
| table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} |
| table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} |
| table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} |
| table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} |
| table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} |
| table.frame-all{border-width:1px} |
| table.frame-sides{border-width:0 1px} |
| table.frame-topbot{border-width:1px 0} |
| th.halign-left,td.halign-left{text-align:left} |
| th.halign-right,td.halign-right{text-align:right} |
| th.halign-center,td.halign-center{text-align:center} |
| th.valign-top,td.valign-top{vertical-align:top} |
| th.valign-bottom,td.valign-bottom{vertical-align:bottom} |
| th.valign-middle,td.valign-middle{vertical-align:middle} |
| table thead th,table tfoot th{font-weight:bold} |
| tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} |
| tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} |
| p.tableblock>code:only-child{background:none;padding:0} |
| p.tableblock{font-size:1em} |
| 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:.625em} |
| ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} |
| ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} |
| ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} |
| ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} |
| ul.inline{margin:0 auto .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:400;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:.75em;font-weight:bold} |
| td.hdlist1,td.hdlist2{vertical-align:top} |
| .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} |
| .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} |
| .colist>table tr>td:last-of-type{padding:.25em 0} |
| .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} |
| .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} |
| .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} |
| .imageblock>.title{margin-bottom:0} |
| .imageblock.thumb,.imageblock.th{border-width:6px} |
| .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} |
| .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} |
| .image.left{margin-right:.625em} |
| .image.right{margin-left:.625em} |
| a.image{text-decoration:none} |
| span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} |
| span.footnote a,span.footnoteref a{text-decoration:none} |
| span.footnote a:active,span.footnoteref a:active{text-decoration:underline} |
| #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} |
| #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} |
| #footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.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:-.625em;margin-bottom:0;padding:.75em 0} |
| .gist .file-data>table{border:0;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:#000} |
| .black-background{background-color:#000} |
| .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>.fa{cursor:default} |
| .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} |
| .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} |
| .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,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[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} |
| .conum[data-value] *{color:#fff!important} |
| .conum[data-value]+b{display:none} |
| .conum[data-value]:after{content:attr(data-value)} |
| pre .conum[data-value]{position:relative;top:-.125em} |
| b.conum *{color:inherit!important} |
| .conum:not([data-value]):empty{display:none} |
| h1,h2{letter-spacing:-.01em} |
| dt,th.tableblock,td.content{text-rendering:optimizeLegibility} |
| p,td.content{letter-spacing:-.01em} |
| p strong,td.content strong{letter-spacing:-.005em} |
| p,blockquote,dt,td.content{font-size:1.0625rem} |
| p{margin-bottom:1.25rem} |
| .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} |
| .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} |
| .print-only{display:none!important} |
| @media print{@page{margin:1.25cm .75cm} |
| *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} |
| a{color:inherit!important;text-decoration:underline!important} |
| a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} |
| a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} |
| abbr[title]:after{content:" (" attr(title) ")"} |
| pre,blockquote,tr,img{page-break-inside:avoid} |
| thead{display:table-header-group} |
| img{max-width:100%!important} |
| p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} |
| h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} |
| #toc,.sidebarblock,.exampleblock>.content{background:none!important} |
| #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} |
| .sect1{padding-bottom:0!important} |
| .sect1+.sect1{border:0!important} |
| #header>h1:first-child{margin-top:1.25rem} |
| body.book #header{text-align:center} |
| body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} |
| body.book #header .details{border:0!important;display:block;padding:0!important} |
| body.book #header .details span:first-child{margin-left:0!important} |
| body.book #header .details br{display:block} |
| body.book #header .details br+span:before{content:none!important} |
| body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} |
| body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} |
| .listingblock code[data-lang]:before{display:block} |
| #footer{background:none!important;padding:0 .9375em} |
| #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} |
| .hide-on-print{display:none!important} |
| .print-only{display:block!important} |
| .hide-for-print{display:none!important} |
| .show-for-print{display:inherit!important}} |
| </style> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.min.css"> |
| </head> |
| <body id="software-modules" class="book"> |
| <div id="header"> |
| <h1>Software Modules</h1> |
| </div> |
| <div id="content"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div id="toc" class="toc"> |
| <div id="toctitle" class="title">Table of Contents</div> |
| <ul class="sectlevel1"> |
| <li><a href="#_get_rest_v1_softwaremodules">GET /rest/v1/softwaremodules</a></li> |
| <li><a href="#_post_rest_v1_softwaremodules">POST /rest/v1/softwaremodules</a></li> |
| <li><a href="#_delete_rest_v1_softwaremodules_softwaremoduleid">DELETE /rest/v1/softwaremodules/{softwareModuleId}</a></li> |
| <li><a href="#_get_rest_v1_softwaremodules_softwaremoduleid">GET /rest/v1/softwaremodules/{softwareModuleId}</a></li> |
| <li><a href="#_put_rest_v1_softwaremodules_softwaremoduleid">PUT /rest/v1/softwaremodules/{softwareModuleId}</a></li> |
| <li><a href="#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts">GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts</a></li> |
| <li><a href="#_post_rest_v1_softwaremodules_softwaremoduleid_artifacts">POST /rest/v1/softwaremodules/{softwareModuleId}/artifacts</a></li> |
| <li><a href="#_delete_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid">DELETE /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</a></li> |
| <li><a href="#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid">GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</a></li> |
| <li><a href="#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid_download">GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}/download</a></li> |
| <li><a href="#_get_rest_v1_softwaremodules_softwaremoduleid_metadata">GET /rest/v1/softwaremodules/{softwareModuleId}/metadata</a></li> |
| <li><a href="#_post_rest_v1_softwaremodules_softwaremoduleid_metadata">POST /rest/v1/softwaremodules/{softwareModuleId}/metadata</a></li> |
| <li><a href="#_delete_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey">DELETE /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</a></li> |
| <li><a href="#_get_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey">GET /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</a></li> |
| <li><a href="#_put_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey">PUT /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</a></li> |
| <li><a href="#_additional_content">Additional content</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules"><a class="link" href="#_get_rest_v1_softwaremodules">GET /rest/v1/softwaremodules</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes"><a class="link" href="#_implementation_notes">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the GET request of retrieving all softwaremodules within SP. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_get_software_modules"><a class="link" href="#_get_software_modules">Get software modules</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules' -i -X GET</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_parameter"><a class="link" href="#_request_parameter">Request parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules?offset=1&limit=2&sort=version%3ADESC&q=name%3D%3DSM* HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].vendor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].version</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 963 |
| |
| { |
| "content" : [ { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644253220, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644253223, |
| "name" : "os", |
| "description" : "a description", |
| "version" : "1.0", |
| "type" : "os", |
| "vendor" : "Vendor Limited, California", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/113" |
| } |
| }, |
| "id" : 113 |
| }, { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644253227, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644253230, |
| "name" : "application", |
| "description" : "a description", |
| "version" : "1.0", |
| "type" : "application", |
| "vendor" : "Vendor Limited, California", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/114" |
| } |
| }, |
| "id" : 114 |
| } ], |
| "total" : 2, |
| "size" : 2 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses"><a class="link" href="#_error_responses">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_post_rest_v1_softwaremodules"><a class="link" href="#_post_rest_v1_softwaremodules">POST /rest/v1/softwaremodules</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_2"><a class="link" href="#_implementation_notes_2">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the POST request of creating new software modules within SP. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_create_software_modules"><a class="link" href="#_create_software_modules">Create software modules</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules' -i -X POST \ |
| -H 'Content-Type: application/hal+json;charset=UTF-8' \ |
| -d '[ { |
| "vendor" : "vendor1", |
| "name" : "name1", |
| "description" : "description1", |
| "type" : "os", |
| "version" : "version1" |
| }, { |
| "vendor" : "vendor1", |
| "name" : "name3", |
| "description" : "description1", |
| "type" : "application", |
| "version" : "version1" |
| } ]'</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules HTTP/1.1 |
| Content-Length: 261 |
| Content-Type: application/hal+json;charset=UTF-8 |
| Host: management-api.host.com |
| |
| [ { |
| "vendor" : "vendor1", |
| "name" : "name1", |
| "description" : "description1", |
| "type" : "os", |
| "version" : "version1" |
| }, { |
| "vendor" : "vendor1", |
| "name" : "name3", |
| "description" : "description1", |
| "type" : "application", |
| "version" : "version1" |
| } ]</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| <th class="tableblock halign-left valign-top">Mandatory</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]version</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]vendor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The type of the software module identified by its key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].description</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].vendor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].deleted</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].version</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 815 |
| |
| [ { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644217462, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644217462, |
| "name" : "name1", |
| "description" : "description1", |
| "version" : "version1", |
| "type" : "os", |
| "vendor" : "vendor1", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/100" |
| } |
| }, |
| "id" : 100 |
| }, { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644217464, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644217464, |
| "name" : "name3", |
| "description" : "description1", |
| "version" : "version1", |
| "type" : "application", |
| "vendor" : "vendor1", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/101" |
| } |
| }, |
| "id" : 101 |
| } ]</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_2"><a class="link" href="#_error_responses_2">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>409 Conflict</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">E.g. in case an entity is created or modified by another user in another request at the same time. You may retry your modification request.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>415 Unsupported Media Type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request was attempt with a media-type which is not supported by the server for this resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_delete_rest_v1_softwaremodules_softwaremoduleid"><a class="link" href="#_delete_rest_v1_softwaremodules_softwaremoduleid">DELETE /rest/v1/softwaremodules/{softwareModuleId}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_3"><a class="link" href="#_implementation_notes_3">Implementation Notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the DELETE request for a single softwaremodule within SP. Required Permission: DELETE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_delete_software_module"><a class="link" href="#_delete_software_module">Delete software module</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/98' -i -X DELETE</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremodules/98 HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_3"><a class="link" href="#_error_responses_3">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules_softwaremoduleid"><a class="link" href="#_get_rest_v1_softwaremodules_softwaremoduleid">GET /rest/v1/softwaremodules/{softwareModuleId}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_4"><a class="link" href="#_implementation_notes_4">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the GET request of retrieving a single softwaremodule within SP. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_get_software_module"><a class="link" href="#_get_software_module">Get software module</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/102' -i -X GET</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/102 HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">vendor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.artifacts</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of artifacts of given software module.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 759 |
| |
| { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644222552, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644222556, |
| "name" : "os", |
| "description" : "a description", |
| "version" : "1.0", |
| "type" : "os", |
| "vendor" : "Vendor Limited, California", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/102" |
| }, |
| "artifacts" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/102/artifacts" |
| }, |
| "type" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/119" |
| }, |
| "metadata" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/102/metadata?offset=0&limit=50" |
| } |
| }, |
| "id" : 102 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_4"><a class="link" href="#_error_responses_4">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_put_rest_v1_softwaremodules_softwaremoduleid"><a class="link" href="#_put_rest_v1_softwaremodules_softwaremoduleid">PUT /rest/v1/softwaremodules/{softwareModuleId}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_5"><a class="link" href="#_implementation_notes_5">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the PUT request for a single softwaremodule within SP. Required Permission: UPDATE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_update_software_module"><a class="link" href="#_update_software_module">Update software module</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/99' -i -X PUT \ |
| -H 'Content-Type: application/hal+json;charset=UTF-8' \ |
| -d '{ |
| "vendor" : "another Vendor", |
| "description" : "a new description" |
| }'</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/softwaremodules/99 HTTP/1.1 |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 72 |
| Host: management-api.host.com |
| |
| { |
| "vendor" : "another Vendor", |
| "description" : "a new description" |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| <th class="tableblock halign-left valign-top">Mandatory</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">vendor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">vendor</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.artifacts</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of artifacts of given software module.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Length: 747 |
| Content-Type: application/hal+json;charset=UTF-8 |
| |
| { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644212345, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644212357, |
| "name" : "os", |
| "description" : "a new description", |
| "version" : "1.0", |
| "type" : "os", |
| "vendor" : "another Vendor", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/99" |
| }, |
| "artifacts" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/artifacts" |
| }, |
| "type" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/112" |
| }, |
| "metadata" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/metadata?offset=0&limit=50" |
| } |
| }, |
| "id" : 99 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_5"><a class="link" href="#_error_responses_5">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>409 Conflict</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">E.g. in case an entity is created or modified by another user in another request at the same time. You may retry your modification request.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>415 Unsupported Media Type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request was attempt with a media-type which is not supported by the server for this resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules_softwaremoduleid_artifacts"><a class="link" href="#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts">GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_6"><a class="link" href="#_implementation_notes_6">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the GET request of retrieving all meta data of artifacts assigned to a software module. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_list_artifacts_metadata"><a class="link" href="#_list_artifacts_metadata">List artifacts metadata</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_6"><a class="link" href="#_curl_6">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/112/artifacts' -i -X GET</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/112/artifacts HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].size</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Size of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].hashes.md5</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].hashes.sha1</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[].providedFilename</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 444 |
| |
| [ { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644248143, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644248143, |
| "hashes" : { |
| "sha1" : "2d86c2a659e364e9abba49ea6ffcd53dd5559f05", |
| "md5" : "0d1b08c34858921bc7c662b228acb7ba" |
| }, |
| "providedFilename" : "file1", |
| "size" : 3, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/112/artifacts/47" |
| } |
| }, |
| "id" : 47 |
| } ]</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_6"><a class="link" href="#_error_responses_6">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_post_rest_v1_softwaremodules_softwaremoduleid_artifacts"><a class="link" href="#_post_rest_v1_softwaremodules_softwaremoduleid_artifacts">POST /rest/v1/softwaremodules/{softwareModuleId}/artifacts</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_7"><a class="link" href="#_implementation_notes_7">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_upload_artifact"><a class="link" href="#_upload_artifact">Upload artifact</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/97/artifacts' -i -X POST \ |
| -H 'Content-Type: multipart/form-data' \ |
| -F 'file=@origFilename'</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules/97/artifacts HTTP/1.1 |
| Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Host: management-api.host.com |
| |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Content-Disposition: form-data; name=file; filename=origFilename |
| |
| ???? |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filename</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>file</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Binary of file.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>md5sum</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sha1sum</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_parameter_example_2"><a class="link" href="#_request_parameter_example_2">Request parameter example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules/111/artifacts HTTP/1.1 |
| Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Host: management-api.host.com |
| |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Content-Disposition: form-data; name=filename |
| |
| filename |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Content-Disposition: form-data; name=file |
| |
| s |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Content-Disposition: form-data; name=md5sum |
| |
| md5sum |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Content-Disposition: form-data; name=sha1sum |
| |
| sha1sum |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm |
| Content-Disposition: form-data; name=file; filename=origFilename |
| |
| ??? |
| --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_201_2"><a class="link" href="#_response_status_201_2">Response (Status 201)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Size of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.download</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Download link of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">hashes.md5</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">hashes.sha1</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">providedFilename</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created |
| Content-Length: 570 |
| Content-Type: application/hal+json;charset=UTF-8 |
| |
| { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644202166, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644202166, |
| "hashes" : { |
| "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb", |
| "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0" |
| }, |
| "providedFilename" : "origFilename", |
| "size" : 4, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/97/artifacts/46" |
| }, |
| "download" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/97/artifacts/46/download" |
| } |
| }, |
| "id" : 46 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_7"><a class="link" href="#_error_responses_7">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>415 Unsupported Media Type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request was attempt with a media-type which is not supported by the server for this resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_delete_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid"><a class="link" href="#_delete_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid">DELETE /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_8"><a class="link" href="#_implementation_notes_8">Implementation Notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the DELETE request for a single SoftwareModule within SP. Required Permission: DELETE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_delete_arifact"><a class="link" href="#_delete_arifact">Delete arifact</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/117/artifacts/50' -i -X DELETE</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremodules/117/artifacts/50 HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">artifactId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_8"><a class="link" href="#_error_responses_8">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid"><a class="link" href="#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid">GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_9"><a class="link" href="#_implementation_notes_9">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the GET request of retrieving a single Artifact meta data request. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_get_artifact_metadata"><a class="link" href="#_get_artifact_metadata">Get artifact metadata</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_9"><a class="link" href="#_curl_9">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/115/artifacts/48' -i -X GET</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/115/artifacts/48 HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_7"><a class="link" href="#_request_path_parameter_7">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">artifactId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Size of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">hashes.md5</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">hashes.sha1</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">providedFilename</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">_links.download</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Download link of the artifact.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 565 |
| |
| { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644258317, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644258317, |
| "hashes" : { |
| "sha1" : "8b71973e835cd0718827238b1cf89f0079e44dae", |
| "md5" : "a90218782025c48e09ba0436cf30d029" |
| }, |
| "providedFilename" : "file1", |
| "size" : 5, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/115/artifacts/48" |
| }, |
| "download" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/115/artifacts/48/download" |
| } |
| }, |
| "id" : 48 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_9"><a class="link" href="#_error_responses_9">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid_download"><a class="link" href="#_get_rest_v1_softwaremodules_softwaremoduleid_artifacts_artifactid_download">GET /rest/v1/softwaremodules/{softwareModuleId}/artifacts/{artifactId}/download</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_10"><a class="link" href="#_implementation_notes_10">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Handles the GET request for downloading an artifact. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_download_artifact"><a class="link" href="#_download_artifact">Download artifact</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_10"><a class="link" href="#_curl_10">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/116/artifacts/49/download' -i -X GET \ |
| -H 'Accept: application/octet-stream'</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_10"><a class="link" href="#_request_url_10">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/116/artifacts/49/download HTTP/1.1 |
| Accept: application/octet-stream |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_8"><a class="link" href="#_request_path_parameter_8">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">artifactId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_example_10"><a class="link" href="#_response_example_10">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Last-Modified: Thu, 01 Aug 2019 07:24:23 GMT |
| Accept-Ranges: bytes |
| Content-Range: bytes 0-2/3 |
| Content-Type: application/octet-stream |
| Content-Disposition: attachment;filename=file1 |
| Content-Length: 3 |
| ETag: 2d86c2a659e364e9abba49ea6ffcd53dd5559f05 |
| |
| ???</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_10"><a class="link" href="#_error_responses_10">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules_softwaremoduleid_metadata"><a class="link" href="#_get_rest_v1_softwaremodules_softwaremoduleid_metadata">GET /rest/v1/softwaremodules/{softwareModuleId}/metadata</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_11"><a class="link" href="#_implementation_notes_11">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Get a paged list of meta data for a software module. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_get_a_paged_list_of_metadata"><a class="link" href="#_get_a_paged_list_of_metadata">Get a paged list of metadata</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_11"><a class="link" href="#_curl_11">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/126/metadata' -i -X GET</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_11"><a class="link" href="#_request_url_11">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/126/metadata HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_9"><a class="link" href="#_request_path_parameter_9">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_query_parameter_2"><a class="link" href="#_request_query_parameter_2">Request query parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_parameter_example_3"><a class="link" href="#_request_parameter_example_3">Request parameter example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/123/metadata?offset=1&limit=2&sort=key%3ADESC&q=key%3D%3Dknown* HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_9"><a class="link" href="#_response_status_200_9">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_8"><a class="link" href="#_response_fields_8">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].key</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].value</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">content[].targetVisible</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_11"><a class="link" href="#_response_example_11">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Length: 405 |
| Content-Type: application/hal+json;charset=UTF-8 |
| |
| { |
| "content" : [ { |
| "key" : "knownKey0", |
| "value" : "knownValue0", |
| "targetVisible" : false |
| }, { |
| "key" : "knownKey1", |
| "value" : "knownValue1", |
| "targetVisible" : false |
| }, { |
| "key" : "knownKey2", |
| "value" : "knownValue2", |
| "targetVisible" : false |
| }, { |
| "key" : "knownKey3", |
| "value" : "knownValue3", |
| "targetVisible" : false |
| } ], |
| "total" : 4, |
| "size" : 4 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_11"><a class="link" href="#_error_responses_11">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_post_rest_v1_softwaremodules_softwaremoduleid_metadata"><a class="link" href="#_post_rest_v1_softwaremodules_softwaremoduleid_metadata">POST /rest/v1/softwaremodules/{softwareModuleId}/metadata</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_12"><a class="link" href="#_implementation_notes_12">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Create a list of meta data entries Required Permission: UPDATE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_create_a_list_of_metadata_entries"><a class="link" href="#_create_a_list_of_metadata_entries">Create a list of metadata entries</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_12"><a class="link" href="#_curl_12">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/105/metadata' -i -X POST \ |
| -H 'Content-Type: application/hal+json;charset=UTF-8' \ |
| -d '[ { |
| "value" : "knownValue1", |
| "key" : "knownKey1" |
| }, { |
| "targetVisible" : true, |
| "value" : "knownValue2", |
| "key" : "knownKey2" |
| } ]'</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_12"><a class="link" href="#_request_url_12">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules/105/metadata HTTP/1.1 |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 136 |
| Host: management-api.host.com |
| |
| [ { |
| "value" : "knownValue1", |
| "key" : "knownKey1" |
| }, { |
| "targetVisible" : true, |
| "value" : "knownValue2", |
| "key" : "knownKey2" |
| } ]</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_10"><a class="link" href="#_request_path_parameter_10">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| <th class="tableblock halign-left valign-top">Mandatory</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]value</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]targetVisible</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_201_3"><a class="link" href="#_response_status_201_3">Response (Status 201)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_9"><a class="link" href="#_response_fields_9">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]value</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">[]targetVisible</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_12"><a class="link" href="#_response_example_12">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created |
| Content-Length: 163 |
| Content-Type: application/hal+json;charset=UTF-8 |
| |
| [ { |
| "key" : "knownKey1", |
| "value" : "knownValue1", |
| "targetVisible" : false |
| }, { |
| "key" : "knownKey2", |
| "value" : "knownValue2", |
| "targetVisible" : true |
| } ]</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_12"><a class="link" href="#_error_responses_12">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>409 Conflict</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">E.g. in case an entity is created or modified by another user in another request at the same time. You may retry your modification request.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>415 Unsupported Media Type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request was attempt with a media-type which is not supported by the server for this resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_delete_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey"><a class="link" href="#_delete_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey">DELETE /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_13"><a class="link" href="#_implementation_notes_13">Implementation Notes</a></h3> |
| <div class="paragraph"> |
| <p>Delete a single meta data. Required Permission: UPDATE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_deleting_a_single_metadata"><a class="link" href="#_deleting_a_single_metadata">Deleting a single metadata</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_13"><a class="link" href="#_curl_13">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/129/metadata/knownKey' -i -X DELETE</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_13"><a class="link" href="#_request_url_13">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremodules/129/metadata/knownKey HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_11"><a class="link" href="#_request_path_parameter_11">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">{metadataKey</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_10"><a class="link" href="#_response_status_200_10">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_example_13"><a class="link" href="#_response_example_13">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_13"><a class="link" href="#_error_responses_13">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_get_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey"><a class="link" href="#_get_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey">GET /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_14"><a class="link" href="#_implementation_notes_14">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Get a single meta data value for a meta data key. Required Permission: READ_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_get_a_single_metadata_value"><a class="link" href="#_get_a_single_metadata_value">Get a single metadata value</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_14"><a class="link" href="#_curl_14">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/120/metadata/knownKey' -i -X GET</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_14"><a class="link" href="#_request_url_14">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/120/metadata/knownKey HTTP/1.1 |
| Host: management-api.host.com</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_12"><a class="link" href="#_request_path_parameter_12">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">metadataKey</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_11"><a class="link" href="#_response_status_200_11">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_10"><a class="link" href="#_response_fields_10">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">targetVisible</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_14"><a class="link" href="#_response_example_14">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Length: 77 |
| Content-Type: application/hal+json;charset=UTF-8 |
| |
| { |
| "key" : "knownKey", |
| "value" : "knownValue", |
| "targetVisible" : false |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_14"><a class="link" href="#_error_responses_14">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_put_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey"><a class="link" href="#_put_rest_v1_softwaremodules_softwaremoduleid_metadata_metadatakey">PUT /rest/v1/softwaremodules/{softwareModuleId}/metadata/{metadataKey}</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_implementation_notes_15"><a class="link" href="#_implementation_notes_15">Implementation notes</a></h3> |
| <div class="paragraph"> |
| <p>Update a single meta data value for speficic key. Required Permission: UPDATE_REPOSITORY</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_updating_a_single_metadata_value"><a class="link" href="#_updating_a_single_metadata_value">Updating a single metadata value</a></h3> |
| <div class="sect3"> |
| <h4 id="_curl_15"><a class="link" href="#_curl_15">CURL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/110/metadata/knownKey' -i -X PUT \ |
| -H 'Content-Type: application/hal+json;charset=UTF-8' \ |
| -d '{ |
| "targetVisible" : true, |
| "value" : "valueForUpdate", |
| "key" : "knownKey" |
| }'</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_url_15"><a class="link" href="#_request_url_15">Request URL</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/softwaremodules/110/metadata/knownKey HTTP/1.1 |
| Content-Type: application/hal+json;charset=UTF-8 |
| Content-Length: 80 |
| Host: management-api.host.com |
| |
| { |
| "targetVisible" : true, |
| "value" : "valueForUpdate", |
| "key" : "knownKey" |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_path_parameter_13"><a class="link" href="#_request_path_parameter_13">Request path parameter</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">metadataKey</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| <col style="width: 20%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| <th class="tableblock halign-left valign-top">Mandatory</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">targetVisible</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_response_status_200_12"><a class="link" href="#_response_status_200_12">Response (Status 200)</a></h3> |
| <div class="sect3"> |
| <h4 id="_response_fields_11"><a class="link" href="#_response_fields_11">Response fields</a></h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| <col style="width: 25%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Path</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Allowed Values</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">targetVisible</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_response_example_15"><a class="link" href="#_response_example_15">Response example</a></h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK |
| Content-Length: 747 |
| Content-Type: application/hal+json;charset=UTF-8 |
| |
| { |
| "createdBy" : "bumlux", |
| "createdAt" : 1564644212345, |
| "lastModifiedBy" : "bumlux", |
| "lastModifiedAt" : 1564644212357, |
| "name" : "os", |
| "description" : "a new description", |
| "version" : "1.0", |
| "type" : "os", |
| "vendor" : "another Vendor", |
| "deleted" : false, |
| "_links" : { |
| "self" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/99" |
| }, |
| "artifacts" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/artifacts" |
| }, |
| "type" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/112" |
| }, |
| "metadata" : { |
| "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/metadata?offset=0&limit=50" |
| } |
| }, |
| "id" : 99 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_error_responses_15"><a class="link" href="#_error_responses_15">Error responses</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| <col style="width: 33%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">HTTP Status Code</th> |
| <th class="tableblock halign-left valign-top">Reason</th> |
| <th class="tableblock halign-left valign-top">Response Model</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>400 Bad Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Bad Request - e.g. invalid parameters</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>401 Unauthorized</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The request requires user authentication.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>403 Forbidden</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>404 Not Found</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Not Found Software Module.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">See <a href="#error-body">Error body</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>405 Method Not Allowed</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The http request method is not allowed on the resource.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>406 Not Acceptable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">In case accept header is specified and not application/json.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>429 Too Many Request</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Too many requests. The server will refuse further attempts and the client has to wait another second.</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_additional_content"><a class="link" href="#_additional_content">Additional content</a></h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="error-body"><a class="link" href="#error-body">Error body</a></h3> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-http" data-lang="http">{ |
| "errorCode": "string", |
| "exceptionClass": "string", |
| "message": "string", |
| "parameters": [ |
| "string" |
| ] |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_field_description"><a class="link" href="#_field_description">Field description</a></h3> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Field</strong></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Description</strong></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">errorCode</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A error code/key set by server</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">exceptionClass</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The involved exceptionClass</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">message</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">An error message set by the server</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">parameters</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">A list of parameters</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer-text"> |
| Last updated 2018-06-11 15:04:18 +02:00 |
| </div> |
| </div> |
| </body> |
| </html> |
