9 https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json[Swagger UI]
12 https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0[plant UML UI]
14 serviceOrder API designed for ONAP.
15 This API is build from TMF open API18.0 (applying TMF Guideline 3.0);
16 Only operations GET (by id and list) and POST are available.
19 === Version information
21 __Version__ : 3.0.0_inProgress
27 __BasePath__ : /nbi/api/v3
35 * ServiceOrder : A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.
40 * `application/json;charset=utf-8`
57 Specific business errors for current operation will be encapsulated in
59 HTTP Response 422 Unprocessable entity
64 [options="header", cols=".^2,.^3,.^4"]
68 __required__|<<_createhub,CreateHub>>
74 [options="header", cols=".^2,.^14,.^4"]
76 |HTTP Code|Description|Schema
79 `location` (string)|file
82 List of supported error codes:
83 - 20: Invalid URL parameter value
86 - 23: Missing body field
87 - 24: Invalid body field
89 - 26: Invalid header value
90 - 27: Missing query-string parameter
91 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
94 List of supported error codes:
95 - 40: Missing credentials
96 - 41: Invalid credentials
97 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
100 List of supported error codes:
102 - 51: Forbidden requester
104 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
107 List of supported error codes:
108 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
109 |**422**|Unprocessable entity
111 Functional error|<<_errorrepresentation,ErrorRepresentation>>
112 |**500**|Internal Server Error
114 List of supported error codes:
115 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
116 |**503**|Service Unavailable
118 List of supported error codes:
119 - 5: The service is temporarily unavailable
120 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
126 * `application/json;charset=utf-8`
130 ==== Retrieve a lits of hub
137 Specific business errors for current operation will be encapsulated in
139 HTTP Response 422 Unprocessable entity
144 [options="header", cols=".^2,.^3,.^4"]
147 |**Query**|**eventType** +
148 __optional__|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)
156 [options="header", cols=".^2,.^14,.^4"]
158 |HTTP Code|Description|Schema
159 |**200**|Success|< <<_hub,Hub>> > array
162 List of supported error codes:
163 - 20: Invalid URL parameter value
166 - 23: Missing body field
167 - 24: Invalid body field
169 - 26: Invalid header value
170 - 27: Missing query-string parameter
171 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
172 |**401**|Unauthorized
174 List of supported error codes:
175 - 40: Missing credentials
176 - 41: Invalid credentials
177 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
180 List of supported error codes:
182 - 51: Forbidden requester
184 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
187 List of supported error codes:
188 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
189 |**422**|Unprocessable entity
191 Functional error|<<_errorrepresentation,ErrorRepresentation>>
192 |**500**|Internal Server Error
194 List of supported error codes:
195 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
196 |**503**|Service Unavailable
198 List of supported error codes:
199 - 5: The service is temporarily unavailable
200 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
206 * `application/json;charset=utf-8`
210 ==== Retrieve an HUB by id
217 Retrieve an HUB by id
219 Specific business errors for current operation will be encapsulated in
221 HTTP Response 422 Unprocessable entity
226 [options="header", cols=".^2,.^3,.^4"]
229 |**Path**|**hubId** +
236 [options="header", cols=".^2,.^14,.^4"]
238 |HTTP Code|Description|Schema
239 |**200**|Success|<<_hub,Hub>>
242 List of supported error codes:
243 - 20: Invalid URL parameter value
246 - 23: Missing body field
247 - 24: Invalid body field
249 - 26: Invalid header value
250 - 27: Missing query-string parameter
251 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
252 |**401**|Unauthorized
254 List of supported error codes:
255 - 40: Missing credentials
256 - 41: Invalid credentials
257 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
260 List of supported error codes:
262 - 51: Forbidden requester
264 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
267 List of supported error codes:
268 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
269 |**422**|Unprocessable entity
271 Functional error|<<_errorrepresentation,ErrorRepresentation>>
272 |**500**|Internal Server Error
274 List of supported error codes:
275 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
276 |**503**|Service Unavailable
278 List of supported error codes:
279 - 5: The service is temporarily unavailable
280 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
286 * `application/json;charset=utf-8`
297 Specific business errors for current operation will be encapsulated in
299 HTTP Response 422 Unprocessable entity
304 [options="header", cols=".^2,.^3,.^4"]
307 |**Path**|**hubId** +
314 [options="header", cols=".^2,.^14,.^4"]
316 |HTTP Code|Description|Schema
317 |**204**|Success|No Content
320 List of supported error codes:
321 - 20: Invalid URL parameter value
324 - 23: Missing body field
325 - 24: Invalid body field
327 - 26: Invalid header value
328 - 27: Missing query-string parameter
329 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
330 |**401**|Unauthorized
332 List of supported error codes:
333 - 40: Missing credentials
334 - 41: Invalid credentials
335 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
338 List of supported error codes:
340 - 51: Forbidden requester
342 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
345 List of supported error codes:
346 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
347 |**422**|Unprocessable entity
349 Functional error|<<_errorrepresentation,ErrorRepresentation>>
350 |**500**|Internal Server Error
352 List of supported error codes:
353 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
354 |**503**|Service Unavailable
356 List of supported error codes:
357 - 5: The service is temporarily unavailable
358 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
362 [[_notification_resource]]
365 [[_notificationserviceordercreationnotification]]
366 ==== Service order creation notification
368 POST /notification/serviceOrderCreationNotification
373 Service order creation notification
375 Specific business errors for current operation will be encapsulated in
377 HTTP Response 422 Unprocessable entity
382 [options="header", cols=".^2,.^3,.^4"]
385 |**Body**|**serviceOrderCreationNotification** +
386 __required__|<<_serviceordercreationnotification,ServiceOrderCreationNotification>>
392 [options="header", cols=".^2,.^14,.^4"]
394 |HTTP Code|Description|Schema
395 |**204**|Success|No Content
398 List of supported error codes:
399 - 20: Invalid URL parameter value
402 - 23: Missing body field
403 - 24: Invalid body field
405 - 26: Invalid header value
406 - 27: Missing query-string parameter
407 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
408 |**401**|Unauthorized
410 List of supported error codes:
411 - 40: Missing credentials
412 - 41: Invalid credentials
413 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
416 List of supported error codes:
418 - 51: Forbidden requester
420 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
423 List of supported error codes:
424 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
425 |**422**|Unprocessable entity
427 Functional error|<<_errorrepresentation,ErrorRepresentation>>
428 |**500**|Internal Server Error
430 List of supported error codes:
431 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
432 |**503**|Service Unavailable
434 List of supported error codes:
435 - 5: The service is temporarily unavailable
436 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
442 * `application/json;charset=utf-8`
445 [[_notificationserviceorderitemstatechangenotification]]
446 ==== ServiceOrder Item State Change Notification description
448 POST /notification/serviceOrderItemStateChangeNotification
453 Specific business errors for current operation will be encapsulated in
455 HTTP Response 422 Unprocessable entity
460 [options="header", cols=".^2,.^3,.^4"]
463 |**Body**|**serviceOrderItemStateChangeNotification** +
464 __required__|<<_serviceorderitemstatechangenotification,ServiceOrderItemStateChangeNotification>>
470 [options="header", cols=".^2,.^14,.^4"]
472 |HTTP Code|Description|Schema
473 |**204**|Success|No Content
476 List of supported error codes:
477 - 20: Invalid URL parameter value
480 - 23: Missing body field
481 - 24: Invalid body field
483 - 26: Invalid header value
484 - 27: Missing query-string parameter
485 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
486 |**401**|Unauthorized
488 List of supported error codes:
489 - 40: Missing credentials
490 - 41: Invalid credentials
491 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
494 List of supported error codes:
496 - 51: Forbidden requester
498 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
501 List of supported error codes:
502 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
503 |**422**|Unprocessable entity
505 Functional error|<<_errorrepresentation,ErrorRepresentation>>
506 |**500**|Internal Server Error
508 List of supported error codes:
509 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
510 |**503**|Service Unavailable
512 List of supported error codes:
513 - 5: The service is temporarily unavailable
514 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
520 * `application/json;charset=utf-8`
523 [[_notificationserviceorderstatechangenotification]]
524 ==== Service order state change notification description
526 POST /notification/serviceOrderStateChangeNotification
531 Specific business errors for current operation will be encapsulated in
533 HTTP Response 422 Unprocessable entity
538 [options="header", cols=".^2,.^3,.^4"]
541 |**Body**|**serviceOrderstateChangeNotification** +
542 __required__|<<_serviceorderstatechangenotification,ServiceOrderStateChangeNotification>>
548 [options="header", cols=".^2,.^14,.^4"]
550 |HTTP Code|Description|Schema
551 |**204**|Success|No Content
554 List of supported error codes:
555 - 20: Invalid URL parameter value
558 - 23: Missing body field
559 - 24: Invalid body field
561 - 26: Invalid header value
562 - 27: Missing query-string parameter
563 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
564 |**401**|Unauthorized
566 List of supported error codes:
567 - 40: Missing credentials
568 - 41: Invalid credentials
569 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
572 List of supported error codes:
574 - 51: Forbidden requester
576 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
579 List of supported error codes:
580 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
581 |**422**|Unprocessable entity
583 Functional error|<<_errorrepresentation,ErrorRepresentation>>
584 |**500**|Internal Server Error
586 List of supported error codes:
587 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
588 |**503**|Service Unavailable
590 List of supported error codes:
591 - 5: The service is temporarily unavailable
592 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
598 * `application/json;charset=utf-8`
601 [[_serviceorder_resource]]
603 A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.
606 [[_serviceordercreate]]
607 ==== Create a service order
614 This operation creates a service order entity.
615 The TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values.
616 POST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.
618 In Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created.
620 In Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC.
621 Depending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API.
623 Specific business errors for current operation will be encapsulated in
625 HTTP Response 422 Unprocessable entity
627 * 100: OrderItem with 'add' action but serviceSpecification id missing
629 * 101: OrderItem with 'change'/'noChange'/'remove' but service id missing
631 * 102: OrderItem with 'add' action - serviceSpecification id provided but not existing
633 * 103: OrderItem with 'add' action but service id already existing in the inventory
635 * 104: A customer for existing service(s) is provided but he did not exist
637 * 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory
639 * 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided
644 [options="header", cols=".^2,.^3,.^4"]
647 |**Body**|**serviceOrder** +
648 __required__|<<_createserviceorder,CreateServiceOrder>>
654 [options="header", cols=".^2,.^14,.^4"]
656 |HTTP Code|Description|Schema
657 |**201**|Success|<<_serviceorder,ServiceOrder>>
660 List of supported error codes:
661 - 20: Invalid URL parameter value
664 - 23: Missing body field
665 - 24: Invalid body field
667 - 26: Invalid header value
668 - 27: Missing query-string parameter
669 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
670 |**401**|Unauthorized
672 List of supported error codes:
673 - 40: Missing credentials
674 - 41: Invalid credentials
675 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
678 List of supported error codes:
680 - 51: Forbidden requester
682 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
685 List of supported error codes:
686 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
687 |**422**|Unprocessable entity
691 Specific encapsulated business errors for current operation
693 * 100: OrderItem with 'add' action but serviceSpecification id missing
695 * 101: OrderItem with 'change'/'noChange'/'remove' but service id missing
697 * 102: OrderItem with 'add' action - serviceSpecification id provided but not existing
699 * 103: OrderItem with 'add' action but service id already existing in the inventory
701 * 104: A customer for existing service(s) is provided but he did not exist
703 * 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory
705 * 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided|<<_errorrepresentation,ErrorRepresentation>>
706 |**500**|Internal Server Error
708 List of supported error codes:
709 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
710 |**503**|Service Unavailable
712 List of supported error codes:
713 - 5: The service is temporarily unavailable
714 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
720 * `application/json;charset=utf-8`
725 * `application/json;charset=utf-8`
728 [[_serviceorderfind]]
729 ==== List service orders
736 Retrieve and list service order entities according to given criteria.
737 Only a predefined set of attribute is proposed.
738 Attribute selection could be described in the fields attribute.
740 Specific business errors for current operation will be encapsulated in
742 HTTP Response 422 Unprocessable entity
747 [options="header", cols=".^2,.^3,.^9,.^4"]
749 |Type|Name|Description|Schema
750 |**Query**|**description** +
752 |**Query**|**externalId** +
754 |**Query**|**fields** +
755 __optional__|this attribute could be used to filter retrieved attribute(s) and/or sort SO.|string
756 |**Query**|**limit** +
757 __optional__|The maximum number of elements to retrieve (it can be greater than the actual available number of items).|integer (int32)
758 |**Query**|**offset** +
759 __optional__|The index of the first element to retrieve. Zero is the first element of the collection.|integer (int32)
760 |**Query**|**orderDate.gt** +
761 __optional__|order date greather than|string
762 |**Query**|**orderDate.lt** +
763 __optional__|order date lower than|string
764 |**Query**|**state** +
765 __optional__|state of the order(s) to be retrieved|string
771 [options="header", cols=".^2,.^14,.^4"]
773 |HTTP Code|Description|Schema
776 `X-Total-Count` (integer (int32)) +
777 `X-Result-Count` (integer (int32))|< <<_serviceorder,ServiceOrder>> > array
780 List of supported error codes:
781 - 20: Invalid URL parameter value
784 - 23: Missing body field
785 - 24: Invalid body field
787 - 26: Invalid header value
788 - 27: Missing query-string parameter
789 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
790 |**401**|Unauthorized
792 List of supported error codes:
793 - 40: Missing credentials
794 - 41: Invalid credentials
795 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
798 List of supported error codes:
800 - 51: Forbidden requester
802 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
805 List of supported error codes:
806 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
807 |**422**|Unprocessable entity
809 Functional error|<<_errorrepresentation,ErrorRepresentation>>
810 |**500**|Internal Server Error
812 List of supported error codes:
813 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
814 |**503**|Service Unavailable
816 List of supported error codes:
817 - 5: The service is temporarily unavailable
818 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
824 * `application/json;charset=utf-8`
828 ==== Retrieve a service order
830 GET /serviceOrder/{id}
835 This operation retrieves a service order entity.
836 Attribute selection is enabled for all first level attributes.
838 Specific business errors for current operation will be encapsulated in
840 HTTP Response 422 Unprocessable entity
845 [options="header", cols=".^2,.^3,.^9,.^4"]
847 |Type|Name|Description|Schema
850 |**Query**|**fields** +
851 __optional__|Attribute selection|string
857 [options="header", cols=".^2,.^14,.^4"]
859 |HTTP Code|Description|Schema
860 |**200**|Success|<<_serviceorder,ServiceOrder>>
863 List of supported error codes:
864 - 20: Invalid URL parameter value
867 - 23: Missing body field
868 - 24: Invalid body field
870 - 26: Invalid header value
871 - 27: Missing query-string parameter
872 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
873 |**401**|Unauthorized
875 List of supported error codes:
876 - 40: Missing credentials
877 - 41: Invalid credentials
878 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
881 List of supported error codes:
883 - 51: Forbidden requester
885 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
888 List of supported error codes:
889 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
890 |**422**|Unprocessable entity
892 Functional error|<<_errorrepresentation,ErrorRepresentation>>
893 |**500**|Internal Server Error
895 List of supported error codes:
896 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
897 |**503**|Service Unavailable
899 List of supported error codes:
900 - 5: The service is temporarily unavailable
901 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
907 * `application/json;charset=utf-8`
915 Action type to be describer on the order item.
916 modify is not managed in Beijing release
918 __Type__ : enum (add, modify, delete, noChange)
923 This structure is used as a request for POST Hub operation
926 [options="header", cols=".^3,.^11,.^4"]
928 |Name|Description|Schema
930 __required__|Address where notification must be send|string
932 __required__|The query must have an eventType=notificationName information.
933 Optionally a ? could be added to reduce hub.
934 query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string
938 [[_createserviceorder]]
939 === CreateServiceOrder
940 This structure is used in the operation POST for a serviceOrder request.
941 Attribute description is not accurate and should be find in the serviceOrder class.
944 [options="header", cols=".^3,.^11,.^4"]
946 |Name|Description|Schema
949 |**@schemaLocation** +
954 __optional__|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)|string
956 __optional__|A free-text description of the service order|string
958 __optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string
960 __optional__||< <<_createserviceorderitem,CreateServiceOrderItem>> > array
961 |**orderRelationship** +
962 __optional__||< <<_orderrelationship,OrderRelationship>> > array
964 __optional__|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string
966 __optional__||< <<_relatedparty,RelatedParty>> > array
967 |**requestedCompletionDate** +
968 __optional__|Requested delivery date from the requestor perspective|string (date-time)
969 |**requestedStartDate** +
970 __optional__|Order start date wished by the requestor|string (date-time)
974 [[_createserviceorderitem]]
975 === CreateServiceOrderItem
976 This structure is used in the operation POST for a serviceOrder request to describe an item.
977 Attribute description is not accurate and should be find in the serviceOrderItem class.
980 [options="header", cols=".^3,.^11,.^4"]
982 |Name|Description|Schema
984 __optional__|Indicates the base type of the resource.|string
985 |**@schemaLocation** +
986 __optional__|A link to the schema describing this REST resource|string
988 __optional__|Indicates the type of resource.|string
990 __optional__||<<_actiontype,ActionType>>
992 __required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string
993 |**orderItemRelationship** +
994 __optional__||< <<_orderitemrelationship,OrderItemRelationship>> > array
996 __required__||<<_service,Service>>
1000 [[_errorrepresentation]]
1001 === ErrorRepresentation
1002 Representation of an error.
1005 [options="header", cols=".^3,.^11,.^4"]
1007 |Name|Description|Schema
1008 |**@schemaLocation** +
1009 __optional__|it provides a link to the schema describing a REST resource|string
1011 __optional__|The class type of a REST resource|string
1013 __required__|Application related code (as defined in the API or from a common list)|integer (int32)
1015 __optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string
1017 __required__|Text that explains the reason for error. This can be shown to a client user.|string
1018 |**referenceError** +
1019 __optional__|url pointing to documentation describing the error|string
1021 __optional__|http error code extension like 400-2|string
1027 __Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)
1032 An HUB resource is used by client side to subscribe to notification.
1033 Not managed in the Beijing release.
1036 [options="header", cols=".^3,.^11,.^4"]
1038 |Name|Description|Schema
1040 __required__|Address where notification must be send|string
1042 __optional__|Hub Id|string
1044 __required__||string
1050 Used to describe notification for this API
1055 [[_orderitemrelationship]]
1056 === OrderItemRelationship
1057 Linked order item to the one containing this attribute.
1058 nbi component used this relationship to sort request to ONAP.
1061 [options="header", cols=".^3,.^11,.^4"]
1063 |Name|Description|Schema
1065 __required__|Unique identifier of an order item|string
1067 __required__||<<_relationshiptype,RelationshipType>>
1073 An optional array of messages associated with the Order
1076 [options="header", cols=".^3,.^11,.^4"]
1078 |Name|Description|Schema
1080 __optional__|A code associated to this message|string
1081 |**correctionRequired** +
1082 __required__|Indicator that an action is required to allow service order fullfilment to follow up|boolean
1084 __optional__|Service Order attribute related to this error message|string
1085 |**messageInformation** +
1086 __optional__|Message related to this order|string
1088 __required__||<<_severitymessage,SeverityMessage>>
1092 [[_orderrelationship]]
1093 === OrderRelationship
1094 Linked order to the one containing this attribute.
1095 This relationship is not used to sort ONAP request.
1098 [options="header", cols=".^3,.^11,.^4"]
1100 |Name|Description|Schema
1101 |**@referredType** +
1102 __optional__|Type of the referred order.|string
1104 __optional__|A hyperlink to the related order|string
1106 __required__|The id of the related order|string
1108 __optional__|The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)|string
1114 A related party defines party which are involved in this order and the role they are playing.
1115 for Beijing release:
1116 With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:
1117 o It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.
1118 o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.
1121 [options="header", cols=".^3,.^11,.^4"]
1123 |Name|Description|Schema
1124 |**@referredType** +
1125 __optional__||string
1127 __optional__|An hyperlink to the party - not used in Beijnig release|string
1129 __required__|Unique identifier of a related party|string
1131 __optional__|Name of the related party|string
1133 __required__|The role of the related party (e.g. Owner, requester, fullfiller etc).
1134 ONLY 'ONAPcustomer' is considered|string
1138 [[_relationshiptype]]
1139 === RelationshipType
1141 Only reliesOn is managed in Beijing release.
1143 __Type__ : enum (reliesOn)
1148 Service (to be added, modified, deleted) description
1151 [options="header", cols=".^3,.^11,.^4"]
1153 |Name|Description|Schema
1154 |**@schemaLocation** +
1155 __optional__|The URL to get the resource schema.
1156 Not managed in Beijing Release|string
1158 __optional__|To define the service type
1159 Not managed in Beijing Release|string
1161 __optional__|Reference to the Service (useful for delete or modify command).
1162 Not managed in Beijing release.|string
1164 __required__|Identifier of a service instance.
1165 It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id|string
1167 __optional__|Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.|string
1169 __optional__||< <<_relatedparty,RelatedParty>> > array
1170 |**serviceCharacteristic** +
1171 __optional__||< <<_servicecharacteristic,ServiceCharacteristic>> > array
1172 |**serviceRelationship** +
1173 __optional__||< <<_servicerelationship,ServiceRelationship>> > array
1174 |**serviceSpecification** +
1175 __optional__||<<_servicespecificationref,ServiceSpecificationRef>>
1177 __optional__|The lifecycle state of the service requested;
1178 Not managed in Beijing release.|string
1182 [[_servicecharacteristic]]
1183 === ServiceCharacteristic
1184 ServiceCharacteristic
1187 [options="header", cols=".^3,.^11,.^4"]
1189 |Name|Description|Schema
1191 __required__|Name of characteristic|string
1193 __optional__||<<_value,Value>>
1195 __optional__||string
1201 A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa
1204 [options="header", cols=".^3,.^11,.^4"]
1206 |Name|Description|Schema
1208 __optional__||string
1209 |**@schemaLocation** +
1210 __optional__||string
1212 __optional__||string
1214 __optional__|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)|string
1215 |**completionDateTime** +
1216 __optional__|Date when the order was completed|string (date-time)
1218 __optional__|A free-text description of the service order|string
1219 |**expectedCompletionDate** +
1220 __optional__||string (date-time)
1222 __optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string
1224 __optional__|Hyperlink to access the order|string
1226 __required__|ID created on repository side|string
1228 __optional__||string (date-time)
1230 __optional__||< <<_serviceorderitem,ServiceOrderItem>> > array
1232 __optional__||< <<_ordermessage,OrderMessage>> > array
1233 |**orderRelationship** +
1234 __optional__||< <<_orderrelationship,OrderRelationship>> > array
1236 __optional__|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string
1238 __optional__||< <<_relatedparty,RelatedParty>> > array
1239 |**requestedCompletionDate** +
1240 __optional__|Requested delivery date from the requestor perspective|string (date-time)
1241 |**requestedStartDate** +
1242 __optional__|Order start date wished by the requestor|string (date-time)
1244 __optional__|Date when the order was started for processing|string (date-time)
1246 __optional__||<<_statetype,StateType>>
1250 [[_serviceordercreationnotification]]
1251 === ServiceOrderCreationNotification
1252 Notification structure for a service order creation notification
1255 [options="header", cols=".^3,.^11,.^4"]
1257 |Name|Description|Schema
1259 __required__||<<_serviceordersummary,ServiceOrderSummary>>
1261 __required__||string (date-time)
1263 __required__||string
1265 __required__|**Default** : `"ServiceOrderCreationNotification"`|string
1269 [[_serviceorderitem]]
1270 === ServiceOrderItem
1271 An identified part of the order. A service order is decomposed into one or more order items.
1274 [options="header", cols=".^3,.^11,.^4"]
1276 |Name|Description|Schema
1278 __optional__|not used in Beijing relase|string
1279 |**@schemaLocation** +
1280 __optional__|not used in Beijing relase|string
1282 __optional__|Used to extend the order item.
1283 not used in Beijing relase|string
1285 __optional__||<<_actiontype,ActionType>>
1287 __required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string
1288 |**orderItemMessage** +
1289 __optional__||< <<_ordermessage,OrderMessage>> > array
1290 |**orderItemRelationship** +
1291 __optional__||< <<_orderitemrelationship,OrderItemRelationship>> > array
1292 |**percentProgress** +
1293 __optional__|Progress of the delivery in percentage.|string
1295 __required__||<<_service,Service>>
1297 __optional__||<<_statetype,StateType>>
1301 [[_serviceorderitemstatechangenotification]]
1302 === ServiceOrderItemStateChangeNotification
1304 [options="header", cols=".^3,.^11,.^4"]
1306 |Name|Description|Schema
1308 __required__||<<_serviceordersummarywithitem,ServiceOrderSummaryWithItem>>
1310 __required__||string (date-time)
1312 __required__||string
1314 __required__|**Default** : `"ServiceOrderStateChangeNotification"`|string
1318 [[_serviceorderitemsummary]]
1319 === ServiceOrderItemSummary
1320 Service Order item summary to be used for notification
1323 [options="header", cols=".^3,.^11,.^4"]
1325 |Name|Description|Schema
1327 __optional__||<<_actiontype,ActionType>>
1329 __required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string
1331 __required__||<<_service,Service>>
1333 __optional__||<<_statetype,StateType>>
1337 [[_serviceorderstatechangenotification]]
1338 === ServiceOrderStateChangeNotification
1339 Service order state change notification description
1342 [options="header", cols=".^3,.^11,.^4"]
1344 |Name|Description|Schema
1346 __required__||<<_serviceordersummary,ServiceOrderSummary>>
1348 __required__||string (date-time)
1350 __required__||string
1352 __required__|**Default** : `"ServiceOrderStateChangeNotification"`|string
1356 [[_serviceordersummary]]
1357 === ServiceOrderSummary
1358 This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages
1361 [options="header", cols=".^3,.^11,.^4"]
1363 |Name|Description|Schema
1364 |**completionDateTime** +
1365 __optional__|Date when the order was completed|string (date-time)
1367 __optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string
1369 __optional__|Hyperlink to access the order|string
1371 __required__|ID created on repository side|string
1373 __optional__||string (date-time)
1375 __optional__||<<_statetype,StateType>>
1379 [[_serviceordersummarywithitem]]
1380 === ServiceOrderSummaryWithItem
1381 Service order item summary with item description
1384 [options="header", cols=".^3,.^11,.^4"]
1386 |Name|Description|Schema
1387 |**completionDateTime** +
1388 __optional__|Date when the order was completed|string (date-time)
1390 __optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string
1392 __optional__|Hyperlink to access the order|string
1394 __required__|ID created on repository side|string
1396 __optional__||string (date-time)
1398 __optional__||< <<_serviceorderitemsummary,ServiceOrderItemSummary>> > array
1400 __optional__||<<_statetype,StateType>>
1409 [options="header", cols=".^3,.^11,.^4"]
1411 |Name|Description|Schema
1413 __optional__|Reference of the service|string
1415 __required__|Unique identifier of the service|string
1419 [[_servicerelationship]]
1420 === ServiceRelationship
1421 Linked Services to the one instantiate
1422 nbi component used this relationship to sort request to ONAP.
1425 [options="header", cols=".^3,.^4"]
1429 __required__|<<_service,Service>>
1431 __required__|<<_relationshiptype,RelationshipType>>
1435 [[_servicespecificationref]]
1436 === ServiceSpecificationRef
1437 The service specification (these attributes are fetched from the catalogue).
1440 [options="header", cols=".^3,.^11,.^4"]
1442 |Name|Description|Schema
1444 __optional__|Not used in Beijing release|string
1445 |**@schemaLocation** +
1446 __optional__|Not used in Beijing release|string
1448 __optional__|Not used in Beijing release|string
1450 __optional__|Reference of the service specification
1451 Not used in Beijing release.|string
1453 __required__|Unique identifier of the service specification
1454 This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.|string
1456 __optional__|Name of the service specification
1457 Not used in Beijing release|string
1458 |**targetServiceSchema** +
1459 __optional__||<<_targetserviceschema,TargetServiceSchema>>
1461 __optional__|Version of the service Specification
1462 Not used in Beijing release|string
1466 [[_severitymessage]]
1468 __Type__ : enum (information, error)
1473 List of possible state for the order and the orderItem.
1475 __Type__ : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial)
1478 [[_targetserviceschema]]
1479 === TargetServiceSchema
1480 Target to the schema describing the service spec resource
1483 [options="header", cols=".^3,.^11,.^4"]
1485 |Name|Description|Schema
1486 |**@schemaLocation** +
1487 __required__|This field provided a link to the schema describing this REST resource.|string
1489 __required__|Indicates the (class) type of resource.|string
1495 Value is a descriptive structure for service characteristic;
1496 For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.
1499 [options="header", cols=".^3,.^11,.^4"]
1501 |Name|Description|Schema
1502 |**@schemaLocation** +
1503 __optional__|This field provided a link to the schema describing this REST resource.
1504 Not used in Beijing Release|string
1506 __optional__|Indicates the (class) type of resource.
1507 Not used in Beijing Release|string
1508 |**serviceCharacteristicValue** +
1509 __optional__|Value of the characteristic.
1510 This attribute must be used in Beijing Release to provide characteristic value.|string