docs/offeredapis/serviceOrder/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 ServiceOrder</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 ServiceOrder</h1>
 431 <div id="toc" class="toc2">
 432 <div id="toctitle">Table of Contents</div>
 433 <ul class="sectlevel1">
 434 <li><a href="#_overview">Overview</a>
 435 <ul class="sectlevel2">
 436 <li><a href="#_api_url">Api URL</a></li>
 437 <li><a href="#_version_information">Version information</a></li>
 438 <li><a href="#_uri_scheme">URI scheme</a></li>
 439 <li><a href="#_tags">Tags</a></li>
 440 <li><a href="#_produces">Produces</a></li>
 441 </ul>
 442 </li>
 443 <li><a href="#_paths">Resources</a>
 444 <ul class="sectlevel2">
 445 <li><a href="#_hub_resource">Hub</a></li>
 446 <li><a href="#_notification_resource">Notification</a></li>
 447 <li><a href="#_serviceorder_resource">ServiceOrder</a></li>
 448 </ul>
 449 </li>
 450 <li><a href="#_definitions">Definitions</a>
 451 <ul class="sectlevel2">
 452 <li><a href="#_actiontype">ActionType</a></li>
 453 <li><a href="#_createhub">CreateHub</a></li>
 454 <li><a href="#_createserviceorder">CreateServiceOrder</a></li>
 455 <li><a href="#_createserviceorderitem">CreateServiceOrderItem</a></li>
 456 <li><a href="#_errorrepresentation">ErrorRepresentation</a></li>
 457 <li><a href="#_eventtype">EventType</a></li>
 458 <li><a href="#_hub">Hub</a></li>
 459 <li><a href="#_notification">Notification</a></li>
 460 <li><a href="#_orderitemrelationship">OrderItemRelationship</a></li>
 461 <li><a href="#_ordermessage">OrderMessage</a></li>
 462 <li><a href="#_orderrelationship">OrderRelationship</a></li>
 463 <li><a href="#_relatedparty">RelatedParty</a></li>
 464 <li><a href="#_relationshiptype">RelationshipType</a></li>
 465 <li><a href="#_service">Service</a></li>
 466 <li><a href="#_servicecharacteristic">ServiceCharacteristic</a></li>
 467 <li><a href="#_serviceorder">ServiceOrder</a></li>
 468 <li><a href="#_serviceordercreationnotification">ServiceOrderCreationNotification</a></li>
 469 <li><a href="#_serviceorderitem">ServiceOrderItem</a></li>
 470 <li><a href="#_serviceorderitemstatechangenotification">ServiceOrderItemStateChangeNotification</a></li>
 471 <li><a href="#_serviceorderitemsummary">ServiceOrderItemSummary</a></li>
 472 <li><a href="#_serviceorderstatechangenotification">ServiceOrderStateChangeNotification</a></li>
 473 <li><a href="#_serviceordersummary">ServiceOrderSummary</a></li>
 474 <li><a href="#_serviceordersummarywithitem">ServiceOrderSummaryWithItem</a></li>
 475 <li><a href="#_serviceref">ServiceRef</a></li>
 476 <li><a href="#_servicerelationship">ServiceRelationship</a></li>
 477 <li><a href="#_servicespecificationref">ServiceSpecificationRef</a></li>
 478 <li><a href="#_severitymessage">SeverityMessage</a></li>
 479 <li><a href="#_statetype">StateType</a></li>
 480 <li><a href="#_targetserviceschema">TargetServiceSchema</a></li>
 481 <li><a href="#_value">Value</a></li>
 482 </ul>
 483 </li>
 484 </ul>
 485 </div>
 486 </div>
 487 <div id="content">
 488 <div class="sect1">
 489 <h2 id="_overview">Overview</h2>
 490 <div class="sectionbody">
 491 <div class="sect2">
 492 <h3 id="_api_url">Api URL</h3>
 493 <div class="paragraph">
 494 <p><a href="https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json">Swagger UI</a></p>
 495 </div>
 496 <div class="paragraph">
 497 <p><a href="https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&amp;src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&amp;noCache=366455.0">plant UML UI</a></p>
 498 </div>
 499 <div class="paragraph">
 500 <p>serviceOrder API designed for ONAP.
 501 This API is build from TMF open API18.0 (applying TMF Guideline 3.0);
 502 Only operations GET (by id and list) and POST are available.</p>
 503 </div>
 504 </div>
 505 <div class="sect2">
 506 <h3 id="_version_information">Version information</h3>
 507 <div class="paragraph">
 508 <p><em>Version</em> : 3.0.0_inProgress</p>
 509 </div>
 510 </div>
 511 <div class="sect2">
 512 <h3 id="_uri_scheme">URI scheme</h3>
 513 <div class="paragraph">
 514 <p><em>Host</em> : serverRoot<br>
 515 <em>BasePath</em> : /nbi/api/v3<br>
 516 <em>Schemes</em> : HTTPS</p>
 517 </div>
 518 </div>
 519 <div class="sect2">
 520 <h3 id="_tags">Tags</h3>
 521 <div class="ulist">
 522 <ul>
 523 <li>
 524 <p>Hub</p>
 525 </li>
 526 <li>
 527 <p>Notification</p>
 528 </li>
 529 <li>
 530 <p>ServiceOrder : A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.</p>
 531 </li>
 532 </ul>
 533 </div>
 534 </div>
 535 <div class="sect2">
 536 <h3 id="_produces">Produces</h3>
 537 <div class="ulist">
 538 <ul>
 539 <li>
 540 <p><code>application/json;charset=utf-8</code></p>
 541 </li>
 542 </ul>
 543 </div>
 544 </div>
 545 </div>
 546 </div>
 547 <div class="sect1">
 548 <h2 id="_paths">Resources</h2>
 549 <div class="sectionbody">
 550 <div class="sect2">
 551 <h3 id="_hub_resource">Hub</h3>
 552 <div class="sect3">
 553 <h4 id="_hubcreate">Create Hub</h4>
 554 <div class="literalblock">
 555 <div class="content">
 556 <pre>POST /hub</pre>
 557 </div>
 558 </div>
 559 <div class="sect4">
 560 <h5 id="_description">Description</h5>
 561 <div class="paragraph">
 562 <p>Specific business errors for current operation will be encapsulated in</p>
 563 </div>
 564 <div class="paragraph">
 565 <p>HTTP Response 422 Unprocessable entity</p>
 566 </div>
 567 </div>
 568 <div class="sect4">
 569 <h5 id="_parameters">Parameters</h5>
 570 <table class="tableblock frame-all grid-all spread">
 571 <colgroup>
 572 <col style="width: 22.2222%;">
 573 <col style="width: 33.3333%;">
 574 <col style="width: 44.4445%;">
 575 </colgroup>
 576 <thead>
 577 <tr>
 578 <th class="tableblock halign-left valign-middle">Type</th>
 579 <th class="tableblock halign-left valign-middle">Name</th>
 580 <th class="tableblock halign-left valign-middle">Schema</th>
 581 </tr>
 582 </thead>
 583 <tbody>
 584 <tr>
 585 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
 586 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Hub</strong><br>
 587 <em>required</em></p></td>
 588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_createhub">CreateHub</a></p></td>
 589 </tr>
 590 </tbody>
 591 </table>
 592 </div>
 593 <div class="sect4">
 594 <h5 id="_responses">Responses</h5>
 595 <table class="tableblock frame-all grid-all spread">
 596 <colgroup>
 597 <col style="width: 10%;">
 598 <col style="width: 70%;">
 599 <col style="width: 20%;">
 600 </colgroup>
 601 <thead>
 602 <tr>
 603 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 604 <th class="tableblock halign-left valign-middle">Description</th>
 605 <th class="tableblock halign-left valign-middle">Schema</th>
 606 </tr>
 607 </thead>
 608 <tbody>
 609 <tr>
 610 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>201</strong></p></td>
 611 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success<br>
 612 <strong>Headers</strong> : <br>
 613 <code>location</code> (string)</p></td>
 614 <td class="tableblock halign-left valign-middle"><p class="tableblock">file</p></td>
 615 </tr>
 616 <tr>
 617 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 618 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 619 <p class="tableblock">List of supported error codes:
 620 - 20: Invalid URL parameter value
 621 - 21: Missing body
 622 - 22: Invalid body
 623 - 23: Missing body field
 624 - 24: Invalid body field
 625 - 25: Missing header
 626 - 26: Invalid header value
 627 - 27: Missing query-string parameter
 628 - 28: Invalid query-string parameter value</p></td>
 629 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 630 </tr>
 631 <tr>
 632 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 633 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 634 <p class="tableblock">List of supported error codes:
 635 - 40: Missing credentials
 636 - 41: Invalid credentials
 637 - 42: Expired credentials</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>403</strong></p></td>
 642 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 643 <p class="tableblock">List of supported error codes:
 644 - 50: Access denied
 645 - 51: Forbidden requester
 646 - 52: Forbidden user
 647 - 53: Too many requests</p></td>
 648 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 649 </tr>
 650 <tr>
 651 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 652 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 653 <p class="tableblock">List of supported error codes:
 654 - 60: Resource not found</p></td>
 655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 656 </tr>
 657 <tr>
 658 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 659 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 660 <p class="tableblock">Functional error</p></td>
 661 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 662 </tr>
 663 <tr>
 664 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 665 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 666 <p class="tableblock">List of supported error codes:
 667 - 1: Internal error</p></td>
 668 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 669 </tr>
 670 <tr>
 671 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 672 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 673 <p class="tableblock">List of supported error codes:
 674 - 5: The service is temporarily unavailable
 675 - 6: Orange API is over capacity, retry later !</p></td>
 676 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 677 </tr>
 678 </tbody>
 679 </table>
 680 </div>
 681 <div class="sect4">
 682 <h5 id="_consumes">Consumes</h5>
 683 <div class="ulist">
 684 <ul>
 685 <li>
 686 <p><code>application/json;charset=utf-8</code></p>
 687 </li>
 688 </ul>
 689 </div>
 690 </div>
 691 </div>
 692 <div class="sect3">
 693 <h4 id="_hubfind">Retrieve a lits of hub</h4>
 694 <div class="literalblock">
 695 <div class="content">
 696 <pre>GET /hub</pre>
 697 </div>
 698 </div>
 699 <div class="sect4">
 700 <h5 id="_description_2">Description</h5>
 701 <div class="paragraph">
 702 <p>Specific business errors for current operation will be encapsulated in</p>
 703 </div>
 704 <div class="paragraph">
 705 <p>HTTP Response 422 Unprocessable entity</p>
 706 </div>
 707 </div>
 708 <div class="sect4">
 709 <h5 id="_parameters_2">Parameters</h5>
 710 <table class="tableblock frame-all grid-all spread">
 711 <colgroup>
 712 <col style="width: 22.2222%;">
 713 <col style="width: 33.3333%;">
 714 <col style="width: 44.4445%;">
 715 </colgroup>
 716 <thead>
 717 <tr>
 718 <th class="tableblock halign-left valign-middle">Type</th>
 719 <th class="tableblock halign-left valign-middle">Name</th>
 720 <th class="tableblock halign-left valign-middle">Schema</th>
 721 </tr>
 722 </thead>
 723 <tbody>
 724 <tr>
 725 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventType</strong><br>
 727 <em>optional</em></p></td>
 728 <td class="tableblock halign-left valign-middle"><p class="tableblock">enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)</p></td>
 729 </tr>
 730 <tr>
 731 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 732 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 733 <em>optional</em></p></td>
 734 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 735 </tr>
 736 </tbody>
 737 </table>
 738 </div>
 739 <div class="sect4">
 740 <h5 id="_responses_2">Responses</h5>
 741 <table class="tableblock frame-all grid-all spread">
 742 <colgroup>
 743 <col style="width: 10%;">
 744 <col style="width: 70%;">
 745 <col style="width: 20%;">
 746 </colgroup>
 747 <thead>
 748 <tr>
 749 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 750 <th class="tableblock halign-left valign-middle">Description</th>
 751 <th class="tableblock halign-left valign-middle">Schema</th>
 752 </tr>
 753 </thead>
 754 <tbody>
 755 <tr>
 756 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 757 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 758 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_hub">Hub</a> &gt; array</p></td>
 759 </tr>
 760 <tr>
 761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 762 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 763 <p class="tableblock">List of supported error codes:
 764 - 20: Invalid URL parameter value
 765 - 21: Missing body
 766 - 22: Invalid body
 767 - 23: Missing body field
 768 - 24: Invalid body field
 769 - 25: Missing header
 770 - 26: Invalid header value
 771 - 27: Missing query-string parameter
 772 - 28: Invalid query-string parameter value</p></td>
 773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 774 </tr>
 775 <tr>
 776 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 777 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 778 <p class="tableblock">List of supported error codes:
 779 - 40: Missing credentials
 780 - 41: Invalid credentials
 781 - 42: Expired credentials</p></td>
 782 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 783 </tr>
 784 <tr>
 785 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 786 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 787 <p class="tableblock">List of supported error codes:
 788 - 50: Access denied
 789 - 51: Forbidden requester
 790 - 52: Forbidden user
 791 - 53: Too many requests</p></td>
 792 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 793 </tr>
 794 <tr>
 795 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 796 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 797 <p class="tableblock">List of supported error codes:
 798 - 60: Resource not found</p></td>
 799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 800 </tr>
 801 <tr>
 802 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 803 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 804 <p class="tableblock">Functional error</p></td>
 805 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 806 </tr>
 807 <tr>
 808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 809 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 810 <p class="tableblock">List of supported error codes:
 811 - 1: Internal error</p></td>
 812 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 813 </tr>
 814 <tr>
 815 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 816 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 817 <p class="tableblock">List of supported error codes:
 818 - 5: The service is temporarily unavailable
 819 - 6: Orange API is over capacity, retry later !</p></td>
 820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 821 </tr>
 822 </tbody>
 823 </table>
 824 </div>
 825 <div class="sect4">
 826 <h5 id="_produces_2">Produces</h5>
 827 <div class="ulist">
 828 <ul>
 829 <li>
 830 <p><code>application/json;charset=utf-8</code></p>
 831 </li>
 832 </ul>
 833 </div>
 834 </div>
 835 </div>
 836 <div class="sect3">
 837 <h4 id="_hubget">Retrieve an HUB by id</h4>
 838 <div class="literalblock">
 839 <div class="content">
 840 <pre>GET /hub/{hubId}</pre>
 841 </div>
 842 </div>
 843 <div class="sect4">
 844 <h5 id="_description_3">Description</h5>
 845 <div class="paragraph">
 846 <p>Retrieve an HUB by id</p>
 847 </div>
 848 <div class="paragraph">
 849 <p>Specific business errors for current operation will be encapsulated in</p>
 850 </div>
 851 <div class="paragraph">
 852 <p>HTTP Response 422 Unprocessable entity</p>
 853 </div>
 854 </div>
 855 <div class="sect4">
 856 <h5 id="_parameters_3">Parameters</h5>
 857 <table class="tableblock frame-all grid-all spread">
 858 <colgroup>
 859 <col style="width: 22.2222%;">
 860 <col style="width: 33.3333%;">
 861 <col style="width: 44.4445%;">
 862 </colgroup>
 863 <thead>
 864 <tr>
 865 <th class="tableblock halign-left valign-middle">Type</th>
 866 <th class="tableblock halign-left valign-middle">Name</th>
 867 <th class="tableblock halign-left valign-middle">Schema</th>
 868 </tr>
 869 </thead>
 870 <tbody>
 871 <tr>
 872 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
 873 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>hubId</strong><br>
 874 <em>required</em></p></td>
 875 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 876 </tr>
 877 </tbody>
 878 </table>
 879 </div>
 880 <div class="sect4">
 881 <h5 id="_responses_3">Responses</h5>
 882 <table class="tableblock frame-all grid-all spread">
 883 <colgroup>
 884 <col style="width: 10%;">
 885 <col style="width: 70%;">
 886 <col style="width: 20%;">
 887 </colgroup>
 888 <thead>
 889 <tr>
 890 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 891 <th class="tableblock halign-left valign-middle">Description</th>
 892 <th class="tableblock halign-left valign-middle">Schema</th>
 893 </tr>
 894 </thead>
 895 <tbody>
 896 <tr>
 897 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 898 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 899 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_hub">Hub</a></p></td>
 900 </tr>
 901 <tr>
 902 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 903 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 904 <p class="tableblock">List of supported error codes:
 905 - 20: Invalid URL parameter value
 906 - 21: Missing body
 907 - 22: Invalid body
 908 - 23: Missing body field
 909 - 24: Invalid body field
 910 - 25: Missing header
 911 - 26: Invalid header value
 912 - 27: Missing query-string parameter
 913 - 28: Invalid query-string parameter value</p></td>
 914 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 915 </tr>
 916 <tr>
 917 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 918 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 919 <p class="tableblock">List of supported error codes:
 920 - 40: Missing credentials
 921 - 41: Invalid credentials
 922 - 42: Expired credentials</p></td>
 923 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 924 </tr>
 925 <tr>
 926 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 927 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 928 <p class="tableblock">List of supported error codes:
 929 - 50: Access denied
 930 - 51: Forbidden requester
 931 - 52: Forbidden user
 932 - 53: Too many requests</p></td>
 933 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 934 </tr>
 935 <tr>
 936 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 937 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 938 <p class="tableblock">List of supported error codes:
 939 - 60: Resource not found</p></td>
 940 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 941 </tr>
 942 <tr>
 943 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 944 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 945 <p class="tableblock">Functional error</p></td>
 946 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 947 </tr>
 948 <tr>
 949 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 950 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 951 <p class="tableblock">List of supported error codes:
 952 - 1: Internal error</p></td>
 953 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 954 </tr>
 955 <tr>
 956 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 957 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 958 <p class="tableblock">List of supported error codes:
 959 - 5: The service is temporarily unavailable
 960 - 6: Orange API is over capacity, retry later !</p></td>
 961 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 962 </tr>
 963 </tbody>
 964 </table>
 965 </div>
 966 <div class="sect4">
 967 <h5 id="_produces_3">Produces</h5>
 968 <div class="ulist">
 969 <ul>
 970 <li>
 971 <p><code>application/json;charset=utf-8</code></p>
 972 </li>
 973 </ul>
 974 </div>
 975 </div>
 976 </div>
 977 <div class="sect3">
 978 <h4 id="_hubdelete">delete hub</h4>
 979 <div class="literalblock">
 980 <div class="content">
 981 <pre>DELETE /hub/{hubId}</pre>
 982 </div>
 983 </div>
 984 <div class="sect4">
 985 <h5 id="_description_4">Description</h5>
 986 <div class="paragraph">
 987 <p>Specific business errors for current operation will be encapsulated in</p>
 988 </div>
 989 <div class="paragraph">
 990 <p>HTTP Response 422 Unprocessable entity</p>
 991 </div>
 992 </div>
 993 <div class="sect4">
 994 <h5 id="_parameters_4">Parameters</h5>
 995 <table class="tableblock frame-all grid-all spread">
 996 <colgroup>
 997 <col style="width: 22.2222%;">
 998 <col style="width: 33.3333%;">
 999 <col style="width: 44.4445%;">
