docs/offeredapis/serviceInventory/documentation.html

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