docs/offeredapis/serviceInventory/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 ServiceInventory</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 ServiceInventory</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="#_service_resource">Service</a></li>
 452 </ul>
 453 </li>
 454 <li><a href="#_definitions">Definitions</a>
 455 <ul class="sectlevel2">
 456 <li><a href="#_errorrepresentation">ErrorRepresentation</a></li>
 457 <li><a href="#_listrelatedpartyref">ListRelatedPartyRef</a></li>
 458 <li><a href="#_listservice">ListService</a></li>
 459 <li><a href="#_listservicespecificationref">ListServiceSpecificationRef</a></li>
 460 <li><a href="#_relatedpartyref">RelatedPartyRef</a></li>
 461 <li><a href="#_service">Service</a></li>
 462 <li><a href="#_servicecharacteristic">ServiceCharacteristic</a></li>
 463 <li><a href="#_servicespecificationref">ServiceSpecificationRef</a></li>
 464 <li><a href="#_supportingresource">SupportingResource</a></li>
 465 <li><a href="#_value">Value</a></li>
 466 <li><a href="#_statevalues">stateValues</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>serviceInventory API designed for ONAP Beijing Release.
 479 This API is build from TMF open API18.0 (applying TMF Guideline 3.0)
 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>Service</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="_service_resource">Service</h3>
 534 <div class="sect3">
 535 <h4 id="_servicefind">List services</h4>
 536 <div class="literalblock">
 537 <div class="content">
 538 <pre>GET /service</pre>
 539 </div>
 540 </div>
 541 <div class="sect4">
 542 <h5 id="_description">Description</h5>
 543 <div class="paragraph">
 544 <p>This operation list service entities.
 545 Attribute selection is restricted.
 546 fields attribute may be used to filter retrieved attribute(s) for each service</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: 22.2222%;">
 560 <col style="width: 33.3333%;">
 561 <col style="width: 44.4445%;">
 562 </colgroup>
 563 <thead>
 564 <tr>
 565 <th class="tableblock halign-left valign-middle">Type</th>
 566 <th class="tableblock halign-left valign-middle">Name</th>
 567 <th class="tableblock halign-left valign-middle">Schema</th>
 568 </tr>
 569 </thead>
 570 <tbody>
 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>fields</strong><br>
 574 <em>optional</em></p></td>
 575 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 576 </tr>
 577 <tr>
 578 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 579 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 580 <em>optional</em></p></td>
 581 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 582 </tr>
 583 <tr>
 584 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 585 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty.id</strong><br>
 586 <em>optional</em></p></td>
 587 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 588 </tr>
 589 <tr>
 590 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 591 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification.id</strong><br>
 592 <em>optional</em></p></td>
 593 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 594 </tr>
 595 <tr>
 596 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 597 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification.name</strong><br>
 598 <em>optional</em></p></td>
 599 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 600 </tr>
 601 </tbody>
 602 </table>
 603 </div>
 604 <div class="sect4">
 605 <h5 id="_responses">Responses</h5>
 606 <table class="tableblock frame-all grid-all spread">
 607 <colgroup>
 608 <col style="width: 10%;">
 609 <col style="width: 70%;">
 610 <col style="width: 20%;">
 611 </colgroup>
 612 <thead>
 613 <tr>
 614 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 615 <th class="tableblock halign-left valign-middle">Description</th>
 616 <th class="tableblock halign-left valign-middle">Schema</th>
 617 </tr>
 618 </thead>
 619 <tbody>
 620 <tr>
 621 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 622 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 623 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_listservice">ListService</a> &gt; array</p></td>
 624 </tr>
 625 <tr>
 626 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 627 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 628 <p class="tableblock">List of supported error codes:
 629 - 20: Invalid URL parameter value
 630 - 21: Missing body
 631 - 22: Invalid body
 632 - 23: Missing body field
 633 - 24: Invalid body field
 634 - 25: Missing header
 635 - 26: Invalid header value
 636 - 27: Missing query-string parameter
 637 - 28: Invalid query-string parameter value</p></td>
 638 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 639 </tr>
 640 <tr>
 641 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 642 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 643 <p class="tableblock">List of supported error codes:
 644 - 40: Missing credentials
 645 - 41: Invalid credentials
 646 - 42: Expired credentials</p></td>
 647 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 648 </tr>
 649 <tr>
 650 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 651 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 652 <p class="tableblock">List of supported error codes:
 653 - 50: Access denied
 654 - 51: Forbidden requester
 655 - 52: Forbidden user
 656 - 53: Too many requests</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>404</strong></p></td>
 661 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 662 <p class="tableblock">List of supported error codes:
 663 - 60: Resource not found</p></td>
 664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 665 </tr>
 666 <tr>
 667 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 668 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 669 <p class="tableblock">Functional 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>500</strong></p></td>
 674 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 675 <p class="tableblock">List of supported error codes:
 676 - 1: Internal error</p></td>
 677 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 678 </tr>
 679 <tr>
 680 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 681 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 682 <p class="tableblock">List of supported error codes:
 683 - 5: The service is temporarily unavailable
 684 - 6: Orange API is over capacity, retry later !</p></td>
 685 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 686 </tr>
 687 </tbody>
 688 </table>
 689 </div>
 690 </div>
 691 <div class="sect3">
 692 <h4 id="_serviceget">Retrieve a service</h4>
 693 <div class="literalblock">
 694 <div class="content">
 695 <pre>GET /service/{id}</pre>
 696 </div>
 697 </div>
 698 <div class="sect4">
 699 <h5 id="_description_2">Description</h5>
 700 <div class="paragraph">
 701 <p>This operation retrieves a service entity.
 702 Attribute selection is enabled for all first level attributes.</p>
 703 </div>
 704 <div class="paragraph">
 705 <p>Specific business errors for current operation will be encapsulated in</p>
 706 </div>
 707 <div class="paragraph">
 708 <p>HTTP Response 422 Unprocessable entity</p>
 709 </div>
 710 </div>
 711 <div class="sect4">
 712 <h5 id="_parameters_2">Parameters</h5>
 713 <table class="tableblock frame-all grid-all spread">
 714 <colgroup>
 715 <col style="width: 22.2222%;">
 716 <col style="width: 33.3333%;">
 717 <col style="width: 44.4445%;">
 718 </colgroup>
 719 <thead>
 720 <tr>
 721 <th class="tableblock halign-left valign-middle">Type</th>
 722 <th class="tableblock halign-left valign-middle">Name</th>
 723 <th class="tableblock halign-left valign-middle">Schema</th>
 724 </tr>
 725 </thead>
 726 <tbody>
 727 <tr>
 728 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
 729 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 730 <em>required</em></p></td>
 731 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 732 </tr>
 733 <tr>
 734 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 735 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty.id</strong><br>
 736 <em>optional</em></p></td>
 737 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 738 </tr>
 739 <tr>
 740 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 741 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification.id</strong><br>
 742 <em>optional</em></p></td>
 743 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 744 </tr>
 745 <tr>
 746 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 747 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification.name</strong><br>
 748 <em>optional</em></p></td>
 749 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 750 </tr>
 751 </tbody>
 752 </table>
 753 </div>
 754 <div class="sect4">
 755 <h5 id="_responses_2">Responses</h5>
 756 <table class="tableblock frame-all grid-all spread">
 757 <colgroup>
 758 <col style="width: 10%;">
 759 <col style="width: 70%;">
 760 <col style="width: 20%;">
 761 </colgroup>
 762 <thead>
 763 <tr>
 764 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 765 <th class="tableblock halign-left valign-middle">Description</th>
 766 <th class="tableblock halign-left valign-middle">Schema</th>
 767 </tr>
 768 </thead>
 769 <tbody>
 770 <tr>
 771 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 772 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
 774 </tr>
 775 <tr>
 776 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 777 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 778 <p class="tableblock">List of supported error codes:
 779 - 20: Invalid URL parameter value
 780 - 21: Missing body
 781 - 22: Invalid body
 782 - 23: Missing body field
 783 - 24: Invalid body field
 784 - 25: Missing header
 785 - 26: Invalid header value
 786 - 27: Missing query-string parameter
 787 - 28: Invalid query-string parameter value</p></td>
 788 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 789 </tr>
 790 <tr>
 791 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 792 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 793 <p class="tableblock">List of supported error codes:
 794 - 40: Missing credentials
 795 - 41: Invalid credentials
 796 - 42: Expired credentials</p></td>
 797 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 798 </tr>
 799 <tr>
 800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 801 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 802 <p class="tableblock">List of supported error codes:
 803 - 50: Access denied
 804 - 51: Forbidden requester
 805 - 52: Forbidden user
 806 - 53: Too many requests</p></td>
 807 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 808 </tr>
 809 <tr>
 810 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 811 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 812 <p class="tableblock">List of supported error codes:
 813 - 60: Resource not found</p></td>
 814 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 815 </tr>
 816 <tr>
 817 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 818 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 819 <p class="tableblock">Functional error</p></td>
 820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 821 </tr>
 822 <tr>
 823 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 824 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 825 <p class="tableblock">List of supported error codes:
 826 - 1: Internal error</p></td>
 827 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 828 </tr>
 829 <tr>
 830 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 831 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 832 <p class="tableblock">List of supported error codes:
 833 - 5: The service is temporarily unavailable
 834 - 6: Orange API is over capacity, retry later !</p></td>
 835 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 836 </tr>
 837 </tbody>
 838 </table>
 839 </div>
 840 </div>
 841 </div>
 842 </div>
 843 </div>
 844 <div class="sect1">
 845 <h2 id="_definitions">Definitions</h2>
 846 <div class="sectionbody">
 847 <div class="sect2">
 848 <h3 id="_errorrepresentation">ErrorRepresentation</h3>
 849 <div class="paragraph">
 850 <p>This class is used to describe error.
 851 for nbi Beijing release we do not manage additional error for serviceCatalog</p>
 852 </div>
 853 <table class="tableblock frame-all grid-all spread">
 854 <colgroup>
 855 <col style="width: 16.6666%;">
 856 <col style="width: 61.1111%;">
 857 <col style="width: 22.2223%;">
 858 </colgroup>
 859 <thead>
 860 <tr>
 861 <th class="tableblock halign-left valign-middle">Name</th>
 862 <th class="tableblock halign-left valign-middle">Description</th>
 863 <th class="tableblock halign-left valign-middle">Schema</th>
 864 </tr>
 865 </thead>
 866 <tbody>
 867 <tr>
 868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
 869 <em>optional</em></p></td>
 870 <td class="tableblock halign-left valign-middle"><p class="tableblock">it provides a link to the schema describing a REST resource.</p></td>
 871 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 872 </tr>
 873 <tr>
 874 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
 875 <em>optional</em></p></td>
 876 <td class="tableblock halign-left valign-middle"><p class="tableblock">The class type of a REST resource.</p></td>
 877 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 878 </tr>
 879 <tr>
 880 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br>
 881 <em>required</em></p></td>
 882 <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>
 883 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
 884 </tr>
 885 <tr>
 886 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
 887 <em>optional</em></p></td>
 888 <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>
 889 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 890 </tr>
 891 <tr>
 892 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br>
 893 <em>required</em></p></td>
 894 <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>
 895 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 896 </tr>
 897 <tr>
 898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>referenceError</strong><br>
 899 <em>optional</em></p></td>
 900 <td class="tableblock halign-left valign-middle"><p class="tableblock">url pointing to documentation describing the error</p></td>
 901 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 902 </tr>
 903 <tr>
 904 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
 905 <em>optional</em></p></td>
 906 <td class="tableblock halign-left valign-middle"><p class="tableblock">http error code extension like 400-2</p></td>
 907 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 908 </tr>
 909 </tbody>
 910 </table>
 911 </div>
 912 <div class="sect2">
 913 <h3 id="_listrelatedpartyref">ListRelatedPartyRef</h3>
 914 <div class="paragraph">
 915 <p>This class is used to structure list of service(s) retrieved</p>
 916 </div>
 917 <table class="tableblock frame-all grid-all spread">
 918 <colgroup>
 919 <col style="width: 16.6666%;">
 920 <col style="width: 61.1111%;">
 921 <col style="width: 22.2223%;">
 922 </colgroup>
 923 <thead>
 924 <tr>
 925 <th class="tableblock halign-left valign-middle">Name</th>
 926 <th class="tableblock halign-left valign-middle">Description</th>
 927 <th class="tableblock halign-left valign-middle">Schema</th>
 928 </tr>
 929 </thead>
 930 <tbody>
 931 <tr>
 932 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 933 <em>optional</em></p></td>
 934 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of a related party</p></td>
 935 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 936 </tr>
 937 <tr>
 938 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br>
 939 <em>optional</em></p></td>
 940 <td class="tableblock halign-left valign-middle"><p class="tableblock">Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.</p></td>
 941 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 942 </tr>
 943 </tbody>
 944 </table>
 945 </div>
 946 <div class="sect2">
 947 <h3 id="_listservice">ListService</h3>
 948 <div class="paragraph">
 949 <p>This class is used to structure list of service(s) retrieved</p>
 950 </div>
 951 <table class="tableblock frame-all grid-all spread">
 952 <colgroup>
 953 <col style="width: 16.6666%;">
 954 <col style="width: 61.1111%;">
 955 <col style="width: 22.2223%;">
 956 </colgroup>
 957 <thead>
 958 <tr>
 959 <th class="tableblock halign-left valign-middle">Name</th>
 960 <th class="tableblock halign-left valign-middle">Description</th>
 961 <th class="tableblock halign-left valign-middle">Schema</th>
 962 </tr>
 963 </thead>
 964 <tbody>
 965 <tr>
 966 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 967 <em>optional</em></p></td>
 968 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service</p></td>
 969 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 970 </tr>
 971 <tr>
 972 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
 973 <em>optional</em></p></td>
 974 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service</p></td>
 975 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 976 </tr>
 977 <tr>
 978 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
 979 <em>optional</em></p></td>
 980 <td class="tableblock halign-left valign-middle"></td>
 981 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_listrelatedpartyref">ListRelatedPartyRef</a></p></td>
 982 </tr>
 983 <tr>
 984 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification</strong><br>
 985 <em>optional</em></p></td>
 986 <td class="tableblock halign-left valign-middle"></td>
 987 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_listservicespecificationref">ListServiceSpecificationRef</a></p></td>
 988 </tr>
 989 </tbody>
 990 </table>
 991 </div>
 992 <div class="sect2">
 993 <h3 id="_listservicespecificationref">ListServiceSpecificationRef</h3>
 994 <div class="paragraph">
 995 <p>This class is used to structure list of service(s) retrieved</p>
 996 </div>
 997 <table class="tableblock frame-all grid-all spread">
 998 <colgroup>
 999 <col style="width: 16.6666%;">
