docs/offeredapis/serviceCatalog/documentation.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="UTF-8">
   5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <meta name="generator" content="Asciidoctor 1.5.6.1">
   8 <title>API ServiceCatalog</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  10 <style>
  11 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12 /* Remove comment around @import statement below when using as a custom stylesheet */
  13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15 audio,canvas,video{display:inline-block}
  16 audio:not([controls]){display:none;height:0}
  17 [hidden],template{display:none}
  18 script{display:none!important}
  19 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  20 a{background:transparent}
  21 a:focus{outline:thin dotted}
  22 a:active,a:hover{outline:0}
  23 h1{font-size:2em;margin:.67em 0}
  24 abbr[title]{border-bottom:1px dotted}
  25 b,strong{font-weight:bold}
  26 dfn{font-style:italic}
  27 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  28 mark{background:#ff0;color:#000}
  29 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  30 pre{white-space:pre-wrap}
  31 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  32 small{font-size:80%}
  33 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  34 sup{top:-.5em}
  35 sub{bottom:-.25em}
  36 img{border:0}
  37 svg:not(:root){overflow:hidden}
  38 figure{margin:0}
  39 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  40 legend{border:0;padding:0}
  41 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  42 button,input{line-height:normal}
  43 button,select{text-transform:none}
  44 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  45 button[disabled],html input[disabled]{cursor:default}
  46 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  47 input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
  48 input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
  49 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  50 textarea{overflow:auto;vertical-align:top}
  51 table{border-collapse:collapse;border-spacing:0}
  52 *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  53 html,body{font-size:100%}
  54 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  55 a:hover{cursor:pointer}
  56 img,object,embed{max-width:100%;height:auto}
  57 object,embed{height:100%}
  58 img{-ms-interpolation-mode:bicubic}
  59 .left{float:left!important}
  60 .right{float:right!important}
  61 .text-left{text-align:left!important}
  62 .text-right{text-align:right!important}
  63 .text-center{text-align:center!important}
  64 .text-justify{text-align:justify!important}
  65 .hide{display:none}
  66 img,object,svg{display:inline-block;vertical-align:middle}
  67 textarea{height:auto;min-height:50px}
  68 select{width:100%}
  69 .center{margin-left:auto;margin-right:auto}
  70 .spread{width:100%}
  71 p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
  72 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  73 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  74 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  75 a:hover,a:focus{color:#1d4b8f}
  76 a img{border:none}
  77 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  78 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  79 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  80 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  81 h1{font-size:2.125em}
  82 h2{font-size:1.6875em}
  83 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  84 h4,h5{font-size:1.125em}
  85 h6{font-size:1em}
  86 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  87 em,i{font-style:italic;line-height:inherit}
  88 strong,b{font-weight:bold;line-height:inherit}
  89 small{font-size:60%;line-height:inherit}
  90 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  91 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  92 ul,ol{margin-left:1.5em}
  93 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  94 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  95 ul.square{list-style-type:square}
  96 ul.circle{list-style-type:circle}
  97 ul.disc{list-style-type:disc}
  98 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  99 dl dt{margin-bottom:.3125em;font-weight:bold}
 100 dl dd{margin-bottom:1.25em}
 101 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
 102 abbr{text-transform:none}
 103 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
 104 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
 105 blockquote cite:before{content:"\2014 \0020"}
 106 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
 107 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 108 @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 109 h1{font-size:2.75em}
 110 h2{font-size:2.3125em}
 111 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 112 h4{font-size:1.4375em}}
 113 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
 114 table thead,table tfoot{background:#f7f8f7;font-weight:bold}
 115 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 116 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 117 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
 118 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
 119 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 120 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 121 .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
 122 .clearfix:after,.float-group:after{clear:both}
 123 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
 124 *:not(pre)>code.nobreak{word-wrap:normal}
 125 *:not(pre)>code.nowrap{white-space:nowrap}
 126 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
 127 em em{font-style:normal}
 128 strong strong{font-weight:400}
 129 .keyseq{color:rgba(51,51,51,.8)}
 130 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 131 .keyseq kbd:first-child{margin-left:0}
 132 .keyseq kbd:last-child{margin-right:0}
 133 .menuseq,.menuref{color:#000}
 134 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 135 .menuseq{word-spacing:-.02em}
 136 .menuseq b.caret{font-size:1.25em;line-height:.8}
 137 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 138 b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
 139 b.button:before{content:"[";padding:0 3px 0 2px}
 140 b.button:after{content:"]";padding:0 2px 0 3px}
 141 p a>code:hover{color:rgba(0,0,0,.9)}
 142 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 143 #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
 144 #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
 145 #content{margin-top:1.25em}
 146 #content:before{content:none}
 147 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 148 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
 149 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
 150 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
 151 #header .details span:first-child{margin-left:-.125em}
 152 #header .details span.email a{color:rgba(0,0,0,.85)}
 153 #header .details br{display:none}
 154 #header .details br+span:before{content:"\00a0\2013\00a0"}
 155 #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 156 #header .details br+span#revremark:before{content:"\00a0|\00a0"}
 157 #header #revnumber{text-transform:capitalize}
 158 #header #revnumber:after{content:"\00a0"}
 159 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 160 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
 161 #toc>ul{margin-left:.125em}
 162 #toc ul.sectlevel0>li>a{font-style:italic}
 163 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 164 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 165 #toc li{line-height:1.3334;margin-top:.3334em}
 166 #toc a{text-decoration:none}
 167 #toc a:active{text-decoration:underline}
 168 #toctitle{color:#7a2518;font-size:1.2em}
 169 @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
 170 body.toc2{padding-left:15em;padding-right:0}
 171 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 172 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 173 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 174 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 175 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 176 body.toc2.toc-right{padding-left:0;padding-right:15em}
 177 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
 178 @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 179 #toc.toc2{width:20em}
 180 #toc.toc2 #toctitle{font-size:1.375em}
 181 #toc.toc2>ul{font-size:.95em}
 182 #toc.toc2 ul ul{padding-left:1.25em}
 183 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 184 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 185 #content #toc>:first-child{margin-top:0}
 186 #content #toc>:last-child{margin-bottom:0}
 187 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
 188 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
 189 .sect1{padding-bottom:.625em}
 190 @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
 191 .sect1+.sect1{border-top:1px solid #efefed}
 192 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 193 #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 194 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 195 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 196 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 197 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 198 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 199 table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
 200 .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
 201 table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
 202 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 203 .admonitionblock>table td.icon{text-align:center;width:80px}
 204 .admonitionblock>table td.icon img{max-width:initial}
 205 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 206 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
 207 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 208 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
 209 .exampleblock>.content>:first-child{margin-top:0}
 210 .exampleblock>.content>:last-child{margin-bottom:0}
 211 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 212 .sidebarblock>:first-child{margin-top:0}
 213 .sidebarblock>:last-child{margin-bottom:0}
 214 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 215 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 216 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
 217 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
 218 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
 219 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
 220 @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
 221 @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
 222 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
 223 .listingblock pre.highlightjs{padding:0}
 224 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
 225 .listingblock pre.prettyprint{border-width:0}
 226 .listingblock>.content{position:relative}
 227 .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
 228 .listingblock:hover code[data-lang]:before{display:block}
 229 .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
 230 .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
 231 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 232 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
 233 table.pyhltable td.code{padding-left:.75em;padding-right:0}
 234 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
 235 pre.pygments .lineno{display:inline-block;margin-right:.25em}
 236 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
 237 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 238 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
 239 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 240 .quoteblock blockquote{margin:0;padding:0;border:0}
 241 .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 242 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 243 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
 244 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
 245 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
 246 .quoteblock .quoteblock blockquote:before{display:none}
 247 .verseblock{margin:0 1em 1.25em 1em}
 248 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 249 .verseblock pre strong{font-weight:400}
 250 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 251 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 252 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 253 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 254 .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
 255 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
 256 .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
 257 table.tableblock{max-width:100%;border-collapse:separate}
 258 table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
 259 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 260 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
 261 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
 262 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
 263 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px 0}
 264 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0 0}
 265 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
 266 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
 267 table.frame-all{border-width:1px}
 268 table.frame-sides{border-width:0 1px}
 269 table.frame-topbot{border-width:1px 0}
 270 th.halign-left,td.halign-left{text-align:left}
 271 th.halign-right,td.halign-right{text-align:right}
 272 th.halign-center,td.halign-center{text-align:center}
 273 th.valign-top,td.valign-top{vertical-align:top}
 274 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 275 th.valign-middle,td.valign-middle{vertical-align:middle}
 276 table thead th,table tfoot th{font-weight:bold}
 277 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
 278 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 279 p.tableblock>code:only-child{background:none;padding:0}
 280 p.tableblock{font-size:1em}
 281 td>div.verse{white-space:pre}
 282 ol{margin-left:1.75em}
 283 ul li ol{margin-left:1.5em}
 284 dl dd{margin-left:1.125em}
 285 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 286 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 287 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 288 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 289 ul.unstyled,ol.unstyled{margin-left:0}
 290 ul.checklist{margin-left:.625em}
 291 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 292 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
 293 ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
 294 ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
 295 ul.inline>li>*{display:block}
 296 .unstyled dl dt{font-weight:400;font-style:normal}
 297 ol.arabic{list-style-type:decimal}
 298 ol.decimal{list-style-type:decimal-leading-zero}
 299 ol.loweralpha{list-style-type:lower-alpha}
 300 ol.upperalpha{list-style-type:upper-alpha}
 301 ol.lowerroman{list-style-type:lower-roman}
 302 ol.upperroman{list-style-type:upper-roman}
 303 ol.lowergreek{list-style-type:lower-greek}
 304 .hdlist>table,.colist>table{border:0;background:none}
 305 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 306 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 307 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 308 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 309 .colist>table tr>td:first-of-type{padding:.4em .75em 0 .75em;line-height:1;vertical-align:top}
 310 .colist>table tr>td:first-of-type img{max-width:initial}
 311 .colist>table tr>td:last-of-type{padding:.25em 0}
 312 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
 313 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
 314 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
 315 .imageblock>.title{margin-bottom:0}
 316 .imageblock.thumb,.imageblock.th{border-width:6px}
 317 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 318 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 319 .image.left{margin-right:.625em}
 320 .image.right{margin-left:.625em}
 321 a.image{text-decoration:none;display:inline-block}
 322 a.image object{pointer-events:none}
 323 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 324 sup.footnote a,sup.footnoteref a{text-decoration:none}
 325 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 326 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 327 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
 328 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
 329 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
 330 #footnotes .footnote:last-of-type{margin-bottom:0}
 331 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 332 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
 333 .gist .file-data>table td.line-data{width:99%}
 334 div.unbreakable{page-break-inside:avoid}
 335 .big{font-size:larger}
 336 .small{font-size:smaller}
 337 .underline{text-decoration:underline}
 338 .overline{text-decoration:overline}
 339 .line-through{text-decoration:line-through}
 340 .aqua{color:#00bfbf}
 341 .aqua-background{background-color:#00fafa}
 342 .black{color:#000}
 343 .black-background{background-color:#000}
 344 .blue{color:#0000bf}
 345 .blue-background{background-color:#0000fa}
 346 .fuchsia{color:#bf00bf}
 347 .fuchsia-background{background-color:#fa00fa}
 348 .gray{color:#606060}
 349 .gray-background{background-color:#7d7d7d}
 350 .green{color:#006000}
 351 .green-background{background-color:#007d00}
 352 .lime{color:#00bf00}
 353 .lime-background{background-color:#00fa00}
 354 .maroon{color:#600000}
 355 .maroon-background{background-color:#7d0000}
 356 .navy{color:#000060}
 357 .navy-background{background-color:#00007d}
 358 .olive{color:#606000}
 359 .olive-background{background-color:#7d7d00}
 360 .purple{color:#600060}
 361 .purple-background{background-color:#7d007d}
 362 .red{color:#bf0000}
 363 .red-background{background-color:#fa0000}
 364 .silver{color:#909090}
 365 .silver-background{background-color:#bcbcbc}
 366 .teal{color:#006060}
 367 .teal-background{background-color:#007d7d}
 368 .white{color:#bfbfbf}
 369 .white-background{background-color:#fafafa}
 370 .yellow{color:#bfbf00}
 371 .yellow-background{background-color:#fafa00}
 372 span.icon>.fa{cursor:default}
 373 a span.icon>.fa{cursor:inherit}
 374 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 375 .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
 376 .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 377 .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
 378 .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
 379 .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
 380 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 381 .conum[data-value] *{color:#fff!important}
 382 .conum[data-value]+b{display:none}
 383 .conum[data-value]:after{content:attr(data-value)}
 384 pre .conum[data-value]{position:relative;top:-.125em}
 385 b.conum *{color:inherit!important}
 386 .conum:not([data-value]):empty{display:none}
 387 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 388 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
 389 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 390 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
 391 p{margin-bottom:1.25rem}
 392 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 393 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 394 .print-only{display:none!important}
 395 @media print{@page{margin:1.25cm .75cm}
 396 *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
 397 a{color:inherit!important;text-decoration:underline!important}
 398 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 399 a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 400 abbr[title]:after{content:" (" attr(title) ")"}
 401 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 402 thead{display:table-header-group}
 403 svg{max-width:100%}
 404 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 405 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 406 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 407 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
 408 .sect1{padding-bottom:0!important}
 409 .sect1+.sect1{border:0!important}
 410 #header>h1:first-child{margin-top:1.25rem}
 411 body.book #header{text-align:center}
 412 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
 413 body.book #header .details{border:0!important;display:block;padding:0!important}
 414 body.book #header .details span:first-child{margin-left:0!important}
 415 body.book #header .details br{display:block}
 416 body.book #header .details br+span:before{content:none!important}
 417 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 418 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 419 .listingblock code[data-lang]:before{display:block}
 420 #footer{background:none!important;padding:0 .9375em}
 421 #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
 422 .hide-on-print{display:none!important}
 423 .print-only{display:block!important}
 424 .hide-for-print{display:none!important}
 425 .show-for-print{display:inherit!important}}
 426 </style>
 427 </head>
 428 <body class="article toc2 toc-left">
 429 <div id="header">
 430 <h1>API ServiceCatalog</h1>
 431 <div id="toc" class="toc2">
 432 <div id="toctitle">Table of Contents</div>
 433 <ul class="sectlevel1">
 434 <li><a href="#_overview">Overview</a>
 435 <ul class="sectlevel2">
 436 <li><a href="#_api_url">Api URL</a></li>
 437 <li><a href="#_version_information">Version information</a></li>
 438 <li><a href="#_uri_scheme">URI scheme</a></li>
 439 <li><a href="#_tags">Tags</a></li>
 440 <li><a href="#_produces">Produces</a></li>
 441 </ul>
 442 </li>
 443 <li><a href="#_paths">Resources</a>
 444 <ul class="sectlevel2">
 445 <li><a href="#_servicespecification_resource">ServiceSpecification</a></li>
 446 </ul>
 447 </li>
 448 <li><a href="#_definitions">Definitions</a>
 449 <ul class="sectlevel2">
 450 <li><a href="#_attachment">Attachment</a></li>
 451 <li><a href="#_distributionstatus">DistributionStatus</a></li>
 452 <li><a href="#_errorrepresentation">ErrorRepresentation</a></li>
 453 <li><a href="#_lifecyclestatusvalues">LifecycleStatusValues</a></li>
 454 <li><a href="#_relatedpartyref">RelatedPartyRef</a></li>
 455 <li><a href="#_resourcespecificationref">ResourceSpecificationRef</a></li>
 456 <li><a href="#_servicespeccharacteristic">ServiceSpecCharacteristic</a></li>
 457 <li><a href="#_servicespeccharacteristicvalue">ServiceSpecCharacteristicValue</a></li>
 458 <li><a href="#_servicespecification">ServiceSpecification</a></li>
 459 <li><a href="#_targetserviceschemaref">TargetServiceSchemaRef</a></li>
 460 <li><a href="#_timeperiod">TimePeriod</a></li>
 461 </ul>
 462 </li>
 463 </ul>
 464 </div>
 465 </div>
 466 <div id="content">
 467 <div class="sect1">
 468 <h2 id="_overview">Overview</h2>
 469 <div class="sectionbody">
 470 <div class="sect2">
 471 <h3 id="_api_url">Api URL</h3>
 472 <div class="paragraph">
 473 <p><a href="https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json">Swagger UI</a></p>
 474 </div>
 475 <div class="paragraph">
 476 <p><a href="https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&amp;src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&amp;noCache=995303.0">plant UML UI</a></p>
 477 </div>
 478 <div class="paragraph">
 479 <p>serviceCatalog API designed for ONAP Beijing Release.
 480 This API is build from TMF open API17.5.
 481 Only operation GET (by id &amp; byList) for resource serviceSpecification is available</p>
 482 </div>
 483 </div>
 484 <div class="sect2">
 485 <h3 id="_version_information">Version information</h3>
 486 <div class="paragraph">
 487 <p><em>Version</em> : 3.0.0_inProgress</p>
 488 </div>
 489 </div>
 490 <div class="sect2">
 491 <h3 id="_uri_scheme">URI scheme</h3>
 492 <div class="paragraph">
 493 <p><em>Host</em> : serverRoot<br>
 494 <em>BasePath</em> : /nbi/api/v3<br>
 495 <em>Schemes</em> : HTTPS</p>
 496 </div>
 497 </div>
 498 <div class="sect2">
 499 <h3 id="_tags">Tags</h3>
 500 <div class="ulist">
 501 <ul>
 502 <li>
 503 <p>ServiceSpecification</p>
 504 </li>
 505 </ul>
 506 </div>
 507 </div>
 508 <div class="sect2">
 509 <h3 id="_produces">Produces</h3>
 510 <div class="ulist">
 511 <ul>
 512 <li>
 513 <p><code>application/json;charset=utf-8</code></p>
 514 </li>
 515 </ul>
 516 </div>
 517 </div>
 518 </div>
 519 </div>
 520 <div class="sect1">
 521 <h2 id="_paths">Resources</h2>
 522 <div class="sectionbody">
 523 <div class="sect2">
 524 <h3 id="_servicespecification_resource">ServiceSpecification</h3>
 525 <div class="sect3">
 526 <h4 id="_servicespecificationfind">List service specifications</h4>
 527 <div class="literalblock">
 528 <div class="content">
 529 <pre>GET /serviceSpecification</pre>
 530 </div>
 531 </div>
 532 <div class="sect4">
 533 <h5 id="_description">Description</h5>
 534 <div class="paragraph">
 535 <p>This operation returns service specifications from a catalog.
 536 Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering
 537 Fields attribute could be used to filter attributes retrieved</p>
 538 </div>
 539 <div class="paragraph">
 540 <p>Specific business errors for current operation will be encapsulated in</p>
 541 </div>
 542 <div class="paragraph">
 543 <p>HTTP Response 422 Unprocessable entity</p>
 544 </div>
 545 </div>
 546 <div class="sect4">
 547 <h5 id="_parameters">Parameters</h5>
 548 <table class="tableblock frame-all grid-all spread">
 549 <colgroup>
 550 <col style="width: 11.1111%;">
 551 <col style="width: 16.6666%;">
 552 <col style="width: 50%;">
 553 <col style="width: 22.2223%;">
 554 </colgroup>
 555 <thead>
 556 <tr>
 557 <th class="tableblock halign-left valign-middle">Type</th>
 558 <th class="tableblock halign-left valign-middle">Name</th>
 559 <th class="tableblock halign-left valign-middle">Description</th>
 560 <th class="tableblock halign-left valign-middle">Schema</th>
 561 </tr>
 562 </thead>
 563 <tbody>
 564 <tr>
 565 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 566 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
 567 <em>optional</em></p></td>
 568 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Category (filter)</p></td>
 569 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 570 </tr>
 571 <tr>
 572 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 573 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>distributionStatus</strong><br>
 574 <em>optional</em></p></td>
 575 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service distribution status (filter)</p></td>
 576 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 577 </tr>
 578 <tr>
 579 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 580 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br>
 581 <em>optional</em></p></td>
 582 <td class="tableblock halign-left valign-middle"><p class="tableblock">Field selection - used to filtering the attributes to be retreived</p></td>
 583 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 584 </tr>
 585 </tbody>
 586 </table>
 587 </div>
 588 <div class="sect4">
 589 <h5 id="_responses">Responses</h5>
 590 <table class="tableblock frame-all grid-all spread">
 591 <colgroup>
 592 <col style="width: 10%;">
 593 <col style="width: 70%;">
 594 <col style="width: 20%;">
 595 </colgroup>
 596 <thead>
 597 <tr>
 598 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 599 <th class="tableblock halign-left valign-middle">Description</th>
 600 <th class="tableblock halign-left valign-middle">Schema</th>
 601 </tr>
 602 </thead>
 603 <tbody>
 604 <tr>
 605 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 606 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 607 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicespecification">ServiceSpecification</a> &gt; array</p></td>
 608 </tr>
 609 <tr>
 610 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 611 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 612 <p class="tableblock">List of supported error codes:
 613 - 20: Invalid URL parameter value
 614 - 21: Missing body
 615 - 22: Invalid body
 616 - 23: Missing body field
 617 - 24: Invalid body field
 618 - 25: Missing header
 619 - 26: Invalid header value
 620 - 27: Missing query-string parameter
 621 - 28: Invalid query-string parameter value</p></td>
 622 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 623 </tr>
 624 <tr>
 625 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 626 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 627 <p class="tableblock">List of supported error codes:
 628 - 40: Missing credentials
 629 - 41: Invalid credentials
 630 - 42: Expired credentials</p></td>
 631 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 632 </tr>
 633 <tr>
 634 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 635 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 636 <p class="tableblock">List of supported error codes:
 637 - 50: Access denied
 638 - 51: Forbidden requester
 639 - 52: Forbidden user
 640 - 53: Too many requests</p></td>
 641 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 642 </tr>
 643 <tr>
 644 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 645 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 646 <p class="tableblock">List of supported error codes:
 647 - 60: Resource not found</p></td>
 648 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 649 </tr>
 650 <tr>
 651 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 652 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 653 <p class="tableblock">Functional error</p></td>
 654 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 655 </tr>
 656 <tr>
 657 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 658 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 659 <p class="tableblock">List of supported error codes:
 660 - 1: Internal error</p></td>
 661 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 662 </tr>
 663 <tr>
 664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 665 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 666 <p class="tableblock">List of supported error codes:
 667 - 5: The service is temporarily unavailable
 668 - 6: Orange API is over capacity, retry later !</p></td>
 669 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 670 </tr>
 671 </tbody>
 672 </table>
 673 </div>
 674 <div class="sect4">
 675 <h5 id="_produces_2">Produces</h5>
 676 <div class="ulist">
 677 <ul>
 678 <li>
 679 <p><code>application/json;charset=utf-8</code></p>
 680 </li>
 681 </ul>
 682 </div>
 683 </div>
 684 </div>
 685 <div class="sect3">
 686 <h4 id="_servicespecificationget">Retrieve a service specification</h4>
 687 <div class="literalblock">
 688 <div class="content">
 689 <pre>GET /serviceSpecification/{id}</pre>
 690 </div>
 691 </div>
 692 <div class="sect4">
 693 <h5 id="_description_2">Description</h5>
 694 <div class="paragraph">
 695 <p>This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.</p>
 696 </div>
 697 <div class="paragraph">
 698 <p>Specific business errors for current operation will be encapsulated in</p>
 699 </div>
 700 <div class="paragraph">
 701 <p>HTTP Response 422 Unprocessable entity</p>
 702 </div>
 703 </div>
 704 <div class="sect4">
 705 <h5 id="_parameters_2">Parameters</h5>
 706 <table class="tableblock frame-all grid-all spread">
 707 <colgroup>
 708 <col style="width: 11.1111%;">
 709 <col style="width: 16.6666%;">
 710 <col style="width: 50%;">
 711 <col style="width: 22.2223%;">
 712 </colgroup>
 713 <thead>
 714 <tr>
 715 <th class="tableblock halign-left valign-middle">Type</th>
 716 <th class="tableblock halign-left valign-middle">Name</th>
 717 <th class="tableblock halign-left valign-middle">Description</th>
 718 <th class="tableblock halign-left valign-middle">Schema</th>
 719 </tr>
 720 </thead>
 721 <tbody>
 722 <tr>
 723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
 724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 725 <em>required</em></p></td>
 726 <td class="tableblock halign-left valign-middle"></td>
 727 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 728 </tr>
 729 <tr>
 730 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 731 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br>
 732 <em>optional</em></p></td>
 733 <td class="tableblock halign-left valign-middle"><p class="tableblock">Attribute selection</p></td>
 734 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 735 </tr>
 736 </tbody>
 737 </table>
 738 </div>
 739 <div class="sect4">
 740 <h5 id="_responses_2">Responses</h5>
 741 <table class="tableblock frame-all grid-all spread">
 742 <colgroup>
 743 <col style="width: 10%;">
 744 <col style="width: 70%;">
 745 <col style="width: 20%;">
 746 </colgroup>
 747 <thead>
 748 <tr>
 749 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 750 <th class="tableblock halign-left valign-middle">Description</th>
 751 <th class="tableblock halign-left valign-middle">Schema</th>
 752 </tr>
 753 </thead>
 754 <tbody>
 755 <tr>
 756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 757 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 758 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_servicespecification">ServiceSpecification</a></p></td>
 759 </tr>
 760 <tr>
 761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 762 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 763 <p class="tableblock">List of supported error codes:
 764 - 20: Invalid URL parameter value
 765 - 21: Missing body
 766 - 22: Invalid body
 767 - 23: Missing body field
 768 - 24: Invalid body field
 769 - 25: Missing header
 770 - 26: Invalid header value
 771 - 27: Missing query-string parameter
 772 - 28: Invalid query-string parameter value</p></td>
 773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 774 </tr>
 775 <tr>
 776 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 777 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 778 <p class="tableblock">List of supported error codes:
 779 - 40: Missing credentials
 780 - 41: Invalid credentials
 781 - 42: Expired credentials</p></td>
 782 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 783 </tr>
 784 <tr>
 785 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 786 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 787 <p class="tableblock">List of supported error codes:
 788 - 50: Access denied
 789 - 51: Forbidden requester
 790 - 52: Forbidden user
 791 - 53: Too many requests</p></td>
 792 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 793 </tr>
 794 <tr>
 795 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 796 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 797 <p class="tableblock">List of supported error codes:
 798 - 60: Resource not found</p></td>
 799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 800 </tr>
 801 <tr>
 802 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 803 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 804 <p class="tableblock">Functional error</p></td>
 805 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 806 </tr>
 807 <tr>
 808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 809 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 810 <p class="tableblock">List of supported error codes:
 811 - 1: Internal error</p></td>
 812 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 813 </tr>
 814 <tr>
 815 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 816 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 817 <p class="tableblock">List of supported error codes:
 818 - 5: The service is temporarily unavailable
 819 - 6: Orange API is over capacity, retry later !</p></td>
 820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 821 </tr>
 822 </tbody>
 823 </table>
 824 </div>
 825 <div class="sect4">
 826 <h5 id="_produces_3">Produces</h5>
 827 <div class="ulist">
 828 <ul>
 829 <li>
 830 <p><code>application/json;charset=utf-8</code></p>
 831 </li>
 832 </ul>
 833 </div>
 834 </div>
 835 </div>
 836 </div>
 837 </div>
 838 </div>
 839 <div class="sect1">
 840 <h2 id="_definitions">Definitions</h2>
 841 <div class="sectionbody">
 842 <div class="sect2">
 843 <h3 id="_attachment">Attachment</h3>
 844 <div class="paragraph">
 845 <p>An attachment is a file uses to describe the service.
 846 In nbi we use attachment to retrieve ONAP artifacts.</p>
 847 </div>
 848 <table class="tableblock frame-all grid-all spread">
 849 <colgroup>
 850 <col style="width: 16.6666%;">
 851 <col style="width: 61.1111%;">
 852 <col style="width: 22.2223%;">
 853 </colgroup>
 854 <thead>
 855 <tr>
 856 <th class="tableblock halign-left valign-middle">Name</th>
 857 <th class="tableblock halign-left valign-middle">Description</th>
 858 <th class="tableblock halign-left valign-middle">Schema</th>
 859 </tr>
 860 </thead>
 861 <tbody>
 862 <tr>
 863 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
 864 <em>optional</em></p></td>
 865 <td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes:
 866 artifactLabel
 867 artifactGroupType
 868 artifactTimeout
 869 artifactChecksum
 870 artifactVersion
 871 generatedFromUUID<br>
 872 <strong>Default</strong> : <code>"ONAPartifact"</code></p></td>
 873 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 874 </tr>
 875 <tr>
 876 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactChecksum</strong><br>
 877 <em>optional</em></p></td>
 878 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactChecksum</p></td>
 879 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 880 </tr>
 881 <tr>
 882 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactGroupType</strong><br>
 883 <em>optional</em></p></td>
 884 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactGroupType</p></td>
 885 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 886 </tr>
 887 <tr>
 888 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactLabel</strong><br>
 889 <em>optional</em></p></td>
 890 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactLabel</p></td>
 891 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 892 </tr>
 893 <tr>
 894 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactTimeout</strong><br>
 895 <em>optional</em></p></td>
 896 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactTimeout</p></td>
 897 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 898 </tr>
 899 <tr>
 900 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactVersion</strong><br>
 901 <em>optional</em></p></td>
 902 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactVersion</p></td>
 903 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 904 </tr>
 905 <tr>
 906 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
 907 <em>optional</em></p></td>
 908 <td class="tableblock halign-left valign-middle"><p class="tableblock">Description of the attachment - filled with artifactDescription</p></td>
 909 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 910 </tr>
 911 <tr>
 912 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>generatedFromUUID</strong><br>
 913 <em>optional</em></p></td>
 914 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID</p></td>
 915 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 916 </tr>
 917 <tr>
 918 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 919 <em>optional</em></p></td>
 920 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the attachment - filled with artifactUUID.</p></td>
 921 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 922 </tr>
 923 <tr>
 924 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>mimeType</strong><br>
 925 <em>optional</em></p></td>
 926 <td class="tableblock halign-left valign-middle"><p class="tableblock">Filled with artifactType</p></td>
 927 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 928 </tr>
 929 <tr>
 930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
 931 <em>optional</em></p></td>
 932 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the attachment - filled with artifactName</p></td>
 933 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 934 </tr>
 935 <tr>
 936 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>url</strong><br>
 937 <em>optional</em></p></td>
 938 <td class="tableblock halign-left valign-middle"><p class="tableblock">Uniform Resource Locator, is a web page address - filled with artifactURL</p></td>
 939 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 940 </tr>
 941 </tbody>
 942 </table>
 943 </div>
 944 <div class="sect2">
 945 <h3 id="_distributionstatus">DistributionStatus</h3>
 946 <div class="paragraph">
 947 <p>Service distribution status from ONAP.</p>
 948 </div>
 949 <div class="paragraph">
 950 <p><em>Type</em> : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED)</p>
 951 </div>
 952 </div>
 953 <div class="sect2">
 954 <h3 id="_errorrepresentation">ErrorRepresentation</h3>
 955 <div class="paragraph">
 956 <p>This class is used to describe error.
 957 for nbi Beijing release we do not manage additional error for serviceCatalog</p>
 958 </div>
 959 <table class="tableblock frame-all grid-all spread">
 960 <colgroup>
 961 <col style="width: 16.6666%;">
 962 <col style="width: 61.1111%;">
 963 <col style="width: 22.2223%;">
 964 </colgroup>
 965 <thead>
 966 <tr>
 967 <th class="tableblock halign-left valign-middle">Name</th>
 968 <th class="tableblock halign-left valign-middle">Description</th>
 969 <th class="tableblock halign-left valign-middle">Schema</th>
 970 </tr>
 971 </thead>
 972 <tbody>
 973 <tr>
 974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
 975 <em>optional</em></p></td>
 976 <td class="tableblock halign-left valign-middle"><p class="tableblock">it provides a link to the schema describing a REST resource.</p></td>
 977 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 978 </tr>
 979 <tr>
 980 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
 981 <em>optional</em></p></td>
 982 <td class="tableblock halign-left valign-middle"><p class="tableblock">The class type of a REST resource.</p></td>
 983 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 984 </tr>
 985 <tr>
 986 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br>
 987 <em>required</em></p></td>
 988 <td class="tableblock halign-left valign-middle"><p class="tableblock">Application related code (as defined in the API or from a common list)</p></td>
 989 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
 990 </tr>
 991 <tr>
 992 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
 993 <em>optional</em></p></td>
 994 <td class="tableblock halign-left valign-middle"><p class="tableblock">Text that provide more details and corrective actions related to the error. This can be shown to a client user</p></td>
 995 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 996 </tr>
 997 <tr>
 998 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br>
 999 <em>required</em></p></td>
1000 <td class="tableblock halign-left valign-middle"><p class="tableblock">Text that explains the reason for error. This can be shown to a client user.</p></td>
1001 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1002 </tr>
1003 <tr>
1004 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>referenceErrror</strong><br>
1005 <em>optional</em></p></td>
1006 <td class="tableblock halign-left valign-middle"><p class="tableblock">url pointing to documentation describing the error</p></td>
1007 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1008 </tr>
1009 <tr>
1010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
1011 <em>optional</em></p></td>
1012 <td class="tableblock halign-left valign-middle"><p class="tableblock">http error code extension like 400-2</p></td>
1013 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1014 </tr>
1015 </tbody>
1016 </table>
1017 </div>
1018 <div class="sect2">
1019 <h3 id="_lifecyclestatusvalues">LifecycleStatusValues</h3>
1020 <div class="paragraph">
1021 <p>Service lifecycle value from ONAP SDC</p>
1022 </div>
1023 <div class="paragraph">
1024 <p><em>Type</em> : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED)</p>
1025 </div>
1026 </div>
1027 <div class="sect2">
1028 <h3 id="_relatedpartyref">RelatedPartyRef</h3>
1029 <div class="paragraph">
1030 <p>Party linked to the service catalog.
1031 in nbi we retrieve information about last updater of the service in SDC</p>
1032 </div>
1033 <table class="tableblock frame-all grid-all spread">
1034 <colgroup>
1035 <col style="width: 16.6666%;">
1036 <col style="width: 61.1111%;">
1037 <col style="width: 22.2223%;">
1038 </colgroup>
1039 <thead>
1040 <tr>
1041 <th class="tableblock halign-left valign-middle">Name</th>
1042 <th class="tableblock halign-left valign-middle">Description</th>
1043 <th class="tableblock halign-left valign-middle">Schema</th>
1044 </tr>
1045 </thead>
1046 <tbody>
1047 <tr>
1048 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1049 <em>optional</em></p></td>
1050 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the related party. Filled with lastUpdaterUserId</p></td>
1051 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1052 </tr>
1053 <tr>
1054 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1055 <em>optional</em></p></td>
1056 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the related party - Filled with lastUpdatedFullName</p></td>
1057 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1058 </tr>
1059 <tr>
1060 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br>
1061 <em>optional</em></p></td>
1062 <td class="tableblock halign-left valign-middle"><p class="tableblock">Role payed by the related party
1063 Only role 'lastUpdater' is retrieved in Beijing release</p></td>
1064 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1065 </tr>
1066 </tbody>
1067 </table>
1068 </div>
1069 <div class="sect2">
1070 <h3 id="_resourcespecificationref">ResourceSpecificationRef</h3>
1071 <div class="paragraph">
1072 <p>A list of resourceSpec identified to deliver the service.
1073 for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.</p>
1074 </div>
1075 <table class="tableblock frame-all grid-all spread">
1076 <colgroup>
1077 <col style="width: 16.6666%;">
1078 <col style="width: 61.1111%;">
1079 <col style="width: 22.2223%;">
1080 </colgroup>
1081 <thead>
1082 <tr>
1083 <th class="tableblock halign-left valign-middle">Name</th>
1084 <th class="tableblock halign-left valign-middle">Description</th>
1085 <th class="tableblock halign-left valign-middle">Schema</th>
1086 </tr>
1087 </thead>
1088 <tbody>
1089 <tr>
1090 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1091 <em>optional</em></p></td>
1092 <td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:
1093 resourceInstanceName
1094 resourceInvariantUUID
1095 resourceType
1096 modelCustomizationName
1097 modelCustomizationId<br>
1098 <strong>Default</strong> : <code>"ONAPresource"</code></p></td>
1099 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1100 </tr>
1101 <tr>
1102 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1103 <em>optional</em></p></td>
1104 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the resource specification - filled with resourceUUID</p></td>
1105 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1106 </tr>
1107 <tr>
1108 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelCustomizationId</strong><br>
1109 <em>optional</em></p></td>
1110 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource</p></td>
1111 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1112 </tr>
1113 <tr>
1114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelCustomizationName</strong><br>
1115 <em>optional</em></p></td>
1116 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource</p></td>
1117 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1118 </tr>
1119 <tr>
1120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1121 <em>optional</em></p></td>
1122 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the resource specification - filled with resourceName</p></td>
1123 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1124 </tr>
1125 <tr>
1126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceInstanceName</strong><br>
1127 <em>optional</em></p></td>
1128 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName</p></td>
1129 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1130 </tr>
1131 <tr>
1132 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceInvariantUUID</strong><br>
1133 <em>optional</em></p></td>
1134 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID</p></td>
1135 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1136 </tr>
1137 <tr>
1138 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceType</strong><br>
1139 <em>optional</em></p></td>
1140 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - resoucreType</p></td>
1141 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1142 </tr>
1143 <tr>
1144 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
1145 <em>optional</em></p></td>
1146 <td class="tableblock halign-left valign-middle"><p class="tableblock">Version for this resource specification - filled with resourceVersion</p></td>
1147 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1148 </tr>
1149 </tbody>
1150 </table>
1151 </div>
1152 <div class="sect2">
1153 <h3 id="_servicespeccharacteristic">ServiceSpecCharacteristic</h3>
1154 <div class="paragraph">
1155 <p>A characteristic quality or distinctive feature of a ServiceSpecification.
1156 ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.</p>
1157 </div>
1158 <table class="tableblock frame-all grid-all spread">
1159 <colgroup>
1160 <col style="width: 16.6666%;">
1161 <col style="width: 61.1111%;">
1162 <col style="width: 22.2223%;">
1163 </colgroup>
1164 <thead>
1165 <tr>
1166 <th class="tableblock halign-left valign-middle">Name</th>
1167 <th class="tableblock halign-left valign-middle">Description</th>
1168 <th class="tableblock halign-left valign-middle">Schema</th>
1169 </tr>
1170 </thead>
1171 <tbody>
1172 <tr>
1173 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1174 <em>optional</em></p></td>
1175 <td class="tableblock halign-left valign-middle"><p class="tableblock">An url pointing to type description - we do not use it in nbi Beijing release</p></td>
1176 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1177 </tr>
1178 <tr>
1179 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1180 <em>optional</em></p></td>
1181 <td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.</p></td>
1182 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1183 </tr>
1184 <tr>
1185 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1186 <em>optional</em></p></td>
1187 <td class="tableblock halign-left valign-middle"><p class="tableblock">A narrative that explains in detail what the characteristic is - Filled with parameter_description</p></td>
1188 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1189 </tr>
1190 <tr>
1191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1192 <em>optional</em></p></td>
1193 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the characteristic - Filled with parameter_name</p></td>
1194 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1195 </tr>
1196 <tr>
1197 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>required</strong><br>
1198 <em>optional</em></p></td>
1199 <td class="tableblock halign-left valign-middle"><p class="tableblock">A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’<br>
1200 <strong>Default</strong> : <code>true</code></p></td>
1201 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1202 </tr>
1203 <tr>
1204 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecCharacteristicValue</strong><br>
1205 <em>optional</em></p></td>
1206 <td class="tableblock halign-left valign-middle"></td>
1207 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicespeccharacteristicvalue">ServiceSpecCharacteristicValue</a> &gt; array</p></td>
1208 </tr>
1209 <tr>
1210 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
1211 <em>optional</em></p></td>
1212 <td class="tableblock halign-left valign-middle"><p class="tableblock">Status of the characteristic - filled with status_value</p></td>
1213 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1214 </tr>
1215 <tr>
1216 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br>
1217 <em>optional</em></p></td>
1218 <td class="tableblock halign-left valign-middle"><p class="tableblock">A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type</p></td>
1219 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1220 </tr>
1221 </tbody>
1222 </table>
1223 </div>
1224 <div class="sect2">
1225 <h3 id="_servicespeccharacteristicvalue">ServiceSpecCharacteristicValue</h3>
1226 <div class="paragraph">
1227 <p>A number or text that can be assigned to a service specification characteristic.
1228 ServiceSpecCharacteristicValue are retrieved in the service Tosca file</p>
1229 </div>
1230 <table class="tableblock frame-all grid-all spread">
1231 <colgroup>
1232 <col style="width: 16.6666%;">
1233 <col style="width: 61.1111%;">
1234 <col style="width: 22.2223%;">
1235 </colgroup>
1236 <thead>
1237 <tr>
1238 <th class="tableblock halign-left valign-middle">Name</th>
1239 <th class="tableblock halign-left valign-middle">Description</th>
1240 <th class="tableblock halign-left valign-middle">Schema</th>
1241 </tr>
1242 </thead>
1243 <tbody>
1244 <tr>
1245 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>isDefault</strong><br>
1246 <em>optional</em></p></td>
1247 <td class="tableblock halign-left valign-middle"><p class="tableblock">Information calculated from parameter default in the Tosca file</p></td>
1248 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1249 </tr>
1250 <tr>
1251 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
1252 <em>optional</em></p></td>
1253 <td class="tableblock halign-left valign-middle"><p class="tableblock">A discrete value that the characteristic can take on</p></td>
1254 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1255 </tr>
1256 <tr>
1257 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br>
1258 <em>optional</em></p></td>
1259 <td class="tableblock halign-left valign-middle"><p class="tableblock">A kind of value that the characteristic can take on, such as numeric, text, and so forth
1260 Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type.
1261 We do not manage parameter_type= list or map for Beijing release</p></td>
1262 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1263 </tr>
1264 </tbody>
1265 </table>
1266 </div>
1267 <div class="sect2">
1268 <h3 id="_servicespecification">ServiceSpecification</h3>
1269 <div class="paragraph">
1270 <p>ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
1271 the service information are retrieved in SDC</p>
1272 </div>
1273 <table class="tableblock frame-all grid-all spread">
1274 <colgroup>
1275 <col style="width: 16.6666%;">
1276 <col style="width: 61.1111%;">
1277 <col style="width: 22.2223%;">
1278 </colgroup>
1279 <thead>
1280 <tr>
1281 <th class="tableblock halign-left valign-middle">Name</th>
1282 <th class="tableblock halign-left valign-middle">Description</th>
1283 <th class="tableblock halign-left valign-middle">Schema</th>
1284 </tr>
1285 </thead>
1286 <tbody>
1287 <tr>
1288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1289 <em>optional</em></p></td>
1290 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used for Beijing release</p></td>
1291 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1292 </tr>
1293 <tr>
1294 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1295 <em>optional</em></p></td>
1296 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used for Beijing release</p></td>
1297 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1298 </tr>
1299 <tr>
1300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1301 <em>optional</em></p></td>
1302 <td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:
1303 invariantUUID
1304 toscaModelURL
1305 toscaResourceName
1306 category (1)
1307 subcategory (1)
1308 distributionStatus<br>
1309 <strong>Default</strong> : <code>"ONAPservice"</code></p></td>
1310 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1311 </tr>
1312 <tr>
1313 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>attachment</strong><br>
1314 <em>optional</em></p></td>
1315 <td class="tableblock halign-left valign-middle"></td>
1316 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_attachment">Attachment</a> &gt; array</p></td>
1317 </tr>
1318 <tr>
1319 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
1320 <em>optional</em></p></td>
1321 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute - extended through @type - category
1322 Please note that this attribute is managed in TMF - in future release we&#8217;ll introduce category resource</p></td>
1323 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1324 </tr>
1325 <tr>
1326 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1327 <em>optional</em></p></td>
1328 <td class="tableblock halign-left valign-middle"><p class="tableblock">A narrative that explains in detail what the service specification is - Filled with SDC Service description</p></td>
1329 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1330 </tr>
1331 <tr>
1332 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>distributionStatus</strong><br>
1333 <em>optional</em></p></td>
1334 <td class="tableblock halign-left valign-middle"></td>
1335 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_distributionstatus">DistributionStatus</a></p></td>
1336 </tr>
1337 <tr>
1338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1339 <em>optional</em></p></td>
1340 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service specification- not mapped in Beijing</p></td>
1341 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1342 </tr>
1343 <tr>
1344 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1345 <em>optional</em></p></td>
1346 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service specification. Filled with SDC Service uuid</p></td>
1347 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1348 </tr>
1349 <tr>
1350 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>invariantUUID</strong><br>
1351 <em>required</em></p></td>
1352 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - invariantUUID</p></td>
1353 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1354 </tr>
1355 <tr>
1356 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lifecycleStatus</strong><br>
1357 <em>optional</em></p></td>
1358 <td class="tableblock halign-left valign-middle"></td>
1359 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_lifecyclestatusvalues">LifecycleStatusValues</a></p></td>
1360 </tr>
1361 <tr>
1362 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1363 <em>optional</em></p></td>
1364 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service specification- Filled with SDC Service name</p></td>
1365 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1366 </tr>
1367 <tr>
1368 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
1369 <em>optional</em></p></td>
1370 <td class="tableblock halign-left valign-middle"></td>
1371 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedpartyref">RelatedPartyRef</a> &gt; array</p></td>
1372 </tr>
1373 <tr>
1374 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceSpecification</strong><br>
1375 <em>optional</em></p></td>
1376 <td class="tableblock halign-left valign-middle"></td>
1377 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_resourcespecificationref">ResourceSpecificationRef</a> &gt; array</p></td>
1378 </tr>
1379 <tr>
1380 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecCharacteristic</strong><br>
1381 <em>optional</em></p></td>
1382 <td class="tableblock halign-left valign-middle"></td>
1383 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicespeccharacteristic">ServiceSpecCharacteristic</a> &gt; array</p></td>
1384 </tr>
1385 <tr>
1386 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subcategory</strong><br>
1387 <em>optional</em></p></td>
1388 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute - extended through @type - category
1389 Please note that this attribute is managed in TMF - in future release we&#8217;ll introduce category resourc</p></td>
1390 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1391 </tr>
1392 <tr>
1393 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>targetServiceSchema</strong><br>
1394 <em>optional</em></p></td>
1395 <td class="tableblock halign-left valign-middle"></td>
1396 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_targetserviceschemaref">TargetServiceSchemaRef</a></p></td>
1397 </tr>
1398 <tr>
1399 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelURL</strong><br>
1400 <em>optional</em></p></td>
1401 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - toscaModelURL</p></td>
1402 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1403 </tr>
1404 <tr>
1405 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaResourceName</strong><br>
1406 <em>optional</em></p></td>
1407 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - toscaResourceName</p></td>
1408 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1409 </tr>
1410 <tr>
1411 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
1412 <em>optional</em></p></td>
1413 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service specification version - Filled with SDC Service version</p></td>
1414 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1415 </tr>
1416 </tbody>
1417 </table>
1418 </div>
1419 <div class="sect2">
1420 <h3 id="_targetserviceschemaref">TargetServiceSchemaRef</h3>
1421 <table class="tableblock frame-all grid-all spread">
1422 <colgroup>
1423 <col style="width: 42.8571%;">
1424 <col style="width: 57.1429%;">
1425 </colgroup>
1426 <thead>
1427 <tr>
1428 <th class="tableblock halign-left valign-middle">Name</th>
1429 <th class="tableblock halign-left valign-middle">Schema</th>
1430 </tr>
1431 </thead>
1432 <tbody>
1433 <tr>
1434 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1435 <em>required</em></p></td>
1436 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1437 </tr>
1438 <tr>
1439 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1440 <em>required</em></p></td>
1441 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1442 </tr>
1443 </tbody>
1444 </table>
1445 </div>
1446 <div class="sect2">
1447 <h3 id="_timeperiod">TimePeriod</h3>
1448 <div class="paragraph">
1449 <p>A time period</p>
1450 </div>
1451 <table class="tableblock frame-all grid-all spread">
1452 <colgroup>
1453 <col style="width: 16.6666%;">
1454 <col style="width: 61.1111%;">
1455 <col style="width: 22.2223%;">
1456 </colgroup>
1457 <thead>
1458 <tr>
1459 <th class="tableblock halign-left valign-middle">Name</th>
1460 <th class="tableblock halign-left valign-middle">Description</th>
1461 <th class="tableblock halign-left valign-middle">Schema</th>
1462 </tr>
1463 </thead>
1464 <tbody>
1465 <tr>
1466 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>endDateTime</strong><br>
1467 <em>optional</em></p></td>
1468 <td class="tableblock halign-left valign-middle"><p class="tableblock">End date and time of the period</p></td>
1469 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1470 </tr>
1471 <tr>
1472 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>startDateTime</strong><br>
1473 <em>optional</em></p></td>
1474 <td class="tableblock halign-left valign-middle"><p class="tableblock">Start date and time of the period</p></td>
1475 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1476 </tr>
1477 </tbody>
1478 </table>
1479 </div>
1480 </div>
1481 </div>
1482 </div>
1483 <div id="footer">
1484 <div id="footer-text">
1485 Last updated 2018-09-12 13:43:40 +00:00
1486 </div>
1487 </div>
1488 </body>
1489 </html>