docs/offeredapis/serviceOrder/documentation.html

   1 <!--
   2 This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 http://creativecommons.org/licenses/by/4.0
   4 Copyright 2018 Orange
   5 -->
   6 <!DOCTYPE html>
   7 <html lang="en">
   8 <head>
   9 <meta charset="UTF-8">
  10 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
  11 <meta name="viewport" content="width=device-width, initial-scale=1.0">
  12 <meta name="generator" content="Asciidoctor 1.5.6.1">
  13 <title>API ServiceOrder</title>
  14 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  15 <style>
  16 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  17 /* Remove comment around @import statement below when using as a custom stylesheet */
  18 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  19 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  20 audio,canvas,video{display:inline-block}
  21 audio:not([controls]){display:none;height:0}
  22 [hidden],template{display:none}
  23 script{display:none!important}
  24 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  25 a{background:transparent}
  26 a:focus{outline:thin dotted}
  27 a:active,a:hover{outline:0}
  28 h1{font-size:2em;margin:.67em 0}
  29 abbr[title]{border-bottom:1px dotted}
  30 b,strong{font-weight:bold}
  31 dfn{font-style:italic}
  32 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  33 mark{background:#ff0;color:#000}
  34 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  35 pre{white-space:pre-wrap}
  36 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  37 small{font-size:80%}
  38 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  39 sup{top:-.5em}
  40 sub{bottom:-.25em}
  41 img{border:0}
  42 svg:not(:root){overflow:hidden}
  43 figure{margin:0}
  44 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  45 legend{border:0;padding:0}
  46 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  47 button,input{line-height:normal}
  48 button,select{text-transform:none}
  49 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  50 button[disabled],html input[disabled]{cursor:default}
  51 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  52 input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
  53 input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
  54 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  55 textarea{overflow:auto;vertical-align:top}
  56 table{border-collapse:collapse;border-spacing:0}
  57 *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  58 html,body{font-size:100%}
  59 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  60 a:hover{cursor:pointer}
  61 img,object,embed{max-width:100%;height:auto}
  62 object,embed{height:100%}
  63 img{-ms-interpolation-mode:bicubic}
  64 .left{float:left!important}
  65 .right{float:right!important}
  66 .text-left{text-align:left!important}
  67 .text-right{text-align:right!important}
  68 .text-center{text-align:center!important}
  69 .text-justify{text-align:justify!important}
  70 .hide{display:none}
  71 img,object,svg{display:inline-block;vertical-align:middle}
  72 textarea{height:auto;min-height:50px}
  73 select{width:100%}
  74 .center{margin-left:auto;margin-right:auto}
  75 .spread{width:100%}
  76 p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
  77 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  78 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  79 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  80 a:hover,a:focus{color:#1d4b8f}
  81 a img{border:none}
  82 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  83 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  84 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  85 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  86 h1{font-size:2.125em}
  87 h2{font-size:1.6875em}
  88 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  89 h4,h5{font-size:1.125em}
  90 h6{font-size:1em}
  91 hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  92 em,i{font-style:italic;line-height:inherit}
  93 strong,b{font-weight:bold;line-height:inherit}
  94 small{font-size:60%;line-height:inherit}
  95 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  96 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  97 ul,ol{margin-left:1.5em}
  98 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  99 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
 100 ul.square{list-style-type:square}
 101 ul.circle{list-style-type:circle}
 102 ul.disc{list-style-type:disc}
 103 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
 104 dl dt{margin-bottom:.3125em;font-weight:bold}
 105 dl dd{margin-bottom:1.25em}
 106 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
 107 abbr{text-transform:none}
 108 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
 109 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
 110 blockquote cite:before{content:"\2014 \0020"}
 111 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
 112 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 113 @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 114 h1{font-size:2.75em}
 115 h2{font-size:2.3125em}
 116 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 117 h4{font-size:1.4375em}}
 118 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
 119 table thead,table tfoot{background:#f7f8f7;font-weight:bold}
 120 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 121 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 122 table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
 123 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
 124 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 125 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 126 .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
 127 .clearfix:after,.float-group:after{clear:both}
 128 *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
 129 *:not(pre)>code.nobreak{word-wrap:normal}
 130 *:not(pre)>code.nowrap{white-space:nowrap}
 131 pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
 132 em em{font-style:normal}
 133 strong strong{font-weight:400}
 134 .keyseq{color:rgba(51,51,51,.8)}
 135 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 136 .keyseq kbd:first-child{margin-left:0}
 137 .keyseq kbd:last-child{margin-right:0}
 138 .menuseq,.menuref{color:#000}
 139 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 140 .menuseq{word-spacing:-.02em}
 141 .menuseq b.caret{font-size:1.25em;line-height:.8}
 142 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 143 b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
 144 b.button:before{content:"[";padding:0 3px 0 2px}
 145 b.button:after{content:"]";padding:0 2px 0 3px}
 146 p a>code:hover{color:rgba(0,0,0,.9)}
 147 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 148 #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
 149 #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
 150 #content{margin-top:1.25em}
 151 #content:before{content:none}
 152 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 153 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
 154 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
 155 #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
 156 #header .details span:first-child{margin-left:-.125em}
 157 #header .details span.email a{color:rgba(0,0,0,.85)}
 158 #header .details br{display:none}
 159 #header .details br+span:before{content:"\00a0\2013\00a0"}
 160 #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 161 #header .details br+span#revremark:before{content:"\00a0|\00a0"}
 162 #header #revnumber{text-transform:capitalize}
 163 #header #revnumber:after{content:"\00a0"}
 164 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 165 #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
 166 #toc>ul{margin-left:.125em}
 167 #toc ul.sectlevel0>li>a{font-style:italic}
 168 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 169 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 170 #toc li{line-height:1.3334;margin-top:.3334em}
 171 #toc a{text-decoration:none}
 172 #toc a:active{text-decoration:underline}
 173 #toctitle{color:#7a2518;font-size:1.2em}
 174 @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
 175 body.toc2{padding-left:15em;padding-right:0}
 176 #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 177 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 178 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 179 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 180 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 181 body.toc2.toc-right{padding-left:0;padding-right:15em}
 182 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
 183 @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 184 #toc.toc2{width:20em}
 185 #toc.toc2 #toctitle{font-size:1.375em}
 186 #toc.toc2>ul{font-size:.95em}
 187 #toc.toc2 ul ul{padding-left:1.25em}
 188 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 189 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 190 #content #toc>:first-child{margin-top:0}
 191 #content #toc>:last-child{margin-bottom:0}
 192 #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
 193 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
 194 .sect1{padding-bottom:.625em}
 195 @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
 196 .sect1+.sect1{border-top:1px solid #efefed}
 197 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 198 #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 199 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 200 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 201 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 202 .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 203 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 204 table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
 205 .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
 206 table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
 207 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 208 .admonitionblock>table td.icon{text-align:center;width:80px}
 209 .admonitionblock>table td.icon img{max-width:initial}
 210 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 211 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
 212 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 213 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
 214 .exampleblock>.content>:first-child{margin-top:0}
 215 .exampleblock>.content>:last-child{margin-bottom:0}
 216 .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
 217 .sidebarblock>:first-child{margin-top:0}
 218 .sidebarblock>:last-child{margin-bottom:0}
 219 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 220 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 221 .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
 222 .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
 223 .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
 224 .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
 225 @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
 226 @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
 227 .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
 228 .listingblock pre.highlightjs{padding:0}
 229 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
 230 .listingblock pre.prettyprint{border-width:0}
 231 .listingblock>.content{position:relative}
 232 .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
 233 .listingblock:hover code[data-lang]:before{display:block}
 234 .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
 235 .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
 236 table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 237 table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
 238 table.pyhltable td.code{padding-left:.75em;padding-right:0}
 239 pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
 240 pre.pygments .lineno{display:inline-block;margin-right:.25em}
 241 table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
 242 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 243 .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
 244 .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 245 .quoteblock blockquote{margin:0;padding:0;border:0}
 246 .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 247 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 248 .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
 249 .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
 250 .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
 251 .quoteblock .quoteblock blockquote:before{display:none}
 252 .verseblock{margin:0 1em 1.25em 1em}
 253 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 254 .verseblock pre strong{font-weight:400}
 255 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 256 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 257 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 258 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 259 .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
 260 .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
 261 .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
 262 table.tableblock{max-width:100%;border-collapse:separate}
 263 table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
 264 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 265 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
 266 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
 267 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
 268 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px 0}
 269 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0 0}
 270 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
 271 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
 272 table.frame-all{border-width:1px}
 273 table.frame-sides{border-width:0 1px}
 274 table.frame-topbot{border-width:1px 0}
 275 th.halign-left,td.halign-left{text-align:left}
 276 th.halign-right,td.halign-right{text-align:right}
 277 th.halign-center,td.halign-center{text-align:center}
 278 th.valign-top,td.valign-top{vertical-align:top}
 279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 280 th.valign-middle,td.valign-middle{vertical-align:middle}
 281 table thead th,table tfoot th{font-weight:bold}
 282 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
 283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 284 p.tableblock>code:only-child{background:none;padding:0}
 285 p.tableblock{font-size:1em}
 286 td>div.verse{white-space:pre}
 287 ol{margin-left:1.75em}
 288 ul li ol{margin-left:1.5em}
 289 dl dd{margin-left:1.125em}
 290 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 291 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 292 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 293 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 294 ul.unstyled,ol.unstyled{margin-left:0}
 295 ul.checklist{margin-left:.625em}
 296 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 297 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
 298 ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
 299 ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
 300 ul.inline>li>*{display:block}
 301 .unstyled dl dt{font-weight:400;font-style:normal}
 302 ol.arabic{list-style-type:decimal}
 303 ol.decimal{list-style-type:decimal-leading-zero}
 304 ol.loweralpha{list-style-type:lower-alpha}
 305 ol.upperalpha{list-style-type:upper-alpha}
 306 ol.lowerroman{list-style-type:lower-roman}
 307 ol.upperroman{list-style-type:upper-roman}
 308 ol.lowergreek{list-style-type:lower-greek}
 309 .hdlist>table,.colist>table{border:0;background:none}
 310 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 311 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 312 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 314 .colist>table tr>td:first-of-type{padding:.4em .75em 0 .75em;line-height:1;vertical-align:top}
 315 .colist>table tr>td:first-of-type img{max-width:initial}
 316 .colist>table tr>td:last-of-type{padding:.25em 0}
 317 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
 318 .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
 319 .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
 320 .imageblock>.title{margin-bottom:0}
 321 .imageblock.thumb,.imageblock.th{border-width:6px}
 322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 324 .image.left{margin-right:.625em}
 325 .image.right{margin-left:.625em}
 326 a.image{text-decoration:none;display:inline-block}
 327 a.image object{pointer-events:none}
 328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 329 sup.footnote a,sup.footnoteref a{text-decoration:none}
 330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
 333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
 334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
 335 #footnotes .footnote:last-of-type{margin-bottom:0}
 336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 337 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
 338 .gist .file-data>table td.line-data{width:99%}
 339 div.unbreakable{page-break-inside:avoid}
 340 .big{font-size:larger}
 341 .small{font-size:smaller}
 342 .underline{text-decoration:underline}
 343 .overline{text-decoration:overline}
 344 .line-through{text-decoration:line-through}
 345 .aqua{color:#00bfbf}
 346 .aqua-background{background-color:#00fafa}
 347 .black{color:#000}
 348 .black-background{background-color:#000}
 349 .blue{color:#0000bf}
 350 .blue-background{background-color:#0000fa}
 351 .fuchsia{color:#bf00bf}
 352 .fuchsia-background{background-color:#fa00fa}
 353 .gray{color:#606060}
 354 .gray-background{background-color:#7d7d7d}
 355 .green{color:#006000}
 356 .green-background{background-color:#007d00}
 357 .lime{color:#00bf00}
 358 .lime-background{background-color:#00fa00}
 359 .maroon{color:#600000}
 360 .maroon-background{background-color:#7d0000}
 361 .navy{color:#000060}
 362 .navy-background{background-color:#00007d}
 363 .olive{color:#606000}
 364 .olive-background{background-color:#7d7d00}
 365 .purple{color:#600060}
 366 .purple-background{background-color:#7d007d}
 367 .red{color:#bf0000}
 368 .red-background{background-color:#fa0000}
 369 .silver{color:#909090}
 370 .silver-background{background-color:#bcbcbc}
 371 .teal{color:#006060}
 372 .teal-background{background-color:#007d7d}
 373 .white{color:#bfbfbf}
 374 .white-background{background-color:#fafafa}
 375 .yellow{color:#bfbf00}
 376 .yellow-background{background-color:#fafa00}
 377 span.icon>.fa{cursor:default}
 378 a span.icon>.fa{cursor:inherit}
 379 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 380 .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
 381 .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 382 .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
 383 .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
 384 .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
 385 .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 386 .conum[data-value] *{color:#fff!important}
 387 .conum[data-value]+b{display:none}
 388 .conum[data-value]:after{content:attr(data-value)}
 389 pre .conum[data-value]{position:relative;top:-.125em}
 390 b.conum *{color:inherit!important}
 391 .conum:not([data-value]):empty{display:none}
 392 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 393 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
 394 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 395 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
 396 p{margin-bottom:1.25rem}
 397 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 398 .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 399 .print-only{display:none!important}
 400 @media print{@page{margin:1.25cm .75cm}
 401 *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
 402 a{color:inherit!important;text-decoration:underline!important}
 403 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 404 a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 405 abbr[title]:after{content:" (" attr(title) ")"}
 406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 407 thead{display:table-header-group}
 408 svg{max-width:100%}
 409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 411 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 412 #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
 413 .sect1{padding-bottom:0!important}
 414 .sect1+.sect1{border:0!important}
 415 #header>h1:first-child{margin-top:1.25rem}
 416 body.book #header{text-align:center}
 417 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
 418 body.book #header .details{border:0!important;display:block;padding:0!important}
 419 body.book #header .details span:first-child{margin-left:0!important}
 420 body.book #header .details br{display:block}
 421 body.book #header .details br+span:before{content:none!important}
 422 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 423 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 424 .listingblock code[data-lang]:before{display:block}
 425 #footer{background:none!important;padding:0 .9375em}
 426 #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
 427 .hide-on-print{display:none!important}
 428 .print-only{display:block!important}
 429 .hide-for-print{display:none!important}
 430 .show-for-print{display:inherit!important}}
 431 </style>
 432 </head>
 433 <body class="article toc2 toc-left">
 434 <div id="header">
 435 <h1>API ServiceOrder</h1>
 436 <div id="toc" class="toc2">
 437 <div id="toctitle">Table of Contents</div>
 438 <ul class="sectlevel1">
 439 <li><a href="#_overview">Overview</a>
 440 <ul class="sectlevel2">
 441 <li><a href="#_api_url">Api URL</a></li>
 442 <li><a href="#_version_information">Version information</a></li>
 443 <li><a href="#_uri_scheme">URI scheme</a></li>
 444 <li><a href="#_tags">Tags</a></li>
 445 <li><a href="#_consumes">Consumes</a></li>
 446 <li><a href="#_produces">Produces</a></li>
 447 </ul>
 448 </li>
 449 <li><a href="#_paths">Resources</a>
 450 <ul class="sectlevel2">
 451 <li><a href="#_serviceorder_resource">ServiceOrder</a></li>
 452 </ul>
 453 </li>
 454 <li><a href="#_definitions">Definitions</a>
 455 <ul class="sectlevel2">
 456 <li><a href="#_actiontype">ActionType</a></li>
 457 <li><a href="#_createserviceorder">CreateServiceOrder</a></li>
 458 <li><a href="#_createserviceorderitem">CreateServiceOrderItem</a></li>
 459 <li><a href="#_errorrepresentation">ErrorRepresentation</a></li>
 460 <li><a href="#_hub">Hub</a></li>
 461 <li><a href="#_orderitemrelationship">OrderItemRelationship</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="#_serviceorderitem">ServiceOrderItem</a></li>
 469 <li><a href="#_serviceref">ServiceRef</a></li>
 470 <li><a href="#_servicerelationship">ServiceRelationship</a></li>
 471 <li><a href="#_servicespecificationref">ServiceSpecificationRef</a></li>
 472 <li><a href="#_statetype">StateType</a></li>
 473 <li><a href="#_targetserviceschema">TargetServiceSchema</a></li>
 474 <li><a href="#_value">Value</a></li>
 475 </ul>
 476 </li>
 477 </ul>
 478 </div>
 479 </div>
 480 <div id="content">
 481 <div class="sect1">
 482 <h2 id="_overview">Overview</h2>
 483 <div class="sectionbody">
 484 <div class="sect2">
 485 <div class="paragraph">
 486 <p>serviceOrder API designed for ONAP Beijing Release.
 487 This API is build from TMF open API18.0 (applying TMF Guideline 3.0);
 488 Only operations GET (by id and list) and POST are available.</p>
 489 </div>
 490 </div>
 491 <div class="sect2">
 492 <h3 id="_version_information">Version information</h3>
 493 <div class="paragraph">
 494 <p><em>Version</em> : 1.0.0_inProgress</p>
 495 </div>
 496 </div>
 497 <div class="sect2">
 498 <h3 id="_uri_scheme">URI scheme</h3>
 499 <div class="paragraph">
 500 <p><em>Host</em> : serverRoot<br>
 501 <em>BasePath</em> : /nbi/api/v1<br>
 502 <em>Schemes</em> : HTTPS</p>
 503 </div>
 504 </div>
 505 <div class="sect2">
 506 <h3 id="_tags">Tags</h3>
 507 <div class="ulist">
 508 <ul>
 509 <li>
 510 <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>
 511 </li>
 512 </ul>
 513 </div>
 514 </div>
 515 <div class="sect2">
 516 <h3 id="_consumes">Consumes</h3>
 517 <div class="ulist">
 518 <ul>
 519 <li>
 520 <p><code>application/json;charset=utf-8</code></p>
 521 </li>
 522 </ul>
 523 </div>
 524 </div>
 525 <div class="sect2">
 526 <h3 id="_produces">Produces</h3>
 527 <div class="ulist">
 528 <ul>
 529 <li>
 530 <p><code>application/json;charset=utf-8</code></p>
 531 </li>
 532 </ul>
 533 </div>
 534 </div>
 535 </div>
 536 </div>
 537 <div class="sect1">
 538 <h2 id="_paths">Resources</h2>
 539 <div class="sectionbody">
 540 <div class="sect2">
 541 <h3 id="_serviceorder_resource">ServiceOrder</h3>
 542 <div class="paragraph">
 543 <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>
 544 </div>
 545 <div class="sect3">
 546 <h4 id="_serviceordercreate">Create a service order</h4>
 547 <div class="literalblock">
 548 <div class="content">
 549 <pre>POST /serviceOrder</pre>
 550 </div>
 551 </div>
 552 <div class="sect4">
 553 <h5 id="_description">Description</h5>
 554 <div class="paragraph">
 555 <p>This operation creates a service order entity.
 556 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.
 557 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>
 558 </div>
 559 <div class="paragraph">
 560 <p>Specific business errors for current operation will be encapsulated in</p>
 561 </div>
 562 <div class="paragraph">
 563 <p>HTTP Response 422 Unprocessable entity</p>
 564 </div>
 565 <div class="ulist">
 566 <ul>
 567 <li>
 568 <p>100: OrderItem with 'add' action but serviceSpecification id missing</p>
 569 </li>
 570 <li>
 571 <p>101: OrderItem with 'change'/'noChange'/'remove' but service id missing</p>
 572 </li>
 573 <li>
 574 <p>102: OrderItem with 'add' action - serviceSpecification id provided but not existing</p>
 575 </li>
 576 <li>
 577 <p>103: OrderItem with 'add' action but service id already existing in the inventory</p>
 578 </li>
 579 <li>
 580 <p>104: A customer for existing service(s) is provided but he did not exist</p>
 581 </li>
 582 <li>
 583 <p>105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory</p>
 584 </li>
 585 <li>
 586 <p>106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided</p>
 587 </li>
 588 </ul>
 589 </div>
 590 </div>
 591 <div class="sect4">
 592 <h5 id="_parameters">Parameters</h5>
 593 <table class="tableblock frame-all grid-all spread">
 594 <colgroup>
 595 <col style="width: 22.2222%;">
 596 <col style="width: 33.3333%;">
 597 <col style="width: 44.4445%;">
 598 </colgroup>
 599 <thead>
 600 <tr>
 601 <th class="tableblock halign-left valign-middle">Type</th>
 602 <th class="tableblock halign-left valign-middle">Name</th>
 603 <th class="tableblock halign-left valign-middle">Schema</th>
 604 </tr>
 605 </thead>
 606 <tbody>
 607 <tr>
 608 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td>
 609 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrder</strong><br>
 610 <em>required</em></p></td>
 611 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_createserviceorder">CreateServiceOrder</a></p></td>
 612 </tr>
 613 </tbody>
 614 </table>
 615 </div>
 616 <div class="sect4">
 617 <h5 id="_responses">Responses</h5>
 618 <table class="tableblock frame-all grid-all spread">
 619 <colgroup>
 620 <col style="width: 10%;">
 621 <col style="width: 70%;">
 622 <col style="width: 20%;">
 623 </colgroup>
 624 <thead>
 625 <tr>
 626 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 627 <th class="tableblock halign-left valign-middle">Description</th>
 628 <th class="tableblock halign-left valign-middle">Schema</th>
 629 </tr>
 630 </thead>
 631 <tbody>
 632 <tr>
 633 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>201</strong></p></td>
 634 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 635 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_createserviceorder">CreateServiceOrder</a></p></td>
 636 </tr>
 637 <tr>
 638 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 639 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 640 <p class="tableblock">List of supported error codes:
 641 - 20: Invalid URL parameter value
 642 - 21: Missing body
 643 - 22: Invalid body
 644 - 23: Missing body field
 645 - 24: Invalid body field
 646 - 25: Missing header
 647 - 26: Invalid header value
 648 - 27: Missing query-string parameter
 649 - 28: Invalid query-string parameter value</p></td>
 650 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 651 </tr>
 652 <tr>
 653 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 654 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 655 <p class="tableblock">List of supported error codes:
 656 - 40: Missing credentials
 657 - 41: Invalid credentials
 658 - 42: Expired credentials</p></td>
 659 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 660 </tr>
 661 <tr>
 662 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 663 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 664 <p class="tableblock">List of supported error codes:
 665 - 50: Access denied
 666 - 51: Forbidden requester
 667 - 52: Forbidden user
 668 - 53: Too many requests</p></td>
 669 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 670 </tr>
 671 <tr>
 672 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 673 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 674 <p class="tableblock">List of supported error codes:
 675 - 60: Resource not found</p></td>
 676 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 677 </tr>
 678 <tr>
 679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 680 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 681 <p class="tableblock">Functional error</p>
 682 <p class="tableblock">Specific encapsulated business errors for current operation</p>
 683 <p class="tableblock">* 100: OrderItem with 'add' action but serviceSpecification id missing</p>
 684 <p class="tableblock">* 101: OrderItem with 'change'/'noChange'/'remove' but service id missing</p>
 685 <p class="tableblock">* 102: OrderItem with 'add' action - serviceSpecification id provided but not existing</p>
 686 <p class="tableblock">* 103: OrderItem with 'add' action but service id already existing in the inventory</p>
 687 <p class="tableblock">* 104: A customer for existing service(s) is provided but he did not exist</p>
 688 <p class="tableblock">* 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory</p>
 689 <p class="tableblock">* 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided</p></td>
 690 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 691 </tr>
 692 <tr>
 693 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 694 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 695 <p class="tableblock">List of supported error codes:
 696 - 1: Internal error</p></td>
 697 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 698 </tr>
 699 <tr>
 700 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 701 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 702 <p class="tableblock">List of supported error codes:
 703 - 5: The service is temporarily unavailable
 704 - 6: Orange API is over capacity, retry later !</p></td>
 705 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 706 </tr>
 707 </tbody>
 708 </table>
 709 </div>
 710 </div>
 711 <div class="sect3">
 712 <h4 id="_serviceorderfind">List service orders</h4>
 713 <div class="literalblock">
 714 <div class="content">
 715 <pre>GET /serviceOrder</pre>
 716 </div>
 717 </div>
 718 <div class="sect4">
 719 <h5 id="_description_2">Description</h5>
 720 <div class="paragraph">
 721 <p>Retrieve and list service order entities according to given criteria.
 722 Only a predefined set of attribute is proposed.
 723 Attribute selection could be described in the fields attribute.</p>
 724 </div>
 725 <div class="paragraph">
 726 <p>Specific business errors for current operation will be encapsulated in</p>
 727 </div>
 728 <div class="paragraph">
 729 <p>HTTP Response 422 Unprocessable entity</p>
 730 </div>
 731 </div>
 732 <div class="sect4">
 733 <h5 id="_parameters_2">Parameters</h5>
 734 <table class="tableblock frame-all grid-all spread">
 735 <colgroup>
 736 <col style="width: 11.1111%;">
 737 <col style="width: 16.6666%;">
 738 <col style="width: 50%;">
 739 <col style="width: 22.2223%;">
 740 </colgroup>
 741 <thead>
 742 <tr>
 743 <th class="tableblock halign-left valign-middle">Type</th>
 744 <th class="tableblock halign-left valign-middle">Name</th>
 745 <th class="tableblock halign-left valign-middle">Description</th>
 746 <th class="tableblock halign-left valign-middle">Schema</th>
 747 </tr>
 748 </thead>
 749 <tbody>
 750 <tr>
 751 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 752 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
 753 <em>optional</em></p></td>
 754 <td class="tableblock halign-left valign-middle"></td>
 755 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 756 </tr>
 757 <tr>
 758 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 759 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
 760 <em>optional</em></p></td>
 761 <td class="tableblock halign-left valign-middle"></td>
 762 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 763 </tr>
 764 <tr>
 765 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 766 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br>
 767 <em>optional</em></p></td>
 768 <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>
 769 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 770 </tr>
 771 <tr>
 772 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 773 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>limit</strong><br>
 774 <em>optional</em></p></td>
 775 <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>
 776 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
 777 </tr>
 778 <tr>
 779 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 780 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>offset</strong><br>
 781 <em>optional</em></p></td>
 782 <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>
 783 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
 784 </tr>
 785 <tr>
 786 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 787 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate.gt</strong><br>
 788 <em>optional</em></p></td>
 789 <td class="tableblock halign-left valign-middle"><p class="tableblock">order date greather than</p></td>
 790 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 791 </tr>
 792 <tr>
 793 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 794 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate.lt</strong><br>
 795 <em>optional</em></p></td>
 796 <td class="tableblock halign-left valign-middle"><p class="tableblock">order date lower than</p></td>
 797 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 798 </tr>
 799 <tr>
 800 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 801 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
 802 <em>optional</em></p></td>
 803 <td class="tableblock halign-left valign-middle"><p class="tableblock">state of the order(s) to be retrieved</p></td>
 804 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 805 </tr>
 806 </tbody>
 807 </table>
 808 </div>
 809 <div class="sect4">
 810 <h5 id="_responses_2">Responses</h5>
 811 <table class="tableblock frame-all grid-all spread">
 812 <colgroup>
 813 <col style="width: 10%;">
 814 <col style="width: 70%;">
 815 <col style="width: 20%;">
 816 </colgroup>
 817 <thead>
 818 <tr>
 819 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 820 <th class="tableblock halign-left valign-middle">Description</th>
 821 <th class="tableblock halign-left valign-middle">Schema</th>
 822 </tr>
 823 </thead>
 824 <tbody>
 825 <tr>
 826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 827 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success<br>
 828 <strong>Headers</strong> : <br>
 829 <code>X-Total-Count</code> (integer (int32))<br>
 830 <code>X-Result-Count</code> (integer (int32))</p></td>
 831 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_serviceorder">ServiceOrder</a> &gt; array</p></td>
 832 </tr>
 833 <tr>
 834 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 835 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 836 <p class="tableblock">List of supported error codes:
 837 - 20: Invalid URL parameter value
 838 - 21: Missing body
 839 - 22: Invalid body
 840 - 23: Missing body field
 841 - 24: Invalid body field
 842 - 25: Missing header
 843 - 26: Invalid header value
 844 - 27: Missing query-string parameter
 845 - 28: Invalid query-string parameter value</p></td>
 846 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 847 </tr>
 848 <tr>
 849 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 850 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 851 <p class="tableblock">List of supported error codes:
 852 - 40: Missing credentials
 853 - 41: Invalid credentials
 854 - 42: Expired credentials</p></td>
 855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 856 </tr>
 857 <tr>
 858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
 859 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
 860 <p class="tableblock">List of supported error codes:
 861 - 50: Access denied
 862 - 51: Forbidden requester
 863 - 52: Forbidden user
 864 - 53: Too many requests</p></td>
 865 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 866 </tr>
 867 <tr>
 868 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
 869 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
 870 <p class="tableblock">List of supported error codes:
 871 - 60: Resource not found</p></td>
 872 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 873 </tr>
 874 <tr>
 875 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
 876 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
 877 <p class="tableblock">Functional error</p></td>
 878 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 879 </tr>
 880 <tr>
 881 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
 882 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
 883 <p class="tableblock">List of supported error codes:
 884 - 1: Internal error</p></td>
 885 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 886 </tr>
 887 <tr>
 888 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
 889 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
 890 <p class="tableblock">List of supported error codes:
 891 - 5: The service is temporarily unavailable
 892 - 6: Orange API is over capacity, retry later !</p></td>
 893 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 894 </tr>
 895 </tbody>
 896 </table>
 897 </div>
 898 </div>
 899 <div class="sect3">
 900 <h4 id="_serviceorderget">Retrieve a service order</h4>
 901 <div class="literalblock">
 902 <div class="content">
 903 <pre>GET /serviceOrder/{id}</pre>
 904 </div>
 905 </div>
 906 <div class="sect4">
 907 <h5 id="_description_3">Description</h5>
 908 <div class="paragraph">
 909 <p>This operation retrieves a service order entity.
 910 Attribute selection is enabled for all first level attributes.</p>
 911 </div>
 912 <div class="paragraph">
 913 <p>Specific business errors for current operation will be encapsulated in</p>
 914 </div>
 915 <div class="paragraph">
 916 <p>HTTP Response 422 Unprocessable entity</p>
 917 </div>
 918 </div>
 919 <div class="sect4">
 920 <h5 id="_parameters_3">Parameters</h5>
 921 <table class="tableblock frame-all grid-all spread">
 922 <colgroup>
 923 <col style="width: 11.1111%;">
 924 <col style="width: 16.6666%;">
 925 <col style="width: 50%;">
 926 <col style="width: 22.2223%;">
 927 </colgroup>
 928 <thead>
 929 <tr>
 930 <th class="tableblock halign-left valign-middle">Type</th>
 931 <th class="tableblock halign-left valign-middle">Name</th>
 932 <th class="tableblock halign-left valign-middle">Description</th>
 933 <th class="tableblock halign-left valign-middle">Schema</th>
 934 </tr>
 935 </thead>
 936 <tbody>
 937 <tr>
 938 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td>
 939 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
 940 <em>required</em></p></td>
 941 <td class="tableblock halign-left valign-middle"></td>
 942 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 943 </tr>
 944 <tr>
 945 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
 946 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br>
 947 <em>optional</em></p></td>
 948 <td class="tableblock halign-left valign-middle"><p class="tableblock">Attribute selection</p></td>
 949 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 950 </tr>
 951 </tbody>
 952 </table>
 953 </div>
 954 <div class="sect4">
 955 <h5 id="_responses_3">Responses</h5>
 956 <table class="tableblock frame-all grid-all spread">
 957 <colgroup>
 958 <col style="width: 10%;">
 959 <col style="width: 70%;">
 960 <col style="width: 20%;">
 961 </colgroup>
 962 <thead>
 963 <tr>
 964 <th class="tableblock halign-left valign-middle">HTTP Code</th>
 965 <th class="tableblock halign-left valign-middle">Description</th>
 966 <th class="tableblock halign-left valign-middle">Schema</th>
 967 </tr>
 968 </thead>
 969 <tbody>
 970 <tr>
 971 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
 972 <td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td>
 973 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorder">ServiceOrder</a></p></td>
 974 </tr>
 975 <tr>
 976 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td>
 977 <td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p>
 978 <p class="tableblock">List of supported error codes:
 979 - 20: Invalid URL parameter value
 980 - 21: Missing body
 981 - 22: Invalid body
 982 - 23: Missing body field
 983 - 24: Invalid body field
 984 - 25: Missing header
 985 - 26: Invalid header value
 986 - 27: Missing query-string parameter
 987 - 28: Invalid query-string parameter value</p></td>
 988 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 989 </tr>
 990 <tr>
 991 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
 992 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p>
 993 <p class="tableblock">List of supported error codes:
 994 - 40: Missing credentials
 995 - 41: Invalid credentials
 996 - 42: Expired credentials</p></td>
 997 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
 998 </tr>
 999 <tr>
1000 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
1001 <td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p>
1002 <p class="tableblock">List of supported error codes:
1003 - 50: Access denied
1004 - 51: Forbidden requester
1005 - 52: Forbidden user
1006 - 53: Too many requests</p></td>
1007 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1008 </tr>
1009 <tr>
1010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
1011 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p>
1012 <p class="tableblock">List of supported error codes:
1013 - 60: Resource not found</p></td>
1014 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1015 </tr>
1016 <tr>
1017 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td>
1018 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p>
1019 <p class="tableblock">Functional error</p></td>
1020 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1021 </tr>
1022 <tr>
1023 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td>
1024 <td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p>
1025 <p class="tableblock">List of supported error codes:
1026 - 1: Internal error</p></td>
1027 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1028 </tr>
1029 <tr>
1030 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td>
1031 <td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p>
1032 <p class="tableblock">List of supported error codes:
1033 - 5: The service is temporarily unavailable
1034 - 6: Orange API is over capacity, retry later !</p></td>
1035 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td>
1036 </tr>
1037 </tbody>
1038 </table>
1039 </div>
1040 </div>
1041 </div>
1042 </div>
1043 </div>
1044 <div class="sect1">
1045 <h2 id="_definitions">Definitions</h2>
1046 <div class="sectionbody">
1047 <div class="sect2">
1048 <h3 id="_actiontype">ActionType</h3>
1049 <div class="paragraph">
1050 <p>Action type to be describer on the order item.
1051 modify is not managed in Beijing release</p>
1052 </div>
1053 <div class="paragraph">
1054 <p><em>Type</em> : enum (add, modify, delete, noChange)</p>
1055 </div>
1056 </div>
1057 <div class="sect2">
1058 <h3 id="_createserviceorder">CreateServiceOrder</h3>
1059 <div class="paragraph">
1060 <p>This structure is used in the operation POST for a serviceOrder request.
1061 Attribute description is not accurate and should be find in the serviceOrder class.</p>
1062 </div>
1063 <table class="tableblock frame-all grid-all spread">
1064 <colgroup>
1065 <col style="width: 16.6666%;">
1066 <col style="width: 61.1111%;">
1067 <col style="width: 22.2223%;">
1068 </colgroup>
1069 <thead>
1070 <tr>
1071 <th class="tableblock halign-left valign-middle">Name</th>
1072 <th class="tableblock halign-left valign-middle">Description</th>
1073 <th class="tableblock halign-left valign-middle">Schema</th>
1074 </tr>
1075 </thead>
1076 <tbody>
1077 <tr>
1078 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1079 <em>optional</em></p></td>
1080 <td class="tableblock halign-left valign-middle"></td>
1081 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1082 </tr>
1083 <tr>
1084 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1085 <em>optional</em></p></td>
1086 <td class="tableblock halign-left valign-middle"></td>
1087 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1088 </tr>
1089 <tr>
1090 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1091 <em>optional</em></p></td>
1092 <td class="tableblock halign-left valign-middle"></td>
1093 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1094 </tr>
1095 <tr>
1096 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
1097 <em>optional</em></p></td>
1098 <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>
1099 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1100 </tr>
1101 <tr>
1102 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1103 <em>optional</em></p></td>
1104 <td class="tableblock halign-left valign-middle"><p class="tableblock">A free-text description of the service order</p></td>
1105 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1106 </tr>
1107 <tr>
1108 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
1109 <em>optional</em></p></td>
1110 <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>
1111 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1112 </tr>
1113 <tr>
1114 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItem</strong><br>
1115 <em>optional</em></p></td>
1116 <td class="tableblock halign-left valign-middle"></td>
1117 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_createserviceorderitem">CreateServiceOrderItem</a> &gt; array</p></td>
1118 </tr>
1119 <tr>
1120 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderRelationship</strong><br>
1121 <em>optional</em></p></td>
1122 <td class="tableblock halign-left valign-middle"></td>
1123 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderrelationship">OrderRelationship</a> &gt; array</p></td>
1124 </tr>
1125 <tr>
1126 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>priority</strong><br>
1127 <em>optional</em></p></td>
1128 <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>
1129 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1130 </tr>
1131 <tr>
1132 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
1133 <em>optional</em></p></td>
1134 <td class="tableblock halign-left valign-middle"></td>
1135 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedparty">RelatedParty</a> &gt; array</p></td>
1136 </tr>
1137 <tr>
1138 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedCompletionDate</strong><br>
1139 <em>optional</em></p></td>
1140 <td class="tableblock halign-left valign-middle"><p class="tableblock">Requested delivery date from the requestor perspective</p></td>
1141 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1142 </tr>
1143 <tr>
1144 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedStartDate</strong><br>
1145 <em>optional</em></p></td>
1146 <td class="tableblock halign-left valign-middle"><p class="tableblock">Order start date wished by the requestor</p></td>
1147 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1148 </tr>
1149 </tbody>
1150 </table>
1151 </div>
1152 <div class="sect2">
1153 <h3 id="_createserviceorderitem">CreateServiceOrderItem</h3>
1154 <div class="paragraph">
1155 <p>This structure is used in the operation POST for a serviceOrder request to describe an item.
1156 Attribute description is not accurate and should be find in the serviceOrderItem class.</p>
1157 </div>
1158 <table class="tableblock frame-all grid-all spread">
1159 <colgroup>
1160 <col style="width: 16.6666%;">
1161 <col style="width: 61.1111%;">
1162 <col style="width: 22.2223%;">
1163 </colgroup>
1164 <thead>
1165 <tr>
1166 <th class="tableblock halign-left valign-middle">Name</th>
1167 <th class="tableblock halign-left valign-middle">Description</th>
1168 <th class="tableblock halign-left valign-middle">Schema</th>
1169 </tr>
1170 </thead>
1171 <tbody>
1172 <tr>
1173 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1174 <em>optional</em></p></td>
1175 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the base type of the resource.</p></td>
1176 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1177 </tr>
1178 <tr>
1179 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1180 <em>optional</em></p></td>
1181 <td class="tableblock halign-left valign-middle"><p class="tableblock">A link to the schema describing this REST resource</p></td>
1182 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1183 </tr>
1184 <tr>
1185 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1186 <em>optional</em></p></td>
1187 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the type of resource.</p></td>
1188 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1189 </tr>
1190 <tr>
1191 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
1192 <em>optional</em></p></td>
1193 <td class="tableblock halign-left valign-middle"></td>
1194 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_actiontype">ActionType</a></p></td>
1195 </tr>
1196 <tr>
1197 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1198 <em>required</em></p></td>
1199 <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>
1200 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1201 </tr>
1202 <tr>
1203 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItemRelationship</strong><br>
1204 <em>optional</em></p></td>
1205 <td class="tableblock halign-left valign-middle"></td>
1206 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderitemrelationship">OrderItemRelationship</a> &gt; array</p></td>
1207 </tr>
1208 <tr>
1209 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
1210 <em>required</em></p></td>
1211 <td class="tableblock halign-left valign-middle"></td>
1212 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
1213 </tr>
1214 </tbody>
1215 </table>
1216 </div>
1217 <div class="sect2">
1218 <h3 id="_errorrepresentation">ErrorRepresentation</h3>
1219 <div class="paragraph">
1220 <p>Representation of an error.</p>
1221 </div>
1222 <table class="tableblock frame-all grid-all spread">
1223 <colgroup>
1224 <col style="width: 16.6666%;">
1225 <col style="width: 61.1111%;">
1226 <col style="width: 22.2223%;">
1227 </colgroup>
1228 <thead>
1229 <tr>
1230 <th class="tableblock halign-left valign-middle">Name</th>
1231 <th class="tableblock halign-left valign-middle">Description</th>
1232 <th class="tableblock halign-left valign-middle">Schema</th>
1233 </tr>
1234 </thead>
1235 <tbody>
1236 <tr>
1237 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1238 <em>optional</em></p></td>
1239 <td class="tableblock halign-left valign-middle"><p class="tableblock">it provides a link to the schema describing a REST resource</p></td>
1240 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1241 </tr>
1242 <tr>
1243 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1244 <em>optional</em></p></td>
1245 <td class="tableblock halign-left valign-middle"><p class="tableblock">The class type of a REST resource</p></td>
1246 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1247 </tr>
1248 <tr>
1249 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br>
1250 <em>required</em></p></td>
1251 <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>
1252 <td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
1253 </tr>
1254 <tr>
1255 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br>
1256 <em>optional</em></p></td>
1257 <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>
1258 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1259 </tr>
1260 <tr>
1261 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br>
1262 <em>required</em></p></td>
1263 <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>
1264 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1265 </tr>
1266 <tr>
1267 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>referenceError</strong><br>
1268 <em>optional</em></p></td>
1269 <td class="tableblock halign-left valign-middle"><p class="tableblock">url pointing to documentation describing the error</p></td>
1270 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1271 </tr>
1272 <tr>
1273 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br>
1274 <em>optional</em></p></td>
1275 <td class="tableblock halign-left valign-middle"><p class="tableblock">http error code extension like 400-2</p></td>
1276 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1277 </tr>
1278 </tbody>
1279 </table>
1280 </div>
1281 <div class="sect2">
1282 <h3 id="_hub">Hub</h3>
1283 <div class="paragraph">
1284 <p>An HUB resource is used by client side to subscribe to notification.
1285 Not managed in the Beijing release.</p>
1286 </div>
1287 <table class="tableblock frame-all grid-all spread">
1288 <colgroup>
1289 <col style="width: 42.8571%;">
1290 <col style="width: 57.1429%;">
1291 </colgroup>
1292 <thead>
1293 <tr>
1294 <th class="tableblock halign-left valign-middle">Name</th>
1295 <th class="tableblock halign-left valign-middle">Schema</th>
1296 </tr>
1297 </thead>
1298 <tbody>
1299 <tr>
1300 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>callback</strong><br>
1301 <em>required</em></p></td>
1302 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1303 </tr>
1304 <tr>
1305 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1306 <em>optional</em></p></td>
1307 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1308 </tr>
1309 <tr>
1310 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>query</strong><br>
1311 <em>optional</em></p></td>
1312 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1313 </tr>
1314 </tbody>
1315 </table>
1316 </div>
1317 <div class="sect2">
1318 <h3 id="_orderitemrelationship">OrderItemRelationship</h3>
1319 <div class="paragraph">
1320 <p>Linked order item to the one containing this attribute.
1321 nbi component used this relationship to sort request to ONAP.</p>
1322 </div>
1323 <table class="tableblock frame-all grid-all spread">
1324 <colgroup>
1325 <col style="width: 16.6666%;">
1326 <col style="width: 61.1111%;">
1327 <col style="width: 22.2223%;">
1328 </colgroup>
1329 <thead>
1330 <tr>
1331 <th class="tableblock halign-left valign-middle">Name</th>
1332 <th class="tableblock halign-left valign-middle">Description</th>
1333 <th class="tableblock halign-left valign-middle">Schema</th>
1334 </tr>
1335 </thead>
1336 <tbody>
1337 <tr>
1338 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1339 <em>required</em></p></td>
1340 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of an order item</p></td>
1341 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1342 </tr>
1343 <tr>
1344 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
1345 <em>required</em></p></td>
1346 <td class="tableblock halign-left valign-middle"></td>
1347 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_relationshiptype">RelationshipType</a></p></td>
1348 </tr>
1349 </tbody>
1350 </table>
1351 </div>
1352 <div class="sect2">
1353 <h3 id="_orderrelationship">OrderRelationship</h3>
1354 <div class="paragraph">
1355 <p>Linked order to the one containing this attribute.
1356 This relationship is not used to sort ONAP request.</p>
1357 </div>
1358 <table class="tableblock frame-all grid-all spread">
1359 <colgroup>
1360 <col style="width: 16.6666%;">
1361 <col style="width: 61.1111%;">
1362 <col style="width: 22.2223%;">
1363 </colgroup>
1364 <thead>
1365 <tr>
1366 <th class="tableblock halign-left valign-middle">Name</th>
1367 <th class="tableblock halign-left valign-middle">Description</th>
1368 <th class="tableblock halign-left valign-middle">Schema</th>
1369 </tr>
1370 </thead>
1371 <tbody>
1372 <tr>
1373 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
1374 <em>optional</em></p></td>
1375 <td class="tableblock halign-left valign-middle"><p class="tableblock">Type of the referred order.</p></td>
1376 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1377 </tr>
1378 <tr>
1379 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1380 <em>optional</em></p></td>
1381 <td class="tableblock halign-left valign-middle"><p class="tableblock">A hyperlink to the related order</p></td>
1382 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1383 </tr>
1384 <tr>
1385 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1386 <em>required</em></p></td>
1387 <td class="tableblock halign-left valign-middle"><p class="tableblock">The id of the related order</p></td>
1388 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1389 </tr>
1390 <tr>
1391 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
1392 <em>optional</em></p></td>
1393 <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>
1394 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1395 </tr>
1396 </tbody>
1397 </table>
1398 </div>
1399 <div class="sect2">
1400 <h3 id="_relatedparty">RelatedParty</h3>
1401 <div class="paragraph">
1402 <p>A related party defines party which are involved in this order and the role they are playing.
1403 for Beijing release:
1404 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:
1405 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.
1406 o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.</p>
1407 </div>
1408 <table class="tableblock frame-all grid-all spread">
1409 <colgroup>
1410 <col style="width: 16.6666%;">
1411 <col style="width: 61.1111%;">
1412 <col style="width: 22.2223%;">
1413 </colgroup>
1414 <thead>
1415 <tr>
1416 <th class="tableblock halign-left valign-middle">Name</th>
1417 <th class="tableblock halign-left valign-middle">Description</th>
1418 <th class="tableblock halign-left valign-middle">Schema</th>
1419 </tr>
1420 </thead>
1421 <tbody>
1422 <tr>
1423 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@referredType</strong><br>
1424 <em>optional</em></p></td>
1425 <td class="tableblock halign-left valign-middle"></td>
1426 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1427 </tr>
1428 <tr>
1429 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1430 <em>optional</em></p></td>
1431 <td class="tableblock halign-left valign-middle"><p class="tableblock">An hyperlink to the party - not used in Beijnig release</p></td>
1432 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1433 </tr>
1434 <tr>
1435 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1436 <em>required</em></p></td>
1437 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of a related party</p></td>
1438 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1439 </tr>
1440 <tr>
1441 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1442 <em>optional</em></p></td>
1443 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the related party</p></td>
1444 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1445 </tr>
1446 <tr>
1447 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br>
1448 <em>required</em></p></td>
1449 <td class="tableblock halign-left valign-middle"><p class="tableblock">The role of the related party (e.g. Owner, requester, fullfiller etc).
1450 ONLY 'ONAPcustomer' is considered</p></td>
1451 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1452 </tr>
1453 </tbody>
1454 </table>
1455 </div>
1456 <div class="sect2">
1457 <h3 id="_relationshiptype">RelationshipType</h3>
1458 <div class="paragraph">
1459 <p>Relationship type;
1460 Only reliesOn is managed in Beijing release.</p>
1461 </div>
1462 <div class="paragraph">
1463 <p><em>Type</em> : enum (reliesOn)</p>
1464 </div>
1465 </div>
1466 <div class="sect2">
1467 <h3 id="_service">Service</h3>
1468 <div class="paragraph">
1469 <p>Service (to be added, modified, deleted) description</p>
1470 </div>
1471 <table class="tableblock frame-all grid-all spread">
1472 <colgroup>
1473 <col style="width: 16.6666%;">
1474 <col style="width: 61.1111%;">
1475 <col style="width: 22.2223%;">
1476 </colgroup>
1477 <thead>
1478 <tr>
1479 <th class="tableblock halign-left valign-middle">Name</th>
1480 <th class="tableblock halign-left valign-middle">Description</th>
1481 <th class="tableblock halign-left valign-middle">Schema</th>
1482 </tr>
1483 </thead>
1484 <tbody>
1485 <tr>
1486 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1487 <em>optional</em></p></td>
1488 <td class="tableblock halign-left valign-middle"><p class="tableblock">The URL to get the resource schema.
1489 Not managed in Beijing Release</p></td>
1490 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1491 </tr>
1492 <tr>
1493 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1494 <em>optional</em></p></td>
1495 <td class="tableblock halign-left valign-middle"><p class="tableblock">To define the service type
1496 Not managed in Beijing Release</p></td>
1497 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1498 </tr>
1499 <tr>
1500 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1501 <em>optional</em></p></td>
1502 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference to the Service (useful for delete or modify command).
1503 Not managed in Beijing release.</p></td>
1504 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1505 </tr>
1506 <tr>
1507 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1508 <em>required</em></p></td>
1509 <td class="tableblock halign-left valign-middle"><p class="tableblock">Identifier of a service instance.
1510 It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id</p></td>
1511 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1512 </tr>
1513 <tr>
1514 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1515 <em>optional</em></p></td>
1516 <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>
1517 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1518 </tr>
1519 <tr>
1520 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
1521 <em>optional</em></p></td>
1522 <td class="tableblock halign-left valign-middle"></td>
1523 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedparty">RelatedParty</a> &gt; array</p></td>
1524 </tr>
1525 <tr>
1526 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceCharacteristic</strong><br>
1527 <em>optional</em></p></td>
1528 <td class="tableblock halign-left valign-middle"></td>
1529 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicecharacteristic">ServiceCharacteristic</a> &gt; array</p></td>
1530 </tr>
1531 <tr>
1532 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceRelationship</strong><br>
1533 <em>optional</em></p></td>
1534 <td class="tableblock halign-left valign-middle"></td>
1535 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_servicerelationship">ServiceRelationship</a> &gt; array</p></td>
1536 </tr>
1537 <tr>
1538 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecification</strong><br>
1539 <em>optional</em></p></td>
1540 <td class="tableblock halign-left valign-middle"></td>
1541 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_servicespecificationref">ServiceSpecificationRef</a></p></td>
1542 </tr>
1543 <tr>
1544 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceState</strong><br>
1545 <em>optional</em></p></td>
1546 <td class="tableblock halign-left valign-middle"><p class="tableblock">The lifecycle state of the service requested;
1547 Not managed in Beijing release.</p></td>
1548 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1549 </tr>
1550 </tbody>
1551 </table>
1552 </div>
1553 <div class="sect2">
1554 <h3 id="_servicecharacteristic">ServiceCharacteristic</h3>
1555 <div class="paragraph">
1556 <p>ServiceCharacteristic</p>
1557 </div>
1558 <table class="tableblock frame-all grid-all spread">
1559 <colgroup>
1560 <col style="width: 16.6666%;">
1561 <col style="width: 61.1111%;">
1562 <col style="width: 22.2223%;">
1563 </colgroup>
1564 <thead>
1565 <tr>
1566 <th class="tableblock halign-left valign-middle">Name</th>
1567 <th class="tableblock halign-left valign-middle">Description</th>
1568 <th class="tableblock halign-left valign-middle">Schema</th>
1569 </tr>
1570 </thead>
1571 <tbody>
1572 <tr>
1573 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1574 <em>required</em></p></td>
1575 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of characteristic</p></td>
1576 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1577 </tr>
1578 <tr>
1579 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br>
1580 <em>optional</em></p></td>
1581 <td class="tableblock halign-left valign-middle"></td>
1582 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_value">Value</a></p></td>
1583 </tr>
1584 <tr>
1585 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br>
1586 <em>optional</em></p></td>
1587 <td class="tableblock halign-left valign-middle"></td>
1588 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1589 </tr>
1590 </tbody>
1591 </table>
1592 </div>
1593 <div class="sect2">
1594 <h3 id="_serviceorder">ServiceOrder</h3>
1595 <div class="paragraph">
1596 <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>
1597 </div>
1598 <table class="tableblock frame-all grid-all spread">
1599 <colgroup>
1600 <col style="width: 16.6666%;">
1601 <col style="width: 61.1111%;">
1602 <col style="width: 22.2223%;">
1603 </colgroup>
1604 <thead>
1605 <tr>
1606 <th class="tableblock halign-left valign-middle">Name</th>
1607 <th class="tableblock halign-left valign-middle">Description</th>
1608 <th class="tableblock halign-left valign-middle">Schema</th>
1609 </tr>
1610 </thead>
1611 <tbody>
1612 <tr>
1613 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1614 <em>optional</em></p></td>
1615 <td class="tableblock halign-left valign-middle"></td>
1616 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1617 </tr>
1618 <tr>
1619 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1620 <em>optional</em></p></td>
1621 <td class="tableblock halign-left valign-middle"></td>
1622 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1623 </tr>
1624 <tr>
1625 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1626 <em>optional</em></p></td>
1627 <td class="tableblock halign-left valign-middle"></td>
1628 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1629 </tr>
1630 <tr>
1631 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
1632 <em>optional</em></p></td>
1633 <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>
1634 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1635 </tr>
1636 <tr>
1637 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>completionDateTime</strong><br>
1638 <em>optional</em></p></td>
1639 <td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was completed</p></td>
1640 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1641 </tr>
1642 <tr>
1643 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
1644 <em>optional</em></p></td>
1645 <td class="tableblock halign-left valign-middle"><p class="tableblock">A free-text description of the service order</p></td>
1646 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1647 </tr>
1648 <tr>
1649 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>expectedCompletionDate</strong><br>
1650 <em>optional</em></p></td>
1651 <td class="tableblock halign-left valign-middle"></td>
1652 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1653 </tr>
1654 <tr>
1655 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>externalId</strong><br>
1656 <em>optional</em></p></td>
1657 <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>
1658 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1659 </tr>
1660 <tr>
1661 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1662 <em>optional</em></p></td>
1663 <td class="tableblock halign-left valign-middle"><p class="tableblock">Hyperlink to access the order</p></td>
1664 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1665 </tr>
1666 <tr>
1667 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1668 <em>required</em></p></td>
1669 <td class="tableblock halign-left valign-middle"><p class="tableblock">ID created on repository side</p></td>
1670 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1671 </tr>
1672 <tr>
1673 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderDate</strong><br>
1674 <em>optional</em></p></td>
1675 <td class="tableblock halign-left valign-middle"></td>
1676 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1677 </tr>
1678 <tr>
1679 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItem</strong><br>
1680 <em>optional</em></p></td>
1681 <td class="tableblock halign-left valign-middle"></td>
1682 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_serviceorderitem">ServiceOrderItem</a> &gt; array</p></td>
1683 </tr>
1684 <tr>
1685 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderRelationship</strong><br>
1686 <em>optional</em></p></td>
1687 <td class="tableblock halign-left valign-middle"></td>
1688 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderrelationship">OrderRelationship</a> &gt; array</p></td>
1689 </tr>
1690 <tr>
1691 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>priority</strong><br>
1692 <em>optional</em></p></td>
1693 <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>
1694 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1695 </tr>
1696 <tr>
1697 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br>
1698 <em>optional</em></p></td>
1699 <td class="tableblock halign-left valign-middle"></td>
1700 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_relatedparty">RelatedParty</a> &gt; array</p></td>
1701 </tr>
1702 <tr>
1703 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedCompletionDate</strong><br>
1704 <em>optional</em></p></td>
1705 <td class="tableblock halign-left valign-middle"><p class="tableblock">Requested delivery date from the requestor perspective</p></td>
1706 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1707 </tr>
1708 <tr>
1709 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>requestedStartDate</strong><br>
1710 <em>optional</em></p></td>
1711 <td class="tableblock halign-left valign-middle"><p class="tableblock">Order start date wished by the requestor</p></td>
1712 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1713 </tr>
1714 <tr>
1715 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>startDate</strong><br>
1716 <em>optional</em></p></td>
1717 <td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was started for processing</p></td>
1718 <td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td>
1719 </tr>
1720 <tr>
1721 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
1722 <em>optional</em></p></td>
1723 <td class="tableblock halign-left valign-middle"></td>
1724 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
1725 </tr>
1726 </tbody>
1727 </table>
1728 </div>
1729 <div class="sect2">
1730 <h3 id="_serviceorderitem">ServiceOrderItem</h3>
1731 <div class="paragraph">
1732 <p>An identified part of the order. A service order is decomposed into one or more order items.</p>
1733 </div>
1734 <table class="tableblock frame-all grid-all spread">
1735 <colgroup>
1736 <col style="width: 16.6666%;">
1737 <col style="width: 61.1111%;">
1738 <col style="width: 22.2223%;">
1739 </colgroup>
1740 <thead>
1741 <tr>
1742 <th class="tableblock halign-left valign-middle">Name</th>
1743 <th class="tableblock halign-left valign-middle">Description</th>
1744 <th class="tableblock halign-left valign-middle">Schema</th>
1745 </tr>
1746 </thead>
1747 <tbody>
1748 <tr>
1749 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1750 <em>optional</em></p></td>
1751 <td class="tableblock halign-left valign-middle"><p class="tableblock">not used in Beijing relase</p></td>
1752 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1753 </tr>
1754 <tr>
1755 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1756 <em>optional</em></p></td>
1757 <td class="tableblock halign-left valign-middle"><p class="tableblock">not used in Beijing relase</p></td>
1758 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1759 </tr>
1760 <tr>
1761 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1762 <em>optional</em></p></td>
1763 <td class="tableblock halign-left valign-middle"><p class="tableblock">Used to extend the order item.
1764 not used in Beijing relase</p></td>
1765 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1766 </tr>
1767 <tr>
1768 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>action</strong><br>
1769 <em>optional</em></p></td>
1770 <td class="tableblock halign-left valign-middle"></td>
1771 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_actiontype">ActionType</a></p></td>
1772 </tr>
1773 <tr>
1774 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1775 <em>required</em></p></td>
1776 <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>
1777 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1778 </tr>
1779 <tr>
1780 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItemRelationship</strong><br>
1781 <em>optional</em></p></td>
1782 <td class="tableblock halign-left valign-middle"></td>
1783 <td class="tableblock halign-left valign-middle"><p class="tableblock">&lt; <a href="#_orderitemrelationship">OrderItemRelationship</a> &gt; array</p></td>
1784 </tr>
1785 <tr>
1786 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
1787 <em>required</em></p></td>
1788 <td class="tableblock halign-left valign-middle"></td>
1789 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
1790 </tr>
1791 <tr>
1792 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
1793 <em>optional</em></p></td>
1794 <td class="tableblock halign-left valign-middle"></td>
1795 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statetype">StateType</a></p></td>
1796 </tr>
1797 </tbody>
1798 </table>
1799 </div>
1800 <div class="sect2">
1801 <h3 id="_serviceref">ServiceRef</h3>
1802 <div class="paragraph">
1803 <p>Service references</p>
1804 </div>
1805 <table class="tableblock frame-all grid-all spread">
1806 <colgroup>
1807 <col style="width: 16.6666%;">
1808 <col style="width: 61.1111%;">
1809 <col style="width: 22.2223%;">
1810 </colgroup>
1811 <thead>
1812 <tr>
1813 <th class="tableblock halign-left valign-middle">Name</th>
1814 <th class="tableblock halign-left valign-middle">Description</th>
1815 <th class="tableblock halign-left valign-middle">Schema</th>
1816 </tr>
1817 </thead>
1818 <tbody>
1819 <tr>
1820 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1821 <em>optional</em></p></td>
1822 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service</p></td>
1823 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1824 </tr>
1825 <tr>
1826 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1827 <em>required</em></p></td>
1828 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service</p></td>
1829 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1830 </tr>
1831 </tbody>
1832 </table>
1833 </div>
1834 <div class="sect2">
1835 <h3 id="_servicerelationship">ServiceRelationship</h3>
1836 <div class="paragraph">
1837 <p>Linked Services to the one instantiate
1838 nbi component used this relationship to sort request to ONAP.</p>
1839 </div>
1840 <table class="tableblock frame-all grid-all spread">
1841 <colgroup>
1842 <col style="width: 42.8571%;">
1843 <col style="width: 57.1429%;">
1844 </colgroup>
1845 <thead>
1846 <tr>
1847 <th class="tableblock halign-left valign-middle">Name</th>
1848 <th class="tableblock halign-left valign-middle">Schema</th>
1849 </tr>
1850 </thead>
1851 <tbody>
1852 <tr>
1853 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>service</strong><br>
1854 <em>required</em></p></td>
1855 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_service">Service</a></p></td>
1856 </tr>
1857 <tr>
1858 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>type</strong><br>
1859 <em>required</em></p></td>
1860 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_relationshiptype">RelationshipType</a></p></td>
1861 </tr>
1862 </tbody>
1863 </table>
1864 </div>
1865 <div class="sect2">
1866 <h3 id="_servicespecificationref">ServiceSpecificationRef</h3>
1867 <div class="paragraph">
1868 <p>The service specification (these attributes are fetched from the catalogue).</p>
1869 </div>
1870 <table class="tableblock frame-all grid-all spread">
1871 <colgroup>
1872 <col style="width: 16.6666%;">
1873 <col style="width: 61.1111%;">
1874 <col style="width: 22.2223%;">
1875 </colgroup>
1876 <thead>
1877 <tr>
1878 <th class="tableblock halign-left valign-middle">Name</th>
1879 <th class="tableblock halign-left valign-middle">Description</th>
1880 <th class="tableblock halign-left valign-middle">Schema</th>
1881 </tr>
1882 </thead>
1883 <tbody>
1884 <tr>
1885 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br>
1886 <em>optional</em></p></td>
1887 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used in Beijing release</p></td>
1888 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1889 </tr>
1890 <tr>
1891 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1892 <em>optional</em></p></td>
1893 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used in Beijing release</p></td>
1894 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1895 </tr>
1896 <tr>
1897 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1898 <em>optional</em></p></td>
1899 <td class="tableblock halign-left valign-middle"><p class="tableblock">Not used in Beijing release</p></td>
1900 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1901 </tr>
1902 <tr>
1903 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br>
1904 <em>optional</em></p></td>
1905 <td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service specification
1906 Not used in Beijing release.</p></td>
1907 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1908 </tr>
1909 <tr>
1910 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
1911 <em>required</em></p></td>
1912 <td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service specification
1913 This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.</p></td>
1914 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1915 </tr>
1916 <tr>
1917 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
1918 <em>optional</em></p></td>
1919 <td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service specification
1920 Not used in Beijing release</p></td>
1921 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1922 </tr>
1923 <tr>
1924 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>targetServiceSchema</strong><br>
1925 <em>optional</em></p></td>
1926 <td class="tableblock halign-left valign-middle"></td>
1927 <td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_targetserviceschema">TargetServiceSchema</a></p></td>
1928 </tr>
1929 <tr>
1930 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br>
1931 <em>optional</em></p></td>
1932 <td class="tableblock halign-left valign-middle"><p class="tableblock">Version of the service Specification
1933 Not used in Beijing release</p></td>
1934 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1935 </tr>
1936 </tbody>
1937 </table>
1938 </div>
1939 <div class="sect2">
1940 <h3 id="_statetype">StateType</h3>
1941 <div class="paragraph">
1942 <p>List of possible state for the order and the orderItem.</p>
1943 </div>
1944 <div class="paragraph">
1945 <p><em>Type</em> : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial)</p>
1946 </div>
1947 </div>
1948 <div class="sect2">
1949 <h3 id="_targetserviceschema">TargetServiceSchema</h3>
1950 <div class="paragraph">
1951 <p>Target to the schema describing the service spec resource</p>
1952 </div>
1953 <table class="tableblock frame-all grid-all spread">
1954 <colgroup>
1955 <col style="width: 16.6666%;">
1956 <col style="width: 61.1111%;">
1957 <col style="width: 22.2223%;">
1958 </colgroup>
1959 <thead>
1960 <tr>
1961 <th class="tableblock halign-left valign-middle">Name</th>
1962 <th class="tableblock halign-left valign-middle">Description</th>
1963 <th class="tableblock halign-left valign-middle">Schema</th>
1964 </tr>
1965 </thead>
1966 <tbody>
1967 <tr>
1968 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
1969 <em>required</em></p></td>
1970 <td class="tableblock halign-left valign-middle"><p class="tableblock">This field provided a link to the schema describing this REST resource.</p></td>
1971 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1972 </tr>
1973 <tr>
1974 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
1975 <em>required</em></p></td>
1976 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the (class) type of resource.</p></td>
1977 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
1978 </tr>
1979 </tbody>
1980 </table>
1981 </div>
1982 <div class="sect2">
1983 <h3 id="_value">Value</h3>
1984 <div class="paragraph">
1985 <p>Value is a descriptive structure for service characteristic;
1986 For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.</p>
1987 </div>
1988 <table class="tableblock frame-all grid-all spread">
1989 <colgroup>
1990 <col style="width: 16.6666%;">
1991 <col style="width: 61.1111%;">
1992 <col style="width: 22.2223%;">
1993 </colgroup>
1994 <thead>
1995 <tr>
1996 <th class="tableblock halign-left valign-middle">Name</th>
1997 <th class="tableblock halign-left valign-middle">Description</th>
1998 <th class="tableblock halign-left valign-middle">Schema</th>
1999 </tr>
2000 </thead>
2001 <tbody>
2002 <tr>
2003 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br>
2004 <em>optional</em></p></td>
2005 <td class="tableblock halign-left valign-middle"><p class="tableblock">This field provided a link to the schema describing this REST resource.
2006 Not used in Beijing Release</p></td>
2007 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2008 </tr>
2009 <tr>
2010 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br>
2011 <em>optional</em></p></td>
2012 <td class="tableblock halign-left valign-middle"><p class="tableblock">Indicates the (class) type of resource.
2013 Not used in Beijing Release</p></td>
2014 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2015 </tr>
2016 <tr>
2017 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceCharacteristicValue</strong><br>
2018 <em>optional</em></p></td>
2019 <td class="tableblock halign-left valign-middle"><p class="tableblock">Value of the characteristic.
2020 This attribute must be used in Beijing Release to provide characteristic value.</p></td>
2021 <td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
2022 </tr>
2023 </tbody>
2024 </table>
2025 </div>
2026 </div>
2027 </div>
2028 </div>
2029 <div id="footer">
2030 <div id="footer-text">
2031 Last updated 2018-03-22 09:37:52 UTC
2032 </div>
2033 </div>
2034 </body>
2035 </html>