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