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