3 description: "serviceOrder API designed for ONAP Casablanca release.\nThis API is build from TMF open\
4 \ API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list)\
5 \ and POST are available."
7 title: "API ServiceOrder"
10 backgroundColor: "#FFFFFF"
12 basePath: "/nbi/api/v3"
16 - "application/json;charset=utf-8"
18 - name: "ServiceOrder"
19 description: "A Service Order is a type of order which can be used to describe a\
20 \ group of operations on service – one service order item per service. An action\
21 \ at the level of the service order item describe the operation to be done on\
22 \ a service (add, terminate for example). The service order is triggered from\
23 \ the BSS system in charge of the product order management to ONAP that will manage\
24 \ the service fulfillment."
27 - name: "Notification"
35 - "application/json;charset=utf-8"
37 - "application/json;charset=utf-8"
38 operationId: "serviceOrderCreate"
39 summary: "Create a service order"
40 description: "This operation creates a service order entity.\nThe TMF Open API\
41 \ specification document provides the list of mandatory and non mandatory\
42 \ attributes when creating a ServiceOrder, including any possible rule conditions\
43 \ and applicable default values.\nPOST should be used without specifying the\
44 \ id and the href, the Service Order Management system is in charge of generating\
45 \ the id + href for the ServiceOrder.\n\nIn Beijing Release, NBI will use\
46 \ only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean\
47 \ that only the 'service-instance' level will be created in AAI. Additional\
48 \ resource like VNF and/OR VF are not created.\n\nIn Casablanca release, NBI\
49 \ has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3\
50 \ SO API. This API is able to instantiate in ONAP E2E service; This is useful\
51 \ for CCVPN and VoLTE UC.\nDepending on the service category defined in SDC,\
52 \ NBI will use one or the other SO API. If category starts with e2e, NBI will\
53 \ use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4\
54 \ SO API.\n\nSpecific business errors for current operation will be encapsulated\
55 \ in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add'\
56 \ action but serviceSpecification id missing\n \n - 101: OrderItem with\
57 \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\
58 \ with 'add' action - serviceSpecification id provided but not existing\n\
59 \ \n - 103: OrderItem with 'add' action but service id already existing\
60 \ in the inventory\n \n - 104: A customer for existing service(s) is provided\
61 \ but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\
62 \ - Service id provided but it is not existing in the inventory\n \n - 106:\
63 \ [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId\
67 - name: "serviceOrder"
72 $ref: "#/definitions/CreateServiceOrder"
75 description: "Success"
77 $ref: "#/definitions/ServiceOrder"
79 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
80 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
81 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
82 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
85 $ref: "#/definitions/ErrorRepresentation"
87 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
88 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
90 $ref: "#/definitions/ErrorRepresentation"
92 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
93 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
96 $ref: "#/definitions/ErrorRepresentation"
98 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
101 $ref: "#/definitions/ErrorRepresentation"
103 description: "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated\
104 \ business errors for current operation\n\n - 100: OrderItem with 'add'\
105 \ action but serviceSpecification id missing\n \n - 101: OrderItem with\
106 \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\
107 \ with 'add' action - serviceSpecification id provided but not existing\n\
108 \ \n - 103: OrderItem with 'add' action but service id already existing\
109 \ in the inventory\n \n - 104: A customer for existing service(s) is\
110 \ provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\
111 \ - Service id provided but it is not existing in the inventory\n \n\
112 \ - 106: [Not managed for current Relese] Issue with lcpCloudRegionId\
113 \ and tenantId provided\n "
115 $ref: "#/definitions/ErrorRepresentation"
117 description: "Internal Server Error\n\nList of supported error codes:\n\
120 $ref: "#/definitions/ErrorRepresentation"
122 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
123 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
126 $ref: "#/definitions/ErrorRepresentation"
131 - "application/json;charset=utf-8"
132 operationId: "serviceOrderFind"
133 summary: "List service orders"
134 description: "Retrieve and list service order entities according to given criteria.\n\
135 Only a predefined set of attribute is proposed.\nAttribute selection could\
136 \ be described in the fields attribute.\n\nSpecific business errors for current\
137 \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n"
148 description: "state of the order(s) to be retrieved"
150 - name: "description"
155 - name: "orderDate.gt"
158 description: "order date greather than"
160 - name: "orderDate.lt"
163 description: "order date lower than"
168 description: "this attribute could be used to filter retrieved attribute(s)\
174 description: "The index of the first element to retrieve. Zero is the first\
175 \ element of the collection."
181 description: "The maximum number of elements to retrieve (it can be greater\
182 \ than the actual available number of items)."
187 description: "Success"
191 $ref: "#/definitions/ServiceOrder"
202 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
203 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
204 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
205 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
208 $ref: "#/definitions/ErrorRepresentation"
210 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
211 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
213 $ref: "#/definitions/ErrorRepresentation"
215 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
216 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
219 $ref: "#/definitions/ErrorRepresentation"
221 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
224 $ref: "#/definitions/ErrorRepresentation"
226 description: "Unprocessable entity\n\nFunctional error"
228 $ref: "#/definitions/ErrorRepresentation"
230 description: "Internal Server Error\n\nList of supported error codes:\n\
233 $ref: "#/definitions/ErrorRepresentation"
235 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
236 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
239 $ref: "#/definitions/ErrorRepresentation"
245 - "application/json;charset=utf-8"
246 operationId: "serviceOrderGet"
247 summary: "Retrieve a service order"
248 description: "This operation retrieves a service order entity. \nAttribute selection\
249 \ is enabled for all first level attributes.\n\nSpecific business errors for\
250 \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\
262 description: "Attribute selection"
266 description: "Success"
268 $ref: "#/definitions/ServiceOrder"
270 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
271 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
272 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
273 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
276 $ref: "#/definitions/ErrorRepresentation"
278 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
279 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
281 $ref: "#/definitions/ErrorRepresentation"
283 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
284 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
287 $ref: "#/definitions/ErrorRepresentation"
289 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
292 $ref: "#/definitions/ErrorRepresentation"
294 description: "Unprocessable entity\n\nFunctional error"
296 $ref: "#/definitions/ErrorRepresentation"
298 description: "Internal Server Error\n\nList of supported error codes:\n\
301 $ref: "#/definitions/ErrorRepresentation"
303 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
304 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
307 $ref: "#/definitions/ErrorRepresentation"
313 - "application/json;charset=utf-8"
314 operationId: "hubCreate"
315 summary: "Create Hub"
316 description: "\n\nSpecific business errors for current operation will be encapsulated\
317 \ in\n\nHTTP Response 422 Unprocessable entity\n"
325 $ref: "#/definitions/CreateHub"
328 description: "Success"
336 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
337 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
338 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
339 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
342 $ref: "#/definitions/ErrorRepresentation"
344 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
345 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
347 $ref: "#/definitions/ErrorRepresentation"
349 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
350 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
353 $ref: "#/definitions/ErrorRepresentation"
355 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
358 $ref: "#/definitions/ErrorRepresentation"
360 description: "Unprocessable entity\n\nFunctional error"
362 $ref: "#/definitions/ErrorRepresentation"
364 description: "Internal Server Error\n\nList of supported error codes:\n\
367 $ref: "#/definitions/ErrorRepresentation"
369 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
370 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
373 $ref: "#/definitions/ErrorRepresentation"
378 - "application/json;charset=utf-8"
379 operationId: "hubFind"
380 summary: "Retrieve a lits of hub"
381 description: "\n\nSpecific business errors for current operation will be encapsulated\
382 \ in\n\nHTTP Response 422 Unprocessable entity\n"
396 - "ServiceOrderCreationNotification"
397 - "ServiceOrderStateChangeNotification"
398 - "ServiceOrderItemStateChangeNotification"
401 description: "Success"
405 $ref: "#/definitions/Hub"
407 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
408 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
409 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
410 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
413 $ref: "#/definitions/ErrorRepresentation"
415 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
416 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
418 $ref: "#/definitions/ErrorRepresentation"
420 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
421 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
424 $ref: "#/definitions/ErrorRepresentation"
426 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
429 $ref: "#/definitions/ErrorRepresentation"
431 description: "Unprocessable entity\n\nFunctional error"
433 $ref: "#/definitions/ErrorRepresentation"
435 description: "Internal Server Error\n\nList of supported error codes:\n\
438 $ref: "#/definitions/ErrorRepresentation"
440 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
441 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
444 $ref: "#/definitions/ErrorRepresentation"
450 - "application/json;charset=utf-8"
451 operationId: "hubGet"
452 summary: "Retrieve an HUB by id"
453 description: "Retrieve an HUB by id\n\nSpecific business errors for current\
454 \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n"
464 description: "Success"
466 $ref: "#/definitions/Hub"
468 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
469 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
470 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
471 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
474 $ref: "#/definitions/ErrorRepresentation"
476 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
477 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
479 $ref: "#/definitions/ErrorRepresentation"
481 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
482 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
485 $ref: "#/definitions/ErrorRepresentation"
487 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
490 $ref: "#/definitions/ErrorRepresentation"
492 description: "Unprocessable entity\n\nFunctional error"
494 $ref: "#/definitions/ErrorRepresentation"
496 description: "Internal Server Error\n\nList of supported error codes:\n\
499 $ref: "#/definitions/ErrorRepresentation"
501 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
502 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
505 $ref: "#/definitions/ErrorRepresentation"
509 operationId: "hubDelete"
510 summary: "delete hub"
511 description: "\n\nSpecific business errors for current operation will be encapsulated\
512 \ in\n\nHTTP Response 422 Unprocessable entity\n"
522 description: "Success"
524 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
525 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
526 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
527 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
530 $ref: "#/definitions/ErrorRepresentation"
532 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
533 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
535 $ref: "#/definitions/ErrorRepresentation"
537 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
538 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
541 $ref: "#/definitions/ErrorRepresentation"
543 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
546 $ref: "#/definitions/ErrorRepresentation"
548 description: "Unprocessable entity\n\nFunctional error"
550 $ref: "#/definitions/ErrorRepresentation"
552 description: "Internal Server Error\n\nList of supported error codes:\n\
555 $ref: "#/definitions/ErrorRepresentation"
557 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
558 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
561 $ref: "#/definitions/ErrorRepresentation"
562 /notification/serviceOrderCreationNotification:
567 - "application/json;charset=utf-8"
568 operationId: "notificationServiceOrderCreationNotification"
569 summary: "Service order creation notification"
570 description: "Service order creation notification\n\nSpecific business errors\
571 \ for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\
575 - name: "serviceOrderCreationNotification"
580 $ref: "#/definitions/ServiceOrderCreationNotification"
583 description: "Success"
585 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
586 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
587 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
588 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
591 $ref: "#/definitions/ErrorRepresentation"
593 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
594 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
596 $ref: "#/definitions/ErrorRepresentation"
598 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
599 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
602 $ref: "#/definitions/ErrorRepresentation"
604 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
607 $ref: "#/definitions/ErrorRepresentation"
609 description: "Unprocessable entity\n\nFunctional error"
611 $ref: "#/definitions/ErrorRepresentation"
613 description: "Internal Server Error\n\nList of supported error codes:\n\
616 $ref: "#/definitions/ErrorRepresentation"
618 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
619 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
622 $ref: "#/definitions/ErrorRepresentation"
623 /notification/serviceOrderStateChangeNotification:
628 - "application/json;charset=utf-8"
629 operationId: "notificationServiceOrderStateChangeNotification"
630 summary: "Service order state change notification description"
631 description: "\n\nSpecific business errors for current operation will be encapsulated\
632 \ in\n\nHTTP Response 422 Unprocessable entity\n"
635 - name: "serviceOrderstateChangeNotification"
640 $ref: "#/definitions/ServiceOrderStateChangeNotification"
643 description: "Success"
645 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
646 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
647 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
648 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
651 $ref: "#/definitions/ErrorRepresentation"
653 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
654 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
656 $ref: "#/definitions/ErrorRepresentation"
658 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
659 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
662 $ref: "#/definitions/ErrorRepresentation"
664 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
667 $ref: "#/definitions/ErrorRepresentation"
669 description: "Unprocessable entity\n\nFunctional error"
671 $ref: "#/definitions/ErrorRepresentation"
673 description: "Internal Server Error\n\nList of supported error codes:\n\
676 $ref: "#/definitions/ErrorRepresentation"
678 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
679 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
682 $ref: "#/definitions/ErrorRepresentation"
683 /notification/serviceOrderItemStateChangeNotification:
688 - "application/json;charset=utf-8"
689 operationId: "notificationServiceOrderItemStateChangeNotification"
690 summary: "ServiceOrder Item State Change Notification description"
691 description: "\n\nSpecific business errors for current operation will be encapsulated\
692 \ in\n\nHTTP Response 422 Unprocessable entity\n"
695 - name: "serviceOrderItemStateChangeNotification"
700 $ref: "#/definitions/ServiceOrderItemStateChangeNotification"
703 description: "Success"
705 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
706 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
707 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
708 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
711 $ref: "#/definitions/ErrorRepresentation"
713 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
714 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
716 $ref: "#/definitions/ErrorRepresentation"
718 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
719 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
722 $ref: "#/definitions/ErrorRepresentation"
724 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
727 $ref: "#/definitions/ErrorRepresentation"
729 description: "Unprocessable entity\n\nFunctional error"
731 $ref: "#/definitions/ErrorRepresentation"
733 description: "Internal Server Error\n\nList of supported error codes:\n\
736 $ref: "#/definitions/ErrorRepresentation"
738 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
739 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
742 $ref: "#/definitions/ErrorRepresentation"
745 description: "Action type to be describer on the order item.\nmodify is not managed\
746 \ in Beijing release"
754 description: "List of possible state for the order and the orderItem."
767 description: "Relationship type;\nOnly reliesOn is managed in Beijing release."
775 - "ServiceOrderCreationNotification"
776 - "ServiceOrderStateChangeNotification"
777 - "ServiceOrderItemStateChangeNotification"
785 description: "Representation of an error."
792 description: "Application related code (as defined in the API or from a common\
797 description: "Text that explains the reason for error. This can be shown to\
801 description: "Text that provide more details and corrective actions related\
802 \ to the error. This can be shown to a client user"
805 description: "http error code extension like 400-2"
808 description: "url pointing to documentation describing the error"
811 description: "The class type of a REST resource"
814 description: "it provides a link to the schema describing a REST resource"
817 description: "Linked Services to the one instantiate\nnbi component used this\
818 \ relationship to sort request to ONAP."
825 $ref: "#/definitions/RelationshipType"
827 $ref: "#/definitions/Service"
829 description: "Service references"
835 description: "Unique identifier of the service"
838 description: "Reference of the service"
840 ServiceCharacteristic:
841 description: "ServiceCharacteristic"
847 description: "Name of characteristic"
853 $ref: "#/definitions/Value"
855 description: "A related party defines party which are involved in this order and\
856 \ the role they are playing.\nfor Beijing release:\nWith the current version\
857 \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\
858 \ concept is confusing with Customer BSS concept. We took the following rules\
859 \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\
860 \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\
861 \ in the serviceOrder header (we will not consider in this release the party\
862 \ at item level); External API component will check if this customer exists\
863 \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\
864 \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\
865 generic’ customer always exists."
872 description: "Unique identifier of a related party"
875 description: "An hyperlink to the party - not used in Beijnig release"
878 description: "The role of the related party (e.g. Owner, requester, fullfiller\
879 \ etc).\nONLY 'ONAPcustomer' is considered"
882 description: "Name of the related party"
887 ServiceSpecificationRef:
888 description: "The service specification (these attributes are fetched from the\
895 description: "Unique identifier of the service specification\nThis information\
896 \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\
900 description: "Reference of the service specification\nNot used in Beijing\
904 description: "Name of the service specification\nNot used in Beijing release"
907 description: "Version of the service Specification\nNot used in Beijing release"
910 $ref: "#/definitions/TargetServiceSchema"
912 description: "Not used in Beijing release"
915 description: "Not used in Beijing release"
918 description: "Not used in Beijing release"
921 description: "Service (to be added, modified, deleted) description"
927 description: "Identifier of a service instance.\nIt must be valued if orderItem\
928 \ action is 'delete' and corresponds to a AAI service.id"
931 description: "Reference to the Service (useful for delete or modify command).\n\
932 Not managed in Beijing release."
935 description: "Name of the service - When orderItem action is 'add' this name\
936 \ will be used in ONAP/SO request as InstaceName."
939 description: "The lifecycle state of the service requested;\nNot managed in\
943 description: "To define the service type\nNot managed in Beijing Release"
946 description: "The URL to get the resource schema.\nNot managed in Beijing\
949 serviceCharacteristic:
952 $ref: "#/definitions/ServiceCharacteristic"
956 $ref: "#/definitions/ServiceRelationship"
960 $ref: "#/definitions/RelatedParty"
961 serviceSpecification:
962 $ref: "#/definitions/ServiceSpecificationRef"
963 OrderItemRelationship:
964 description: "Linked order item to the one containing this attribute.\nnbi component\
965 \ used this relationship to sort request to ONAP."
972 $ref: "#/definitions/RelationshipType"
974 description: "Unique identifier of an order item"
977 description: "An identified part of the order. A service order is decomposed into\
978 \ one or more order items."
985 description: "Identifier of the line item (generally it is a sequence number\
989 $ref: "#/definitions/ActionType"
991 $ref: "#/definitions/StateType"
993 description: "Progress of the delivery in percentage."
996 description: "Used to extend the order item.\nnot used in Beijing relase"
999 description: "not used in Beijing relase"
1002 description: "not used in Beijing relase"
1004 orderItemRelationship:
1007 $ref: "#/definitions/OrderItemRelationship"
1009 $ref: "#/definitions/Service"
1013 $ref: "#/definitions/OrderMessage"
1015 description: "A Service Order is a type of order which can be used to place an\
1016 \ order between a customer and a service provider or between a service provider\
1017 \ and a partner and vice versa"
1023 description: "ID created on repository side"
1026 description: "Hyperlink to access the order"
1029 description: "ID given by the consumer and only understandable by him (to\
1030 \ facilitate his searches)"
1033 description: "A way that can be used by consumers to prioritize orders in\
1034 \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\
1035 \ and 4 the lowest)"
1038 description: "A free-text description of the service order"
1041 description: "Used to categorize the order that can be useful for the OM system\
1042 \ (e.g. “broadband”, “TVOption”, ...)"
1045 $ref: "#/definitions/StateType"
1051 description: "Date when the order was completed"
1055 description: "Order start date wished by the requestor"
1058 requestedCompletionDate:
1059 description: "Requested delivery date from the requestor perspective"
1062 expectedCompletionDate:
1067 description: "Date when the order was started for processing"
1082 $ref: "#/definitions/RelatedParty"
1086 $ref: "#/definitions/OrderRelationship"
1090 $ref: "#/definitions/ServiceOrderItem"
1094 $ref: "#/definitions/OrderMessage"
1096 description: "Linked order to the one containing this attribute.\nThis relationship\
1097 \ is not used to sort ONAP request."
1103 description: "The type of related order, can be : “dependency” if the order\
1104 \ needs to be “not started” until another order item is complete (a service\
1105 \ order in this case) or “cross-ref” to keep track of the source order (a\
1109 description: "The id of the related order"
1112 description: "A hyperlink to the related order"
1115 description: "Type of the referred order."
1117 TargetServiceSchema:
1118 description: "Target to the schema describing the service spec resource"
1125 description: "Indicates the (class) type of resource."
1128 description: "This field provided a link to the schema describing this REST\
1132 description: "Value is a descriptive structure for service characteristic;\nFor\
1133 \ Beijing we only manage 'basic' attribute - the serviceCharacteristicValue\
1138 description: "Indicates the (class) type of resource.\nNot used in Beijing\
1142 description: "This field provided a link to the schema describing this REST\
1143 \ resource.\nNot used in Beijing Release"
1145 serviceCharacteristicValue:
1146 description: "Value of the characteristic.\nThis attribute must be used in\
1147 \ Beijing Release to provide characteristic value."
1149 CreateServiceOrderItem:
1150 description: "This structure is used in the operation POST for a serviceOrder\
1151 \ request to describe an item.\nAttribute description is not accurate and should\
1152 \ be find in the serviceOrderItem class."
1159 description: "Identifier of the line item (generally it is a sequence number\
1163 $ref: "#/definitions/ActionType"
1165 description: "Indicates the type of resource."
1168 description: "A link to the schema describing this REST resource"
1171 description: "Indicates the base type of the resource."
1173 orderItemRelationship:
1176 $ref: "#/definitions/OrderItemRelationship"
1178 $ref: "#/definitions/Service"
1180 description: "This structure is used in the operation POST for a serviceOrder\
1181 \ request.\nAttribute description is not accurate and should be find in the\
1182 \ serviceOrder class."
1186 description: "ID given by the consumer and only understandable by him (to\
1187 \ facilitate his searches)"
1190 description: "A way that can be used by consumers to prioritize orders in\
1191 \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\
1192 \ and 4 the lowest)"
1195 description: "A free-text description of the service order"
1198 description: "Used to categorize the order that can be useful for the OM system\
1199 \ (e.g. “broadband”, “TVOption”, ...)"
1202 description: "Order start date wished by the requestor"
1205 requestedCompletionDate:
1206 description: "Requested delivery date from the requestor perspective"
1221 $ref: "#/definitions/RelatedParty"
1225 $ref: "#/definitions/OrderRelationship"
1229 $ref: "#/definitions/CreateServiceOrderItem"
1231 description: "An HUB resource is used by client side to subscribe to notification.\n\
1232 Not managed in the Beijing release."
1240 description: "Hub Id"
1246 description: "Address where notification must be send"
1249 description: "This structure is used as a request for POST Hub operation"
1256 description: "The query must have an eventType=notificationName information.\n\
1257 Optionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”\
1258 &serviceOrder.state=COMPLETED"
1261 description: "Address where notification must be send"
1263 ServiceOrderSummary:
1264 description: "This structure is used to provide a subset of serviceOrder attributes\
1265 \ to be provided in particular for notification messages"
1271 description: "ID created on repository side"
1274 description: "Hyperlink to access the order"
1277 description: "ID given by the consumer and only understandable by him (to\
1278 \ facilitate his searches)"
1281 $ref: "#/definitions/StateType"
1287 description: "Date when the order was completed"
1290 ServiceOrderCreationNotification:
1291 description: "Notification structure for a service order creation notification"
1309 default: "ServiceOrderCreationNotification"
1311 $ref: "#/definitions/ServiceOrderSummary"
1313 description: "Used to describe notification for this API"
1316 ServiceOrderStateChangeNotification:
1317 description: "Service order state change notification description"
1335 default: "ServiceOrderStateChangeNotification"
1337 $ref: "#/definitions/ServiceOrderSummary"
1338 ServiceOrderItemSummary:
1339 description: "Service Order item summary to be used for notification"
1346 description: "Identifier of the line item (generally it is a sequence number\
1350 $ref: "#/definitions/ActionType"
1352 $ref: "#/definitions/StateType"
1354 $ref: "#/definitions/Service"
1355 ServiceOrderSummaryWithItem:
1356 description: "Service order item summary with item description"
1362 description: "ID created on repository side"
1365 description: "Hyperlink to access the order"
1368 description: "ID given by the consumer and only understandable by him (to\
1369 \ facilitate his searches)"
1372 $ref: "#/definitions/StateType"
1378 description: "Date when the order was completed"
1384 $ref: "#/definitions/ServiceOrderItemSummary"
1385 ServiceOrderItemStateChangeNotification:
1404 default: "ServiceOrderStateChangeNotification"
1406 $ref: "#/definitions/ServiceOrderSummaryWithItem"
1408 description: "An optional array of messages associated with the Order"
1411 - "correctionRequired"
1415 description: "A code associated to this message"
1418 description: "Service Order attribute related to this error message"
1421 description: "Message related to this order"
1424 $ref: "#/definitions/SeverityMessage"
1426 description: "Indicator that an action is required to allow service order\
1427 \ fullfilment to follow up"