1000 <col style="width: 61.1111%;">
1001 <col style="width: 22.2223%;">
1002 </colgroup>
1003 <thead>
1004 <tr>
1005 <th class="tableblock halign-left valign-middle">Name</th>
1006 <th class="tableblock halign-left valign-middle">Description</th>
1007 <th class="tableblock halign-left valign-middle">Schema</th>
1008 </tr>
1009 </thead>
1010 <tbody>
1011 <tr>
1012 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1013 <em>optional</em></p></td>
1014 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service specification</p></td>
1015 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1016 </tr>
1017 <tr>
1018 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1019 <em>optional</em></p></td>
1020 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the required service specification</p></td>
1021 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1022 </tr>
1023 </tbody>
1024 </table>
1025 </div>
1026 <div class="sect2">
1027 <h3 id="_relatedpartyref">RelatedPartyRef</h3>
1028 <div class="paragraph">
1029 <p>RelatedParty reference. A related party defines party or party role linked to a specific entity.
1030 Only ONAP Customer is managed in Beijing release.</p>
1031 </div>
1032 <table class="tableblock frame-all grid-all spread">
1033 <colgroup>
1034 <col style="width: 16.6666%;">
1035 <col style="width: 61.1111%;">
1036 <col style="width: 22.2223%;">
1037 </colgroup>
1038 <thead>
1039 <tr>
1040 <th class="tableblock halign-left valign-middle">Name</th>
1041 <th class="tableblock halign-left valign-middle">Description</th>
1042 <th class="tableblock halign-left valign-middle">Schema</th>
1043 </tr>
1044 </thead>
1045 <tbody>
1046 <tr>
1047 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
1048 <em>optional</em></p></td>
1049 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in the Beijing release.</p></td>
1050 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1051 </tr>
1052 <tr>
1053 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1054 <em>optional</em></p></td>
1055 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of a related party.
1056 Not filled in Beijing release.</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>id</strong><br>
1061 <em>optional</em></p></td>
1062 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of a related party</p></td>
1063 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1064 </tr>
1065 <tr>
1066 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br>
1067 <em>optional</em></p></td>
1068 <td class="tableblock halign-left valign-middle"><p class="tableblock">Role played by the related party.
1069 Filled with 'ONAPcustomer'</p></td>
1070 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1071 </tr>
1072 </tbody>
1073 </table>
1074 </div>
1075 <div class="sect2">
1076 <h3 id="_service">Service</h3>
1077 <div class="paragraph">
1078 <p>Instantiated service (service_instance) in AAI</p>
1079 </div>
1080 <table class="tableblock frame-all grid-all spread">
1081 <colgroup>
1082 <col style="width: 16.6666%;">
1083 <col style="width: 61.1111%;">
1084 <col style="width: 22.2223%;">
1085 </colgroup>
1086 <thead>
1087 <tr>
1088 <th class="tableblock halign-left valign-middle">Name</th>
1089 <th class="tableblock halign-left valign-middle">Description</th>
1090 <th class="tableblock halign-left valign-middle">Schema</th>
1091 </tr>
1092 </thead>
1093 <tbody>
1094 <tr>
1095 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1096 <em>optional</em></p></td>
1097 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release</p></td>
1098 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1099 </tr>
1100 <tr>
1101 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1102 <em>optional</em></p></td>
1103 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release</p></td>
1104 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1105 </tr>
1106 <tr>
1107 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1108 <em>optional</em></p></td>
1109 <td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Not used in Beijing release.</p></td>
1110 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1111 </tr>
1112 <tr>
1113 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>characteristic</strong><br>
1114 <em>optional</em></p></td>
1115 <td class="tableblock halign-left valign-middle"></td>
1116 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicecharacteristic">ServiceCharacteristic</a> &gt; array</p></td>
1117 </tr>
1118 <tr>
1119 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>hasStarted</strong><br>
1120 <em>optional</em></p></td>
1121 <td class="tableblock halign-left valign-middle"><p class="tableblock">This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started
1122 Not managed in Beijing release</p></td>
1123 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
1124 </tr>
1125 <tr>
1126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1127 <em>optional</em></p></td>
1128 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service
1129 Not managed in Beijing release</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>id</strong><br>
1134 <em>optional</em></p></td>
1135 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service - Valued with service-instance-id</p></td>
1136 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1137 </tr>
1138 <tr>
1139 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1140 <em>optional</em></p></td>
1141 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service - Valued with service-instance-name</p></td>
1142 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1143 </tr>
1144 <tr>
1145 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
1146 <em>optional</em></p></td>
1147 <td class="tableblock halign-left valign-middle"></td>
1148 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedpartyref">RelatedPartyRef</a> &gt; array</p></td>
1149 </tr>
1150 <tr>
1151 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification</strong><br>
1152 <em>optional</em></p></td>
1153 <td class="tableblock halign-left valign-middle"></td>
1154 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_servicespecificationref">ServiceSpecificationRef</a></p></td>
1155 </tr>
1156 <tr>
1157 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
1158 <em>optional</em></p></td>
1159 <td class="tableblock halign-left valign-middle"></td>
1160 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statevalues">stateValues</a></p></td>
1161 </tr>
1162 <tr>
1163 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>supportingResource</strong><br>
1164 <em>optional</em></p></td>
1165 <td class="tableblock halign-left valign-middle"></td>
1166 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_supportingresource">SupportingResource</a> &gt; array</p></td>
1167 </tr>
1168 <tr>
1169 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
1170 <em>optional</em></p></td>
1171 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service type - valued with 'service-instance'</p></td>
1172 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1173 </tr>
1174 </tbody>
1175 </table>
1176 </div>
1177 <div class="sect2">
1178 <h3 id="_servicecharacteristic">ServiceCharacteristic</h3>
1179 <div class="paragraph">
1180 <p>A list of name value pairs that define the service characteristics
1181 Not managed in Beijing release.</p>
1182 </div>
1183 <table class="tableblock frame-all grid-all spread">
1184 <colgroup>
1185 <col style="width: 16.6666%;">
1186 <col style="width: 61.1111%;">
1187 <col style="width: 22.2223%;">
1188 </colgroup>
1189 <thead>
1190 <tr>
1191 <th class="tableblock halign-left valign-middle">Name</th>
1192 <th class="tableblock halign-left valign-middle">Description</th>
1193 <th class="tableblock halign-left valign-middle">Schema</th>
1194 </tr>
1195 </thead>
1196 <tbody>
1197 <tr>
1198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1199 <em>required</em></p></td>
1200 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the characteristic
1201 Not managed in Beijing release.</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>value</strong><br>
1206 <em>optional</em></p></td>
1207 <td class="tableblock halign-left valign-middle"></td>
1208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_value">Value</a></p></td>
1209 </tr>
1210 <tr>
1211 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br>
1212 <em>optional</em></p></td>
1213 <td class="tableblock halign-left valign-middle"><p class="tableblock">Type of value for this characteristic.
1214 Not managed in Beijing release.</p></td>
1215 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1216 </tr>
1217 </tbody>
1218 </table>
1219 </div>
1220 <div class="sect2">
1221 <h3 id="_servicespecificationref">ServiceSpecificationRef</h3>
1222 <div class="paragraph">
1223 <p>Service specification reference: ServiceSpecification of this service (catalog information)</p>
1224 </div>
1225 <table class="tableblock frame-all grid-all spread">
1226 <colgroup>
1227 <col style="width: 16.6666%;">
1228 <col style="width: 61.1111%;">
1229 <col style="width: 22.2223%;">
1230 </colgroup>
1231 <thead>
1232 <tr>
1233 <th class="tableblock halign-left valign-middle">Name</th>
1234 <th class="tableblock halign-left valign-middle">Description</th>
1235 <th class="tableblock halign-left valign-middle">Schema</th>
1236 </tr>
1237 </thead>
1238 <tbody>
1239 <tr>
1240 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
1241 <em>optional</em></p></td>
1242 <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 attribute: invariantUUID</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>@schemaLocation</strong><br>
1247 <em>optional</em></p></td>
1248 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release</p></td>
1249 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1250 </tr>
1251 <tr>
1252 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1253 <em>optional</em></p></td>
1254 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service specification.
1255 not managed in Beijing release.</p></td>
1256 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1257 </tr>
1258 <tr>
1259 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1260 <em>optional</em></p></td>
1261 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service specification. valued to model-version-id</p></td>
1262 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1263 </tr>
1264 <tr>
1265 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>invariantUUID</strong><br>
1266 <em>optional</em></p></td>
1267 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id</p></td>
1268 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1269 </tr>
1270 <tr>
1271 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1272 <em>optional</em></p></td>
1273 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the required service specification</p></td>
1274 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1275 </tr>
1276 <tr>
1277 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
1278 <em>optional</em></p></td>
1279 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service specification version.
1280 Not managed in Beijing release</p></td>
1281 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1282 </tr>
1283 </tbody>
1284 </table>
1285 </div>
1286 <div class="sect2">
1287 <h3 id="_supportingresource">SupportingResource</h3>
1288 <div class="paragraph">
1289 <p>Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf</p>
1290 </div>
1291 <table class="tableblock frame-all grid-all spread">
1292 <colgroup>
1293 <col style="width: 16.6666%;">
1294 <col style="width: 61.1111%;">
1295 <col style="width: 22.2223%;">
1296 </colgroup>
1297 <thead>
1298 <tr>
1299 <th class="tableblock halign-left valign-middle">Name</th>
1300 <th class="tableblock halign-left valign-middle">Description</th>
1301 <th class="tableblock halign-left valign-middle">Schema</th>
1302 </tr>
1303 </thead>
1304 <tbody>
1305 <tr>
1306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
1307 <em>optional</em></p></td>
1308 <td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:
1309  status
1310  modelInvariantId
1311  modelVersionId
1312  modelCustomisationId</p></td>
1313 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1314 </tr>
1315 <tr>
1316 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1317 <em>optional</em></p></td>
1318 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release.</p></td>
1319 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1320 </tr>
1321 <tr>
1322 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1323 <em>optional</em></p></td>
1324 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the supporting resource</p></td>
1325 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1326 </tr>
1327 <tr>
1328 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1329 <em>optional</em></p></td>
1330 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the supporting resource - Valued to vnf-id</p></td>
1331 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1332 </tr>
1333 <tr>
1334 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelCustomisationId</strong><br>
1335 <em>optional</em></p></td>
1336 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id</p></td>
1337 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1338 </tr>
1339 <tr>
1340 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelInvariantId</strong><br>
1341 <em>optional</em></p></td>
1342 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id</p></td>
1343 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1344 </tr>
1345 <tr>
1346 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelVersionId</strong><br>
1347 <em>optional</em></p></td>
1348 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id</p></td>
1349 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1350 </tr>
1351 <tr>
1352 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1353 <em>optional</em></p></td>
1354 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the supporting resource - Valued with vnf_-name</p></td>
1355 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1356 </tr>
1357 <tr>
1358 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br>
1359 <em>optional</em></p></td>
1360 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release.</p></td>
1361 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1362 </tr>
1363 <tr>
1364 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
1365 <em>optional</em></p></td>
1366 <td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status</p></td>
1367 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1368 </tr>
1369 </tbody>
1370 </table>
1371 </div>
1372 <div class="sect2">
1373 <h3 id="_value">Value</h3>
1374 <div class="paragraph">
1375 <p>Structure used to describe characteristic value.
1376 Not managed in Beijing release.</p>
1377 </div>
1378 <table class="tableblock frame-all grid-all spread">
1379 <colgroup>
1380 <col style="width: 16.6666%;">
1381 <col style="width: 61.1111%;">
1382 <col style="width: 22.2223%;">
1383 </colgroup>
1384 <thead>
1385 <tr>
1386 <th class="tableblock halign-left valign-middle">Name</th>
1387 <th class="tableblock halign-left valign-middle">Description</th>
1388 <th class="tableblock halign-left valign-middle">Schema</th>
1389 </tr>
1390 </thead>
1391 <tbody>
1392 <tr>
1393 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1394 <em>optional</em></p></td>
1395 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release.</p></td>
1396 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1397 </tr>
1398 <tr>
1399 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1400 <em>optional</em></p></td>
1401 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release.</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>serviceCharacteristicValue</strong><br>
1406 <em>optional</em></p></td>
1407 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not managed in Beijing release.</p></td>
1408 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1409 </tr>
1410 </tbody>
1411 </table>
1412 </div>
1413 <div class="sect2">
1414 <h3 id="_statevalues">stateValues</h3>
1415 <div class="paragraph">
1416 <p><em>Type</em> : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)</p>
1417 </div>
1418 </div>
1419 </div>
1420 </div>
1421 </div>
1422 <div id="footer">
1423 <div id="footer-text">
1424 Last updated 2018-03-22 09:31:41 UTC
1425 </div>
1426 </div>
1427 </body>
1428 </html>