docs/offeredapis/serviceCatalog/documentation.html

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