docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml

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