1000 </colgroup>
1001 <thead>
1002 <tr>
1003 <th class="tableblock halign-left valign-middle">Type</th>
1004 <th class="tableblock halign-left valign-middle">Name</th>
1005 <th class="tableblock halign-left valign-middle">Schema</th>
1006 </tr>
1007 </thead>
1008 <tbody>
1009 <tr>
1010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1011 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>hubId</strong><br>
1012 <em>required</em></p></td>
1013 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1014 </tr>
1015 </tbody>
1016 </table>
1017 </div>
1018 <div class="sect4">
1019 <h5 id="_responses_4">Responses</h5>
1020 <table class="tableblock frame-all grid-all spread">
1021 <colgroup>
1022 <col style="width: 10%;">
1023 <col style="width: 70%;">
1024 <col style="width: 20%;">
1025 </colgroup>
1026 <thead>
1027 <tr>
1028 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1029 <th class="tableblock halign-left valign-middle">Description</th>
1030 <th class="tableblock halign-left valign-middle">Schema</th>
1031 </tr>
1032 </thead>
1033 <tbody>
1034 <tr>
1035 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>204</strong></p></td>
1036 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
1037 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1038 </tr>
1039 <tr>
1040 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
1041 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
1042 <p class="tableblock">List of supported error codes:
1043 - 20: Invalid URL parameter value
1044 - 21: Missing body
1045 - 22: Invalid body
1046 - 23: Missing body field
1047 - 24: Invalid body field
1048 - 25: Missing header
1049 - 26: Invalid header value
1050 - 27: Missing query-string parameter
1051 - 28: Invalid query-string parameter value</p></td>
1052 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1053 </tr>
1054 <tr>
1055 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
1056 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
1057 <p class="tableblock">List of supported error codes:
1058 - 40: Missing credentials
1059 - 41: Invalid credentials
1060 - 42: Expired credentials</p></td>
1061 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1062 </tr>
1063 <tr>
1064 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1065 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1066 <p class="tableblock">List of supported error codes:
1067 - 50: Access denied
1068 - 51: Forbidden requester
1069 - 52: Forbidden user
1070 - 53: Too many requests</p></td>
1071 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1072 </tr>
1073 <tr>
1074 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1075 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1076 <p class="tableblock">List of supported error codes:
1077 - 60: Resource not found</p></td>
1078 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1079 </tr>
1080 <tr>
1081 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1082 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1083 <p class="tableblock">Functional error</p></td>
1084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1085 </tr>
1086 <tr>
1087 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1088 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1089 <p class="tableblock">List of supported error codes:
1090 - 1: Internal error</p></td>
1091 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1092 </tr>
1093 <tr>
1094 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1095 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1096 <p class="tableblock">List of supported error codes:
1097 - 5: The service is temporarily unavailable
1098 - 6: Orange API is over capacity, retry later !</p></td>
1099 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1100 </tr>
1101 </tbody>
1102 </table>
1103 </div>
1104 </div>
1105 </div>
1106 <div class="sect2">
1107 <h3 id="_notification_resource">Notification</h3>
1108 <div class="sect3">
1109 <h4 id="_notificationserviceordercreationnotification">Service order creation notification</h4>
1110 <div class="literalblock">
1111 <div class="content">
1112 <pre>POST /notification/serviceOrderCreationNotification</pre>
1113 </div>
1114 </div>
1115 <div class="sect4">
1116 <h5 id="_description_5">Description</h5>
1117 <div class="paragraph">
1118 <p>Service order creation notification</p>
1119 </div>
1120 <div class="paragraph">
1121 <p>Specific business errors for current operation will be encapsulated in</p>
1122 </div>
1123 <div class="paragraph">
1124 <p>HTTP Response 422 Unprocessable entity</p>
1125 </div>
1126 </div>
1127 <div class="sect4">
1128 <h5 id="_parameters_5">Parameters</h5>
1129 <table class="tableblock frame-all grid-all spread">
1130 <colgroup>
1131 <col style="width: 22.2222%;">
1132 <col style="width: 33.3333%;">
1133 <col style="width: 44.4445%;">
1134 </colgroup>
1135 <thead>
1136 <tr>
1137 <th class="tableblock halign-left valign-middle">Type</th>
1138 <th class="tableblock halign-left valign-middle">Name</th>
1139 <th class="tableblock halign-left valign-middle">Schema</th>
1140 </tr>
1141 </thead>
1142 <tbody>
1143 <tr>
1144 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1145 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrderCreationNotification</strong><br>
1146 <em>required</em></p></td>
1147 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceordercreationnotification">ServiceOrderCreationNotification</a></p></td>
1148 </tr>
1149 </tbody>
1150 </table>
1151 </div>
1152 <div class="sect4">
1153 <h5 id="_responses_5">Responses</h5>
1154 <table class="tableblock frame-all grid-all spread">
1155 <colgroup>
1156 <col style="width: 10%;">
1157 <col style="width: 70%;">
1158 <col style="width: 20%;">
1159 </colgroup>
1160 <thead>
1161 <tr>
1162 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1163 <th class="tableblock halign-left valign-middle">Description</th>
1164 <th class="tableblock halign-left valign-middle">Schema</th>
1165 </tr>
1166 </thead>
1167 <tbody>
1168 <tr>
1169 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>204</strong></p></td>
1170 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
1171 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1172 </tr>
1173 <tr>
1174 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
1175 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
1176 <p class="tableblock">List of supported error codes:
1177 - 20: Invalid URL parameter value
1178 - 21: Missing body
1179 - 22: Invalid body
1180 - 23: Missing body field
1181 - 24: Invalid body field
1182 - 25: Missing header
1183 - 26: Invalid header value
1184 - 27: Missing query-string parameter
1185 - 28: Invalid query-string parameter value</p></td>
1186 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1187 </tr>
1188 <tr>
1189 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
1190 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
1191 <p class="tableblock">List of supported error codes:
1192 - 40: Missing credentials
1193 - 41: Invalid credentials
1194 - 42: Expired credentials</p></td>
1195 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1196 </tr>
1197 <tr>
1198 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1199 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1200 <p class="tableblock">List of supported error codes:
1201 - 50: Access denied
1202 - 51: Forbidden requester
1203 - 52: Forbidden user
1204 - 53: Too many requests</p></td>
1205 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1206 </tr>
1207 <tr>
1208 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1209 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1210 <p class="tableblock">List of supported error codes:
1211 - 60: Resource not found</p></td>
1212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1213 </tr>
1214 <tr>
1215 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1216 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1217 <p class="tableblock">Functional error</p></td>
1218 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1219 </tr>
1220 <tr>
1221 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1222 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1223 <p class="tableblock">List of supported error codes:
1224 - 1: Internal error</p></td>
1225 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1226 </tr>
1227 <tr>
1228 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1229 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1230 <p class="tableblock">List of supported error codes:
1231 - 5: The service is temporarily unavailable
1232 - 6: Orange API is over capacity, retry later !</p></td>
1233 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1234 </tr>
1235 </tbody>
1236 </table>
1237 </div>
1238 <div class="sect4">
1239 <h5 id="_consumes_2">Consumes</h5>
1240 <div class="ulist">
1241 <ul>
1242 <li>
1243 <p><code>application/json;charset=utf-8</code></p>
1244 </li>
1245 </ul>
1246 </div>
1247 </div>
1248 </div>
1249 <div class="sect3">
1250 <h4 id="_notificationserviceorderitemstatechangenotification">ServiceOrder Item State Change Notification description</h4>
1251 <div class="literalblock">
1252 <div class="content">
1253 <pre>POST /notification/serviceOrderItemStateChangeNotification</pre>
1254 </div>
1255 </div>
1256 <div class="sect4">
1257 <h5 id="_description_6">Description</h5>
1258 <div class="paragraph">
1259 <p>Specific business errors for current operation will be encapsulated in</p>
1260 </div>
1261 <div class="paragraph">
1262 <p>HTTP Response 422 Unprocessable entity</p>
1263 </div>
1264 </div>
1265 <div class="sect4">
1266 <h5 id="_parameters_6">Parameters</h5>
1267 <table class="tableblock frame-all grid-all spread">
1268 <colgroup>
1269 <col style="width: 22.2222%;">
1270 <col style="width: 33.3333%;">
1271 <col style="width: 44.4445%;">
1272 </colgroup>
1273 <thead>
1274 <tr>
1275 <th class="tableblock halign-left valign-middle">Type</th>
1276 <th class="tableblock halign-left valign-middle">Name</th>
1277 <th class="tableblock halign-left valign-middle">Schema</th>
1278 </tr>
1279 </thead>
1280 <tbody>
1281 <tr>
1282 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1283 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrderItemStateChangeNotification</strong><br>
1284 <em>required</em></p></td>
1285 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorderitemstatechangenotification">ServiceOrderItemStateChangeNotification</a></p></td>
1286 </tr>
1287 </tbody>
1288 </table>
1289 </div>
1290 <div class="sect4">
1291 <h5 id="_responses_6">Responses</h5>
1292 <table class="tableblock frame-all grid-all spread">
1293 <colgroup>
1294 <col style="width: 10%;">
1295 <col style="width: 70%;">
1296 <col style="width: 20%;">
1297 </colgroup>
1298 <thead>
1299 <tr>
1300 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1301 <th class="tableblock halign-left valign-middle">Description</th>
1302 <th class="tableblock halign-left valign-middle">Schema</th>
1303 </tr>
1304 </thead>
1305 <tbody>
1306 <tr>
1307 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>204</strong></p></td>
1308 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
1309 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1310 </tr>
1311 <tr>
1312 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
1313 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
1314 <p class="tableblock">List of supported error codes:
1315 - 20: Invalid URL parameter value
1316 - 21: Missing body
1317 - 22: Invalid body
1318 - 23: Missing body field
1319 - 24: Invalid body field
1320 - 25: Missing header
1321 - 26: Invalid header value
1322 - 27: Missing query-string parameter
1323 - 28: Invalid query-string parameter value</p></td>
1324 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1325 </tr>
1326 <tr>
1327 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
1328 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
1329 <p class="tableblock">List of supported error codes:
1330 - 40: Missing credentials
1331 - 41: Invalid credentials
1332 - 42: Expired credentials</p></td>
1333 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1334 </tr>
1335 <tr>
1336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1337 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1338 <p class="tableblock">List of supported error codes:
1339 - 50: Access denied
1340 - 51: Forbidden requester
1341 - 52: Forbidden user
1342 - 53: Too many requests</p></td>
1343 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1344 </tr>
1345 <tr>
1346 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1347 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1348 <p class="tableblock">List of supported error codes:
1349 - 60: Resource not found</p></td>
1350 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1351 </tr>
1352 <tr>
1353 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1354 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1355 <p class="tableblock">Functional error</p></td>
1356 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1357 </tr>
1358 <tr>
1359 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1360 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1361 <p class="tableblock">List of supported error codes:
1362 - 1: Internal error</p></td>
1363 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1364 </tr>
1365 <tr>
1366 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1367 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1368 <p class="tableblock">List of supported error codes:
1369 - 5: The service is temporarily unavailable
1370 - 6: Orange API is over capacity, retry later !</p></td>
1371 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1372 </tr>
1373 </tbody>
1374 </table>
1375 </div>
1376 <div class="sect4">
1377 <h5 id="_consumes_3">Consumes</h5>
1378 <div class="ulist">
1379 <ul>
1380 <li>
1381 <p><code>application/json;charset=utf-8</code></p>
1382 </li>
1383 </ul>
1384 </div>
1385 </div>
1386 </div>
1387 <div class="sect3">
1388 <h4 id="_notificationserviceorderstatechangenotification">Service order state change notification description</h4>
1389 <div class="literalblock">
1390 <div class="content">
1391 <pre>POST /notification/serviceOrderStateChangeNotification</pre>
1392 </div>
1393 </div>
1394 <div class="sect4">
1395 <h5 id="_description_7">Description</h5>
1396 <div class="paragraph">
1397 <p>Specific business errors for current operation will be encapsulated in</p>
1398 </div>
1399 <div class="paragraph">
1400 <p>HTTP Response 422 Unprocessable entity</p>
1401 </div>
1402 </div>
1403 <div class="sect4">
1404 <h5 id="_parameters_7">Parameters</h5>
1405 <table class="tableblock frame-all grid-all spread">
1406 <colgroup>
1407 <col style="width: 22.2222%;">
1408 <col style="width: 33.3333%;">
1409 <col style="width: 44.4445%;">
1410 </colgroup>
1411 <thead>
1412 <tr>
1413 <th class="tableblock halign-left valign-middle">Type</th>
1414 <th class="tableblock halign-left valign-middle">Name</th>
1415 <th class="tableblock halign-left valign-middle">Schema</th>
1416 </tr>
1417 </thead>
1418 <tbody>
1419 <tr>
1420 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1421 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrderstateChangeNotification</strong><br>
1422 <em>required</em></p></td>
1423 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorderstatechangenotification">ServiceOrderStateChangeNotification</a></p></td>
1424 </tr>
1425 </tbody>
1426 </table>
1427 </div>
1428 <div class="sect4">
1429 <h5 id="_responses_7">Responses</h5>
1430 <table class="tableblock frame-all grid-all spread">
1431 <colgroup>
1432 <col style="width: 10%;">
1433 <col style="width: 70%;">
1434 <col style="width: 20%;">
1435 </colgroup>
1436 <thead>
1437 <tr>
1438 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1439 <th class="tableblock halign-left valign-middle">Description</th>
1440 <th class="tableblock halign-left valign-middle">Schema</th>
1441 </tr>
1442 </thead>
1443 <tbody>
1444 <tr>
1445 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>204</strong></p></td>
1446 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
1447 <td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
1448 </tr>
1449 <tr>
1450 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
1451 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
1452 <p class="tableblock">List of supported error codes:
1453 - 20: Invalid URL parameter value
1454 - 21: Missing body
1455 - 22: Invalid body
1456 - 23: Missing body field
1457 - 24: Invalid body field
1458 - 25: Missing header
1459 - 26: Invalid header value
1460 - 27: Missing query-string parameter
1461 - 28: Invalid query-string parameter value</p></td>
1462 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1463 </tr>
1464 <tr>
1465 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
1466 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
1467 <p class="tableblock">List of supported error codes:
1468 - 40: Missing credentials
1469 - 41: Invalid credentials
1470 - 42: Expired credentials</p></td>
1471 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1472 </tr>
1473 <tr>
1474 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1475 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1476 <p class="tableblock">List of supported error codes:
1477 - 50: Access denied
1478 - 51: Forbidden requester
1479 - 52: Forbidden user
1480 - 53: Too many requests</p></td>
1481 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1482 </tr>
1483 <tr>
1484 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1485 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1486 <p class="tableblock">List of supported error codes:
1487 - 60: Resource not found</p></td>
1488 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1489 </tr>
1490 <tr>
1491 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1492 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1493 <p class="tableblock">Functional error</p></td>
1494 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1495 </tr>
1496 <tr>
1497 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1498 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1499 <p class="tableblock">List of supported error codes:
1500 - 1: Internal error</p></td>
1501 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1502 </tr>
1503 <tr>
1504 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1505 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1506 <p class="tableblock">List of supported error codes:
1507 - 5: The service is temporarily unavailable
1508 - 6: Orange API is over capacity, retry later !</p></td>
1509 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1510 </tr>
1511 </tbody>
1512 </table>
1513 </div>
1514 <div class="sect4">
1515 <h5 id="_consumes_4">Consumes</h5>
1516 <div class="ulist">
1517 <ul>
1518 <li>
1519 <p><code>application/json;charset=utf-8</code></p>
1520 </li>
1521 </ul>
1522 </div>
1523 </div>
1524 </div>
1525 </div>
1526 <div class="sect2">
1527 <h3 id="_serviceorder_resource">ServiceOrder</h3>
1528 <div class="paragraph">
1529 <p>A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.</p>
1530 </div>
1531 <div class="sect3">
1532 <h4 id="_serviceordercreate">Create a service order</h4>
1533 <div class="literalblock">
1534 <div class="content">
1535 <pre>POST /serviceOrder</pre>
1536 </div>
1537 </div>
1538 <div class="sect4">
1539 <h5 id="_description_8">Description</h5>
1540 <div class="paragraph">
1541 <p>This operation creates a service order entity.
1542 The TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values.
1543 POST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.</p>
1544 </div>
1545 <div class="paragraph">
1546 <p>In Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created.</p>
1547 </div>
1548 <div class="paragraph">
1549 <p>In Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC.
1550 Depending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API.</p>
1551 </div>
1552 <div class="paragraph">
1553 <p>Specific business errors for current operation will be encapsulated in</p>
1554 </div>
1555 <div class="paragraph">
1556 <p>HTTP Response 422 Unprocessable entity</p>
1557 </div>
1558 <div class="ulist">
1559 <ul>
1560 <li>
1561 <p>100: OrderItem with 'add' action but serviceSpecification id missing</p>
1562 </li>
1563 <li>
1564 <p>101: OrderItem with 'change'/'noChange'/'remove' but service id missing</p>
1565 </li>
1566 <li>
1567 <p>102: OrderItem with 'add' action - serviceSpecification id provided but not existing</p>
1568 </li>
1569 <li>
1570 <p>103: OrderItem with 'add' action but service id already existing in the inventory</p>
1571 </li>
1572 <li>
1573 <p>104: A customer for existing service(s) is provided but he did not exist</p>
1574 </li>
1575 <li>
1576 <p>105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory</p>
1577 </li>
1578 <li>
1579 <p>106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided</p>
1580 </li>
1581 </ul>
1582 </div>
1583 </div>
1584 <div class="sect4">
1585 <h5 id="_parameters_8">Parameters</h5>
1586 <table class="tableblock frame-all grid-all spread">
1587 <colgroup>
1588 <col style="width: 22.2222%;">
1589 <col style="width: 33.3333%;">
1590 <col style="width: 44.4445%;">
1591 </colgroup>
1592 <thead>
1593 <tr>
1594 <th class="tableblock halign-left valign-middle">Type</th>
1595 <th class="tableblock halign-left valign-middle">Name</th>
1596 <th class="tableblock halign-left valign-middle">Schema</th>
1597 </tr>
1598 </thead>
1599 <tbody>
1600 <tr>
1601 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
1602 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrder</strong><br>
1603 <em>required</em></p></td>
1604 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_createserviceorder">CreateServiceOrder</a></p></td>
1605 </tr>
1606 </tbody>
1607 </table>
1608 </div>
1609 <div class="sect4">
1610 <h5 id="_responses_8">Responses</h5>
1611 <table class="tableblock frame-all grid-all spread">
1612 <colgroup>
1613 <col style="width: 10%;">
1614 <col style="width: 70%;">
1615 <col style="width: 20%;">
1616 </colgroup>
1617 <thead>
1618 <tr>
1619 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1620 <th class="tableblock halign-left valign-middle">Description</th>
1621 <th class="tableblock halign-left valign-middle">Schema</th>
1622 </tr>
1623 </thead>
1624 <tbody>
1625 <tr>
1626 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>201</strong></p></td>
1627 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
1628 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorder">ServiceOrder</a></p></td>
1629 </tr>
1630 <tr>
1631 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
1632 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
1633 <p class="tableblock">List of supported error codes:
1634 - 20: Invalid URL parameter value
1635 - 21: Missing body
1636 - 22: Invalid body
1637 - 23: Missing body field
1638 - 24: Invalid body field
1639 - 25: Missing header
1640 - 26: Invalid header value
1641 - 27: Missing query-string parameter
1642 - 28: Invalid query-string parameter value</p></td>
1643 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1644 </tr>
1645 <tr>
1646 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
1647 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
1648 <p class="tableblock">List of supported error codes:
1649 - 40: Missing credentials
1650 - 41: Invalid credentials
1651 - 42: Expired credentials</p></td>
1652 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1653 </tr>
1654 <tr>
1655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1656 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1657 <p class="tableblock">List of supported error codes:
1658 - 50: Access denied
1659 - 51: Forbidden requester
1660 - 52: Forbidden user
1661 - 53: Too many requests</p></td>
1662 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1663 </tr>
1664 <tr>
1665 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1666 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1667 <p class="tableblock">List of supported error codes:
1668 - 60: Resource not found</p></td>
1669 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1670 </tr>
1671 <tr>
1672 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1673 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1674 <p class="tableblock">Functional error</p>
1675 <p class="tableblock">Specific encapsulated business errors for current operation</p>
1676 <p class="tableblock">* 100: OrderItem with 'add' action but serviceSpecification id missing</p>
1677 <p class="tableblock">* 101: OrderItem with 'change'/'noChange'/'remove' but service id missing</p>
1678 <p class="tableblock">* 102: OrderItem with 'add' action - serviceSpecification id provided but not existing</p>
1679 <p class="tableblock">* 103: OrderItem with 'add' action but service id already existing in the inventory</p>
1680 <p class="tableblock">* 104: A customer for existing service(s) is provided but he did not exist</p>
1681 <p class="tableblock">* 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory</p>
1682 <p class="tableblock">* 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided</p></td>
1683 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1684 </tr>
1685 <tr>
1686 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1687 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1688 <p class="tableblock">List of supported error codes:
1689 - 1: Internal error</p></td>
1690 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1691 </tr>
1692 <tr>
1693 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1694 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1695 <p class="tableblock">List of supported error codes:
1696 - 5: The service is temporarily unavailable
1697 - 6: Orange API is over capacity, retry later !</p></td>
1698 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1699 </tr>
1700 </tbody>
1701 </table>
1702 </div>
1703 <div class="sect4">
1704 <h5 id="_consumes_5">Consumes</h5>
1705 <div class="ulist">
1706 <ul>
1707 <li>
1708 <p><code>application/json;charset=utf-8</code></p>
1709 </li>
1710 </ul>
1711 </div>
1712 </div>
1713 <div class="sect4">
1714 <h5 id="_produces_4">Produces</h5>
1715 <div class="ulist">
1716 <ul>
1717 <li>
1718 <p><code>application/json;charset=utf-8</code></p>
1719 </li>
1720 </ul>
1721 </div>
1722 </div>
1723 </div>
1724 <div class="sect3">
1725 <h4 id="_serviceorderfind">List service orders</h4>
1726 <div class="literalblock">
1727 <div class="content">
1728 <pre>GET /serviceOrder</pre>
1729 </div>
1730 </div>
1731 <div class="sect4">
1732 <h5 id="_description_9">Description</h5>
1733 <div class="paragraph">
1734 <p>Retrieve and list service order entities according to given criteria.
1735 Only a predefined set of attribute is proposed.
1736 Attribute selection could be described in the fields attribute.</p>
1737 </div>
1738 <div class="paragraph">
1739 <p>Specific business errors for current operation will be encapsulated in</p>
1740 </div>
1741 <div class="paragraph">
1742 <p>HTTP Response 422 Unprocessable entity</p>
1743 </div>
1744 </div>
1745 <div class="sect4">
1746 <h5 id="_parameters_9">Parameters</h5>
1747 <table class="tableblock frame-all grid-all spread">
1748 <colgroup>
1749 <col style="width: 11.1111%;">
1750 <col style="width: 16.6666%;">
1751 <col style="width: 50%;">
1752 <col style="width: 22.2223%;">
1753 </colgroup>
1754 <thead>
1755 <tr>
1756 <th class="tableblock halign-left valign-middle">Type</th>
1757 <th class="tableblock halign-left valign-middle">Name</th>
1758 <th class="tableblock halign-left valign-middle">Description</th>
1759 <th class="tableblock halign-left valign-middle">Schema</th>
1760 </tr>
1761 </thead>
1762 <tbody>
1763 <tr>
1764 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1765 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1766 <em>optional</em></p></td>
1767 <td class="tableblock halign-left valign-middle"></td>
1768 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1769 </tr>
1770 <tr>
1771 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1772 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
1773 <em>optional</em></p></td>
1774 <td class="tableblock halign-left valign-middle"></td>
1775 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1776 </tr>
1777 <tr>
1778 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1779 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br>
1780 <em>optional</em></p></td>
1781 <td class="tableblock halign-left valign-middle"><p class="tableblock">this attribute could be used to filter retrieved attribute(s) and/or sort SO.</p></td>
1782 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1783 </tr>
1784 <tr>
1785 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1786 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>limit</strong><br>
1787 <em>optional</em></p></td>
1788 <td class="tableblock halign-left valign-middle"><p class="tableblock">The maximum number of elements to retrieve (it can be greater than the actual available number of items).</p></td>
1789 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1790 </tr>
1791 <tr>
1792 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1793 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>offset</strong><br>
1794 <em>optional</em></p></td>
1795 <td class="tableblock halign-left valign-middle"><p class="tableblock">The index of the first element to retrieve. Zero is the first element of the collection.</p></td>
1796 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1797 </tr>
1798 <tr>
1799 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate.gt</strong><br>
1801 <em>optional</em></p></td>
1802 <td class="tableblock halign-left valign-middle"><p class="tableblock">order date greather than</p></td>
1803 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1804 </tr>
1805 <tr>
1806 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1807 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate.lt</strong><br>
1808 <em>optional</em></p></td>
1809 <td class="tableblock halign-left valign-middle"><p class="tableblock">order date lower than</p></td>
1810 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1811 </tr>
1812 <tr>
1813 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1814 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
1815 <em>optional</em></p></td>
1816 <td class="tableblock halign-left valign-middle"><p class="tableblock">state of the order(s) to be retrieved</p></td>
1817 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1818 </tr>
1819 </tbody>
1820 </table>
1821 </div>
1822 <div class="sect4">
1823 <h5 id="_responses_9">Responses</h5>
1824 <table class="tableblock frame-all grid-all spread">
1825 <colgroup>
1826 <col style="width: 10%;">
1827 <col style="width: 70%;">
1828 <col style="width: 20%;">
1829 </colgroup>
1830 <thead>
1831 <tr>
1832 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1833 <th class="tableblock halign-left valign-middle">Description</th>
1834 <th class="tableblock halign-left valign-middle">Schema</th>
1835 </tr>
1836 </thead>
1837 <tbody>
1838 <tr>
1839 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1840 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success<br>
1841 <strong>Headers</strong> : <br>
1842 <code>X-Total-Count</code> (integer (int32))<br>
1843 <code>X-Result-Count</code> (integer (int32))</p></td>
1844 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_serviceorder">ServiceOrder</a> &gt; array</p></td>
1845 </tr>
1846 <tr>
1847 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
1848 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
1849 <p class="tableblock">List of supported error codes:
1850 - 20: Invalid URL parameter value
1851 - 21: Missing body
1852 - 22: Invalid body
1853 - 23: Missing body field
1854 - 24: Invalid body field
1855 - 25: Missing header
1856 - 26: Invalid header value
1857 - 27: Missing query-string parameter
1858 - 28: Invalid query-string parameter value</p></td>
1859 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1860 </tr>
1861 <tr>
1862 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
1863 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
1864 <p class="tableblock">List of supported error codes:
1865 - 40: Missing credentials
1866 - 41: Invalid credentials
1867 - 42: Expired credentials</p></td>
1868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1869 </tr>
1870 <tr>
1871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1872 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1873 <p class="tableblock">List of supported error codes:
1874 - 50: Access denied
1875 - 51: Forbidden requester
1876 - 52: Forbidden user
1877 - 53: Too many requests</p></td>
1878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1879 </tr>
1880 <tr>
1881 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1882 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1883 <p class="tableblock">List of supported error codes:
1884 - 60: Resource not found</p></td>
1885 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1886 </tr>
1887 <tr>
1888 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1889 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1890 <p class="tableblock">Functional error</p></td>
1891 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1892 </tr>
1893 <tr>
1894 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1895 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1896 <p class="tableblock">List of supported error codes:
1897 - 1: Internal error</p></td>
1898 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1899 </tr>
1900 <tr>
1901 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1902 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1903 <p class="tableblock">List of supported error codes:
1904 - 5: The service is temporarily unavailable
1905 - 6: Orange API is over capacity, retry later !</p></td>
1906 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1907 </tr>
1908 </tbody>
1909 </table>
1910 </div>
1911 <div class="sect4">
1912 <h5 id="_produces_5">Produces</h5>
1913 <div class="ulist">
1914 <ul>
1915 <li>
1916 <p><code>application/json;charset=utf-8</code></p>
1917 </li>
1918 </ul>
1919 </div>
1920 </div>
1921 </div>
1922 <div class="sect3">
1923 <h4 id="_serviceorderget">Retrieve a service order</h4>
1924 <div class="literalblock">
1925 <div class="content">
1926 <pre>GET /serviceOrder/{id}</pre>
1927 </div>
1928 </div>
1929 <div class="sect4">
1930 <h5 id="_description_10">Description</h5>
1931 <div class="paragraph">
1932 <p>This operation retrieves a service order entity.
1933 Attribute selection is enabled for all first level attributes.</p>
1934 </div>
1935 <div class="paragraph">
1936 <p>Specific business errors for current operation will be encapsulated in</p>
1937 </div>
1938 <div class="paragraph">
1939 <p>HTTP Response 422 Unprocessable entity</p>
1940 </div>
1941 </div>
1942 <div class="sect4">
1943 <h5 id="_parameters_10">Parameters</h5>
1944 <table class="tableblock frame-all grid-all spread">
1945 <colgroup>
1946 <col style="width: 11.1111%;">
1947 <col style="width: 16.6666%;">
1948 <col style="width: 50%;">
1949 <col style="width: 22.2223%;">
1950 </colgroup>
1951 <thead>
1952 <tr>
1953 <th class="tableblock halign-left valign-middle">Type</th>
1954 <th class="tableblock halign-left valign-middle">Name</th>
1955 <th class="tableblock halign-left valign-middle">Description</th>
1956 <th class="tableblock halign-left valign-middle">Schema</th>
1957 </tr>
1958 </thead>
1959 <tbody>
1960 <tr>
1961 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
1962 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1963 <em>required</em></p></td>
1964 <td class="tableblock halign-left valign-middle"></td>
1965 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1966 </tr>
1967 <tr>
1968 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
1969 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br>
1970 <em>optional</em></p></td>
1971 <td class="tableblock halign-left valign-middle"><p class="tableblock">Attribute selection</p></td>
1972 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1973 </tr>
1974 </tbody>
1975 </table>
1976 </div>
1977 <div class="sect4">
1978 <h5 id="_responses_10">Responses</h5>
1979 <table class="tableblock frame-all grid-all spread">
1980 <colgroup>
1981 <col style="width: 10%;">
1982 <col style="width: 70%;">
1983 <col style="width: 20%;">
1984 </colgroup>
1985 <thead>
1986 <tr>
1987 <th class="tableblock halign-left valign-middle">HTTP Code</th>
1988 <th class="tableblock halign-left valign-middle">Description</th>
1989 <th class="tableblock halign-left valign-middle">Schema</th>
1990 </tr>
1991 </thead>
1992 <tbody>
1993 <tr>
1994 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
1995 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
1996 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorder">ServiceOrder</a></p></td>
1997 </tr>
1998 <tr>
1999 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
2000 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
2001 <p class="tableblock">List of supported error codes:
2002 - 20: Invalid URL parameter value
2003 - 21: Missing body
2004 - 22: Invalid body
2005 - 23: Missing body field
2006 - 24: Invalid body field
2007 - 25: Missing header
2008 - 26: Invalid header value
2009 - 27: Missing query-string parameter
2010 - 28: Invalid query-string parameter value</p></td>
2011 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2012 </tr>
2013 <tr>
2014 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
2015 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
2016 <p class="tableblock">List of supported error codes:
2017 - 40: Missing credentials
2018 - 41: Invalid credentials
2019 - 42: Expired credentials</p></td>
2020 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2021 </tr>
2022 <tr>
2023 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
2024 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
2025 <p class="tableblock">List of supported error codes:
2026 - 50: Access denied
2027 - 51: Forbidden requester
2028 - 52: Forbidden user
2029 - 53: Too many requests</p></td>
2030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2031 </tr>
2032 <tr>
2033 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
2034 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
2035 <p class="tableblock">List of supported error codes:
2036 - 60: Resource not found</p></td>
2037 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2038 </tr>
2039 <tr>
2040 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
2041 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
2042 <p class="tableblock">Functional error</p></td>
2043 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2044 </tr>
2045 <tr>
2046 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
2047 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
2048 <p class="tableblock">List of supported error codes:
2049 - 1: Internal error</p></td>
2050 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2051 </tr>
2052 <tr>
2053 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
2054 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
2055 <p class="tableblock">List of supported error codes:
2056 - 5: The service is temporarily unavailable
2057 - 6: Orange API is over capacity, retry later !</p></td>
2058 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
2059 </tr>
2060 </tbody>
2061 </table>
2062 </div>
2063 <div class="sect4">
2064 <h5 id="_produces_6">Produces</h5>
2065 <div class="ulist">
2066 <ul>
2067 <li>
2068 <p><code>application/json;charset=utf-8</code></p>
2069 </li>
2070 </ul>
2071 </div>
2072 </div>
2073 </div>
2074 </div>
2075 </div>
2076 </div>
2077 <div class="sect1">
2078 <h2 id="_definitions">Definitions</h2>
2079 <div class="sectionbody">
2080 <div class="sect2">
2081 <h3 id="_actiontype">ActionType</h3>
2082 <div class="paragraph">
2083 <p>Action type to be describer on the order item.
2084 modify is not managed in Beijing release</p>
2085 </div>
2086 <div class="paragraph">
2087 <p><em>Type</em> : enum (add, modify, delete, noChange)</p>
2088 </div>
2089 </div>
2090 <div class="sect2">
2091 <h3 id="_createhub">CreateHub</h3>
2092 <div class="paragraph">
2093 <p>This structure is used as a request for POST Hub operation</p>
2094 </div>
2095 <table class="tableblock frame-all grid-all spread">
2096 <colgroup>
2097 <col style="width: 16.6666%;">
2098 <col style="width: 61.1111%;">
2099 <col style="width: 22.2223%;">
2100 </colgroup>
2101 <thead>
2102 <tr>
2103 <th class="tableblock halign-left valign-middle">Name</th>
2104 <th class="tableblock halign-left valign-middle">Description</th>
2105 <th class="tableblock halign-left valign-middle">Schema</th>
2106 </tr>
2107 </thead>
2108 <tbody>
2109 <tr>
2110 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>callback</strong><br>
2111 <em>required</em></p></td>
2112 <td class="tableblock halign-left valign-middle"><p class="tableblock">Address where notification must be send</p></td>
2113 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2114 </tr>
2115 <tr>
2116 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>query</strong><br>
2117 <em>required</em></p></td>
2118 <td class="tableblock halign-left valign-middle"><p class="tableblock">The query must have an eventType=notificationName information.
2119 Optionally a ? could be added to reduce hub.
2120 query”:”eventType = ServiceOrderStateChangeNotification”&amp;serviceOrder.state=COMPLETED</p></td>
2121 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2122 </tr>
2123 </tbody>
2124 </table>
2125 </div>
2126 <div class="sect2">
2127 <h3 id="_createserviceorder">CreateServiceOrder</h3>
2128 <div class="paragraph">
2129 <p>This structure is used in the operation POST for a serviceOrder request.
2130 Attribute description is not accurate and should be find in the serviceOrder class.</p>
2131 </div>
2132 <table class="tableblock frame-all grid-all spread">
2133 <colgroup>
2134 <col style="width: 16.6666%;">
2135 <col style="width: 61.1111%;">
2136 <col style="width: 22.2223%;">
2137 </colgroup>
2138 <thead>
2139 <tr>
2140 <th class="tableblock halign-left valign-middle">Name</th>
2141 <th class="tableblock halign-left valign-middle">Description</th>
2142 <th class="tableblock halign-left valign-middle">Schema</th>
2143 </tr>
2144 </thead>
2145 <tbody>
2146 <tr>
2147 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
2148 <em>optional</em></p></td>
2149 <td class="tableblock halign-left valign-middle"></td>
2150 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2151 </tr>
2152 <tr>
2153 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2154 <em>optional</em></p></td>
2155 <td class="tableblock halign-left valign-middle"></td>
2156 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2157 </tr>
2158 <tr>
2159 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2160 <em>optional</em></p></td>
2161 <td class="tableblock halign-left valign-middle"></td>
2162 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2163 </tr>
2164 <tr>
2165 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
2166 <em>optional</em></p></td>
2167 <td class="tableblock halign-left valign-middle"><p class="tableblock">Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)</p></td>
2168 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2169 </tr>
2170 <tr>
2171 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2172 <em>optional</em></p></td>
2173 <td class="tableblock halign-left valign-middle"><p class="tableblock">A free-text description of the service order</p></td>
2174 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2175 </tr>
2176 <tr>
2177 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
2178 <em>optional</em></p></td>
2179 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID given by the consumer and only understandable by him (to facilitate his searches)</p></td>
2180 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2181 </tr>
2182 <tr>
2183 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItem</strong><br>
2184 <em>optional</em></p></td>
2185 <td class="tableblock halign-left valign-middle"></td>
2186 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_createserviceorderitem">CreateServiceOrderItem</a> &gt; array</p></td>
2187 </tr>
2188 <tr>
2189 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderRelationship</strong><br>
2190 <em>optional</em></p></td>
2191 <td class="tableblock halign-left valign-middle"></td>
2192 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderrelationship">OrderRelationship</a> &gt; array</p></td>
2193 </tr>
2194 <tr>
2195 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>priority</strong><br>
2196 <em>optional</em></p></td>
2197 <td class="tableblock halign-left valign-middle"><p class="tableblock">A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)</p></td>
2198 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2199 </tr>
2200 <tr>
2201 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
2202 <em>optional</em></p></td>
2203 <td class="tableblock halign-left valign-middle"></td>
2204 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedparty">RelatedParty</a> &gt; array</p></td>
2205 </tr>
2206 <tr>
2207 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedCompletionDate</strong><br>
2208 <em>optional</em></p></td>
2209 <td class="tableblock halign-left valign-middle"><p class="tableblock">Requested delivery date from the requestor perspective</p></td>
2210 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2211 </tr>
2212 <tr>
2213 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedStartDate</strong><br>
2214 <em>optional</em></p></td>
2215 <td class="tableblock halign-left valign-middle"><p class="tableblock">Order start date wished by the requestor</p></td>
2216 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2217 </tr>
2218 </tbody>
2219 </table>
2220 </div>
2221 <div class="sect2">
2222 <h3 id="_createserviceorderitem">CreateServiceOrderItem</h3>
2223 <div class="paragraph">
2224 <p>This structure is used in the operation POST for a serviceOrder request to describe an item.
2225 Attribute description is not accurate and should be find in the serviceOrderItem class.</p>
2226 </div>
2227 <table class="tableblock frame-all grid-all spread">
2228 <colgroup>
2229 <col style="width: 16.6666%;">
2230 <col style="width: 61.1111%;">
2231 <col style="width: 22.2223%;">
2232 </colgroup>
2233 <thead>
2234 <tr>
2235 <th class="tableblock halign-left valign-middle">Name</th>
2236 <th class="tableblock halign-left valign-middle">Description</th>
2237 <th class="tableblock halign-left valign-middle">Schema</th>
2238 </tr>
2239 </thead>
2240 <tbody>
2241 <tr>
2242 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
2243 <em>optional</em></p></td>
2244 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the base type of the resource.</p></td>
2245 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2246 </tr>
2247 <tr>
2248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2249 <em>optional</em></p></td>
2250 <td class="tableblock halign-left valign-middle"><p class="tableblock">A link to the schema describing this REST resource</p></td>
2251 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2252 </tr>
2253 <tr>
2254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2255 <em>optional</em></p></td>
2256 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the type of resource.</p></td>
2257 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2258 </tr>
2259 <tr>
2260 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
2261 <em>optional</em></p></td>
2262 <td class="tableblock halign-left valign-middle"></td>
2263 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_actiontype">ActionType</a></p></td>
2264 </tr>
2265 <tr>
2266 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2267 <em>required</em></p></td>
2268 <td class="tableblock halign-left valign-middle"><p class="tableblock">Identifier of the line item (generally it is a sequence number 01, 02, 03, …)</p></td>
2269 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2270 </tr>
2271 <tr>
2272 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItemRelationship</strong><br>
2273 <em>optional</em></p></td>
2274 <td class="tableblock halign-left valign-middle"></td>
2275 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderitemrelationship">OrderItemRelationship</a> &gt; array</p></td>
2276 </tr>
2277 <tr>
2278 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
2279 <em>required</em></p></td>
2280 <td class="tableblock halign-left valign-middle"></td>
2281 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
2282 </tr>
2283 </tbody>
2284 </table>
2285 </div>
2286 <div class="sect2">
2287 <h3 id="_errorrepresentation">ErrorRepresentation</h3>
2288 <div class="paragraph">
2289 <p>Representation of an error.</p>
2290 </div>
2291 <table class="tableblock frame-all grid-all spread">
2292 <colgroup>
2293 <col style="width: 16.6666%;">
2294 <col style="width: 61.1111%;">
2295 <col style="width: 22.2223%;">
2296 </colgroup>
2297 <thead>
2298 <tr>
2299 <th class="tableblock halign-left valign-middle">Name</th>
2300 <th class="tableblock halign-left valign-middle">Description</th>
2301 <th class="tableblock halign-left valign-middle">Schema</th>
2302 </tr>
2303 </thead>
2304 <tbody>
2305 <tr>
2306 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2307 <em>optional</em></p></td>
2308 <td class="tableblock halign-left valign-middle"><p class="tableblock">it provides a link to the schema describing a REST resource</p></td>
2309 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2310 </tr>
2311 <tr>
2312 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2313 <em>optional</em></p></td>
2314 <td class="tableblock halign-left valign-middle"><p class="tableblock">The class type of a REST resource</p></td>
2315 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2316 </tr>
2317 <tr>
2318 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br>
2319 <em>required</em></p></td>
2320 <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>
2321 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
2322 </tr>
2323 <tr>
2324 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
2325 <em>optional</em></p></td>
2326 <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>
2327 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2328 </tr>
2329 <tr>
2330 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br>
2331 <em>required</em></p></td>
2332 <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>
2333 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2334 </tr>
2335 <tr>
2336 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>referenceError</strong><br>
2337 <em>optional</em></p></td>
2338 <td class="tableblock halign-left valign-middle"><p class="tableblock">url pointing to documentation describing the error</p></td>
2339 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2340 </tr>
2341 <tr>
2342 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
2343 <em>optional</em></p></td>
2344 <td class="tableblock halign-left valign-middle"><p class="tableblock">http error code extension like 400-2</p></td>
2345 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2346 </tr>
2347 </tbody>
2348 </table>
2349 </div>
2350 <div class="sect2">
2351 <h3 id="_eventtype">EventType</h3>
2352 <div class="paragraph">
2353 <p><em>Type</em> : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)</p>
2354 </div>
2355 </div>
2356 <div class="sect2">
2357 <h3 id="_hub">Hub</h3>
2358 <div class="paragraph">
2359 <p>An HUB resource is used by client side to subscribe to notification.
2360 Not managed in the Beijing release.</p>
2361 </div>
2362 <table class="tableblock frame-all grid-all spread">
2363 <colgroup>
2364 <col style="width: 16.6666%;">
2365 <col style="width: 61.1111%;">
2366 <col style="width: 22.2223%;">
2367 </colgroup>
2368 <thead>
2369 <tr>
2370 <th class="tableblock halign-left valign-middle">Name</th>
2371 <th class="tableblock halign-left valign-middle">Description</th>
2372 <th class="tableblock halign-left valign-middle">Schema</th>
2373 </tr>
2374 </thead>
2375 <tbody>
2376 <tr>
2377 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>callback</strong><br>
2378 <em>required</em></p></td>
2379 <td class="tableblock halign-left valign-middle"><p class="tableblock">Address where notification must be send</p></td>
2380 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2381 </tr>
2382 <tr>
2383 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2384 <em>optional</em></p></td>
2385 <td class="tableblock halign-left valign-middle"><p class="tableblock">Hub Id</p></td>
2386 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2387 </tr>
2388 <tr>
2389 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>query</strong><br>
2390 <em>required</em></p></td>
2391 <td class="tableblock halign-left valign-middle"></td>
2392 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2393 </tr>
2394 </tbody>
2395 </table>
2396 </div>
2397 <div class="sect2">
2398 <h3 id="_notification">Notification</h3>
2399 <div class="paragraph">
2400 <p>Used to describe notification for this API</p>
2401 </div>
2402 <div class="paragraph">
2403 <p><em>Type</em> : object</p>
2404 </div>
2405 </div>
2406 <div class="sect2">
2407 <h3 id="_orderitemrelationship">OrderItemRelationship</h3>
2408 <div class="paragraph">
2409 <p>Linked order item to the one containing this attribute.
2410 nbi component used this relationship to sort request to ONAP.</p>
2411 </div>
2412 <table class="tableblock frame-all grid-all spread">
2413 <colgroup>
2414 <col style="width: 16.6666%;">
2415 <col style="width: 61.1111%;">
2416 <col style="width: 22.2223%;">
2417 </colgroup>
2418 <thead>
2419 <tr>
2420 <th class="tableblock halign-left valign-middle">Name</th>
2421 <th class="tableblock halign-left valign-middle">Description</th>
2422 <th class="tableblock halign-left valign-middle">Schema</th>
2423 </tr>
2424 </thead>
2425 <tbody>
2426 <tr>
2427 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2428 <em>required</em></p></td>
2429 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of an order item</p></td>
2430 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2431 </tr>
2432 <tr>
2433 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
2434 <em>required</em></p></td>
2435 <td class="tableblock halign-left valign-middle"></td>
2436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_relationshiptype">RelationshipType</a></p></td>
2437 </tr>
2438 </tbody>
2439 </table>
2440 </div>
2441 <div class="sect2">
2442 <h3 id="_ordermessage">OrderMessage</h3>
2443 <div class="paragraph">
2444 <p>An optional array of messages associated with the Order</p>
2445 </div>
2446 <table class="tableblock frame-all grid-all spread">
2447 <colgroup>
2448 <col style="width: 16.6666%;">
2449 <col style="width: 61.1111%;">
2450 <col style="width: 22.2223%;">
2451 </colgroup>
2452 <thead>
2453 <tr>
2454 <th class="tableblock halign-left valign-middle">Name</th>
2455 <th class="tableblock halign-left valign-middle">Description</th>
2456 <th class="tableblock halign-left valign-middle">Schema</th>
2457 </tr>
2458 </thead>
2459 <tbody>
2460 <tr>
2461 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br>
2462 <em>optional</em></p></td>
2463 <td class="tableblock halign-left valign-middle"><p class="tableblock">A code associated to this message</p></td>
2464 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2465 </tr>
2466 <tr>
2467 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>correctionRequired</strong><br>
2468 <em>required</em></p></td>
2469 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicator that an action is required to allow service order fullfilment to follow up</p></td>
2470 <td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
2471 </tr>
2472 <tr>
2473 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>field</strong><br>
2474 <em>optional</em></p></td>
2475 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Order attribute related to this error message</p></td>
2476 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2477 </tr>
2478 <tr>
2479 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>messageInformation</strong><br>
2480 <em>optional</em></p></td>
2481 <td class="tableblock halign-left valign-middle"><p class="tableblock">Message related to this order</p></td>
2482 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2483 </tr>
2484 <tr>
2485 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>severity</strong><br>
2486 <em>required</em></p></td>
2487 <td class="tableblock halign-left valign-middle"></td>
2488 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_severitymessage">SeverityMessage</a></p></td>
2489 </tr>
2490 </tbody>
2491 </table>
2492 </div>
2493 <div class="sect2">
2494 <h3 id="_orderrelationship">OrderRelationship</h3>
2495 <div class="paragraph">
2496 <p>Linked order to the one containing this attribute.
2497 This relationship is not used to sort ONAP request.</p>
2498 </div>
2499 <table class="tableblock frame-all grid-all spread">
2500 <colgroup>
2501 <col style="width: 16.6666%;">
2502 <col style="width: 61.1111%;">
2503 <col style="width: 22.2223%;">
2504 </colgroup>
2505 <thead>
2506 <tr>
2507 <th class="tableblock halign-left valign-middle">Name</th>
2508 <th class="tableblock halign-left valign-middle">Description</th>
2509 <th class="tableblock halign-left valign-middle">Schema</th>
2510 </tr>
2511 </thead>
2512 <tbody>
2513 <tr>
2514 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
2515 <em>optional</em></p></td>
2516 <td class="tableblock halign-left valign-middle"><p class="tableblock">Type of the referred order.</p></td>
2517 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2518 </tr>
2519 <tr>
2520 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
2521 <em>optional</em></p></td>
2522 <td class="tableblock halign-left valign-middle"><p class="tableblock">A hyperlink to the related order</p></td>
2523 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2524 </tr>
2525 <tr>
2526 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2527 <em>required</em></p></td>
2528 <td class="tableblock halign-left valign-middle"><p class="tableblock">The id of the related order</p></td>
2529 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2530 </tr>
2531 <tr>
2532 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
2533 <em>optional</em></p></td>
2534 <td class="tableblock halign-left valign-middle"><p class="tableblock">The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)</p></td>
2535 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2536 </tr>
2537 </tbody>
2538 </table>
2539 </div>
2540 <div class="sect2">
2541 <h3 id="_relatedparty">RelatedParty</h3>
2542 <div class="paragraph">
2543 <p>A related party defines party which are involved in this order and the role they are playing.
2544 for Beijing release:
2545 With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:
2546 o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.
2547 o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.</p>
2548 </div>
2549 <table class="tableblock frame-all grid-all spread">
2550 <colgroup>
2551 <col style="width: 16.6666%;">
2552 <col style="width: 61.1111%;">
2553 <col style="width: 22.2223%;">
2554 </colgroup>
2555 <thead>
2556 <tr>
2557 <th class="tableblock halign-left valign-middle">Name</th>
2558 <th class="tableblock halign-left valign-middle">Description</th>
2559 <th class="tableblock halign-left valign-middle">Schema</th>
2560 </tr>
2561 </thead>
2562 <tbody>
2563 <tr>
2564 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
2565 <em>optional</em></p></td>
2566 <td class="tableblock halign-left valign-middle"></td>
2567 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2568 </tr>
2569 <tr>
2570 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
2571 <em>optional</em></p></td>
2572 <td class="tableblock halign-left valign-middle"><p class="tableblock">An hyperlink to the party - not used in Beijnig release</p></td>
2573 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2574 </tr>
2575 <tr>
2576 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2577 <em>required</em></p></td>
2578 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of a related party</p></td>
2579 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2580 </tr>
2581 <tr>
2582 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2583 <em>optional</em></p></td>
2584 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the related party</p></td>
2585 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2586 </tr>
2587 <tr>
2588 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br>
2589 <em>required</em></p></td>
2590 <td class="tableblock halign-left valign-middle"><p class="tableblock">The role of the related party (e.g. Owner, requester, fullfiller etc).
2591 ONLY 'ONAPcustomer' is considered</p></td>
2592 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2593 </tr>
2594 </tbody>
2595 </table>
2596 </div>
2597 <div class="sect2">
2598 <h3 id="_relationshiptype">RelationshipType</h3>
2599 <div class="paragraph">
2600 <p>Relationship type;
2601 Only reliesOn is managed in Beijing release.</p>
2602 </div>
2603 <div class="paragraph">
2604 <p><em>Type</em> : enum (reliesOn)</p>
2605 </div>
2606 </div>
2607 <div class="sect2">
2608 <h3 id="_service">Service</h3>
2609 <div class="paragraph">
2610 <p>Service (to be added, modified, deleted) description</p>
2611 </div>
2612 <table class="tableblock frame-all grid-all spread">
2613 <colgroup>
2614 <col style="width: 16.6666%;">
2615 <col style="width: 61.1111%;">
2616 <col style="width: 22.2223%;">
2617 </colgroup>
2618 <thead>
2619 <tr>
2620 <th class="tableblock halign-left valign-middle">Name</th>
2621 <th class="tableblock halign-left valign-middle">Description</th>
2622 <th class="tableblock halign-left valign-middle">Schema</th>
2623 </tr>
2624 </thead>
2625 <tbody>
2626 <tr>
2627 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2628 <em>optional</em></p></td>
2629 <td class="tableblock halign-left valign-middle"><p class="tableblock">The URL to get the resource schema.
2630 Not managed in Beijing Release</p></td>
2631 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2632 </tr>
2633 <tr>
2634 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2635 <em>optional</em></p></td>
2636 <td class="tableblock halign-left valign-middle"><p class="tableblock">To define the service type
2637 Not managed in Beijing Release</p></td>
2638 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2639 </tr>
2640 <tr>
2641 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
2642 <em>optional</em></p></td>
2643 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference to the Service (useful for delete or modify command).
2644 Not managed in Beijing release.</p></td>
2645 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2646 </tr>
2647 <tr>
2648 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2649 <em>required</em></p></td>
2650 <td class="tableblock halign-left valign-middle"><p class="tableblock">Identifier of a service instance.
2651 It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id</p></td>
2652 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2653 </tr>
2654 <tr>
2655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2656 <em>optional</em></p></td>
2657 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.</p></td>
2658 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2659 </tr>
2660 <tr>
2661 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
2662 <em>optional</em></p></td>
2663 <td class="tableblock halign-left valign-middle"></td>
2664 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedparty">RelatedParty</a> &gt; array</p></td>
2665 </tr>
2666 <tr>
2667 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceCharacteristic</strong><br>
2668 <em>optional</em></p></td>
2669 <td class="tableblock halign-left valign-middle"></td>
2670 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicecharacteristic">ServiceCharacteristic</a> &gt; array</p></td>
2671 </tr>
2672 <tr>
2673 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceRelationship</strong><br>
2674 <em>optional</em></p></td>
2675 <td class="tableblock halign-left valign-middle"></td>
2676 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicerelationship">ServiceRelationship</a> &gt; array</p></td>
2677 </tr>
2678 <tr>
2679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification</strong><br>
2680 <em>optional</em></p></td>
2681 <td class="tableblock halign-left valign-middle"></td>
2682 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_servicespecificationref">ServiceSpecificationRef</a></p></td>
2683 </tr>
2684 <tr>
2685 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceState</strong><br>
2686 <em>optional</em></p></td>
2687 <td class="tableblock halign-left valign-middle"><p class="tableblock">The lifecycle state of the service requested;
2688 Not managed in Beijing release.</p></td>
2689 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2690 </tr>
2691 </tbody>
2692 </table>
2693 </div>
2694 <div class="sect2">
2695 <h3 id="_servicecharacteristic">ServiceCharacteristic</h3>
2696 <div class="paragraph">
2697 <p>ServiceCharacteristic</p>
2698 </div>
2699 <table class="tableblock frame-all grid-all spread">
2700 <colgroup>
2701 <col style="width: 16.6666%;">
2702 <col style="width: 61.1111%;">
2703 <col style="width: 22.2223%;">
2704 </colgroup>
2705 <thead>
2706 <tr>
2707 <th class="tableblock halign-left valign-middle">Name</th>
2708 <th class="tableblock halign-left valign-middle">Description</th>
2709 <th class="tableblock halign-left valign-middle">Schema</th>
2710 </tr>
2711 </thead>
2712 <tbody>
2713 <tr>
2714 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
2715 <em>required</em></p></td>
2716 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of characteristic</p></td>
2717 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2718 </tr>
2719 <tr>
2720 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
2721 <em>optional</em></p></td>
2722 <td class="tableblock halign-left valign-middle"></td>
2723 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_value">Value</a></p></td>
2724 </tr>
2725 <tr>
2726 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br>
2727 <em>optional</em></p></td>
2728 <td class="tableblock halign-left valign-middle"></td>
2729 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2730 </tr>
2731 </tbody>
2732 </table>
2733 </div>
2734 <div class="sect2">
2735 <h3 id="_serviceorder">ServiceOrder</h3>
2736 <div class="paragraph">
2737 <p>A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa</p>
2738 </div>
2739 <table class="tableblock frame-all grid-all spread">
2740 <colgroup>
2741 <col style="width: 16.6666%;">
2742 <col style="width: 61.1111%;">
2743 <col style="width: 22.2223%;">
2744 </colgroup>
2745 <thead>
2746 <tr>
2747 <th class="tableblock halign-left valign-middle">Name</th>
2748 <th class="tableblock halign-left valign-middle">Description</th>
2749 <th class="tableblock halign-left valign-middle">Schema</th>
2750 </tr>
2751 </thead>
2752 <tbody>
2753 <tr>
2754 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
2755 <em>optional</em></p></td>
2756 <td class="tableblock halign-left valign-middle"></td>
2757 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2758 </tr>
2759 <tr>
2760 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2761 <em>optional</em></p></td>
2762 <td class="tableblock halign-left valign-middle"></td>
2763 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2764 </tr>
2765 <tr>
2766 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2767 <em>optional</em></p></td>
2768 <td class="tableblock halign-left valign-middle"></td>
2769 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2770 </tr>
2771 <tr>
2772 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
2773 <em>optional</em></p></td>
2774 <td class="tableblock halign-left valign-middle"><p class="tableblock">Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)</p></td>
2775 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2776 </tr>
2777 <tr>
2778 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>completionDateTime</strong><br>
2779 <em>optional</em></p></td>
2780 <td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was completed</p></td>
2781 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2782 </tr>
2783 <tr>
2784 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
2785 <em>optional</em></p></td>
2786 <td class="tableblock halign-left valign-middle"><p class="tableblock">A free-text description of the service order</p></td>
2787 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2788 </tr>
2789 <tr>
2790 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>expectedCompletionDate</strong><br>
2791 <em>optional</em></p></td>
2792 <td class="tableblock halign-left valign-middle"></td>
2793 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2794 </tr>
2795 <tr>
2796 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
2797 <em>optional</em></p></td>
2798 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID given by the consumer and only understandable by him (to facilitate his searches)</p></td>
2799 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2800 </tr>
2801 <tr>
2802 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
2803 <em>optional</em></p></td>
2804 <td class="tableblock halign-left valign-middle"><p class="tableblock">Hyperlink to access the order</p></td>
2805 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2806 </tr>
2807 <tr>
2808 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2809 <em>required</em></p></td>
2810 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID created on repository side</p></td>
2811 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2812 </tr>
2813 <tr>
2814 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate</strong><br>
2815 <em>optional</em></p></td>
2816 <td class="tableblock halign-left valign-middle"></td>
2817 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2818 </tr>
2819 <tr>
2820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItem</strong><br>
2821 <em>optional</em></p></td>
2822 <td class="tableblock halign-left valign-middle"></td>
2823 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_serviceorderitem">ServiceOrderItem</a> &gt; array</p></td>
2824 </tr>
2825 <tr>
2826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderMessage</strong><br>
2827 <em>optional</em></p></td>
2828 <td class="tableblock halign-left valign-middle"></td>
2829 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_ordermessage">OrderMessage</a> &gt; array</p></td>
2830 </tr>
2831 <tr>
2832 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderRelationship</strong><br>
2833 <em>optional</em></p></td>
2834 <td class="tableblock halign-left valign-middle"></td>
2835 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderrelationship">OrderRelationship</a> &gt; array</p></td>
2836 </tr>
2837 <tr>
2838 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>priority</strong><br>
2839 <em>optional</em></p></td>
2840 <td class="tableblock halign-left valign-middle"><p class="tableblock">A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)</p></td>
2841 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2842 </tr>
2843 <tr>
2844 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
2845 <em>optional</em></p></td>
2846 <td class="tableblock halign-left valign-middle"></td>
2847 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedparty">RelatedParty</a> &gt; array</p></td>
2848 </tr>
2849 <tr>
2850 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedCompletionDate</strong><br>
2851 <em>optional</em></p></td>
2852 <td class="tableblock halign-left valign-middle"><p class="tableblock">Requested delivery date from the requestor perspective</p></td>
2853 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2854 </tr>
2855 <tr>
2856 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedStartDate</strong><br>
2857 <em>optional</em></p></td>
2858 <td class="tableblock halign-left valign-middle"><p class="tableblock">Order start date wished by the requestor</p></td>
2859 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2860 </tr>
2861 <tr>
2862 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>startDate</strong><br>
2863 <em>optional</em></p></td>
2864 <td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was started for processing</p></td>
2865 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2866 </tr>
2867 <tr>
2868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
2869 <em>optional</em></p></td>
2870 <td class="tableblock halign-left valign-middle"></td>
2871 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
2872 </tr>
2873 </tbody>
2874 </table>
2875 </div>
2876 <div class="sect2">
2877 <h3 id="_serviceordercreationnotification">ServiceOrderCreationNotification</h3>
2878 <div class="paragraph">
2879 <p>Notification structure for a service order creation notification</p>
2880 </div>
2881 <table class="tableblock frame-all grid-all spread">
2882 <colgroup>
2883 <col style="width: 16.6666%;">
2884 <col style="width: 61.1111%;">
2885 <col style="width: 22.2223%;">
2886 </colgroup>
2887 <thead>
2888 <tr>
2889 <th class="tableblock halign-left valign-middle">Name</th>
2890 <th class="tableblock halign-left valign-middle">Description</th>
2891 <th class="tableblock halign-left valign-middle">Schema</th>
2892 </tr>
2893 </thead>
2894 <tbody>
2895 <tr>
2896 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
2897 <em>required</em></p></td>
2898 <td class="tableblock halign-left valign-middle"></td>
2899 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceordersummary">ServiceOrderSummary</a></p></td>
2900 </tr>
2901 <tr>
2902 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</strong><br>
2903 <em>required</em></p></td>
2904 <td class="tableblock halign-left valign-middle"></td>
2905 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
2906 </tr>
2907 <tr>
2908 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</strong><br>
2909 <em>required</em></p></td>
2910 <td class="tableblock halign-left valign-middle"></td>
2911 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2912 </tr>
2913 <tr>
2914 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventType</strong><br>
2915 <em>required</em></p></td>
2916 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Default</strong> : <code>"ServiceOrderCreationNotification"</code></p></td>
2917 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2918 </tr>
2919 </tbody>
2920 </table>
2921 </div>
2922 <div class="sect2">
2923 <h3 id="_serviceorderitem">ServiceOrderItem</h3>
2924 <div class="paragraph">
2925 <p>An identified part of the order. A service order is decomposed into one or more order items.</p>
2926 </div>
2927 <table class="tableblock frame-all grid-all spread">
2928 <colgroup>
2929 <col style="width: 16.6666%;">
2930 <col style="width: 61.1111%;">
2931 <col style="width: 22.2223%;">
2932 </colgroup>
2933 <thead>
2934 <tr>
2935 <th class="tableblock halign-left valign-middle">Name</th>
2936 <th class="tableblock halign-left valign-middle">Description</th>
2937 <th class="tableblock halign-left valign-middle">Schema</th>
2938 </tr>
2939 </thead>
2940 <tbody>
2941 <tr>
2942 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
2943 <em>optional</em></p></td>
2944 <td class="tableblock halign-left valign-middle"><p class="tableblock">not used in Beijing relase</p></td>
2945 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2946 </tr>
2947 <tr>
2948 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2949 <em>optional</em></p></td>
2950 <td class="tableblock halign-left valign-middle"><p class="tableblock">not used in Beijing relase</p></td>
2951 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2952 </tr>
2953 <tr>
2954 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2955 <em>optional</em></p></td>
2956 <td class="tableblock halign-left valign-middle"><p class="tableblock">Used to extend the order item.
2957 not used in Beijing relase</p></td>
2958 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2959 </tr>
2960 <tr>
2961 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
2962 <em>optional</em></p></td>
2963 <td class="tableblock halign-left valign-middle"></td>
2964 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_actiontype">ActionType</a></p></td>
2965 </tr>
2966 <tr>
2967 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
2968 <em>required</em></p></td>
2969 <td class="tableblock halign-left valign-middle"><p class="tableblock">Identifier of the line item (generally it is a sequence number 01, 02, 03, …)</p></td>
2970 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2971 </tr>
2972 <tr>
2973 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItemMessage</strong><br>
2974 <em>optional</em></p></td>
2975 <td class="tableblock halign-left valign-middle"></td>
2976 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_ordermessage">OrderMessage</a> &gt; array</p></td>
2977 </tr>
2978 <tr>
2979 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItemRelationship</strong><br>
2980 <em>optional</em></p></td>
2981 <td class="tableblock halign-left valign-middle"></td>
2982 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderitemrelationship">OrderItemRelationship</a> &gt; array</p></td>
2983 </tr>
2984 <tr>
2985 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>percentProgress</strong><br>
2986 <em>optional</em></p></td>
2987 <td class="tableblock halign-left valign-middle"><p class="tableblock">Progress of the delivery in percentage.</p></td>
2988 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2989 </tr>
2990 <tr>
2991 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
2992 <em>required</em></p></td>
2993 <td class="tableblock halign-left valign-middle"></td>
2994 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
2995 </tr>
2996 <tr>
2997 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
2998 <em>optional</em></p></td>
2999 <td class="tableblock halign-left valign-middle"></td>
3000 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
3001 </tr>
3002 </tbody>
3003 </table>
3004 </div>
3005 <div class="sect2">
3006 <h3 id="_serviceorderitemstatechangenotification">ServiceOrderItemStateChangeNotification</h3>
3007 <table class="tableblock frame-all grid-all spread">
3008 <colgroup>
3009 <col style="width: 16.6666%;">
3010 <col style="width: 61.1111%;">
3011 <col style="width: 22.2223%;">
3012 </colgroup>
3013 <thead>
3014 <tr>
3015 <th class="tableblock halign-left valign-middle">Name</th>
3016 <th class="tableblock halign-left valign-middle">Description</th>
3017 <th class="tableblock halign-left valign-middle">Schema</th>
3018 </tr>
3019 </thead>
3020 <tbody>
3021 <tr>
3022 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
3023 <em>required</em></p></td>
3024 <td class="tableblock halign-left valign-middle"></td>
3025 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceordersummarywithitem">ServiceOrderSummaryWithItem</a></p></td>
3026 </tr>
3027 <tr>
3028 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</strong><br>
3029 <em>required</em></p></td>
3030 <td class="tableblock halign-left valign-middle"></td>
3031 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
3032 </tr>
3033 <tr>
3034 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</strong><br>
3035 <em>required</em></p></td>
3036 <td class="tableblock halign-left valign-middle"></td>
3037 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3038 </tr>
3039 <tr>
3040 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventType</strong><br>
3041 <em>required</em></p></td>
3042 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Default</strong> : <code>"ServiceOrderStateChangeNotification"</code></p></td>
3043 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3044 </tr>
3045 </tbody>
3046 </table>
3047 </div>
3048 <div class="sect2">
3049 <h3 id="_serviceorderitemsummary">ServiceOrderItemSummary</h3>
3050 <div class="paragraph">
3051 <p>Service Order item summary to be used for notification</p>
3052 </div>
3053 <table class="tableblock frame-all grid-all spread">
3054 <colgroup>
3055 <col style="width: 16.6666%;">
3056 <col style="width: 61.1111%;">
3057 <col style="width: 22.2223%;">
3058 </colgroup>
3059 <thead>
3060 <tr>
3061 <th class="tableblock halign-left valign-middle">Name</th>
3062 <th class="tableblock halign-left valign-middle">Description</th>
3063 <th class="tableblock halign-left valign-middle">Schema</th>
3064 </tr>
3065 </thead>
3066 <tbody>
3067 <tr>
3068 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
3069 <em>optional</em></p></td>
3070 <td class="tableblock halign-left valign-middle"></td>
3071 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_actiontype">ActionType</a></p></td>
3072 </tr>
3073 <tr>
3074 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3075 <em>required</em></p></td>
3076 <td class="tableblock halign-left valign-middle"><p class="tableblock">Identifier of the line item (generally it is a sequence number 01, 02, 03, …)</p></td>
3077 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3078 </tr>
3079 <tr>
3080 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
3081 <em>required</em></p></td>
3082 <td class="tableblock halign-left valign-middle"></td>
3083 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3084 </tr>
3085 <tr>
3086 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
3087 <em>optional</em></p></td>
3088 <td class="tableblock halign-left valign-middle"></td>
3089 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
3090 </tr>
3091 </tbody>
3092 </table>
3093 </div>
3094 <div class="sect2">
3095 <h3 id="_serviceorderstatechangenotification">ServiceOrderStateChangeNotification</h3>
3096 <div class="paragraph">
3097 <p>Service order state change notification description</p>
3098 </div>
3099 <table class="tableblock frame-all grid-all spread">
3100 <colgroup>
3101 <col style="width: 16.6666%;">
3102 <col style="width: 61.1111%;">
3103 <col style="width: 22.2223%;">
3104 </colgroup>
3105 <thead>
3106 <tr>
3107 <th class="tableblock halign-left valign-middle">Name</th>
3108 <th class="tableblock halign-left valign-middle">Description</th>
3109 <th class="tableblock halign-left valign-middle">Schema</th>
3110 </tr>
3111 </thead>
3112 <tbody>
3113 <tr>
3114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br>
3115 <em>required</em></p></td>
3116 <td class="tableblock halign-left valign-middle"></td>
3117 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceordersummary">ServiceOrderSummary</a></p></td>
3118 </tr>
3119 <tr>
3120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</strong><br>
3121 <em>required</em></p></td>
3122 <td class="tableblock halign-left valign-middle"></td>
3123 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
3124 </tr>
3125 <tr>
3126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</strong><br>
3127 <em>required</em></p></td>
3128 <td class="tableblock halign-left valign-middle"></td>
3129 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3130 </tr>
3131 <tr>
3132 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventType</strong><br>
3133 <em>required</em></p></td>
3134 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Default</strong> : <code>"ServiceOrderStateChangeNotification"</code></p></td>
3135 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3136 </tr>
3137 </tbody>
3138 </table>
3139 </div>
3140 <div class="sect2">
3141 <h3 id="_serviceordersummary">ServiceOrderSummary</h3>
3142 <div class="paragraph">
3143 <p>This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages</p>
3144 </div>
3145 <table class="tableblock frame-all grid-all spread">
3146 <colgroup>
3147 <col style="width: 16.6666%;">
3148 <col style="width: 61.1111%;">
3149 <col style="width: 22.2223%;">
3150 </colgroup>
3151 <thead>
3152 <tr>
3153 <th class="tableblock halign-left valign-middle">Name</th>
3154 <th class="tableblock halign-left valign-middle">Description</th>
3155 <th class="tableblock halign-left valign-middle">Schema</th>
3156 </tr>
3157 </thead>
3158 <tbody>
3159 <tr>
3160 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>completionDateTime</strong><br>
3161 <em>optional</em></p></td>
3162 <td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was completed</p></td>
3163 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
3164 </tr>
3165 <tr>
3166 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
3167 <em>optional</em></p></td>
3168 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID given by the consumer and only understandable by him (to facilitate his searches)</p></td>
3169 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3170 </tr>
3171 <tr>
3172 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
3173 <em>optional</em></p></td>
3174 <td class="tableblock halign-left valign-middle"><p class="tableblock">Hyperlink to access the order</p></td>
3175 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3176 </tr>
3177 <tr>
3178 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3179 <em>required</em></p></td>
3180 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID created on repository side</p></td>
3181 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3182 </tr>
3183 <tr>
3184 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate</strong><br>
3185 <em>optional</em></p></td>
3186 <td class="tableblock halign-left valign-middle"></td>
3187 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
3188 </tr>
3189 <tr>
3190 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
3191 <em>optional</em></p></td>
3192 <td class="tableblock halign-left valign-middle"></td>
3193 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
3194 </tr>
3195 </tbody>
3196 </table>
3197 </div>
3198 <div class="sect2">
3199 <h3 id="_serviceordersummarywithitem">ServiceOrderSummaryWithItem</h3>
3200 <div class="paragraph">
3201 <p>Service order item summary with item description</p>
3202 </div>
3203 <table class="tableblock frame-all grid-all spread">
3204 <colgroup>
3205 <col style="width: 16.6666%;">
3206 <col style="width: 61.1111%;">
3207 <col style="width: 22.2223%;">
3208 </colgroup>
3209 <thead>
3210 <tr>
3211 <th class="tableblock halign-left valign-middle">Name</th>
3212 <th class="tableblock halign-left valign-middle">Description</th>
3213 <th class="tableblock halign-left valign-middle">Schema</th>
3214 </tr>
3215 </thead>
3216 <tbody>
3217 <tr>
3218 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>completionDateTime</strong><br>
3219 <em>optional</em></p></td>
3220 <td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was completed</p></td>
3221 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
3222 </tr>
3223 <tr>
3224 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
3225 <em>optional</em></p></td>
3226 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID given by the consumer and only understandable by him (to facilitate his searches)</p></td>
3227 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3228 </tr>
3229 <tr>
3230 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
3231 <em>optional</em></p></td>
3232 <td class="tableblock halign-left valign-middle"><p class="tableblock">Hyperlink to access the order</p></td>
3233 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3234 </tr>
3235 <tr>
3236 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3237 <em>required</em></p></td>
3238 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID created on repository side</p></td>
3239 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3240 </tr>
3241 <tr>
3242 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate</strong><br>
3243 <em>optional</em></p></td>
3244 <td class="tableblock halign-left valign-middle"></td>
3245 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
3246 </tr>
3247 <tr>
3248 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItem</strong><br>
3249 <em>optional</em></p></td>
3250 <td class="tableblock halign-left valign-middle"></td>
3251 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_serviceorderitemsummary">ServiceOrderItemSummary</a> &gt; array</p></td>
3252 </tr>
3253 <tr>
3254 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
3255 <em>optional</em></p></td>
3256 <td class="tableblock halign-left valign-middle"></td>
3257 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
3258 </tr>
3259 </tbody>
3260 </table>
3261 </div>
3262 <div class="sect2">
3263 <h3 id="_serviceref">ServiceRef</h3>
3264 <div class="paragraph">
3265 <p>Service references</p>
3266 </div>
3267 <table class="tableblock frame-all grid-all spread">
3268 <colgroup>
3269 <col style="width: 16.6666%;">
3270 <col style="width: 61.1111%;">
3271 <col style="width: 22.2223%;">
3272 </colgroup>
3273 <thead>
3274 <tr>
3275 <th class="tableblock halign-left valign-middle">Name</th>
3276 <th class="tableblock halign-left valign-middle">Description</th>
3277 <th class="tableblock halign-left valign-middle">Schema</th>
3278 </tr>
3279 </thead>
3280 <tbody>
3281 <tr>
3282 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
3283 <em>optional</em></p></td>
3284 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service</p></td>
3285 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3286 </tr>
3287 <tr>
3288 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3289 <em>required</em></p></td>
3290 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service</p></td>
3291 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3292 </tr>
3293 </tbody>
3294 </table>
3295 </div>
3296 <div class="sect2">
3297 <h3 id="_servicerelationship">ServiceRelationship</h3>
3298 <div class="paragraph">
3299 <p>Linked Services to the one instantiate
3300 nbi component used this relationship to sort request to ONAP.</p>
3301 </div>
3302 <table class="tableblock frame-all grid-all spread">
3303 <colgroup>
3304 <col style="width: 42.8571%;">
3305 <col style="width: 57.1429%;">
3306 </colgroup>
3307 <thead>
3308 <tr>
3309 <th class="tableblock halign-left valign-middle">Name</th>
3310 <th class="tableblock halign-left valign-middle">Schema</th>
3311 </tr>
3312 </thead>
3313 <tbody>
3314 <tr>
3315 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
3316 <em>required</em></p></td>
3317 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
3318 </tr>
3319 <tr>
3320 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
3321 <em>required</em></p></td>
3322 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_relationshiptype">RelationshipType</a></p></td>
3323 </tr>
3324 </tbody>
3325 </table>
3326 </div>
3327 <div class="sect2">
3328 <h3 id="_servicespecificationref">ServiceSpecificationRef</h3>
3329 <div class="paragraph">
3330 <p>The service specification (these attributes are fetched from the catalogue).</p>
3331 </div>
3332 <table class="tableblock frame-all grid-all spread">
3333 <colgroup>
3334 <col style="width: 16.6666%;">
3335 <col style="width: 61.1111%;">
3336 <col style="width: 22.2223%;">
3337 </colgroup>
3338 <thead>
3339 <tr>
3340 <th class="tableblock halign-left valign-middle">Name</th>
3341 <th class="tableblock halign-left valign-middle">Description</th>
3342 <th class="tableblock halign-left valign-middle">Schema</th>
3343 </tr>
3344 </thead>
3345 <tbody>
3346 <tr>
3347 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
3348 <em>optional</em></p></td>
3349 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used in Beijing release</p></td>
3350 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3351 </tr>
3352 <tr>
3353 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
3354 <em>optional</em></p></td>
3355 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used in Beijing release</p></td>
3356 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3357 </tr>
3358 <tr>
3359 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
3360 <em>optional</em></p></td>
3361 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used in Beijing release</p></td>
3362 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3363 </tr>
3364 <tr>
3365 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
3366 <em>optional</em></p></td>
3367 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service specification
3368 Not used in Beijing release.</p></td>
3369 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3370 </tr>
3371 <tr>
3372 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
3373 <em>required</em></p></td>
3374 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service specification
3375 This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.</p></td>
3376 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3377 </tr>
3378 <tr>
3379 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
3380 <em>optional</em></p></td>
3381 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service specification
3382 Not used in Beijing release</p></td>
3383 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3384 </tr>
3385 <tr>
3386 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>targetServiceSchema</strong><br>
3387 <em>optional</em></p></td>
3388 <td class="tableblock halign-left valign-middle"></td>
3389 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_targetserviceschema">TargetServiceSchema</a></p></td>
3390 </tr>
3391 <tr>
3392 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
3393 <em>optional</em></p></td>
3394 <td class="tableblock halign-left valign-middle"><p class="tableblock">Version of the service Specification
3395 Not used in Beijing release</p></td>
3396 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3397 </tr>
3398 </tbody>
3399 </table>
3400 </div>
3401 <div class="sect2">
3402 <h3 id="_severitymessage">SeverityMessage</h3>
3403 <div class="paragraph">
3404 <p><em>Type</em> : enum (information, error)</p>
3405 </div>
3406 </div>
3407 <div class="sect2">
3408 <h3 id="_statetype">StateType</h3>
3409 <div class="paragraph">
3410 <p>List of possible state for the order and the orderItem.</p>
3411 </div>
3412 <div class="paragraph">
3413 <p><em>Type</em> : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial)</p>
3414 </div>
3415 </div>
3416 <div class="sect2">
3417 <h3 id="_targetserviceschema">TargetServiceSchema</h3>
3418 <div class="paragraph">
3419 <p>Target to the schema describing the service spec resource</p>
3420 </div>
3421 <table class="tableblock frame-all grid-all spread">
3422 <colgroup>
3423 <col style="width: 16.6666%;">
3424 <col style="width: 61.1111%;">
3425 <col style="width: 22.2223%;">
3426 </colgroup>
3427 <thead>
3428 <tr>
3429 <th class="tableblock halign-left valign-middle">Name</th>
3430 <th class="tableblock halign-left valign-middle">Description</th>
3431 <th class="tableblock halign-left valign-middle">Schema</th>
3432 </tr>
3433 </thead>
3434 <tbody>
3435 <tr>
3436 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
3437 <em>required</em></p></td>
3438 <td class="tableblock halign-left valign-middle"><p class="tableblock">This field provided a link to the schema describing this REST resource.</p></td>
3439 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3440 </tr>
3441 <tr>
3442 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
3443 <em>required</em></p></td>
3444 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the (class) type of resource.</p></td>
3445 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3446 </tr>
3447 </tbody>
3448 </table>
3449 </div>
3450 <div class="sect2">
3451 <h3 id="_value">Value</h3>
3452 <div class="paragraph">
3453 <p>Value is a descriptive structure for service characteristic;
3454 For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.</p>
3455 </div>
3456 <table class="tableblock frame-all grid-all spread">
3457 <colgroup>
3458 <col style="width: 16.6666%;">
3459 <col style="width: 61.1111%;">
3460 <col style="width: 22.2223%;">
3461 </colgroup>
3462 <thead>
3463 <tr>
3464 <th class="tableblock halign-left valign-middle">Name</th>
3465 <th class="tableblock halign-left valign-middle">Description</th>
3466 <th class="tableblock halign-left valign-middle">Schema</th>
3467 </tr>
3468 </thead>
3469 <tbody>
3470 <tr>
3471 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
3472 <em>optional</em></p></td>
3473 <td class="tableblock halign-left valign-middle"><p class="tableblock">This field provided a link to the schema describing this REST resource.
3474 Not used in Beijing Release</p></td>
3475 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3476 </tr>
3477 <tr>
3478 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
3479 <em>optional</em></p></td>
3480 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the (class) type of resource.
3481 Not used in Beijing Release</p></td>
3482 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3483 </tr>
3484 <tr>
3485 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceCharacteristicValue</strong><br>
3486 <em>optional</em></p></td>
3487 <td class="tableblock halign-left valign-middle"><p class="tableblock">Value of the characteristic.
3488 This attribute must be used in Beijing Release to provide characteristic value.</p></td>
3489 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
3490 </tr>
3491 </tbody>
3492 </table>
3493 </div>
3494 </div>
3495 </div>
3496 </div>
3497 <div id="footer">
3498 <div id="footer-text">
3499 Last updated 2018-09-12 13:42:33 +00:00
3500 </div>
3501 </div>
3502 </body>
3503 </html>