docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml

   1 swagger: "2.0"
   2 info:
   3   description: "serviceOrder API designed for ONAP Casablanca release.\nThis API is build from TMF open\
   4     \ API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list)\
   5     \ and POST are available."
   6   version: "3.0.0"
   7   title: "API ServiceOrder"
   8   x-logo:
   9     url: "/redoc/logo.png"
  10     backgroundColor: "#FFFFFF"
  11 host: "serverRoot"
  12 basePath: "/nbi/api/v3"
  13 schemes:
  14 - "https"
  15 produces:
  16 - "application/json;charset=utf-8"
  17 tags:
  18 - name: "ServiceOrder"
  19   description: "A Service Order is a type of order which can be used to describe a\
  20     \ group of operations on service – one service order item per service. An action\
  21     \ at the level of the service order item describe the operation to be done on\
  22     \ a service (add, terminate for example). The service order is triggered from\
  23     \ the BSS system in charge of the product order management to ONAP that will manage\
  24     \ the service fulfillment."
  25 - name: "Hub"
  26   description: ""
  27 - name: "Notification"
  28   description: ""
  29 paths:
  30   /serviceOrder:
  31     post:
  32       tags:
  33       - "ServiceOrder"
  34       consumes:
  35       - "application/json;charset=utf-8"
  36       produces:
  37       - "application/json;charset=utf-8"
  38       operationId: "serviceOrderCreate"
  39       summary: "Create a service order"
  40       description: "This operation creates a service order entity.\nThe TMF Open API\
  41         \ specification document provides the list of mandatory and non mandatory\
  42         \ attributes when creating a ServiceOrder, including any possible rule conditions\
  43         \ and applicable default values.\nPOST should be used without specifying the\
  44         \ id and the href, the Service Order Management system is in charge of generating\
  45         \ the id + href for the ServiceOrder.\n\nIn Beijing Release, NBI will use\
  46         \ only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean\
  47         \ that only the 'service-instance' level will be created in AAI. Additional\
  48         \ resource like VNF and/OR VF are not created.\n\nIn Casablanca release, NBI\
  49         \ has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3\
  50         \ SO API. This API is able to instantiate in ONAP E2E service; This is useful\
  51         \ for CCVPN and VoLTE UC.\nDepending on the service category defined in SDC,\
  52         \ NBI will use one or the other SO API. If category starts with e2e, NBI will\
  53         \ use  {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4\
  54         \ SO API.\n\nSpecific business errors for current operation will be encapsulated\
  55         \ in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add'\
  56         \ action but serviceSpecification id missing\n   \n - 101: OrderItem with\
  57         \ 'change'/'noChange'/'remove' but service id missing\n   \n - 102: OrderItem\
  58         \ with 'add' action - serviceSpecification id provided but not existing\n\
  59         \   \n - 103: OrderItem with 'add' action but service id already existing\
  60         \ in the inventory\n   \n - 104: A customer for existing service(s) is provided\
  61         \ but he did not exist\n   \n - 105: OrderItem with 'change'/'noChange'/'remove'\
  62         \ - Service id provided but it is not existing in the inventory\n   \n - 106:\
  63         \ [Not managed for current Relese] Issue with lcpCloudRegionId  and tenantId\
  64         \ provided\n   "
  65       deprecated: false
  66       parameters:
  67       - name: "serviceOrder"
  68         required: true
  69         in: "body"
  70         description: ""
  71         schema:
  72           $ref: "#/definitions/CreateServiceOrder"
  73       responses:
  74         201:
  75           description: "Success"
  76           schema:
  77             $ref: "#/definitions/ServiceOrder"
  78         400:
  79           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
  80             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
  81             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
  82             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
  83             \ parameter value"
  84           schema:
  85             $ref: "#/definitions/ErrorRepresentation"
  86         401:
  87           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
  88             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
  89           schema:
  90             $ref: "#/definitions/ErrorRepresentation"
  91         403:
  92           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
  93             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
  94             \ requests"
  95           schema:
  96             $ref: "#/definitions/ErrorRepresentation"
  97         404:
  98           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
  99             \ not found"
 100           schema:
 101             $ref: "#/definitions/ErrorRepresentation"
 102         422:
 103           description: "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated\
 104             \ business errors for current operation\n\n - 100: OrderItem with 'add'\
 105             \ action but serviceSpecification id missing\n   \n - 101: OrderItem with\
 106             \ 'change'/'noChange'/'remove' but service id missing\n   \n - 102: OrderItem\
 107             \ with 'add' action - serviceSpecification id provided but not existing\n\
 108             \   \n - 103: OrderItem with 'add' action but service id already existing\
 109             \ in the inventory\n   \n - 104: A customer for existing service(s) is\
 110             \ provided but he did not exist\n   \n - 105: OrderItem with 'change'/'noChange'/'remove'\
 111             \ - Service id provided but it is not existing in the inventory\n   \n\
 112             \ - 106: [Not managed for current Relese] Issue with lcpCloudRegionId\
 113             \  and tenantId provided\n   "
 114           schema:
 115             $ref: "#/definitions/ErrorRepresentation"
 116         500:
 117           description: "Internal Server Error\n\nList of supported error codes:\n\
 118             - 1: Internal error"
 119           schema:
 120             $ref: "#/definitions/ErrorRepresentation"
 121         503:
 122           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 123             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 124             \ retry later !"
 125           schema:
 126             $ref: "#/definitions/ErrorRepresentation"
 127     get:
 128       tags:
 129       - "ServiceOrder"
 130       produces:
 131       - "application/json;charset=utf-8"
 132       operationId: "serviceOrderFind"
 133       summary: "List service orders"
 134       description: "Retrieve and list service order entities according to given criteria.\n\
 135         Only a predefined set of attribute is proposed.\nAttribute selection could\
 136         \ be described in the fields attribute.\n\nSpecific business errors for current\
 137         \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n"
 138       deprecated: false
 139       parameters:
 140       - name: "externalId"
 141         required: false
 142         in: "query"
 143         description: ""
 144         type: "string"
 145       - name: "state"
 146         required: false
 147         in: "query"
 148         description: "state of the order(s) to be retrieved"
 149         type: "string"
 150       - name: "description"
 151         required: false
 152         in: "query"
 153         description: ""
 154         type: "string"
 155       - name: "orderDate.gt"
 156         required: false
 157         in: "query"
 158         description: "order date greather than"
 159         type: "string"
 160       - name: "orderDate.lt"
 161         required: false
 162         in: "query"
 163         description: "order date lower than"
 164         type: "string"
 165       - name: "fields"
 166         required: false
 167         in: "query"
 168         description: "this attribute could be used to filter retrieved attribute(s)\
 169           \ and/or sort SO."
 170         type: "string"
 171       - name: "offset"
 172         required: false
 173         in: "query"
 174         description: "The index of the first element to retrieve. Zero is the first\
 175           \ element of the collection."
 176         type: "integer"
 177         format: "int32"
 178       - name: "limit"
 179         required: false
 180         in: "query"
 181         description: "The maximum number of elements to retrieve (it can be greater\
 182           \ than the actual available number of items)."
 183         type: "integer"
 184         format: "int32"
 185       responses:
 186         200:
 187           description: "Success"
 188           schema:
 189             type: "array"
 190             items:
 191               $ref: "#/definitions/ServiceOrder"
 192           headers:
 193             X-Total-Count:
 194               description: ""
 195               type: "integer"
 196               format: "int32"
 197             X-Result-Count:
 198               description: ""
 199               type: "integer"
 200               format: "int32"
 201         400:
 202           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 203             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 204             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 205             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 206             \ parameter value"
 207           schema:
 208             $ref: "#/definitions/ErrorRepresentation"
 209         401:
 210           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 211             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 212           schema:
 213             $ref: "#/definitions/ErrorRepresentation"
 214         403:
 215           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 216             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 217             \ requests"
 218           schema:
 219             $ref: "#/definitions/ErrorRepresentation"
 220         404:
 221           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 222             \ not found"
 223           schema:
 224             $ref: "#/definitions/ErrorRepresentation"
 225         422:
 226           description: "Unprocessable entity\n\nFunctional error"
 227           schema:
 228             $ref: "#/definitions/ErrorRepresentation"
 229         500:
 230           description: "Internal Server Error\n\nList of supported error codes:\n\
 231             - 1: Internal error"
 232           schema:
 233             $ref: "#/definitions/ErrorRepresentation"
 234         503:
 235           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 236             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 237             \ retry later !"
 238           schema:
 239             $ref: "#/definitions/ErrorRepresentation"
 240   /serviceOrder/{id}:
 241     get:
 242       tags:
 243       - "ServiceOrder"
 244       produces:
 245       - "application/json;charset=utf-8"
 246       operationId: "serviceOrderGet"
 247       summary: "Retrieve a service order"
 248       description: "This operation retrieves a service order entity. \nAttribute selection\
 249         \ is enabled for all first level attributes.\n\nSpecific business errors for\
 250         \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\
 251         \ entity\n"
 252       deprecated: false
 253       parameters:
 254       - name: "id"
 255         in: "path"
 256         required: true
 257         type: "string"
 258         description: ""
 259       - name: "fields"
 260         required: false
 261         in: "query"
 262         description: "Attribute selection"
 263         type: "string"
 264       responses:
 265         200:
 266           description: "Success"
 267           schema:
 268             $ref: "#/definitions/ServiceOrder"
 269         400:
 270           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 271             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 272             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 273             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 274             \ parameter value"
 275           schema:
 276             $ref: "#/definitions/ErrorRepresentation"
 277         401:
 278           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 279             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 280           schema:
 281             $ref: "#/definitions/ErrorRepresentation"
 282         403:
 283           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 284             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 285             \ requests"
 286           schema:
 287             $ref: "#/definitions/ErrorRepresentation"
 288         404:
 289           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 290             \ not found"
 291           schema:
 292             $ref: "#/definitions/ErrorRepresentation"
 293         422:
 294           description: "Unprocessable entity\n\nFunctional error"
 295           schema:
 296             $ref: "#/definitions/ErrorRepresentation"
 297         500:
 298           description: "Internal Server Error\n\nList of supported error codes:\n\
 299             - 1: Internal error"
 300           schema:
 301             $ref: "#/definitions/ErrorRepresentation"
 302         503:
 303           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 304             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 305             \ retry later !"
 306           schema:
 307             $ref: "#/definitions/ErrorRepresentation"
 308   /hub:
 309     post:
 310       tags:
 311       - "Hub"
 312       consumes:
 313       - "application/json;charset=utf-8"
 314       operationId: "hubCreate"
 315       summary: "Create Hub"
 316       description: "\n\nSpecific business errors for current operation will be encapsulated\
 317         \ in\n\nHTTP Response 422 Unprocessable entity\n"
 318       deprecated: false
 319       parameters:
 320       - name: "Hub"
 321         required: true
 322         in: "body"
 323         description: ""
 324         schema:
 325           $ref: "#/definitions/CreateHub"
 326       responses:
 327         201:
 328           description: "Success"
 329           schema:
 330             type: "file"
 331           headers:
 332             location:
 333               description: ""
 334               type: "string"
 335         400:
 336           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 337             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 338             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 339             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 340             \ parameter value"
 341           schema:
 342             $ref: "#/definitions/ErrorRepresentation"
 343         401:
 344           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 345             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 346           schema:
 347             $ref: "#/definitions/ErrorRepresentation"
 348         403:
 349           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 350             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 351             \ requests"
 352           schema:
 353             $ref: "#/definitions/ErrorRepresentation"
 354         404:
 355           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 356             \ not found"
 357           schema:
 358             $ref: "#/definitions/ErrorRepresentation"
 359         422:
 360           description: "Unprocessable entity\n\nFunctional error"
 361           schema:
 362             $ref: "#/definitions/ErrorRepresentation"
 363         500:
 364           description: "Internal Server Error\n\nList of supported error codes:\n\
 365             - 1: Internal error"
 366           schema:
 367             $ref: "#/definitions/ErrorRepresentation"
 368         503:
 369           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 370             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 371             \ retry later !"
 372           schema:
 373             $ref: "#/definitions/ErrorRepresentation"
 374     get:
 375       tags:
 376       - "Hub"
 377       produces:
 378       - "application/json;charset=utf-8"
 379       operationId: "hubFind"
 380       summary: "Retrieve a lits of hub"
 381       description: "\n\nSpecific business errors for current operation will be encapsulated\
 382         \ in\n\nHTTP Response 422 Unprocessable entity\n"
 383       deprecated: false
 384       parameters:
 385       - name: "id"
 386         required: false
 387         in: "query"
 388         description: ""
 389         type: "string"
 390       - name: "eventType"
 391         required: false
 392         in: "query"
 393         description: ""
 394         type: "string"
 395         enum:
 396         - "ServiceOrderCreationNotification"
 397         - "ServiceOrderStateChangeNotification"
 398         - "ServiceOrderItemStateChangeNotification"
 399       responses:
 400         200:
 401           description: "Success"
 402           schema:
 403             type: "array"
 404             items:
 405               $ref: "#/definitions/Hub"
 406         400:
 407           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 408             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 409             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 410             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 411             \ parameter value"
 412           schema:
 413             $ref: "#/definitions/ErrorRepresentation"
 414         401:
 415           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 416             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 417           schema:
 418             $ref: "#/definitions/ErrorRepresentation"
 419         403:
 420           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 421             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 422             \ requests"
 423           schema:
 424             $ref: "#/definitions/ErrorRepresentation"
 425         404:
 426           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 427             \ not found"
 428           schema:
 429             $ref: "#/definitions/ErrorRepresentation"
 430         422:
 431           description: "Unprocessable entity\n\nFunctional error"
 432           schema:
 433             $ref: "#/definitions/ErrorRepresentation"
 434         500:
 435           description: "Internal Server Error\n\nList of supported error codes:\n\
 436             - 1: Internal error"
 437           schema:
 438             $ref: "#/definitions/ErrorRepresentation"
 439         503:
 440           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 441             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 442             \ retry later !"
 443           schema:
 444             $ref: "#/definitions/ErrorRepresentation"
 445   /hub/{hubId}:
 446     get:
 447       tags:
 448       - "Hub"
 449       produces:
 450       - "application/json;charset=utf-8"
 451       operationId: "hubGet"
 452       summary: "Retrieve an HUB by id"
 453       description: "Retrieve an HUB by id\n\nSpecific business errors for current\
 454         \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n"
 455       deprecated: false
 456       parameters:
 457       - name: "hubId"
 458         in: "path"
 459         required: true
 460         type: "string"
 461         description: ""
 462       responses:
 463         200:
 464           description: "Success"
 465           schema:
 466             $ref: "#/definitions/Hub"
 467         400:
 468           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 469             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 470             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 471             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 472             \ parameter value"
 473           schema:
 474             $ref: "#/definitions/ErrorRepresentation"
 475         401:
 476           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 477             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 478           schema:
 479             $ref: "#/definitions/ErrorRepresentation"
 480         403:
 481           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 482             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 483             \ requests"
 484           schema:
 485             $ref: "#/definitions/ErrorRepresentation"
 486         404:
 487           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 488             \ not found"
 489           schema:
 490             $ref: "#/definitions/ErrorRepresentation"
 491         422:
 492           description: "Unprocessable entity\n\nFunctional error"
 493           schema:
 494             $ref: "#/definitions/ErrorRepresentation"
 495         500:
 496           description: "Internal Server Error\n\nList of supported error codes:\n\
 497             - 1: Internal error"
 498           schema:
 499             $ref: "#/definitions/ErrorRepresentation"
 500         503:
 501           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 502             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 503             \ retry later !"
 504           schema:
 505             $ref: "#/definitions/ErrorRepresentation"
 506     delete:
 507       tags:
 508       - "Hub"
 509       operationId: "hubDelete"
 510       summary: "delete hub"
 511       description: "\n\nSpecific business errors for current operation will be encapsulated\
 512         \ in\n\nHTTP Response 422 Unprocessable entity\n"
 513       deprecated: false
 514       parameters:
 515       - name: "hubId"
 516         in: "path"
 517         required: true
 518         type: "string"
 519         description: ""
 520       responses:
 521         204:
 522           description: "Success"
 523         400:
 524           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 525             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 526             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 527             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 528             \ parameter value"
 529           schema:
 530             $ref: "#/definitions/ErrorRepresentation"
 531         401:
 532           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 533             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 534           schema:
 535             $ref: "#/definitions/ErrorRepresentation"
 536         403:
 537           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 538             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 539             \ requests"
 540           schema:
 541             $ref: "#/definitions/ErrorRepresentation"
 542         404:
 543           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 544             \ not found"
 545           schema:
 546             $ref: "#/definitions/ErrorRepresentation"
 547         422:
 548           description: "Unprocessable entity\n\nFunctional error"
 549           schema:
 550             $ref: "#/definitions/ErrorRepresentation"
 551         500:
 552           description: "Internal Server Error\n\nList of supported error codes:\n\
 553             - 1: Internal error"
 554           schema:
 555             $ref: "#/definitions/ErrorRepresentation"
 556         503:
 557           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 558             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 559             \ retry later !"
 560           schema:
 561             $ref: "#/definitions/ErrorRepresentation"
 562   /notification/serviceOrderCreationNotification:
 563     post:
 564       tags:
 565       - "Notification"
 566       consumes:
 567       - "application/json;charset=utf-8"
 568       operationId: "notificationServiceOrderCreationNotification"
 569       summary: "Service order creation notification"
 570       description: "Service order creation notification\n\nSpecific business errors\
 571         \ for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\
 572         \ entity\n"
 573       deprecated: false
 574       parameters:
 575       - name: "serviceOrderCreationNotification"
 576         required: true
 577         in: "body"
 578         description: ""
 579         schema:
 580           $ref: "#/definitions/ServiceOrderCreationNotification"
 581       responses:
 582         204:
 583           description: "Success"
 584         400:
 585           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 586             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 587             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 588             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 589             \ parameter value"
 590           schema:
 591             $ref: "#/definitions/ErrorRepresentation"
 592         401:
 593           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 594             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 595           schema:
 596             $ref: "#/definitions/ErrorRepresentation"
 597         403:
 598           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 599             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 600             \ requests"
 601           schema:
 602             $ref: "#/definitions/ErrorRepresentation"
 603         404:
 604           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 605             \ not found"
 606           schema:
 607             $ref: "#/definitions/ErrorRepresentation"
 608         422:
 609           description: "Unprocessable entity\n\nFunctional error"
 610           schema:
 611             $ref: "#/definitions/ErrorRepresentation"
 612         500:
 613           description: "Internal Server Error\n\nList of supported error codes:\n\
 614             - 1: Internal error"
 615           schema:
 616             $ref: "#/definitions/ErrorRepresentation"
 617         503:
 618           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 619             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 620             \ retry later !"
 621           schema:
 622             $ref: "#/definitions/ErrorRepresentation"
 623   /notification/serviceOrderStateChangeNotification:
 624     post:
 625       tags:
 626       - "Notification"
 627       consumes:
 628       - "application/json;charset=utf-8"
 629       operationId: "notificationServiceOrderStateChangeNotification"
 630       summary: "Service order state change notification description"
 631       description: "\n\nSpecific business errors for current operation will be encapsulated\
 632         \ in\n\nHTTP Response 422 Unprocessable entity\n"
 633       deprecated: false
 634       parameters:
 635       - name: "serviceOrderstateChangeNotification"
 636         required: true
 637         in: "body"
 638         description: ""
 639         schema:
 640           $ref: "#/definitions/ServiceOrderStateChangeNotification"
 641       responses:
 642         204:
 643           description: "Success"
 644         400:
 645           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 646             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 647             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 648             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 649             \ parameter value"
 650           schema:
 651             $ref: "#/definitions/ErrorRepresentation"
 652         401:
 653           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 654             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 655           schema:
 656             $ref: "#/definitions/ErrorRepresentation"
 657         403:
 658           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 659             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 660             \ requests"
 661           schema:
 662             $ref: "#/definitions/ErrorRepresentation"
 663         404:
 664           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 665             \ not found"
 666           schema:
 667             $ref: "#/definitions/ErrorRepresentation"
 668         422:
 669           description: "Unprocessable entity\n\nFunctional error"
 670           schema:
 671             $ref: "#/definitions/ErrorRepresentation"
 672         500:
 673           description: "Internal Server Error\n\nList of supported error codes:\n\
 674             - 1: Internal error"
 675           schema:
 676             $ref: "#/definitions/ErrorRepresentation"
 677         503:
 678           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 679             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 680             \ retry later !"
 681           schema:
 682             $ref: "#/definitions/ErrorRepresentation"
 683   /notification/serviceOrderItemStateChangeNotification:
 684     post:
 685       tags:
 686       - "Notification"
 687       consumes:
 688       - "application/json;charset=utf-8"
 689       operationId: "notificationServiceOrderItemStateChangeNotification"
 690       summary: "ServiceOrder Item State Change Notification description"
 691       description: "\n\nSpecific business errors for current operation will be encapsulated\
 692         \ in\n\nHTTP Response 422 Unprocessable entity\n"
 693       deprecated: false
 694       parameters:
 695       - name: "serviceOrderItemStateChangeNotification"
 696         required: true
 697         in: "body"
 698         description: ""
 699         schema:
 700           $ref: "#/definitions/ServiceOrderItemStateChangeNotification"
 701       responses:
 702         204:
 703           description: "Success"
 704         400:
 705           description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
 706             \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
 707             \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
 708             \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
 709             \ parameter value"
 710           schema:
 711             $ref: "#/definitions/ErrorRepresentation"
 712         401:
 713           description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
 714             \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
 715           schema:
 716             $ref: "#/definitions/ErrorRepresentation"
 717         403:
 718           description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
 719             \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
 720             \ requests"
 721           schema:
 722             $ref: "#/definitions/ErrorRepresentation"
 723         404:
 724           description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
 725             \ not found"
 726           schema:
 727             $ref: "#/definitions/ErrorRepresentation"
 728         422:
 729           description: "Unprocessable entity\n\nFunctional error"
 730           schema:
 731             $ref: "#/definitions/ErrorRepresentation"
 732         500:
 733           description: "Internal Server Error\n\nList of supported error codes:\n\
 734             - 1: Internal error"
 735           schema:
 736             $ref: "#/definitions/ErrorRepresentation"
 737         503:
 738           description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
 739             \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
 740             \ retry later !"
 741           schema:
 742             $ref: "#/definitions/ErrorRepresentation"
 743 definitions:
 744   ActionType:
 745     description: "Action type to be describer on the order item.\nmodify is not managed\
 746       \ in Beijing release"
 747     type: "string"
 748     enum:
 749     - "add"
 750     - "modify"
 751     - "delete"
 752     - "noChange"
 753   StateType:
 754     description: "List of possible state for the order and the orderItem."
 755     type: "string"
 756     enum:
 757     - "acknowledged"
 758     - "rejected"
 759     - "pending"
 760     - "held"
 761     - "inProgress"
 762     - "cancelled"
 763     - "completed"
 764     - "failed"
 765     - "partial"
 766   RelationshipType:
 767     description: "Relationship type;\nOnly reliesOn is managed in Beijing release."
 768     type: "string"
 769     enum:
 770     - "reliesOn"
 771   EventType:
 772     description: ""
 773     type: "string"
 774     enum:
 775     - "ServiceOrderCreationNotification"
 776     - "ServiceOrderStateChangeNotification"
 777     - "ServiceOrderItemStateChangeNotification"
 778   SeverityMessage:
 779     description: ""
 780     type: "string"
 781     enum:
 782     - "information"
 783     - "error"
 784   ErrorRepresentation:
 785     description: "Representation of an error."
 786     required:
 787     - "code"
 788     - "reason"
 789     type: "object"
 790     properties:
 791       code:
 792         description: "Application related code (as defined in the API or from a common\
 793           \ list)"
 794         type: "integer"
 795         format: "int32"
 796       reason:
 797         description: "Text that explains the reason for error. This can be shown to\
 798           \ a client user."
 799         type: "string"
 800       message:
 801         description: "Text that provide more details and corrective actions related\
 802           \ to the error. This can be shown to a client user"
 803         type: "string"
 804       status:
 805         description: "http error code extension like 400-2"
 806         type: "string"
 807       referenceError:
 808         description: "url pointing to documentation describing the error"
 809         type: "string"
 810       '@type':
 811         description: "The class type of a REST resource"
 812         type: "string"
 813       '@schemaLocation':
 814         description: "it provides a link to the schema describing a REST resource"
 815         type: "string"
 816   ServiceRelationship:
 817     description: "Linked Services to the one instantiate\nnbi component used this\
 818       \ relationship to sort request to ONAP."
 819     required:
 820     - "type"
 821     - "service"
 822     type: "object"
 823     properties:
 824       type:
 825         $ref: "#/definitions/RelationshipType"
 826       service:
 827         $ref: "#/definitions/Service"
 828   ServiceRef:
 829     description: "Service references"
 830     required:
 831     - "id"
 832     type: "object"
 833     properties:
 834       id:
 835         description: "Unique identifier of the service"
 836         type: "string"
 837       href:
 838         description: "Reference of the service"
 839         type: "string"
 840   ServiceCharacteristic:
 841     description: "ServiceCharacteristic"
 842     required:
 843     - "name"
 844     type: "object"
 845     properties:
 846       name:
 847         description: "Name of characteristic"
 848         type: "string"
 849       valueType:
 850         description: ""
 851         type: "string"
 852       value:
 853         $ref: "#/definitions/Value"
 854   RelatedParty:
 855     description: "A related party defines party which are involved in this order and\
 856       \ the role they are playing.\nfor Beijing release:\nWith the current version\
 857       \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\
 858       \ concept is confusing with Customer BSS concept. We took the following rules\
 859       \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\
 860       \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\
 861       \ in the serviceOrder header (we will not consider in this release the party\
 862       \ at item level); External API component will check if this customer exists\
 863       \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\
 864       \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\
 865       generic’ customer always exists."
 866     required:
 867     - "id"
 868     - "role"
 869     type: "object"
 870     properties:
 871       id:
 872         description: "Unique identifier of a related party"
 873         type: "string"
 874       href:
 875         description: "An hyperlink to the party - not used in Beijnig release"
 876         type: "string"
 877       role:
 878         description: "The role of the related party (e.g. Owner, requester, fullfiller\
 879           \ etc).\nONLY 'ONAPcustomer' is considered"
 880         type: "string"
 881       name:
 882         description: "Name of the related party"
 883         type: "string"
 884       '@referredType':
 885         description: ""
 886         type: "string"
 887   ServiceSpecificationRef:
 888     description: "The service specification (these attributes are fetched from the\
 889       \ catalogue)."
 890     required:
 891     - "id"
 892     type: "object"
 893     properties:
 894       id:
 895         description: "Unique identifier of the service specification\nThis information\
 896           \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\
 897           \ the request."
 898         type: "string"
 899       href:
 900         description: "Reference of the service specification\nNot used in Beijing\
 901           \ release."
 902         type: "string"
 903       name:
 904         description: "Name of the service specification\nNot used in Beijing release"
 905         type: "string"
 906       version:
 907         description: "Version of the service Specification\nNot used in Beijing release"
 908         type: "string"
 909       targetServiceSchema:
 910         $ref: "#/definitions/TargetServiceSchema"
 911       '@type':
 912         description: "Not used in Beijing release"
 913         type: "string"
 914       '@schemaLocation':
 915         description: "Not used in Beijing release"
 916         type: "string"
 917       '@baseType':
 918         description: "Not used in Beijing release"
 919         type: "string"
 920   Service:
 921     description: "Service (to be added, modified, deleted) description"
 922     required:
 923     - "id"
 924     type: "object"
 925     properties:
 926       id:
 927         description: "Identifier of a service instance.\nIt must be valued if orderItem\
 928           \ action is 'delete' and corresponds to a AAI service.id"
 929         type: "string"
 930       href:
 931         description: "Reference to the Service (useful for delete or modify command).\n\
 932           Not managed in Beijing release."
 933         type: "string"
 934       name:
 935         description: "Name of the service - When orderItem action is 'add' this name\
 936           \ will be used in ONAP/SO request as InstaceName."
 937         type: "string"
 938       serviceState:
 939         description: "The lifecycle state of the service requested;\nNot managed in\
 940           \ Beijing release."
 941         type: "string"
 942       '@type':
 943         description: "To define the service type\nNot managed in Beijing Release"
 944         type: "string"
 945       '@schemaLocation':
 946         description: "The URL to get the resource schema.\nNot managed in Beijing\
 947           \ Release"
 948         type: "string"
 949       serviceCharacteristic:
 950         type: "array"
 951         items:
 952           $ref: "#/definitions/ServiceCharacteristic"
 953       serviceRelationship:
 954         type: "array"
 955         items:
 956           $ref: "#/definitions/ServiceRelationship"
 957       relatedParty:
 958         type: "array"
 959         items:
 960           $ref: "#/definitions/RelatedParty"
 961       serviceSpecification:
 962         $ref: "#/definitions/ServiceSpecificationRef"
 963   OrderItemRelationship:
 964     description: "Linked order item to the one containing this attribute.\nnbi component\
 965       \ used this relationship to sort request to ONAP."
 966     required:
 967     - "type"
 968     - "id"
 969     type: "object"
 970     properties:
 971       type:
 972         $ref: "#/definitions/RelationshipType"
 973       id:
 974         description: "Unique identifier of an order item"
 975         type: "string"
 976   ServiceOrderItem:
 977     description: "An identified part of the order. A service order is decomposed into\
 978       \ one or more order items."
 979     required:
 980     - "id"
 981     - "service"
 982     type: "object"
 983     properties:
 984       id:
 985         description: "Identifier of the line item (generally it is a sequence number\
 986           \ 01, 02, 03, …)"
 987         type: "string"
 988       action:
 989         $ref: "#/definitions/ActionType"
 990       state:
 991         $ref: "#/definitions/StateType"
 992       percentProgress:
 993         description: "Progress of the delivery in percentage."
 994         type: "string"
 995       '@type':
 996         description: "Used to extend the order item.\nnot used in Beijing relase"
 997         type: "string"
 998       '@schemaLocation':
 999         description: "not used in Beijing relase"
