docs/offeredapis/api_serviceOrder/swagger.yaml

   1 #    Copyright (c) 2018 Orange
   2 #
   3 #    Licensed under the Apache License, Version 2.0 (the "License");
   4 #    you may not use this file except in compliance with the License.
   5 #    You may obtain a copy of the License at
   6 #
   7 #        http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #    Unless required by applicable law or agreed to in writing, software
  10 #    distributed under the License is distributed on an "AS IS" BASIS,
  11 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #    See the License for the specific language governing permissions and
  13 #    limitations under the License.swagger: "2.0"
  14 swagger: "2.0"
  15 info:
  16   description: "Request the instantiation of a service\n\nA Service Order is a type\
  17     \ of order which can be used to describe a group of operations on service – one\
  18     \ service order item per service. An action at the level of the service order\
  19     \ item describe the operation to be done on a service (add, terminate for example).\
  20     \ The service order is triggered from the BSS system in charge of the product\
  21     \ order management to ONAP that will manage the service fulfillment.\n\nList of\
  22     \ available subscription for serviceOrdering notifications, see /hub resources\
  23     \ for more information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n\
  24     - ServiceOrderItemStateChangeNotification\n\n"
  25   version: "4.0.1"
  26   title: "API ServiceOrder"
  27   x-logo:
  28     url: "/redoc/logo.png"
  29     backgroundColor: "#FFFFFF"
  30 host: "localhost:8080"
  31 basePath: "/nbi/api/v4"
  32 schemes:
  33 - "http"
  34 produces:
  35 - "application/json;charset=utf-8"
  36 tags:
  37 - name: "ServiceOrder"
  38   description: "provided by NBI"
  39 - name: "Notification"
  40   description: "provided by subscribers, which MUST registered by creating a hub resource"
  41 paths:
  42   /serviceOrder:
  43     post:
  44       tags:
  45       - "ServiceOrder"
  46       consumes:
  47       - "application/json;charset=utf-8"
  48       produces:
  49       - "application/json;charset=utf-8"
  50       operationId: "serviceOrderCreate"
  51       summary: "Create a service order"
  52       description: "This operation creates a service order entity.\nThe TMF Open API\
  53         \ specification document provides the list of mandatory and non mandatory\
  54         \ attributes when creating a ServiceOrder, including any possible rule conditions\
  55         \ and applicable default values.\nPOST should be used without specifying the\
  56         \ id and the href, the Service Order Management system is in charge of generating\
  57         \ the id + href for the ServiceOrder.\n\nIn Beijing Release, NBI will use\
  58         \ only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean\
  59         \ that only the 'service-instance' level will be created in AAI. Additional\
  60         \ resource like VNF and/OR VF are not created.\n\nIn Casablanca release, NBI\
  61         \ has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3\
  62         \ SO API. This API is able to instantiate in ONAP E2E service; This is useful\
  63         \ for CCVPN and VoLTE UC.\nDepending on the service category defined in SDC,\
  64         \ NBI will use one or the other SO API. If category starts with e2e, NBI will\
  65         \ use  {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4\
  66         \ SO API."
  67       deprecated: false
  68       parameters:
  69       - name: "serviceOrder"
  70         required: true
  71         in: "body"
  72         description: ""
  73         schema:
  74           $ref: "#/definitions/CreateServiceOrder"
  75       - name: "Target"
  76         required: false
  77         in: "header"
  78         description: ""
  79         type: "string"
  80       responses:
  81         201:
  82           description: "Created"
  83           schema:
  84             $ref: "#/definitions/ServiceOrder"
  85     get:
  86       tags:
  87       - "ServiceOrder"
  88       produces:
  89       - "application/json;charset=utf-8"
  90       operationId: "serviceOrderFind"
  91       summary: "List service orders"
  92       description: "Retrieve and list service order entities according to given criteria.\n\
  93         Only a predefined set of attribute is proposed.\nAttribute selection could\
  94         \ be described in the fields attribute."
  95       deprecated: false
  96       parameters:
  97       - name: "externalId"
  98         required: false
  99         in: "query"
 100         description: ""
 101         type: "string"
 102       - name: "state"
 103         required: false
 104         in: "query"
 105         description: "state of the order(s) to be retrieved"
 106         type: "string"
 107       - name: "description"
 108         required: false
 109         in: "query"
 110         description: ""
 111         type: "string"
 112       - name: "orderDate.gt"
 113         required: false
 114         in: "query"
 115         description: "order date greather than"
 116         type: "string"
 117       - name: "orderDate.lt"
 118         required: false
 119         in: "query"
 120         description: "order date lower than"
 121         type: "string"
 122       - name: "fields"
 123         required: false
 124         in: "query"
 125         description: "this attribute could be used to filter retrieved attribute(s)\
 126           \ and/or sort SO."
 127         type: "string"
 128       - name: "offset"
 129         required: false
 130         in: "query"
 131         description: "The index of the first element to retrieve. Zero is the first\
 132           \ element of the collection."
 133         type: "integer"
 134         format: "int32"
 135       - name: "limit"
 136         required: false
 137         in: "query"
 138         description: "The maximum number of elements to retrieve (it can be greater\
 139           \ than the actual available number of items)."
 140         type: "integer"
 141         format: "int32"
 142       responses:
 143         200:
 144           description: "Ok"
 145           schema:
 146             type: "array"
 147             items:
 148               $ref: "#/definitions/ServiceOrder"
 149           headers:
 150             X-Total-Count:
 151               description: ""
 152               type: "integer"
 153               format: "int32"
 154             X-Result-Count:
 155               description: ""
 156               type: "integer"
 157               format: "int32"
 158   /serviceOrder/{id}:
 159     get:
 160       tags:
 161       - "ServiceOrder"
 162       produces:
 163       - "application/json;charset=utf-8"
 164       operationId: "serviceOrderGet"
 165       summary: "Retrieve a service order"
 166       description: "This operation retrieves a service order entity. \nAttribute selection\
 167         \ is enabled for all first level attributes."
 168       deprecated: false
 169       parameters:
 170       - name: "id"
 171         required: true
 172         in: "path"
 173         description: ""
 174         type: "string"
 175       - name: "fields"
 176         required: false
 177         in: "query"
 178         description: "Attribute selection"
 179         type: "string"
 180       - name: "Target"
 181         required: false
 182         in: "header"
 183         description: ""
 184         type: "string"
 185       responses:
 186         200:
 187           description: "Ok"
 188           schema:
 189             $ref: "#/definitions/ServiceOrder"
 190   /notification:
 191     post:
 192       tags:
 193       - "Notification"
 194       consumes:
 195       - "application/json;charset=utf-8"
 196       produces:
 197       - "application/json;charset=utf-8"
 198       operationId: "notificationCreate"
 199       summary: "NBI will send notification to this operation provided by subscribers"
 200       description: "Notification structure depends of the eventType:\n\n- ServiceOrderCreationNotification\n\
 201         - ServiceOrderStateChangeNotification\n\n```\n{\n  \"eventId\": \"string\"\
 202         ,\n  \"eventDate\": \"2019-03-12T16:21:27.530Z\",\n  \"eventType\": \"string\"\
 203         ,\n  \"event\": {\n    \"id\": \"string\",\n    \"href\": \"string\",\n  \
 204         \  \"externalId\": \"string\",\n    \"state\": \"acknowledged\",\n    \"orderDate\"\
 205         : \"2019-03-12T16:21:27.530Z\",\n    \"completionDateTime\": \"2019-03-12T16:21:27.530Z\"\
 206         \n  }\n}\n```\n\n- ServiceOrderItemStateChangeNotification\n\n```\n{\n  \"\
 207         eventId\": \"string\",\n  \"eventDate\": \"2019-03-12T16:21:44.066Z\",\n \
 208         \ \"eventType\": \"string\",\n  \"event\": {\n    \"id\": \"string\",\n  \
 209         \  \"href\": \"string\",\n    \"externalId\": \"string\",\n    \"state\":\
 210         \ \"acknowledged\",\n    \"orderDate\": \"2019-03-12T16:21:44.066Z\",\n  \
 211         \  \"completionDateTime\": \"2019-03-12T16:21:44.066Z\",\n    \"orderItem\"\
 212         : [\n      {\n        \"id\": \"string\",\n        \"action\": \"add\",\n\
 213         \        \"state\": \"acknowledged\",\n        \"service\": {\n          \"\
 214         id\": \"string\",\n          \"href\": \"string\",\n          \"name\": \"\
 215         string\",\n          \"serviceState\": \"string\",\n          \"serviceCharacteristic\"\
 216         : [\n            {\n              \"name\": \"string\",\n              \"\
 217         valueType\": \"string\",\n              \"value\": {\n                \"serviceCharacteristicValue\"\
 218         : \"string\"\n              }\n            }\n          ],\n          \"serviceRelationship\"\
 219         : [\n            {\n              \"type\": \"reliesOn\"\n            }\n\
 220         \          ],\n          \"relatedParty\": [\n            {\n            \
 221         \  \"id\": \"string\",\n              \"href\": \"string\",\n            \
 222         \  \"role\": \"string\",\n              \"name\": \"string\",\n          \
 223         \    \"@referredType\": \"string\"\n            }\n          ],\n        \
 224         \  \"serviceSpecification\": {\n            \"id\": \"string\",\n        \
 225         \    \"href\": \"string\",\n            \"name\": \"string\",\n          \
 226         \  \"version\": \"string\",\n          }\n        }\n      }\n    ]\n  }\n\
 227         }\n```"
 228       deprecated: false
 229       parameters:
 230       - name: "Notification"
 231         required: true
 232         in: "body"
 233         description: ""
 234         schema:
 235           $ref: "#/definitions/Notification"
 236       - name: "Target"
 237         required: false
 238         in: "header"
 239         description: ""
 240         type: "string"
 241       responses:
 242         201:
 243           description: "Created"
 244           schema:
 245             $ref: "#/definitions/Notification"
 246 definitions:
 247   ActionType:
 248     description: "Action type to be describer on the order item.\nmodify is not managed\
 249       \ in Beijing release"
 250     type: "string"
 251     enum:
 252     - "add"
 253     - "modify"
 254     - "delete"
 255     - "noChange"
 256   StateType:
 257     description: "List of possible state for the order and the orderItem."
 258     type: "string"
 259     enum:
 260     - "acknowledged"
 261     - "rejected"
 262     - "pending"
 263     - "held"
 264     - "inProgress"
 265     - "cancelled"
 266     - "completed"
 267     - "failed"
 268     - "partial"
 269   RelationshipType:
 270     description: "Relationship type;\nOnly reliesOn is managed in Beijing release."
 271     type: "string"
 272     enum:
 273     - "reliesOn"
 274   EventType:
 275     description: ""
 276     type: "string"
 277     enum:
 278     - "ServiceOrderCreationNotification"
 279     - "ServiceOrderStateChangeNotification"
 280     - "ServiceOrderItemStateChangeNotification"
 281   SeverityMessage:
 282     description: ""
 283     type: "string"
 284     enum:
 285     - "information"
 286     - "error"
 287   Error:
 288     description: ""
 289     required:
 290     - "code"
 291     - "reason"
 292     type: "object"
 293     properties:
 294       code:
 295         description: "Application related code (as defined in the API or from a common\
 296           \ list)"
 297         type: "integer"
 298         format: "int32"
 299       reason:
 300         description: "Text that explains the reason for error. This can be shown to\
 301           \ a client user."
 302         type: "string"
 303       message:
 304         description: "Text that provide more details and corrective actions related\
 305           \ to the error. This can be shown to a client user"
 306         type: "string"
 307       status:
 308         description: "http error code extension like 400-2"
 309         type: "string"
 310       referenceError:
 311         description: "url pointing to documentation describing the error"
 312         type: "string"
 313   ServiceRelationship:
 314     description: "Linked Services to the one instantiate\nnbi component used this\
 315       \ relationship to sort request to ONAP."
 316     required:
 317     - "type"
 318     - "service"
 319     type: "object"
 320     properties:
 321       type:
 322         $ref: "#/definitions/RelationshipType"
 323       service:
 324         $ref: "#/definitions/Service"
 325   ServiceRef:
 326     description: "Service references"
 327     required:
 328     - "id"
 329     type: "object"
 330     properties:
 331       id:
 332         description: "Unique identifier of the service"
 333         type: "string"
 334       href:
 335         description: "Reference of the service"
 336         type: "string"
 337   ServiceCharacteristic:
 338     description: "ServiceCharacteristic"
 339     required:
 340     - "name"
 341     type: "object"
 342     properties:
 343       name:
 344         description: "Name of characteristic"
 345         type: "string"
 346       valueType:
 347         description: ""
 348         type: "string"
 349       value:
 350         $ref: "#/definitions/Value"
 351   RelatedParty:
 352     description: "A related party defines party which are involved in this order and\
 353       \ the role they are playing.\nfor Beijing release:\nWith the current version\
 354       \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\
 355       \ concept is confusing with Customer BSS concept. We took the following rules\
 356       \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\
 357       \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\
 358       \ in the serviceOrder header (we will not consider in this release the party\
 359       \ at item level); External API component will check if this customer exists\
 360       \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\
 361       \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\
 362       generic’ customer always exists."
 363     required:
 364     - "id"
 365     - "role"
 366     type: "object"
 367     properties:
 368       id:
 369         description: "Unique identifier of a related party"
 370         type: "string"
 371       href:
 372         description: "An hyperlink to the party - not used in Beijnig release"
 373         type: "string"
 374       role:
 375         description: "The role of the related party (e.g. Owner, requester, fullfiller\
 376           \ etc).\nONLY 'ONAPcustomer' is considered"
 377         type: "string"
 378       name:
 379         description: "Name of the related party"
 380         type: "string"
 381       '@referredType':
 382         description: ""
 383         type: "string"
 384   ServiceSpecificationRef:
 385     description: "The service specification (these attributes are fetched from the\
 386       \ catalogue)."
 387     required:
 388     - "id"
 389     type: "object"
 390     properties:
 391       id:
 392         description: "Unique identifier of the service specification\nThis information\
 393           \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\
 394           \ the request."
 395         type: "string"
 396       href:
 397         description: "Reference of the service specification\nNot used in Beijing\
 398           \ release."
 399         type: "string"
 400       name:
 401         description: "Name of the service specification\nNot used in Beijing release"
 402         type: "string"
 403       version:
 404         description: "Version of the service Specification\nNot used in Beijing release"
 405         type: "string"
 406       targetServiceSchema:
 407         $ref: "#/definitions/TargetServiceSchema"
 408       '@type':
 409         description: "Not used in Beijing release"
 410         type: "string"
 411       '@schemaLocation':
 412         description: "Not used in Beijing release"
 413         type: "string"
 414       '@baseType':
 415         description: "Not used in Beijing release"
 416         type: "string"
 417   Service:
 418     description: "Service (to be added, modified, deleted) description"
 419     required:
 420     - "id"
 421     type: "object"
 422     properties:
 423       id:
 424         description: "Identifier of a service instance.\nIt must be valued if orderItem\
 425           \ action is 'delete' and corresponds to a AAI service.id"
 426         type: "string"
 427       href:
 428         description: "Reference to the Service (useful for delete or modify command).\n\
 429           Not managed in Beijing release."
 430         type: "string"
 431       name:
 432         description: "Name of the service - When orderItem action is 'add' this name\
 433           \ will be used in ONAP/SO request as InstaceName."
 434         type: "string"
 435       serviceState:
 436         description: "The lifecycle state of the service requested;\nNot managed in\
 437           \ Beijing release."
 438         type: "string"
 439       '@type':
 440         description: "To define the service type\nNot managed in Beijing Release"
 441         type: "string"
 442       '@schemaLocation':
 443         description: "The URL to get the resource schema.\nNot managed in Beijing\
 444           \ Release"
 445         type: "string"
 446       serviceCharacteristic:
 447         type: "array"
 448         items:
 449           $ref: "#/definitions/ServiceCharacteristic"
 450       serviceRelationship:
 451         type: "array"
 452         items:
 453           $ref: "#/definitions/ServiceRelationship"
 454       relatedParty:
 455         type: "array"
 456         items:
 457           $ref: "#/definitions/RelatedParty"
 458       serviceSpecification:
 459         $ref: "#/definitions/ServiceSpecificationRef"
 460   OrderItemRelationship:
 461     description: "Linked order item to the one containing this attribute.\nnbi component\
 462       \ used this relationship to sort request to ONAP."
 463     required:
 464     - "type"
 465     - "id"
 466     type: "object"
 467     properties:
 468       type:
 469         $ref: "#/definitions/RelationshipType"
 470       id:
 471         description: "Unique identifier of an order item"
 472         type: "string"
 473   ServiceOrderItem:
 474     description: "An identified part of the order. A service order is decomposed into\
 475       \ one or more order items."
 476     required:
 477     - "id"
 478     - "service"
 479     type: "object"
 480     properties:
 481       id:
 482         description: "Identifier of the line item (generally it is a sequence number\
 483           \ 01, 02, 03, …)"
 484         type: "string"
 485       action:
 486         $ref: "#/definitions/ActionType"
 487       state:
 488         $ref: "#/definitions/StateType"
 489       percentProgress:
 490         description: "Progress of the delivery in percentage."
 491         type: "string"
 492       '@type':
 493         description: "Used to extend the order item.\nnot used in Beijing relase"
 494         type: "string"
 495       '@schemaLocation':
 496         description: "not used in Beijing relase"
 497         type: "string"
 498       '@baseType':
 499         description: "not used in Beijing relase"
 500         type: "string"
 501       orderItemRelationship:
 502         type: "array"
 503         items:
 504           $ref: "#/definitions/OrderItemRelationship"
 505       service:
 506         $ref: "#/definitions/Service"
 507       orderItemMessage:
 508         type: "array"
 509         items:
 510           $ref: "#/definitions/OrderMessage"
 511   ServiceOrder:
 512     description: "A Service Order is a type of order which can be used to place an\
 513       \ order between a customer and a service provider or between a service provider\
 514       \ and a partner and vice versa"
 515     required:
 516     - "id"
 517     type: "object"
 518     properties:
 519       id:
 520         description: "ID created on repository side"
 521         type: "string"
 522       href:
 523         description: "Hyperlink to access the order"
 524         type: "string"
 525       externalId:
 526         description: "ID given by the consumer and only understandable by him (to\
 527           \ facilitate his searches)"
 528         type: "string"
 529       priority:
 530         description: "A way that can be used by consumers to prioritize orders in\
 531           \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\
 532           \ and 4 the lowest)"
 533         type: "string"
 534       description:
 535         description: "A free-text description of the service order"
 536         type: "string"
 537       category:
 538         description: "Used to categorize the order that can be useful for the OM system\
 539           \ (e.g. “broadband”, “TVOption”, ...)"
 540         type: "string"
 541       state:
 542         $ref: "#/definitions/StateType"
 543       orderDate:
 544         description: ""
 545         type: "string"
 546         format: "date-time"
 547       completionDateTime:
 548         description: "Date when the order was completed"
 549         type: "string"
 550         format: "date-time"
 551       requestedStartDate:
 552         description: "Order start date wished by the requestor"
 553         type: "string"
 554         format: "date-time"
 555       requestedCompletionDate:
 556         description: "Requested delivery date from the requestor perspective"
 557         type: "string"
 558         format: "date-time"
 559       expectedCompletionDate:
 560         description: ""
 561         type: "string"
 562         format: "date-time"
 563       startDate:
 564         description: "Date when the order was started for processing"
 565         type: "string"
 566         format: "date-time"
 567       '@baseType':
 568         description: ""
 569         type: "string"
 570       '@type':
 571         description: ""
 572         type: "string"
 573       '@schemaLocation':
 574         description: ""
 575         type: "string"
 576       relatedParty:
 577         type: "array"
 578         items:
 579           $ref: "#/definitions/RelatedParty"
 580       orderRelationship:
 581         type: "array"
 582         items:
 583           $ref: "#/definitions/OrderRelationship"
 584       orderItem:
 585         type: "array"
 586         items:
 587           $ref: "#/definitions/ServiceOrderItem"
 588       orderMessage:
 589         type: "array"
 590         items:
 591           $ref: "#/definitions/OrderMessage"
 592   OrderRelationship:
 593     description: "Linked order to the one containing this attribute.\nThis relationship\
 594       \ is not used to sort ONAP request."
 595     required:
 596     - "id"
 597     type: "object"
 598     properties:
 599       type:
 600         description: "The type of related order, can be : “dependency” if the order\
 601           \ needs to be “not started” until another order item is complete (a service\
 602           \ order in this case) or “cross-ref” to keep track of the source order (a\
 603           \ productOrder)"
 604         type: "string"
 605       id:
 606         description: "The id of the related order"
 607         type: "string"
 608       href:
 609         description: "A hyperlink to the related order"
 610         type: "string"
 611       '@referredType':
 612         description: "Type of the referred order."
 613         type: "string"
 614   TargetServiceSchema:
 615     description: "Target to the schema describing the service spec resource"
 616     required:
 617     - "@type"
 618     - "@schemaLocation"
 619     type: "object"
 620     properties:
 621       '@type':
 622         description: "Indicates the (class) type of resource."
 623         type: "string"
 624       '@schemaLocation':
 625         description: "This field provided a link to the schema describing this REST\
 626           \ resource."
 627         type: "string"
 628   Value:
 629     description: "Value is a descriptive structure for service characteristic"
 630     type: "object"
 631     properties:
 632       serviceCharacteristicValue:
 633         description: "Value of the characteristic."
 634         type: "string"
 635   CreateServiceOrderItem:
 636     description: "This structure is used in the operation POST for a serviceOrder\
 637       \ request to describe an item.\nAttribute description is not accurate and should\
 638       \ be find in the serviceOrderItem class."
 639     required:
 640     - "id"
 641     - "service"
 642     type: "object"
 643     properties:
 644       id:
 645         description: "Identifier of the line item (generally it is a sequence number\
 646           \ 01, 02, 03, …)"
 647         type: "string"
 648       action:
 649         $ref: "#/definitions/ActionType"
 650       orderItemRelationship:
 651         type: "array"
 652         items:
 653           $ref: "#/definitions/OrderItemRelationship"
 654       service:
 655         $ref: "#/definitions/Service"
 656   CreateServiceOrder:
 657     description: "This structure is used in the operation POST for a serviceOrder\
 658       \ request.\nAttribute description is not accurate and should be find in the\
 659       \ serviceOrder class."
 660     type: "object"
 661     properties:
 662       externalId:
 663         description: "ID given by the consumer and only understandable by him (to\
 664           \ facilitate his searches)"
 665         type: "string"
 666       priority:
 667         description: "A way that can be used by consumers to prioritize orders in\
 668           \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\
 669           \ and 4 the lowest)"
 670         type: "string"
 671       description:
 672         description: "A free-text description of the service order"
 673         type: "string"
 674       category:
 675         description: "Used to categorize the order that can be useful for the OM system\
 676           \ (e.g. “broadband”, “TVOption”, ...)"
 677         type: "string"
 678       requestedStartDate:
 679         description: "Order start date wished by the requestor"
 680         type: "string"
 681         format: "date-time"
 682       requestedCompletionDate:
 683         description: "Requested delivery date from the requestor perspective"
 684         type: "string"
 685         format: "date-time"
 686       relatedParty:
 687         type: "array"
 688         items:
 689           $ref: "#/definitions/RelatedParty"
 690       orderRelationship:
 691         type: "array"
 692         items:
 693           $ref: "#/definitions/OrderRelationship"
 694       orderItem:
 695         type: "array"
 696         items:
 697           $ref: "#/definitions/CreateServiceOrderItem"
 698   ServiceOrderSummary:
 699     description: "This structure is used to provide a subset of serviceOrder attributes\
 700       \ to be provided in particular for notification messages"
 701     required:
 702     - "id"
 703     type: "object"
 704     properties:
 705       id:
 706         description: "ID created on repository side"
 707         type: "string"
 708       href:
 709         description: "Hyperlink to access the order"
 710         type: "string"
 711       externalId:
 712         description: "ID given by the consumer and only understandable by him (to\
 713           \ facilitate his searches)"
 714         type: "string"
 715       state:
 716         $ref: "#/definitions/StateType"
 717       orderDate:
 718         description: ""
 719         type: "string"
 720         format: "date-time"
 721       completionDateTime:
 722         description: "Date when the order was completed"
 723         type: "string"
 724         format: "date-time"
 725   Notification:
 726     description: "Notification structure for a serviceOrdering notification"
 727     required:
 728     - "eventId"
 729     - "eventDate"
 730     - "eventType"
 731     - "event"
 732     type: "object"
 733     properties:
 734       eventId:
 735         description: ""
 736         type: "string"
 737       eventDate:
 738         description: ""
 739         type: "string"
 740         format: "date-time"
 741       eventType:
 742         $ref: "#/definitions/EventType"
 743       event:
 744         $ref: "#/definitions/ServiceOrderSummaryWithItem"
 745   ServiceOrderItemSummary:
 746     description: "Service Order item summary to be used for notification"
 747     required:
 748     - "id"
 749     - "service"
 750     type: "object"
 751     properties:
 752       id:
 753         description: "Identifier of the line item (generally it is a sequence number\
 754           \ 01, 02, 03, …)"
 755         type: "string"
 756       action:
 757         $ref: "#/definitions/ActionType"
 758       state:
 759         $ref: "#/definitions/StateType"
 760       service:
 761         $ref: "#/definitions/Service"
 762   ServiceOrderSummaryWithItem:
 763     description: "Service order item summary with item description"
 764     required:
 765     - "id"
 766     type: "object"
 767     properties:
 768       id:
 769         description: "ID created on repository side"
 770         type: "string"
 771       href:
 772         description: "Hyperlink to access the order"
 773         type: "string"
 774       externalId:
 775         description: "ID given by the consumer and only understandable by him (to\
 776           \ facilitate his searches)"
 777         type: "string"
 778       state:
 779         $ref: "#/definitions/StateType"
 780       orderDate:
 781         description: ""
 782         type: "string"
 783         format: "date-time"
 784       completionDateTime:
 785         description: "Date when the order was completed"
 786         type: "string"
 787         format: "date-time"
 788       orderItem:
 789         type: "array"
 790         items:
 791           $ref: "#/definitions/ServiceOrderItemSummary"
 792   OrderMessage:
 793     description: "An optional array of messages associated with the Order"
 794     required:
 795     - "severity"
 796     - "correctionRequired"
 797     type: "object"
 798     properties:
 799       code:
 800         description: "A code associated to this message"
 801         type: "string"
 802       field:
 803         description: "Service Order attribute related to this error message"
 804         type: "string"
 805       messageInformation:
 806         description: "Message related to this order"
 807         type: "string"
 808       severity:
 809         $ref: "#/definitions/SeverityMessage"
 810       correctionRequired:
 811         description: "Indicator that an action is required to allow service order\
 812           \ fullfilment to follow up"
 813         type: "boolean"