docs/offeredapis/serviceOrder/markDown.md

   1 # API ServiceOrder
   2
   3
   4 <a name="overview"></a>
   5 ## Overview
   6
   7 ### Api URL
   8
   9 [Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json)
  10
  11
  12 [plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0)
  13
  14 serviceOrder API designed for ONAP.
  15 This API is build from TMF open API18.0 (applying TMF Guideline 3.0);
  16 Only operations GET (by id and list) and POST are available.
  17
  18
  19 ### Version information
  20 *Version* : 3.0.0_inProgress
  21
  22
  23 ### URI scheme
  24 *Host* : serverRoot
  25 *BasePath* : /nbi/api/v3
  26 *Schemes* : HTTPS
  27
  28
  29 ### Tags
  30
  31 * Hub
  32 * Notification
  33 * 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.
  34
  35
  36 ### Produces
  37
  38 * `application/json;charset=utf-8`
  39
  40
  41 <a name="paths"></a>
  42 ## Resources
  43
  44 <a name="hub_resource"></a>
  45 ### Hub
  46
  47 <a name="hubcreate"></a>
  48 #### Create Hub
  49 ```
  50 POST /hub
  51 ```
  52
  53
  54 ##### Description
  55 Specific business errors for current operation will be encapsulated in
  56
  57 HTTP Response 422 Unprocessable entity
  58
  59
  60 ##### Parameters
  61
  62 |Type|Name|Schema|
  63 |---|---|---|
  64 |**Body**|**Hub**  <br>*required*|[CreateHub](#createhub)|
  65
  66
  67 ##### Responses
  68
  69 |HTTP Code|Description|Schema|
  70 |---|---|---|
  71 |**201**|Success  <br>**Headers** :   <br>`location` (string)|file|
  72 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
  73 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
  74 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
  75 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
  76 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
  77 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
  78 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
  79
  80
  81 ##### Consumes
  82
  83 * `application/json;charset=utf-8`
  84
  85
  86 <a name="hubfind"></a>
  87 #### Retrieve a lits of hub
  88 ```
  89 GET /hub
  90 ```
  91
  92
  93 ##### Description
  94 Specific business errors for current operation will be encapsulated in
  95
  96 HTTP Response 422 Unprocessable entity
  97
  98
  99 ##### Parameters
 100
 101 |Type|Name|Schema|
 102 |---|---|---|
 103 |**Query**|**eventType**  <br>*optional*|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)|
 104 |**Query**|**id**  <br>*optional*|string|
 105
 106
 107 ##### Responses
 108
 109 |HTTP Code|Description|Schema|
 110 |---|---|---|
 111 |**200**|Success|< [Hub](#hub) > array|
 112 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 113 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 114 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 115 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 116 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 117 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 118 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 119
 120
 121 ##### Produces
 122
 123 * `application/json;charset=utf-8`
 124
 125
 126 <a name="hubget"></a>
 127 #### Retrieve an HUB by id
 128 ```
 129 GET /hub/{hubId}
 130 ```
 131
 132
 133 ##### Description
 134 Retrieve an HUB by id
 135
 136 Specific business errors for current operation will be encapsulated in
 137
 138 HTTP Response 422 Unprocessable entity
 139
 140
 141 ##### Parameters
 142
 143 |Type|Name|Schema|
 144 |---|---|---|
 145 |**Path**|**hubId**  <br>*required*|string|
 146
 147
 148 ##### Responses
 149
 150 |HTTP Code|Description|Schema|
 151 |---|---|---|
 152 |**200**|Success|[Hub](#hub)|
 153 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 154 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 155 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 156 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 157 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 158 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 159 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 160
 161
 162 ##### Produces
 163
 164 * `application/json;charset=utf-8`
 165
 166
 167 <a name="hubdelete"></a>
 168 #### delete hub
 169 ```
 170 DELETE /hub/{hubId}
 171 ```
 172
 173
 174 ##### Description
 175 Specific business errors for current operation will be encapsulated in
 176
 177 HTTP Response 422 Unprocessable entity
 178
 179
 180 ##### Parameters
 181
 182 |Type|Name|Schema|
 183 |---|---|---|
 184 |**Path**|**hubId**  <br>*required*|string|
 185
 186
 187 ##### Responses
 188
 189 |HTTP Code|Description|Schema|
 190 |---|---|---|
 191 |**204**|Success|No Content|
 192 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 193 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 194 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 195 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 196 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 197 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 198 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 199
 200
 201 <a name="notification_resource"></a>
 202 ### Notification
 203
 204 <a name="notificationserviceordercreationnotification"></a>
 205 #### Service order creation notification
 206 ```
 207 POST /notification/serviceOrderCreationNotification
 208 ```
 209
 210
 211 ##### Description
 212 Service order creation notification
 213
 214 Specific business errors for current operation will be encapsulated in
 215
 216 HTTP Response 422 Unprocessable entity
 217
 218
 219 ##### Parameters
 220
 221 |Type|Name|Schema|
 222 |---|---|---|
 223 |**Body**|**serviceOrderCreationNotification**  <br>*required*|[ServiceOrderCreationNotification](#serviceordercreationnotification)|
 224
 225
 226 ##### Responses
 227
 228 |HTTP Code|Description|Schema|
 229 |---|---|---|
 230 |**204**|Success|No Content|
 231 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 232 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 233 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 234 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 235 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 236 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 237 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 238
 239
 240 ##### Consumes
 241
 242 * `application/json;charset=utf-8`
 243
 244
 245 <a name="notificationserviceorderitemstatechangenotification"></a>
 246 #### ServiceOrder Item State Change Notification description
 247 ```
 248 POST /notification/serviceOrderItemStateChangeNotification
 249 ```
 250
 251
 252 ##### Description
 253 Specific business errors for current operation will be encapsulated in
 254
 255 HTTP Response 422 Unprocessable entity
 256
 257
 258 ##### Parameters
 259
 260 |Type|Name|Schema|
 261 |---|---|---|
 262 |**Body**|**serviceOrderItemStateChangeNotification**  <br>*required*|[ServiceOrderItemStateChangeNotification](#serviceorderitemstatechangenotification)|
 263
 264
 265 ##### Responses
 266
 267 |HTTP Code|Description|Schema|
 268 |---|---|---|
 269 |**204**|Success|No Content|
 270 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 271 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 272 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 273 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 274 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 275 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 276 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 277
 278
 279 ##### Consumes
 280
 281 * `application/json;charset=utf-8`
 282
 283
 284 <a name="notificationserviceorderstatechangenotification"></a>
 285 #### Service order state change notification description
 286 ```
 287 POST /notification/serviceOrderStateChangeNotification
 288 ```
 289
 290
 291 ##### Description
 292 Specific business errors for current operation will be encapsulated in
 293
 294 HTTP Response 422 Unprocessable entity
 295
 296
 297 ##### Parameters
 298
 299 |Type|Name|Schema|
 300 |---|---|---|
 301 |**Body**|**serviceOrderstateChangeNotification**  <br>*required*|[ServiceOrderStateChangeNotification](#serviceorderstatechangenotification)|
 302
 303
 304 ##### Responses
 305
 306 |HTTP Code|Description|Schema|
 307 |---|---|---|
 308 |**204**|Success|No Content|
 309 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 310 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 311 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 312 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 313 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 314 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 315 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 316
 317
 318 ##### Consumes
 319
 320 * `application/json;charset=utf-8`
 321
 322
 323 <a name="serviceorder_resource"></a>
 324 ### ServiceOrder
 325 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.
 326
 327
 328 <a name="serviceordercreate"></a>
 329 #### Create a service order
 330 ```
 331 POST /serviceOrder
 332 ```
 333
 334
 335 ##### Description
 336 This operation creates a service order entity.
 337 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.
 338 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.
 339
 340 In Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created.
 341
 342 In Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC.
 343 Depending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use  {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API.
 344
 345 Specific business errors for current operation will be encapsulated in
 346
 347 HTTP Response 422 Unprocessable entity
 348
 349  - 100: OrderItem with 'add' action but serviceSpecification id missing
 350
 351  - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing
 352
 353  - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing
 354
 355  - 103: OrderItem with 'add' action but service id already existing in the inventory
 356
 357  - 104: A customer for existing service(s) is provided but he did not exist
 358
 359  - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory
 360
 361  - 106: [Not managed for current Relese] Issue with lcpCloudRegionId  and tenantId provided
 362
 363
 364 ##### Parameters
 365
 366 |Type|Name|Schema|
 367 |---|---|---|
 368 |**Body**|**serviceOrder**  <br>*required*|[CreateServiceOrder](#createserviceorder)|
 369
 370
 371 ##### Responses
 372
 373 |HTTP Code|Description|Schema|
 374 |---|---|---|
 375 |**201**|Success|[ServiceOrder](#serviceorder)|
 376 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 377 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 378 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 379 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 380 |**422**|Unprocessable entity<br><br>Functional error<br><br>Specific encapsulated business errors for current operation<br><br> - 100: OrderItem with 'add' action but serviceSpecification id missing<br>   <br> - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing<br>   <br> - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing<br>   <br> - 103: OrderItem with 'add' action but service id already existing in the inventory<br>   <br> - 104: A customer for existing service(s) is provided but he did not exist<br>   <br> - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory<br>   <br> - 106: [Not managed for current Relese] Issue with lcpCloudRegionId  and tenantId provided|[ErrorRepresentation](#errorrepresentation)|
 381 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 382 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 383
 384
 385 ##### Consumes
 386
 387 * `application/json;charset=utf-8`
 388
 389
 390 ##### Produces
 391
 392 * `application/json;charset=utf-8`
 393
 394
 395 <a name="serviceorderfind"></a>
 396 #### List service orders
 397 ```
 398 GET /serviceOrder
 399 ```
 400
 401
 402 ##### Description
 403 Retrieve and list service order entities according to given criteria.
 404 Only a predefined set of attribute is proposed.
 405 Attribute selection could be described in the fields attribute.
 406
 407 Specific business errors for current operation will be encapsulated in
 408
 409 HTTP Response 422 Unprocessable entity
 410
 411
 412 ##### Parameters
 413
 414 |Type|Name|Description|Schema|
 415 |---|---|---|---|
 416 |**Query**|**description**  <br>*optional*||string|
 417 |**Query**|**externalId**  <br>*optional*||string|
 418 |**Query**|**fields**  <br>*optional*|this attribute could be used to filter retrieved attribute(s) and/or sort SO.|string|
 419 |**Query**|**limit**  <br>*optional*|The maximum number of elements to retrieve (it can be greater than the actual available number of items).|integer (int32)|
 420 |**Query**|**offset**  <br>*optional*|The index of the first element to retrieve. Zero is the first element of the collection.|integer (int32)|
 421 |**Query**|**orderDate.gt**  <br>*optional*|order date greather than|string|
 422 |**Query**|**orderDate.lt**  <br>*optional*|order date lower than|string|
 423 |**Query**|**state**  <br>*optional*|state of the order(s) to be retrieved|string|
 424
 425
 426 ##### Responses
 427
 428 |HTTP Code|Description|Schema|
 429 |---|---|---|
 430 |**200**|Success  <br>**Headers** :   <br>`X-Total-Count` (integer (int32))  <br>`X-Result-Count` (integer (int32))|< [ServiceOrder](#serviceorder) > array|
 431 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 432 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 433 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 434 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 435 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 436 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 437 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 438
 439
 440 ##### Produces
 441
 442 * `application/json;charset=utf-8`
 443
 444
 445 <a name="serviceorderget"></a>
 446 #### Retrieve a service order
 447 ```
 448 GET /serviceOrder/{id}
 449 ```
 450
 451
 452 ##### Description
 453 This operation retrieves a service order entity.
 454 Attribute selection is enabled for all first level attributes.
 455
 456 Specific business errors for current operation will be encapsulated in
 457
 458 HTTP Response 422 Unprocessable entity
 459
 460
 461 ##### Parameters
 462
 463 |Type|Name|Description|Schema|
 464 |---|---|---|---|
 465 |**Path**|**id**  <br>*required*||string|
 466 |**Query**|**fields**  <br>*optional*|Attribute selection|string|
 467
 468
 469 ##### Responses
 470
 471 |HTTP Code|Description|Schema|
 472 |---|---|---|
 473 |**200**|Success|[ServiceOrder](#serviceorder)|
 474 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 475 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 476 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 477 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 478 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 479 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 480 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 481
 482
 483 ##### Produces
 484
 485 * `application/json;charset=utf-8`
 486
 487
 488 <a name="definitions"></a>
 489 ## Definitions
 490
 491 <a name="actiontype"></a>
 492 ### ActionType
 493 Action type to be describer on the order item.
 494 modify is not managed in Beijing release
 495
 496 *Type* : enum (add, modify, delete, noChange)
 497
 498
 499 <a name="createhub"></a>
 500 ### CreateHub
 501 This structure is used as a request for POST Hub operation
 502
 503
 504 |Name|Description|Schema|
 505 |---|---|---|
 506 |**callback**  <br>*required*|Address where notification must be send|string|
 507 |**query**  <br>*required*|The query must have an eventType=notificationName information.<br>Optionally a ? could be added to reduce hub.<br>query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string|
 508
 509
 510 <a name="createserviceorder"></a>
 511 ### CreateServiceOrder
 512 This structure is used in the operation POST for a serviceOrder request.
 513 Attribute description is not accurate and should be find in the serviceOrder class.
 514
 515
 516 |Name|Description|Schema|
 517 |---|---|---|
 518 |**@baseType**  <br>*optional*||string|
 519 |**@schemaLocation**  <br>*optional*||string|
 520 |**@type**  <br>*optional*||string|
 521 |**category**  <br>*optional*|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)|string|
 522 |**description**  <br>*optional*|A free-text description of the service order|string|
 523 |**externalId**  <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string|
 524 |**orderItem**  <br>*optional*||< [CreateServiceOrderItem](#createserviceorderitem) > array|
 525 |**orderRelationship**  <br>*optional*||< [OrderRelationship](#orderrelationship) > array|
 526 |**priority**  <br>*optional*|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)|string|
 527 |**relatedParty**  <br>*optional*||< [RelatedParty](#relatedparty) > array|
 528 |**requestedCompletionDate**  <br>*optional*|Requested delivery date from the requestor perspective|string (date-time)|
 529 |**requestedStartDate**  <br>*optional*|Order start date wished by the requestor|string (date-time)|
 530
 531
 532 <a name="createserviceorderitem"></a>
 533 ### CreateServiceOrderItem
 534 This structure is used in the operation POST for a serviceOrder request to describe an item.
 535 Attribute description is not accurate and should be find in the serviceOrderItem class.
 536
 537
 538 |Name|Description|Schema|
 539 |---|---|---|
 540 |**@baseType**  <br>*optional*|Indicates the base type of the resource.|string|
 541 |**@schemaLocation**  <br>*optional*|A link to the schema describing this REST resource|string|
 542 |**@type**  <br>*optional*|Indicates the type of resource.|string|
 543 |**action**  <br>*optional*||[ActionType](#actiontype)|
 544 |**id**  <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string|
 545 |**orderItemRelationship**  <br>*optional*||< [OrderItemRelationship](#orderitemrelationship) > array|
 546 |**service**  <br>*required*||[Service](#service)|
 547
 548
 549 <a name="errorrepresentation"></a>
 550 ### ErrorRepresentation
 551 Representation of an error.
 552
 553
 554 |Name|Description|Schema|
 555 |---|---|---|
 556 |**@schemaLocation**  <br>*optional*|it provides a link to the schema describing a REST resource|string|
 557 |**@type**  <br>*optional*|The class type of a REST resource|string|
 558 |**code**  <br>*required*|Application related code (as defined in the API or from a common list)|integer (int32)|
 559 |**message**  <br>*optional*|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string|
 560 |**reason**  <br>*required*|Text that explains the reason for error. This can be shown to a client user.|string|
 561 |**referenceError**  <br>*optional*|url pointing to documentation describing the error|string|
 562 |**status**  <br>*optional*|http error code extension like 400-2|string|
 563
 564
 565 <a name="eventtype"></a>
 566 ### EventType
 567 *Type* : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)
 568
 569
 570 <a name="hub"></a>
 571 ### Hub
 572 An HUB resource is used by client side to subscribe to notification.
 573 Not managed in the Beijing release.
 574
 575
 576 |Name|Description|Schema|
 577 |---|---|---|
 578 |**callback**  <br>*required*|Address where notification must be send|string|
 579 |**id**  <br>*optional*|Hub Id|string|
 580 |**query**  <br>*required*||string|
 581
 582
 583 <a name="notification"></a>
 584 ### Notification
 585 Used to describe notification for this API
 586
 587 *Type* : object
 588
 589
 590 <a name="orderitemrelationship"></a>
 591 ### OrderItemRelationship
 592 Linked order item to the one containing this attribute.
 593 nbi component used this relationship to sort request to ONAP.
 594
 595
 596 |Name|Description|Schema|
 597 |---|---|---|
 598 |**id**  <br>*required*|Unique identifier of an order item|string|
 599 |**type**  <br>*required*||[RelationshipType](#relationshiptype)|
 600
 601
 602 <a name="ordermessage"></a>
 603 ### OrderMessage
 604 An optional array of messages associated with the Order
 605
 606
 607 |Name|Description|Schema|
 608 |---|---|---|
 609 |**code**  <br>*optional*|A code associated to this message|string|
 610 |**correctionRequired**  <br>*required*|Indicator that an action is required to allow service order fullfilment to follow up|boolean|
 611 |**field**  <br>*optional*|Service Order attribute related to this error message|string|
 612 |**messageInformation**  <br>*optional*|Message related to this order|string|
 613 |**severity**  <br>*required*||[SeverityMessage](#severitymessage)|
 614
 615
 616 <a name="orderrelationship"></a>
 617 ### OrderRelationship
 618 Linked order to the one containing this attribute.
 619 This relationship is not used to sort ONAP request.
 620
 621
 622 |Name|Description|Schema|
 623 |---|---|---|
 624 |**@referredType**  <br>*optional*|Type of the referred order.|string|
 625 |**href**  <br>*optional*|A hyperlink to the related order|string|
 626 |**id**  <br>*required*|The id of the related order|string|
 627 |**type**  <br>*optional*|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)|string|
 628
 629
 630 <a name="relatedparty"></a>
 631 ### RelatedParty
 632 A related party defines party which are involved in this order and the role they are playing.
 633 for Beijing release:
 634 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:
 635 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.
 636 o       If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.
 637
 638
 639 |Name|Description|Schema|
 640 |---|---|---|
 641 |**@referredType**  <br>*optional*||string|
 642 |**href**  <br>*optional*|An hyperlink to the party - not used in Beijnig release|string|
 643 |**id**  <br>*required*|Unique identifier of a related party|string|
 644 |**name**  <br>*optional*|Name of the related party|string|
 645 |**role**  <br>*required*|The role of the related party (e.g. Owner, requester, fullfiller etc).<br>ONLY 'ONAPcustomer' is considered|string|
 646
 647
 648 <a name="relationshiptype"></a>
 649 ### RelationshipType
 650 Relationship type;
 651 Only reliesOn is managed in Beijing release.
 652
 653 *Type* : enum (reliesOn)
 654
 655
 656 <a name="service"></a>
 657 ### Service
 658 Service (to be added, modified, deleted) description
 659
 660
 661 |Name|Description|Schema|
 662 |---|---|---|
 663 |**@schemaLocation**  <br>*optional*|The URL to get the resource schema.<br>Not managed in Beijing Release|string|
 664 |**@type**  <br>*optional*|To define the service type<br>Not managed in Beijing Release|string|
 665 |**href**  <br>*optional*|Reference to the Service (useful for delete or modify command).<br>Not managed in Beijing release.|string|
 666 |**id**  <br>*required*|Identifier of a service instance.<br>It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id|string|
 667 |**name**  <br>*optional*|Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.|string|
 668 |**relatedParty**  <br>*optional*||< [RelatedParty](#relatedparty) > array|
 669 |**serviceCharacteristic**  <br>*optional*||< [ServiceCharacteristic](#servicecharacteristic) > array|
 670 |**serviceRelationship**  <br>*optional*||< [ServiceRelationship](#servicerelationship) > array|
 671 |**serviceSpecification**  <br>*optional*||[ServiceSpecificationRef](#servicespecificationref)|
 672 |**serviceState**  <br>*optional*|The lifecycle state of the service requested;<br>Not managed in Beijing release.|string|
 673
 674
 675 <a name="servicecharacteristic"></a>
 676 ### ServiceCharacteristic
 677 ServiceCharacteristic
 678
 679
 680 |Name|Description|Schema|
 681 |---|---|---|
 682 |**name**  <br>*required*|Name of characteristic|string|
 683 |**value**  <br>*optional*||[Value](#value)|
 684 |**valueType**  <br>*optional*||string|
 685
 686
 687 <a name="serviceorder"></a>
 688 ### ServiceOrder
 689 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
 690
 691
 692 |Name|Description|Schema|
 693 |---|---|---|
 694 |**@baseType**  <br>*optional*||string|
 695 |**@schemaLocation**  <br>*optional*||string|
 696 |**@type**  <br>*optional*||string|
 697 |**category**  <br>*optional*|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)|string|
 698 |**completionDateTime**  <br>*optional*|Date when the order was completed|string (date-time)|
 699 |**description**  <br>*optional*|A free-text description of the service order|string|
 700 |**expectedCompletionDate**  <br>*optional*||string (date-time)|
 701 |**externalId**  <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string|
 702 |**href**  <br>*optional*|Hyperlink to access the order|string|
 703 |**id**  <br>*required*|ID created on repository side|string|
 704 |**orderDate**  <br>*optional*||string (date-time)|
 705 |**orderItem**  <br>*optional*||< [ServiceOrderItem](#serviceorderitem) > array|
 706 |**orderMessage**  <br>*optional*||< [OrderMessage](#ordermessage) > array|
 707 |**orderRelationship**  <br>*optional*||< [OrderRelationship](#orderrelationship) > array|
 708 |**priority**  <br>*optional*|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)|string|
 709 |**relatedParty**  <br>*optional*||< [RelatedParty](#relatedparty) > array|
 710 |**requestedCompletionDate**  <br>*optional*|Requested delivery date from the requestor perspective|string (date-time)|
 711 |**requestedStartDate**  <br>*optional*|Order start date wished by the requestor|string (date-time)|
 712 |**startDate**  <br>*optional*|Date when the order was started for processing|string (date-time)|
 713 |**state**  <br>*optional*||[StateType](#statetype)|
 714
 715
 716 <a name="serviceordercreationnotification"></a>
 717 ### ServiceOrderCreationNotification
 718 Notification structure for a service order creation notification
 719
 720
 721 |Name|Description|Schema|
 722 |---|---|---|
 723 |**event**  <br>*required*||[ServiceOrderSummary](#serviceordersummary)|
 724 |**eventDate**  <br>*required*||string (date-time)|
 725 |**eventId**  <br>*required*||string|
 726 |**eventType**  <br>*required*|**Default** : `"ServiceOrderCreationNotification"`|string|
 727
 728
 729 <a name="serviceorderitem"></a>
 730 ### ServiceOrderItem
 731 An identified part of the order. A service order is decomposed into one or more order items.
 732
 733
 734 |Name|Description|Schema|
 735 |---|---|---|
 736 |**@baseType**  <br>*optional*|not used in Beijing relase|string|
 737 |**@schemaLocation**  <br>*optional*|not used in Beijing relase|string|
 738 |**@type**  <br>*optional*|Used to extend the order item.<br>not used in Beijing relase|string|
 739 |**action**  <br>*optional*||[ActionType](#actiontype)|
 740 |**id**  <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string|
 741 |**orderItemMessage**  <br>*optional*||< [OrderMessage](#ordermessage) > array|
 742 |**orderItemRelationship**  <br>*optional*||< [OrderItemRelationship](#orderitemrelationship) > array|
 743 |**percentProgress**  <br>*optional*|Progress of the delivery in percentage.|string|
 744 |**service**  <br>*required*||[Service](#service)|
 745 |**state**  <br>*optional*||[StateType](#statetype)|
 746
 747
 748 <a name="serviceorderitemstatechangenotification"></a>
 749 ### ServiceOrderItemStateChangeNotification
 750
 751 |Name|Description|Schema|
 752 |---|---|---|
 753 |**event**  <br>*required*||[ServiceOrderSummaryWithItem](#serviceordersummarywithitem)|
 754 |**eventDate**  <br>*required*||string (date-time)|
 755 |**eventId**  <br>*required*||string|
 756 |**eventType**  <br>*required*|**Default** : `"ServiceOrderStateChangeNotification"`|string|
 757
 758
 759 <a name="serviceorderitemsummary"></a>
 760 ### ServiceOrderItemSummary
 761 Service Order item summary to be used for notification
 762
 763
 764 |Name|Description|Schema|
 765 |---|---|---|
 766 |**action**  <br>*optional*||[ActionType](#actiontype)|
 767 |**id**  <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string|
 768 |**service**  <br>*required*||[Service](#service)|
 769 |**state**  <br>*optional*||[StateType](#statetype)|
 770
 771
 772 <a name="serviceorderstatechangenotification"></a>
 773 ### ServiceOrderStateChangeNotification
 774 Service order state change notification description
 775
 776
 777 |Name|Description|Schema|
 778 |---|---|---|
 779 |**event**  <br>*required*||[ServiceOrderSummary](#serviceordersummary)|
 780 |**eventDate**  <br>*required*||string (date-time)|
 781 |**eventId**  <br>*required*||string|
 782 |**eventType**  <br>*required*|**Default** : `"ServiceOrderStateChangeNotification"`|string|
 783
 784
 785 <a name="serviceordersummary"></a>
 786 ### ServiceOrderSummary
 787 This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages
 788
 789
 790 |Name|Description|Schema|
 791 |---|---|---|
 792 |**completionDateTime**  <br>*optional*|Date when the order was completed|string (date-time)|
 793 |**externalId**  <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string|
 794 |**href**  <br>*optional*|Hyperlink to access the order|string|
 795 |**id**  <br>*required*|ID created on repository side|string|
 796 |**orderDate**  <br>*optional*||string (date-time)|
 797 |**state**  <br>*optional*||[StateType](#statetype)|
 798
 799
 800 <a name="serviceordersummarywithitem"></a>
 801 ### ServiceOrderSummaryWithItem
 802 Service order item summary with item description
 803
 804
 805 |Name|Description|Schema|
 806 |---|---|---|
 807 |**completionDateTime**  <br>*optional*|Date when the order was completed|string (date-time)|
 808 |**externalId**  <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string|
 809 |**href**  <br>*optional*|Hyperlink to access the order|string|
 810 |**id**  <br>*required*|ID created on repository side|string|
 811 |**orderDate**  <br>*optional*||string (date-time)|
 812 |**orderItem**  <br>*optional*||< [ServiceOrderItemSummary](#serviceorderitemsummary) > array|
 813 |**state**  <br>*optional*||[StateType](#statetype)|
 814
 815
 816 <a name="serviceref"></a>
 817 ### ServiceRef
 818 Service references
 819
 820
 821 |Name|Description|Schema|
 822 |---|---|---|
 823 |**href**  <br>*optional*|Reference of the service|string|
 824 |**id**  <br>*required*|Unique identifier of the service|string|
 825
 826
 827 <a name="servicerelationship"></a>
 828 ### ServiceRelationship
 829 Linked Services to the one instantiate
 830 nbi component used this relationship to sort request to ONAP.
 831
 832
 833 |Name|Schema|
 834 |---|---|
 835 |**service**  <br>*required*|[Service](#service)|
 836 |**type**  <br>*required*|[RelationshipType](#relationshiptype)|
 837
 838
 839 <a name="servicespecificationref"></a>
 840 ### ServiceSpecificationRef
 841 The service specification (these attributes are fetched from the catalogue).
 842
 843
 844 |Name|Description|Schema|
 845 |---|---|---|
 846 |**@baseType**  <br>*optional*|Not used in Beijing release|string|
 847 |**@schemaLocation**  <br>*optional*|Not used in Beijing release|string|
 848 |**@type**  <br>*optional*|Not used in Beijing release|string|
 849 |**href**  <br>*optional*|Reference of the service specification<br>Not used in Beijing release.|string|
 850 |**id**  <br>*required*|Unique identifier of the service specification<br>This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.|string|
 851 |**name**  <br>*optional*|Name of the service specification<br>Not used in Beijing release|string|
 852 |**targetServiceSchema**  <br>*optional*||[TargetServiceSchema](#targetserviceschema)|
 853 |**version**  <br>*optional*|Version of the service Specification<br>Not used in Beijing release|string|
 854
 855
 856 <a name="severitymessage"></a>
 857 ### SeverityMessage
 858 *Type* : enum (information, error)
 859
 860
 861 <a name="statetype"></a>
 862 ### StateType
 863 List of possible state for the order and the orderItem.
 864
 865 *Type* : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial)
 866
 867
 868 <a name="targetserviceschema"></a>
 869 ### TargetServiceSchema
 870 Target to the schema describing the service spec resource
 871
 872
 873 |Name|Description|Schema|
 874 |---|---|---|
 875 |**@schemaLocation**  <br>*required*|This field provided a link to the schema describing this REST resource.|string|
 876 |**@type**  <br>*required*|Indicates the (class) type of resource.|string|
 877
 878
 879 <a name="value"></a>
 880 ### Value
 881 Value is a descriptive structure for service characteristic;
 882 For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.
 883
 884
 885 |Name|Description|Schema|
 886 |---|---|---|
 887 |**@schemaLocation**  <br>*optional*|This field provided a link to the schema describing this REST resource.<br>Not used in Beijing Release|string|
 888 |**@type**  <br>*optional*|Indicates the (class) type of resource.<br>Not used in Beijing Release|string|
 889 |**serviceCharacteristicValue**  <br>*optional*|Value of the characteristic.<br>This attribute must be used in Beijing Release to provide characteristic value.|string|
 890