1000         type: "string"
1001       '@baseType':
1002         description: "not used in Beijing relase"
1003         type: "string"
1004       orderItemRelationship:
1005         type: "array"
1006         items:
1007           $ref: "#/definitions/OrderItemRelationship"
1008       service:
1009         $ref: "#/definitions/Service"
1010       orderItemMessage:
1011         type: "array"
1012         items:
1013           $ref: "#/definitions/OrderMessage"
1014   ServiceOrder:
1015     description: "A Service Order is a type of order which can be used to place an\
1016       \ order between a customer and a service provider or between a service provider\
1017       \ and a partner and vice versa"
1018     required:
1019     - "id"
1020     type: "object"
1021     properties:
1022       id:
1023         description: "ID created on repository side"
1024         type: "string"
1025       href:
1026         description: "Hyperlink to access the order"
1027         type: "string"
1028       externalId:
1029         description: "ID given by the consumer and only understandable by him (to\
1030           \ facilitate his searches)"
1031         type: "string"
1032       priority:
1033         description: "A way that can be used by consumers to prioritize orders in\
1034           \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\
1035           \ and 4 the lowest)"
1036         type: "string"
1037       description:
1038         description: "A free-text description of the service order"
1039         type: "string"
1040       category:
1041         description: "Used to categorize the order that can be useful for the OM system\
1042           \ (e.g. “broadband”, “TVOption”, ...)"
1043         type: "string"
1044       state:
1045         $ref: "#/definitions/StateType"
1046       orderDate:
1047         description: ""
1048         type: "string"
1049         format: "date-time"
1050       completionDateTime:
1051         description: "Date when the order was completed"
1052         type: "string"
1053         format: "date-time"
1054       requestedStartDate:
1055         description: "Order start date wished by the requestor"
1056         type: "string"
1057         format: "date-time"
1058       requestedCompletionDate:
1059         description: "Requested delivery date from the requestor perspective"
1060         type: "string"
1061         format: "date-time"
1062       expectedCompletionDate:
1063         description: ""
1064         type: "string"
1065         format: "date-time"
1066       startDate:
1067         description: "Date when the order was started for processing"
1068         type: "string"
1069         format: "date-time"
1070       '@baseType':
1071         description: ""
1072         type: "string"
1073       '@type':
1074         description: ""
1075         type: "string"
1076       '@schemaLocation':
1077         description: ""
1078         type: "string"
1079       relatedParty:
1080         type: "array"
1081         items:
1082           $ref: "#/definitions/RelatedParty"
1083       orderRelationship:
1084         type: "array"
1085         items:
1086           $ref: "#/definitions/OrderRelationship"
1087       orderItem:
1088         type: "array"
1089         items:
1090           $ref: "#/definitions/ServiceOrderItem"
1091       orderMessage:
1092         type: "array"
1093         items:
1094           $ref: "#/definitions/OrderMessage"
1095   OrderRelationship:
1096     description: "Linked order to the one containing this attribute.\nThis relationship\
1097       \ is not used to sort ONAP request."
1098     required:
1099     - "id"
1100     type: "object"
1101     properties:
1102       type:
1103         description: "The type of related order, can be : “dependency” if the order\
1104           \ needs to be “not started” until another order item is complete (a service\
1105           \ order in this case) or “cross-ref” to keep track of the source order (a\
1106           \ productOrder)"
1107         type: "string"
1108       id:
1109         description: "The id of the related order"
1110         type: "string"
1111       href:
1112         description: "A hyperlink to the related order"
1113         type: "string"
1114       '@referredType':
1115         description: "Type of the referred order."
1116         type: "string"
1117   TargetServiceSchema:
1118     description: "Target to the schema describing the service spec resource"
1119     required:
1120     - "@type"
1121     - "@schemaLocation"
1122     type: "object"
1123     properties:
1124       '@type':
1125         description: "Indicates the (class) type of resource."
1126         type: "string"
1127       '@schemaLocation':
1128         description: "This field provided a link to the schema describing this REST\
1129           \ resource."
1130         type: "string"
1131   Value:
1132     description: "Value is a descriptive structure for service characteristic;\nFor\
1133       \ Beijing we only manage 'basic' attribute - the serviceCharacteristicValue\
1134       \ must be used."
1135     type: "object"
1136     properties:
1137       '@type':
1138         description: "Indicates the (class) type of resource.\nNot used in Beijing\
1139           \ Release"
1140         type: "string"
1141       '@schemaLocation':
1142         description: "This field provided a link to the schema describing this REST\
1143           \ resource.\nNot used in Beijing Release"
1144         type: "string"
1145       serviceCharacteristicValue:
1146         description: "Value of the characteristic.\nThis attribute must be used in\
1147           \ Beijing Release to provide characteristic value."
1148         type: "string"
1149   CreateServiceOrderItem:
1150     description: "This structure is used in the operation POST for a serviceOrder\
1151       \ request to describe an item.\nAttribute description is not accurate and should\
1152       \ be find in the serviceOrderItem class."
1153     required:
1154     - "id"
1155     - "service"
1156     type: "object"
1157     properties:
1158       id:
1159         description: "Identifier of the line item (generally it is a sequence number\
1160           \ 01, 02, 03, …)"
1161         type: "string"
1162       action:
1163         $ref: "#/definitions/ActionType"
1164       '@type':
1165         description: "Indicates the type of resource."
1166         type: "string"
1167       '@schemaLocation':
1168         description: "A link to the schema describing this REST resource"
1169         type: "string"
1170       '@baseType':
1171         description: "Indicates the base type of the resource."
1172         type: "string"
1173       orderItemRelationship:
1174         type: "array"
1175         items:
1176           $ref: "#/definitions/OrderItemRelationship"
1177       service:
1178         $ref: "#/definitions/Service"
1179   CreateServiceOrder:
1180     description: "This structure is used in the operation POST for a serviceOrder\
1181       \ request.\nAttribute description is not accurate and should be find in the\
1182       \ serviceOrder class."
1183     type: "object"
1184     properties:
1185       externalId:
1186         description: "ID given by the consumer and only understandable by him (to\
1187           \ facilitate his searches)"
1188         type: "string"
1189       priority:
1190         description: "A way that can be used by consumers to prioritize orders in\
1191           \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\
1192           \ and 4 the lowest)"
1193         type: "string"
1194       description:
1195         description: "A free-text description of the service order"
1196         type: "string"
1197       category:
1198         description: "Used to categorize the order that can be useful for the OM system\
1199           \ (e.g. “broadband”, “TVOption”, ...)"
1200         type: "string"
1201       requestedStartDate:
1202         description: "Order start date wished by the requestor"
1203         type: "string"
1204         format: "date-time"
1205       requestedCompletionDate:
1206         description: "Requested delivery date from the requestor perspective"
1207         type: "string"
1208         format: "date-time"
1209       '@baseType':
1210         description: ""
1211         type: "string"
1212       '@type':
1213         description: ""
1214         type: "string"
1215       '@schemaLocation':
1216         description: ""
1217         type: "string"
1218       relatedParty:
1219         type: "array"
1220         items:
1221           $ref: "#/definitions/RelatedParty"
1222       orderRelationship:
1223         type: "array"
1224         items:
1225           $ref: "#/definitions/OrderRelationship"
1226       orderItem:
1227         type: "array"
1228         items:
1229           $ref: "#/definitions/CreateServiceOrderItem"
1230   Hub:
1231     description: "An HUB resource is used by client side to subscribe to notification.\n\
1232       Not managed in the Beijing release."
1233     discriminator: "id"
1234     required:
1235     - "query"
1236     - "callback"
1237     type: "object"
1238     properties:
1239       id:
1240         description: "Hub Id"
1241         type: "string"
1242       query:
1243         description: ""
1244         type: "string"
1245       callback:
1246         description: "Address where notification must be send"
1247         type: "string"
1248   CreateHub:
1249     description: "This structure is used as a request for POST Hub operation"
1250     required:
1251     - "query"
1252     - "callback"
1253     type: "object"
1254     properties:
1255       query:
1256         description: "The query must have an eventType=notificationName information.\n\
1257           Optionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”\
1258           &serviceOrder.state=COMPLETED"
1259         type: "string"
1260       callback:
1261         description: "Address where notification must be send"
1262         type: "string"
1263   ServiceOrderSummary:
1264     description: "This structure is used to provide a subset of serviceOrder attributes\
1265       \ to be provided in particular for notification messages"
1266     required:
1267     - "id"
1268     type: "object"
1269     properties:
1270       id:
1271         description: "ID created on repository side"
1272         type: "string"
1273       href:
1274         description: "Hyperlink to access the order"
1275         type: "string"
1276       externalId:
1277         description: "ID given by the consumer and only understandable by him (to\
1278           \ facilitate his searches)"
1279         type: "string"
1280       state:
1281         $ref: "#/definitions/StateType"
1282       orderDate:
1283         description: ""
1284         type: "string"
1285         format: "date-time"
1286       completionDateTime:
1287         description: "Date when the order was completed"
1288         type: "string"
1289         format: "date-time"
1290   ServiceOrderCreationNotification:
1291     description: "Notification structure for a service order creation notification"
1292     required:
1293     - "eventId"
1294     - "eventDate"
1295     - "eventType"
1296     - "event"
1297     type: "object"
1298     properties:
1299       eventId:
1300         description: ""
1301         type: "string"
1302       eventDate:
1303         description: ""
1304         type: "string"
1305         format: "date-time"
1306       eventType:
1307         description: ""
1308         type: "string"
1309         default: "ServiceOrderCreationNotification"
1310       event:
1311         $ref: "#/definitions/ServiceOrderSummary"
1312   Notification:
1313     description: "Used to describe notification for this API"
1314     type: "object"
1315     properties: {}
1316   ServiceOrderStateChangeNotification:
1317     description: "Service order state change notification description"
1318     required:
1319     - "eventId"
1320     - "eventDate"
1321     - "eventType"
1322     - "event"
1323     type: "object"
1324     properties:
1325       eventId:
1326         description: ""
1327         type: "string"
1328       eventDate:
1329         description: ""
1330         type: "string"
1331         format: "date-time"
1332       eventType:
1333         description: ""
1334         type: "string"
1335         default: "ServiceOrderStateChangeNotification"
1336       event:
1337         $ref: "#/definitions/ServiceOrderSummary"
1338   ServiceOrderItemSummary:
1339     description: "Service Order item summary to be used for notification"
1340     required:
1341     - "id"
1342     - "service"
1343     type: "object"
1344     properties:
1345       id:
1346         description: "Identifier of the line item (generally it is a sequence number\
1347           \ 01, 02, 03, …)"
1348         type: "string"
1349       action:
1350         $ref: "#/definitions/ActionType"
1351       state:
1352         $ref: "#/definitions/StateType"
1353       service:
1354         $ref: "#/definitions/Service"
1355   ServiceOrderSummaryWithItem:
1356     description: "Service order item summary with item description"
1357     required:
1358     - "id"
1359     type: "object"
1360     properties:
1361       id:
1362         description: "ID created on repository side"
1363         type: "string"
1364       href:
1365         description: "Hyperlink to access the order"
1366         type: "string"
1367       externalId:
1368         description: "ID given by the consumer and only understandable by him (to\
1369           \ facilitate his searches)"
1370         type: "string"
1371       state:
1372         $ref: "#/definitions/StateType"
1373       orderDate:
1374         description: ""
1375         type: "string"
1376         format: "date-time"
1377       completionDateTime:
1378         description: "Date when the order was completed"
1379         type: "string"
1380         format: "date-time"
1381       orderItem:
1382         type: "array"
1383         items:
1384           $ref: "#/definitions/ServiceOrderItemSummary"
1385   ServiceOrderItemStateChangeNotification:
1386     description: ""
1387     required:
1388     - "eventId"
1389     - "eventDate"
1390     - "eventType"
1391     - "event"
1392     type: "object"
1393     properties:
1394       eventId:
1395         description: ""
1396         type: "string"
1397       eventDate:
1398         description: ""
1399         type: "string"
1400         format: "date-time"
1401       eventType:
1402         description: ""
1403         type: "string"
1404         default: "ServiceOrderStateChangeNotification"
1405       event:
1406         $ref: "#/definitions/ServiceOrderSummaryWithItem"
1407   OrderMessage:
1408     description: "An optional array of messages associated with the Order"
1409     required:
1410     - "severity"
1411     - "correctionRequired"
1412     type: "object"
1413     properties:
1414       code:
1415         description: "A code associated to this message"
1416         type: "string"
1417       field:
1418         description: "Service Order attribute related to this error message"
1419         type: "string"
1420       messageInformation:
1421         description: "Message related to this order"
1422         type: "string"
1423       severity:
1424         $ref: "#/definitions/SeverityMessage"
1425       correctionRequired:
1426         description: "Indicator that an action is required to allow service order\
1427           \ fullfilment to follow up"
1428         type: "boolean"