docs/offeredapis/api_serviceOrder/swagger.yaml

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