From 8f141d17f3ea7720df479f4ae51b5a2e169548cb Mon Sep 17 00:00:00 2001 From: romaingimbert Date: Fri, 14 Sep 2018 14:52:20 +0200 Subject: Add API Documentation for Casablanca -update docs -update version related code -change properties MSB Change-Id: I7fb2a257ec035c53e93666d7571a2c74a0624524 Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert --- .../serviceOrder/apiServiceOrder.plantuml | 78 +- docs/offeredapis/serviceOrder/asciiDoc.adoc | 826 ++++++- docs/offeredapis/serviceOrder/documentation.html | 2364 ++++++++++++++++---- docs/offeredapis/serviceOrder/markDown.md | 461 +++- 4 files changed, 3222 insertions(+), 507 deletions(-) (limited to 'docs/offeredapis/serviceOrder') diff --git a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml index eb78af2..775fdeb 100644 --- a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml +++ b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml @@ -1,7 +1,3 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml enum ActionType { @@ -24,6 +20,15 @@ enum StateType { enum RelationshipType { reliesOn } +enum EventType { + ServiceOrderCreationNotification + ServiceOrderStateChangeNotification + ServiceOrderItemStateChangeNotification +} +enum SeverityMessage { + information + error +} class ErrorRepresentation { code:int @@ -89,6 +94,7 @@ class OrderItemRelationship { class ServiceOrderItem { id:string + percentProgress:string @type:string @schemaLocation:string @baseType:string @@ -97,6 +103,7 @@ class ServiceOrderItem { ServiceOrderItem --> "0-1" StateType : state ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship ServiceOrderItem --> "1-1" Service : service + ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage class ServiceOrder { id:string @@ -119,6 +126,7 @@ class ServiceOrder { ServiceOrder --> "0-*" RelatedParty : relatedParty ServiceOrder --> "0-*" OrderRelationship : orderRelationship ServiceOrder --> "0-*" ServiceOrderItem : orderItem + ServiceOrder --> "0-*" OrderMessage : orderMessage class OrderRelationship { type:string @@ -169,4 +177,66 @@ class Hub { callback:string } +class CreateHub { + query:string + callback:string +} + +class ServiceOrderSummary { + id:string + href:string + externalId:string + orderDate:dateTime + completionDateTime:dateTime +} + ServiceOrderSummary --> "0-1" StateType : state + +class ServiceOrderCreationNotification { + eventId:string + eventDate:dateTime + eventType:string +} + ServiceOrderCreationNotification --> "1-1" ServiceOrderSummary : event + +class Notification + +class ServiceOrderStateChangeNotification { + eventId:string + eventDate:dateTime + eventType:string +} + ServiceOrderStateChangeNotification --> "1-1" ServiceOrderSummary : event + +class ServiceOrderItemSummary { + id:string +} + ServiceOrderItemSummary --> "0-1" ActionType : action + ServiceOrderItemSummary --> "0-1" StateType : state + ServiceOrderItemSummary --> "1-1" Service : service + +class ServiceOrderSummaryWithItem { + id:string + href:string + externalId:string + orderDate:dateTime + completionDateTime:dateTime +} + ServiceOrderSummaryWithItem --> "0-1" StateType : state + ServiceOrderSummaryWithItem --> "0-*" ServiceOrderItemSummary : orderItem + +class ServiceOrderItemStateChangeNotification { + eventId:string + eventDate:dateTime + eventType:string +} + ServiceOrderItemStateChangeNotification --> "1-1" ServiceOrderSummaryWithItem : event + +class OrderMessage { + code:string + field:string + messageInformation:string + correctionRequired:boolean +} + OrderMessage --> "1-1" SeverityMessage : severity + @enduml \ No newline at end of file diff --git a/docs/offeredapis/serviceOrder/asciiDoc.adoc b/docs/offeredapis/serviceOrder/asciiDoc.adoc index 29da92f..72ba736 100644 --- a/docs/offeredapis/serviceOrder/asciiDoc.adoc +++ b/docs/offeredapis/serviceOrder/asciiDoc.adoc @@ -1,56 +1,602 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// += API ServiceOrder + + +[[_overview]] +== Overview + +=== Api URL + +https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json[Swagger UI] + + +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] + +serviceOrder API designed for ONAP. +This API is build from TMF open API18.0 (applying TMF Guideline 3.0); +Only operations GET (by id and list) and POST are available. + + +=== Version information +[%hardbreaks] +__Version__ : 3.0.0_inProgress + + +=== URI scheme +[%hardbreaks] +__Host__ : serverRoot +__BasePath__ : /nbi/api/v3 +__Schemes__ : HTTPS + + +=== Tags + +* Hub +* Notification +* 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. + + +=== Produces + +* `application/json;charset=utf-8` + + +[[_paths]] +== Resources + +[[_hub_resource]] +=== Hub + +[[_hubcreate]] +==== Create Hub +.... +POST /hub +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**Hub** + +__required__|<<_createhub,CreateHub>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**201**|Success + +**Headers** : + +`location` (string)|file +|**400**|Bad Request + +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized + +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden + +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found + +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity + +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error + +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable + +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + + +[[_hubfind]] +==== Retrieve a lits of hub +.... +GET /hub +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Query**|**eventType** + +__optional__|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) +|**Query**|**id** + +__optional__|string +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**200**|Success|< <<_hub,Hub>> > array +|**400**|Bad Request + +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized + +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden + +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found + +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity + +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error + +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable + +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== + + +===== Produces + +* `application/json;charset=utf-8` + + +[[_hubget]] +==== Retrieve an HUB by id +.... +GET /hub/{hubId} +.... + + +===== Description +Retrieve an HUB by id + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Path**|**hubId** + +__required__|string +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**200**|Success|<<_hub,Hub>> +|**400**|Bad Request + +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized + +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden + +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found + +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity + +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error + +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable + +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== + + +===== Produces + +* `application/json;charset=utf-8` + + +[[_hubdelete]] +==== delete hub +.... +DELETE /hub/{hubId} +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Path**|**hubId** + +__required__|string +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**400**|Bad Request + +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized + +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden + +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found + +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity + +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error + +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable + +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== + + +[[_notification_resource]] +=== Notification + +[[_notificationserviceordercreationnotification]] +==== Service order creation notification +.... +POST /notification/serviceOrderCreationNotification +.... + + +===== Description +Service order creation notification + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderCreationNotification** + +__required__|<<_serviceordercreationnotification,ServiceOrderCreationNotification>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**400**|Bad Request + +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized + +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden + +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found + +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity + +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error + +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable + +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + + +[[_notificationserviceorderitemstatechangenotification]] +==== ServiceOrder Item State Change Notification description +.... +POST /notification/serviceOrderItemStateChangeNotification +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderItemStateChangeNotification** + +__required__|<<_serviceorderitemstatechangenotification,ServiceOrderItemStateChangeNotification>> +|=== -= API ServiceOrder +===== Responses -[[_overview]] -== Overview +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**400**|Bad Request -=== Api URL +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json[Swagger UI] +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/plantuml&noCache=934804.0[plant UML UI] +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity -serviceOrder API designed for ONAP Beijing Release. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0); -Only operations GET (by id and list) and POST are available. +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable -=== Version information -[%hardbreaks] -__Version__ : 1.0.0_inProgress +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /nbi/api/v1 -__Schemes__ : HTTPS +===== Consumes +* `application/json;charset=utf-8` -=== Tags -* 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. +[[_notificationserviceorderstatechangenotification]] +==== Service order state change notification description +.... +POST /notification/serviceOrderStateChangeNotification +.... -=== Consumes +===== Description +Specific business errors for current operation will be encapsulated in -* `application/json;charset=utf-8` +HTTP Response 422 Unprocessable entity -=== Produces +===== Parameters -* `application/json;charset=utf-8` +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderstateChangeNotification** + +__required__|<<_serviceorderstatechangenotification,ServiceOrderStateChangeNotification>> +|=== -[[_paths]] -== Resources +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**400**|Bad Request + +List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> +|**401**|Unauthorized + +List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> +|**403**|Forbidden + +List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> +|**404**|Not Found + +List of supported error codes: +- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> +|**422**|Unprocessable entity + +Functional error|<<_errorrepresentation,ErrorRepresentation>> +|**500**|Internal Server Error + +List of supported error codes: +- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> +|**503**|Service Unavailable + +List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + [[_serviceorder_resource]] === ServiceOrder @@ -69,6 +615,11 @@ This operation creates a service order entity. 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. 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. +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. + +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. +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. + Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity @@ -103,7 +654,7 @@ __required__|<<_createserviceorder,CreateServiceOrder>> [options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema -|**201**|Success|<<_createserviceorder,CreateServiceOrder>> +|**201**|Success|<<_serviceorder,ServiceOrder>> |**400**|Bad Request List of supported error codes: @@ -164,6 +715,16 @@ List of supported error codes: |=== +===== Consumes + +* `application/json;charset=utf-8` + + +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceorderfind]] ==== List service orders .... @@ -258,6 +819,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceorderget]] ==== Retrieve a service order .... @@ -336,6 +902,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions @@ -347,6 +918,23 @@ modify is not managed in Beijing release __Type__ : enum (add, modify, delete, noChange) +[[_createhub]] +=== CreateHub +This structure is used as a request for POST Hub operation + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**callback** + +__required__|Address where notification must be send|string +|**query** + +__required__|The query must have an eventType=notificationName information. +Optionally a ? could be added to reduce hub. +query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string +|=== + + [[_createserviceorder]] === CreateServiceOrder This structure is used in the operation POST for a serviceOrder request. @@ -434,24 +1022,36 @@ __optional__|http error code extension like 400-2|string |=== +[[_eventtype]] +=== EventType +__Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) + + [[_hub]] === Hub An HUB resource is used by client side to subscribe to notification. Not managed in the Beijing release. -[options="header", cols=".^3,.^4"] +[options="header", cols=".^3,.^11,.^4"] |=== -|Name|Schema +|Name|Description|Schema |**callback** + -__required__|string +__required__|Address where notification must be send|string |**id** + -__optional__|string +__optional__|Hub Id|string |**query** + -__optional__|string +__required__||string |=== +[[_notification]] +=== Notification +Used to describe notification for this API + +__Type__ : object + + [[_orderitemrelationship]] === OrderItemRelationship Linked order item to the one containing this attribute. @@ -468,6 +1068,27 @@ __required__||<<_relationshiptype,RelationshipType>> |=== +[[_ordermessage]] +=== OrderMessage +An optional array of messages associated with the Order + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**code** + +__optional__|A code associated to this message|string +|**correctionRequired** + +__required__|Indicator that an action is required to allow service order fullfilment to follow up|boolean +|**field** + +__optional__|Service Order attribute related to this error message|string +|**messageInformation** + +__optional__|Message related to this order|string +|**severity** + +__required__||<<_severitymessage,SeverityMessage>> +|=== + + [[_orderrelationship]] === OrderRelationship Linked order to the one containing this attribute. @@ -607,6 +1228,8 @@ __required__|ID created on repository side|string __optional__||string (date-time) |**orderItem** + __optional__||< <<_serviceorderitem,ServiceOrderItem>> > array +|**orderMessage** + +__optional__||< <<_ordermessage,OrderMessage>> > array |**orderRelationship** + __optional__||< <<_orderrelationship,OrderRelationship>> > array |**priority** + @@ -624,6 +1247,25 @@ __optional__||<<_statetype,StateType>> |=== +[[_serviceordercreationnotification]] +=== ServiceOrderCreationNotification +Notification structure for a service order creation notification + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__||<<_serviceordersummary,ServiceOrderSummary>> +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__||string +|**eventType** + +__required__|**Default** : `"ServiceOrderCreationNotification"`|string +|=== + + [[_serviceorderitem]] === ServiceOrderItem An identified part of the order. A service order is decomposed into one or more order items. @@ -643,8 +1285,48 @@ not used in Beijing relase|string __optional__||<<_actiontype,ActionType>> |**id** + __required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string +|**orderItemMessage** + +__optional__||< <<_ordermessage,OrderMessage>> > array |**orderItemRelationship** + __optional__||< <<_orderitemrelationship,OrderItemRelationship>> > array +|**percentProgress** + +__optional__|Progress of the delivery in percentage.|string +|**service** + +__required__||<<_service,Service>> +|**state** + +__optional__||<<_statetype,StateType>> +|=== + + +[[_serviceorderitemstatechangenotification]] +=== ServiceOrderItemStateChangeNotification + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__||<<_serviceordersummarywithitem,ServiceOrderSummaryWithItem>> +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__||string +|**eventType** + +__required__|**Default** : `"ServiceOrderStateChangeNotification"`|string +|=== + + +[[_serviceorderitemsummary]] +=== ServiceOrderItemSummary +Service Order item summary to be used for notification + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**action** + +__optional__||<<_actiontype,ActionType>> +|**id** + +__required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string |**service** + __required__||<<_service,Service>> |**state** + @@ -652,6 +1334,73 @@ __optional__||<<_statetype,StateType>> |=== +[[_serviceorderstatechangenotification]] +=== ServiceOrderStateChangeNotification +Service order state change notification description + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__||<<_serviceordersummary,ServiceOrderSummary>> +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__||string +|**eventType** + +__required__|**Default** : `"ServiceOrderStateChangeNotification"`|string +|=== + + +[[_serviceordersummary]] +=== ServiceOrderSummary +This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**completionDateTime** + +__optional__|Date when the order was completed|string (date-time) +|**externalId** + +__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string +|**href** + +__optional__|Hyperlink to access the order|string +|**id** + +__required__|ID created on repository side|string +|**orderDate** + +__optional__||string (date-time) +|**state** + +__optional__||<<_statetype,StateType>> +|=== + + +[[_serviceordersummarywithitem]] +=== ServiceOrderSummaryWithItem +Service order item summary with item description + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**completionDateTime** + +__optional__|Date when the order was completed|string (date-time) +|**externalId** + +__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string +|**href** + +__optional__|Hyperlink to access the order|string +|**id** + +__required__|ID created on repository side|string +|**orderDate** + +__optional__||string (date-time) +|**orderItem** + +__optional__||< <<_serviceorderitemsummary,ServiceOrderItemSummary>> > array +|**state** + +__optional__||<<_statetype,StateType>> +|=== + + [[_serviceref]] === ServiceRef Service references @@ -714,6 +1463,11 @@ Not used in Beijing release|string |=== +[[_severitymessage]] +=== SeverityMessage +__Type__ : enum (information, error) + + [[_statetype]] === StateType List of possible state for the order and the orderItem. diff --git a/docs/offeredapis/serviceOrder/documentation.html b/docs/offeredapis/serviceOrder/documentation.html index 09732b5..cab4964 100644 --- a/docs/offeredapis/serviceOrder/documentation.html +++ b/docs/offeredapis/serviceOrder/documentation.html @@ -1,8 +1,3 @@ - @@ -442,33 +437,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • Version information
  • URI scheme
  • Tags
    • -
  • Consumes
  • Produces
  • Resources
  • Definitions
    • ActionType
      • +
    • CreateHub
    • CreateServiceOrder
    • CreateServiceOrderItem
    • ErrorRepresentation
      • +
    • EventType
    • Hub
      • +
    • Notification
    • OrderItemRelationship
      • +
    • OrderMessage
    • OrderRelationship
    • RelatedParty
    • RelationshipType
    • Service
    • ServiceCharacteristic
    • ServiceOrder
      • +
    • ServiceOrderCreationNotification
    • ServiceOrderItem
      • +
    • ServiceOrderItemStateChangeNotification
      • +
    • ServiceOrderItemSummary
      • +
    • ServiceOrderStateChangeNotification
      • +
    • ServiceOrderSummary
      • +
    • ServiceOrderSummaryWithItem
    • ServiceRef
    • ServiceRelationship
    • ServiceSpecificationRef
      • +
    • SeverityMessage
    • StateType
    • TargetServiceSchema
    • Value
      • @@ -482,8 +489,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

      Overview

      +

      Api URL

      -

      serviceOrder API designed for ONAP Beijing Release. +

      Swagger UI

      +
      +
      +

      plant UML UI

      +
      +
      +

      serviceOrder API designed for ONAP. This API is build from TMF open API18.0 (applying TMF Guideline 3.0); Only operations GET (by id and list) and POST are available.

      @@ -491,14 +505,14 @@ Only operations GET (by id and list) and POST are available.

      Version information

      -

      Version : 1.0.0_inProgress

      +

      Version : 3.0.0_inProgress

      URI scheme

      Host : serverRoot
      -BasePath : /nbi/api/v1
      +BasePath : /nbi/api/v3
      Schemes : HTTPS

      @@ -507,17 +521,13 @@ Only operations GET (by id and list) and POST are available.

      • -

        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.

        +

        Hub

        • -
      -
      -
      -
      -

      Consumes

      -
      -
      • -

        application/json;charset=utf-8

        +

        Notification

        +
        • +
      • +

        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.

      @@ -538,55 +548,22 @@ Only operations GET (by id and list) and POST are available.

      Resources

      -

      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.

      -
      +

      Hub

      -

      Create a service order

      +

      Create Hub

      -
      POST /serviceOrder
      +
      POST /hub
      Description
      -

      This operation creates a service order entity. -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. -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.

      -
      -

      Specific business errors for current operation will be encapsulated in

      HTTP Response 422 Unprocessable entity

      -
      -
        -
      • -

        100: OrderItem with 'add' action but serviceSpecification id missing

        -
        • -
      • -

        101: OrderItem with 'change'/'noChange'/'remove' but service id missing

        -
        • -
      • -

        102: OrderItem with 'add' action - serviceSpecification id provided but not existing

        -
        • -
      • -

        103: OrderItem with 'add' action but service id already existing in the inventory

        -
        • -
      • -

        104: A customer for existing service(s) is provided but he did not exist

        -
        • -
      • -

        105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

        -
        • -
      • -

        106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided

        -
        • -
      -
      Parameters
      @@ -606,9 +583,9 @@ POST should be used without specifying the id and the href, the Service Order Ma

      Body

      -

      serviceOrder
      +

      Hub
      required

      -

      CreateServiceOrder

      +

      CreateHub

      @@ -631,8 +608,10 @@ POST should be used without specifying the id and the href, the Service Order Ma

      201

      -

      Success

      -

      CreateServiceOrder

      +

      Success
      +Headers :
      +location (string)

      +

      file

      400

      @@ -678,15 +657,7 @@ POST should be used without specifying the id and the href, the Service Order Ma

      422

      Unprocessable entity

      -

      Functional error

      -

      Specific encapsulated business errors for current operation

      -

      * 100: OrderItem with 'add' action but serviceSpecification id missing

      -

      * 101: OrderItem with 'change'/'noChange'/'remove' but service id missing

      -

      * 102: OrderItem with 'add' action - serviceSpecification id provided but not existing

      -

      * 103: OrderItem with 'add' action but service id already existing in the inventory

      -

      * 104: A customer for existing service(s) is provided but he did not exist

      -

      * 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

      -

      * 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided

      +

      Functional error

      ErrorRepresentation

      @@ -707,22 +678,27 @@ POST should be used without specifying the id and the href, the Service Order Ma
      +
      +
      Consumes
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      -

      List service orders

      +

      Retrieve a lits of hub

      -
      GET /serviceOrder
      +
      GET /hub
      Description
      -

      Retrieve and list service order entities according to given criteria. -Only a predefined set of attribute is proposed. -Attribute selection could be described in the fields attribute.

      -
      -

      Specific business errors for current operation will be encapsulated in

      @@ -733,74 +709,28 @@ Attribute selection could be described in the fields attribute.

      Parameters
      ----+++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - @@ -824,11 +754,8 @@ Attribute selection could be described in the fields attribute.

      - - + + @@ -895,19 +822,28 @@ Attribute selection could be described in the fields attribute.

      Type NameDescription Schema

      Query

      description
      -optional

      string

      Query

      externalId
      -optional

      string

      Query

      fields
      -optional

      this attribute could be used to filter retrieved attribute(s) and/or sort SO.

      string

      Query

      limit
      -optional

      The maximum number of elements to retrieve (it can be greater than the actual available number of items).

      integer (int32)

      Query

      offset
      -optional

      The index of the first element to retrieve. Zero is the first element of the collection.

      integer (int32)

      Query

      orderDate.gt
      -optional

      order date greather than

      string

      Query

      orderDate.lt
      +

      eventType
      optional

      order date lower than

      string

      enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

      Query

      state
      +

      id
      optional

      state of the order(s) to be retrieved

      string

      200

      Success
      -Headers :
      -X-Total-Count (integer (int32))
      -X-Result-Count (integer (int32))

      < ServiceOrder > array

      Success

      < Hub > array

      400
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      -

      Retrieve a service order

      +

      Retrieve an HUB by id

      -
      GET /serviceOrder/{id}
      +
      GET /hub/{hubId}
      Description
      -

      This operation retrieves a service order entity. -Attribute selection is enabled for all first level attributes.

      +

      Retrieve an HUB by id

      Specific business errors for current operation will be encapsulated in

      @@ -920,32 +856,22 @@ Attribute selection is enabled for all first level attributes.

      Parameters
      ----+++ - - - - - - - - - @@ -970,7 +896,7 @@ Attribute selection is enabled for all first level attributes.

      - + @@ -1037,123 +963,1538 @@ Attribute selection is enabled for all first level attributes.

      Type NameDescription Schema

      Path

      id
      +

      hubId
      required

      string

      Query

      fields
      -optional

      Attribute selection

      string

      200

      Success

      ServiceOrder

      Hub

      400
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +

      delete hub

      +
      +
      +
      DELETE /hub/{hubId}
      -
      -

      Definitions

      -
      -
      -

      ActionType

      -
      -

      Action type to be describer on the order item. -modify is not managed in Beijing release

      +
      +
      Description
      -

      Type : enum (add, modify, delete, noChange)

      -
      +

      Specific business errors for current operation will be encapsulated in

      -
      -

      CreateServiceOrder

      -

      This structure is used in the operation POST for a serviceOrder request. -Attribute description is not accurate and should be find in the serviceOrder class.

      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      Parameters
      ---+++ + - - - - - - - - - - - - - + + + +
      Type NameDescription Schema

      @baseType
      -optional

      string

      @schemaLocation
      -optional

      string

      @type
      -optional

      Path

      hubId
      +required

      string
      +
      +
      +
      Responses
      + +++++ + - - - + + + + + - - - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      category
      -optional

      Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)

      string

      		HTTP CodeDescriptionSchema

      description
      -optional

      A free-text description of the service order

      string

      204

      Success

      No Content

      externalId
      +

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      +
      +

      Notification

      +
      +

      Service order creation notification

      +
      +
      +
      POST /notification/serviceOrderCreationNotification
      +
      +
      +
      +
      Description
      +
      +

      Service order creation notification

      +
      +
      +

      Specific business errors for current operation will be encapsulated in

      +
      +
      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      +
      Parameters
      + +++++ + + + + + + + + + + + + + + +
      TypeNameSchema

      Body

      serviceOrderCreationNotification
      +required

      ServiceOrderCreationNotification

      +
      +
      +
      Responses
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      HTTP CodeDescriptionSchema

      204

      Success

      No Content

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      Consumes
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      +

      ServiceOrder Item State Change Notification description

      +
      +
      +
      POST /notification/serviceOrderItemStateChangeNotification
      +
      +
      +
      +
      Description
      +
      +

      Specific business errors for current operation will be encapsulated in

      +
      +
      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      +
      Parameters
      + +++++ + + + + + + + + + + + + + + +
      TypeNameSchema

      Body

      serviceOrderItemStateChangeNotification
      +required

      ServiceOrderItemStateChangeNotification

      +
      +
      +
      Responses
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      HTTP CodeDescriptionSchema

      204

      Success

      No Content

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      Consumes
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      +

      Service order state change notification description

      +
      +
      +
      POST /notification/serviceOrderStateChangeNotification
      +
      +
      +
      +
      Description
      +
      +

      Specific business errors for current operation will be encapsulated in

      +
      +
      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      +
      Parameters
      + +++++ + + + + + + + + + + + + + + +
      TypeNameSchema

      Body

      serviceOrderstateChangeNotification
      +required

      ServiceOrderStateChangeNotification

      +
      +
      +
      Responses
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      HTTP CodeDescriptionSchema

      204

      Success

      No Content

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      Consumes
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      +
      +

      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.

      +
      +
      +

      Create a service order

      +
      +
      +
      POST /serviceOrder
      +
      +
      +
      +
      Description
      +
      +

      This operation creates a service order entity. +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. +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.

      +
      +
      +

      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.

      +
      +
      +

      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. +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.

      +
      +
      +

      Specific business errors for current operation will be encapsulated in

      +
      +
      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
        +
      • +

        100: OrderItem with 'add' action but serviceSpecification id missing

        +
        • +
      • +

        101: OrderItem with 'change'/'noChange'/'remove' but service id missing

        +
        • +
      • +

        102: OrderItem with 'add' action - serviceSpecification id provided but not existing

        +
        • +
      • +

        103: OrderItem with 'add' action but service id already existing in the inventory

        +
        • +
      • +

        104: A customer for existing service(s) is provided but he did not exist

        +
        • +
      • +

        105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

        +
        • +
      • +

        106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided

        +
        • +
      +
      +
      +
      +
      Parameters
      + +++++ + + + + + + + + + + + + + + +
      TypeNameSchema

      Body

      serviceOrder
      +required

      CreateServiceOrder

      +
      +
      +
      Responses
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      HTTP CodeDescriptionSchema

      201

      Success

      ServiceOrder

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      +

      Specific encapsulated business errors for current operation

      +

      * 100: OrderItem with 'add' action but serviceSpecification id missing

      +

      * 101: OrderItem with 'change'/'noChange'/'remove' but service id missing

      +

      * 102: OrderItem with 'add' action - serviceSpecification id provided but not existing

      +

      * 103: OrderItem with 'add' action but service id already existing in the inventory

      +

      * 104: A customer for existing service(s) is provided but he did not exist

      +

      * 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory

      +

      * 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      Consumes
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      +

      List service orders

      +
      +
      +
      GET /serviceOrder
      +
      +
      +
      +
      Description
      +
      +

      Retrieve and list service order entities according to given criteria. +Only a predefined set of attribute is proposed. +Attribute selection could be described in the fields attribute.

      +
      +
      +

      Specific business errors for current operation will be encapsulated in

      +
      +
      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      +
      Parameters
      + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      TypeNameDescriptionSchema

      Query

      description
      +optional

      string

      Query

      externalId
      +optional

      string

      Query

      fields
      +optional

      this attribute could be used to filter retrieved attribute(s) and/or sort SO.

      string

      Query

      limit
      +optional

      The maximum number of elements to retrieve (it can be greater than the actual available number of items).

      integer (int32)

      Query

      offset
      +optional

      The index of the first element to retrieve. Zero is the first element of the collection.

      integer (int32)

      Query

      orderDate.gt
      +optional

      order date greather than

      string

      Query

      orderDate.lt
      +optional

      order date lower than

      string

      Query

      state
      +optional

      state of the order(s) to be retrieved

      string

      +
      +
      +
      Responses
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      HTTP CodeDescriptionSchema

      200

      Success
      +Headers :
      +X-Total-Count (integer (int32))
      +X-Result-Count (integer (int32))

      < ServiceOrder > array

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      +

      Retrieve a service order

      +
      +
      +
      GET /serviceOrder/{id}
      +
      +
      +
      +
      Description
      +
      +

      This operation retrieves a service order entity. +Attribute selection is enabled for all first level attributes.

      +
      +
      +

      Specific business errors for current operation will be encapsulated in

      +
      +
      +

      HTTP Response 422 Unprocessable entity

      +
      +
      +
      +
      Parameters
      + ++++++ + + + + + + + + + + + + + + + + + + + + + + +
      TypeNameDescriptionSchema

      Path

      id
      +required

      string

      Query

      fields
      +optional

      Attribute selection

      string

      +
      +
      +
      Responses
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      HTTP CodeDescriptionSchema

      200

      Success

      ServiceOrder

      400

      Bad Request

      +

      List of supported error codes: +- 20: Invalid URL parameter value +- 21: Missing body +- 22: Invalid body +- 23: Missing body field +- 24: Invalid body field +- 25: Missing header +- 26: Invalid header value +- 27: Missing query-string parameter +- 28: Invalid query-string parameter value

      ErrorRepresentation

      401

      Unauthorized

      +

      List of supported error codes: +- 40: Missing credentials +- 41: Invalid credentials +- 42: Expired credentials

      ErrorRepresentation

      403

      Forbidden

      +

      List of supported error codes: +- 50: Access denied +- 51: Forbidden requester +- 52: Forbidden user +- 53: Too many requests

      ErrorRepresentation

      404

      Not Found

      +

      List of supported error codes: +- 60: Resource not found

      ErrorRepresentation

      422

      Unprocessable entity

      +

      Functional error

      ErrorRepresentation

      500

      Internal Server Error

      +

      List of supported error codes: +- 1: Internal error

      ErrorRepresentation

      503

      Service Unavailable

      +

      List of supported error codes: +- 5: The service is temporarily unavailable +- 6: Orange API is over capacity, retry later !

      ErrorRepresentation

      +
      +
      +
      Produces
      +
      +
        +
      • +

        application/json;charset=utf-8

        +
        • +
      +
      +
      +
      +
      +
      +
      +
      +

      Definitions

      +
      +
      +

      ActionType

      +
      +

      Action type to be describer on the order item. +modify is not managed in Beijing release

      +
      +
      +

      Type : enum (add, modify, delete, noChange)

      +
      +
      +
      +

      CreateHub

      +
      +

      This structure is used as a request for POST Hub operation

      +
      + +++++ + + + + + + + + + + + + + + + + + + + +
      NameDescriptionSchema

      callback
      +required

      Address where notification must be send

      string

      query
      +required

      The query must have an eventType=notificationName information. +Optionally a ? could be added to reduce hub. +query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED

      string

      +
      +
      +

      CreateServiceOrder

      +
      +

      This structure is used in the operation POST for a serviceOrder request. +Attribute description is not accurate and should be find in the serviceOrder class.

      +
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      NameDescriptionSchema

      @baseType
      +optional

      string

      @schemaLocation
      +optional

      string

      @type
      +optional

      string

      category
      +optional

      Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)

      string

      description
      +optional

      A free-text description of the service order

      string

      externalId
      optional

      ID given by the consumer and only understandable by him (to facilitate his searches)

      string

      orderItem
      +

      orderItem
      +optional

      < CreateServiceOrderItem > array

      orderRelationship
      +optional

      < OrderRelationship > array

      priority
      +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

      relatedParty
      +optional

      < RelatedParty > array

      requestedCompletionDate
      +optional

      Requested delivery date from the requestor perspective

      string (date-time)

      requestedStartDate
      +optional

      Order start date wished by the requestor

      string (date-time)

      +
      +
      +

      CreateServiceOrderItem

      +
      +

      This structure is used in the operation POST for a serviceOrder request to describe an item. +Attribute description is not accurate and should be find in the serviceOrderItem class.

      +
      + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + + +
      NameDescriptionSchema

      @baseType
      +optional

      Indicates the base type of the resource.

      string

      @schemaLocation
      +optional

      A link to the schema describing this REST resource

      string

      @type
      +optional

      Indicates the type of resource.

      string

      action
      +optional

      ActionType

      id
      +required

      Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

      string

      orderItemRelationship
      optional

      < CreateServiceOrderItem > array

      < OrderItemRelationship > array

      orderRelationship
      -optional

      service
      +required

      < OrderRelationship > array

      Service
      +
      +
      +

      ErrorRepresentation

      +
      +

      Representation of an error.

      +
      + +++++ + - + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      priority
      +

      		NameDescriptionSchema

      @schemaLocation
      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)

      it provides a link to the schema describing a REST resource

      string

      relatedParty
      +

      @type
      +optional

      The class type of a REST resource

      string

      code
      +required

      Application related code (as defined in the API or from a common list)

      integer (int32)

      message
      +optional

      Text that provide more details and corrective actions related to the error. This can be shown to a client user

      string

      reason
      +required

      Text that explains the reason for error. This can be shown to a client user.

      string

      referenceError
      +optional

      url pointing to documentation describing the error

      string

      status
      +optional

      http error code extension like 400-2

      string

      +
      +
      +

      EventType

      +
      +

      Type : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

      +
      +
      +
      +

      Hub

      +
      +

      An HUB resource is used by client side to subscribe to notification. +Not managed in the Beijing release.

      +
      + +++++ + + + + + + + + + + + + + + + + + + + + - + + + +
      NameDescriptionSchema

      callback
      +required

      Address where notification must be send

      string

      id
      optional

      Hub Id

      string

      query
      +required

      < RelatedParty > array

      string

      +
      +
      +

      Notification

      +
      +

      Used to describe notification for this API

      +
      +
      +

      Type : object

      +
      +
      +
      +

      OrderItemRelationship

      +
      +

      Linked order item to the one containing this attribute. +nbi component used this relationship to sort request to ONAP.

      +
      + +++++ + + + + + + + - + + + + + + + + + +
      NameDescriptionSchema

      requestedCompletionDate
      +

      id
      +required

      Unique identifier of an order item

      string

      type
      +required

      RelationshipType

      +
      +
      +

      OrderMessage

      +
      +

      An optional array of messages associated with the Order

      +
      + +++++ + + + + + + + + + + - - + + - + + + + + - - + + + + + + + + + + + +
      NameDescriptionSchema

      code
      optional

      Requested delivery date from the requestor perspective

      string (date-time)

      A code associated to this message

      string

      requestedStartDate
      +

      correctionRequired
      +required

      Indicator that an action is required to allow service order fullfilment to follow up

      boolean

      field
      optional

      Order start date wished by the requestor

      string (date-time)

      Service Order attribute related to this error message

      string

      messageInformation
      +optional

      Message related to this order

      string

      severity
      +required

      SeverityMessage
      -

      CreateServiceOrderItem

      +

      OrderRelationship

      -

      This structure is used in the operation POST for a serviceOrder request to describe an item. -Attribute description is not accurate and should be find in the serviceOrderItem class.

      +

      Linked order to the one containing this attribute. +This relationship is not used to sort ONAP request.

      @@ -1170,54 +2511,103 @@ Attribute description is not accurate and should be find in the serviceOrderItem - - + - - + - + + + + + - + + + + +

      @baseType
      +

      @referredType
      optional

      Indicates the base type of the resource.

      Type of the referred order.

      string

      @schemaLocation
      +

      href
      optional

      A link to the schema describing this REST resource

      A hyperlink to the related order

      string

      @type
      +

      id
      +required

      The id of the related order

      string

      type
      optional

      Indicates the type of resource.

      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

      +
      +
      +

      RelatedParty

      +
      +

      A related party defines party which are involved in this order and the role they are playing. +for Beijing release: +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: +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. +o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.

      +
      + +++++ + + + + + + + + + + + - - - + + - + - - - + + - - - + +
      NameDescriptionSchema

      @referredType
      +optional

      string

      action
      +

      href
      optional

      ActionType

      An hyperlink to the party - not used in Beijnig release

      string

      id
      required

      Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

      Unique identifier of a related party

      string

      orderItemRelationship
      +

      name
      optional

      < OrderItemRelationship > array

      Name of the related party

      string

      service
      +

      role
      required

      Service

      The role of the related party (e.g. Owner, requester, fullfiller etc). +ONLY 'ONAPcustomer' is considered

      string
      -

      ErrorRepresentation

      +

      RelationshipType

      -

      Representation of an error.

      +

      Relationship type; +Only reliesOn is managed in Beijing release.

      +
      +
      +

      Type : enum (reliesOn)

      +
      +
      +
      +

      Service

      +
      +

      Service (to be added, modified, deleted) description

      @@ -1236,89 +2626,75 @@ Attribute description is not accurate and should be find in the serviceOrderItem - + - + - - - - - - - + - - + - - + - - - + + - -

      @schemaLocation
      optional

      it provides a link to the schema describing a REST resource

      The URL to get the resource schema. +Not managed in Beijing Release

      string

      @type
      optional

      The class type of a REST resource

      To define the service type +Not managed in Beijing Release

      string

      code
      -required

      Application related code (as defined in the API or from a common list)

      integer (int32)

      message
      +

      href
      optional

      Text that provide more details and corrective actions related to the error. This can be shown to a client user

      Reference to the Service (useful for delete or modify command). +Not managed in Beijing release.

      string

      reason
      +

      id
      required

      Text that explains the reason for error. This can be shown to a client user.

      Identifier of a service instance. +It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id

      string

      referenceError
      +

      name
      optional

      url pointing to documentation describing the error

      Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.

      string

      status
      +

      relatedParty
      optional

      http error code extension like 400-2

      string

      < RelatedParty > array
      -
      -
      -

      Hub

      -
      -

      An HUB resource is used by client side to subscribe to notification. -Not managed in the Beijing release.

      -
      - ---- - - - + + + - - - - + + + - - + + - +
      NameSchema

      serviceCharacteristic
      +optional

      < ServiceCharacteristic > array

      callback
      -required

      string

      serviceRelationship
      +optional

      < ServiceRelationship > array

      id
      +

      serviceSpecification
      optional

      string

      ServiceSpecificationRef

      query
      +

      serviceState
      optional

      The lifecycle state of the service requested; +Not managed in Beijing release.

      string
      -

      OrderItemRelationship

      +

      ServiceCharacteristic

      -

      Linked order item to the one containing this attribute. -nbi component used this relationship to sort request to ONAP.

      +

      ServiceCharacteristic

      @@ -1335,25 +2711,30 @@ nbi component used this relationship to sort request to ONAP.

      - - + - + - + + + + + +

      id
      +

      name
      required

      Unique identifier of an order item

      Name of characteristic

      string

      type
      -required

      value
      +optional

      RelationshipType

      Value

      valueType
      +optional

      string
      -

      OrderRelationship

      +

      ServiceOrder

      -

      Linked order to the one containing this attribute. -This relationship is not used to sort ONAP request.

      +

      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

      @@ -1370,40 +2751,132 @@ This relationship is not used to sort ONAP request.

      - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      @referredType
      +

      @baseType
      optional

      Type of the referred order.

      string

      @schemaLocation
      +optional

      string

      @type
      +optional

      string

      category
      +optional

      Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)

      string

      completionDateTime
      +optional

      Date when the order was completed

      string (date-time)

      description
      +optional

      A free-text description of the service order

      string

      expectedCompletionDate
      +optional

      string (date-time)

      externalId
      +optional

      ID given by the consumer and only understandable by him (to facilitate his searches)

      string

      href
      optional

      A hyperlink to the related order

      Hyperlink to access the order

      string

      id
      required

      The id of the related order

      ID created on repository side

      string

      type
      +

      orderDate
      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 (date-time)

      orderItem
      +optional

      < ServiceOrderItem > array

      orderMessage
      +optional

      < OrderMessage > array

      orderRelationship
      +optional

      < OrderRelationship > array

      priority
      +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

      relatedParty
      +optional

      < RelatedParty > array

      requestedCompletionDate
      +optional

      Requested delivery date from the requestor perspective

      string (date-time)

      requestedStartDate
      +optional

      Order start date wished by the requestor

      string (date-time)

      startDate
      +optional

      Date when the order was started for processing

      string (date-time)

      state
      +optional

      StateType
      -

      RelatedParty

      +

      ServiceOrderCreationNotification

      -

      A related party defines party which are involved in this order and the role they are playing. -for Beijing release: -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: -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. -o If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.

      +

      Notification structure for a service order creation notification

      @@ -1420,53 +2893,36 @@ o If no relatedParty are provided the service will be affected to ‘generic’ - + - - - - - - + - - - + + - - + + - - +

      @referredType
      -optional

      event
      +required

      string

      href
      -optional

      An hyperlink to the party - not used in Beijnig release

      string

      ServiceOrderSummary

      id
      +

      eventDate
      required

      Unique identifier of a related party

      string

      string (date-time)

      name
      -optional

      Name of the related party

      eventId
      +required

      string

      role
      +

      eventType
      required

      The role of the related party (e.g. Owner, requester, fullfiller etc). -ONLY 'ONAPcustomer' is considered

      Default : "ServiceOrderCreationNotification"

      string
      -

      RelationshipType

      -
      -

      Relationship type; -Only reliesOn is managed in Beijing release.

      -
      -
      -

      Type : enum (reliesOn)

      -
      -
      -
      -

      Service

      +

      ServiceOrderItem

      -

      Service (to be added, modified, deleted) description

      +

      An identified part of the order. A service order is decomposed into one or more order items.

      @@ -1483,77 +2939,116 @@ Only reliesOn is managed in Beijing release.

      + + + + + - + - + - - - + + - + - - - + + - - + - + + + + + - + - - + + +

      @baseType
      +optional

      not used in Beijing relase

      string

      @schemaLocation
      optional

      The URL to get the resource schema. -Not managed in Beijing Release

      not used in Beijing relase

      string

      @type
      optional

      To define the service type -Not managed in Beijing Release

      Used to extend the order item. +not used in Beijing relase

      string

      href
      +

      action
      optional

      Reference to the Service (useful for delete or modify command). -Not managed in Beijing release.

      string

      ActionType

      id
      required

      Identifier of a service instance. -It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id

      Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

      string

      name
      +

      orderItemMessage
      optional

      Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.

      string

      < OrderMessage > array

      relatedParty
      +

      orderItemRelationship
      optional

      < RelatedParty > array

      < OrderItemRelationship > array

      serviceCharacteristic
      +

      percentProgress
      optional

      Progress of the delivery in percentage.

      string

      service
      +required

      < ServiceCharacteristic > array

      Service

      serviceRelationship
      +

      state
      optional

      < ServiceRelationship > array

      StateType
      +
      +
      +

      ServiceOrderItemStateChangeNotification

      + +++++ + - + + + + + + + + - + - - + + + + + + + + + + + +

      serviceSpecification
      -optional

      		NameDescriptionSchema

      event
      +required

      ServiceSpecificationRef

      ServiceOrderSummaryWithItem

      serviceState
      -optional

      The lifecycle state of the service requested; -Not managed in Beijing release.

      eventDate
      +required

      string (date-time)

      eventId
      +required

      string

      eventType
      +required

      Default : "ServiceOrderStateChangeNotification"

      string
      -

      ServiceCharacteristic

      +

      ServiceOrderItemSummary

      -

      ServiceCharacteristic

      +

      Service Order item summary to be used for notification

      @@ -1570,30 +3065,36 @@ Not managed in Beijing release.

      - + + + + + - + - + - + - - +

      name
      +

      action
      +optional

      ActionType

      id
      required

      Name of characteristic

      Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

      string

      value
      -optional

      service
      +required

      Value

      Service

      valueType
      +

      state
      optional

      string

      StateType
      -

      ServiceOrder

      +

      ServiceOrderStateChangeNotification

      -

      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

      +

      Service order state change notification description

      @@ -1610,45 +3111,55 @@ Not managed in Beijing release.

      - + - + - + - + - + - - + + + +

      @baseType
      -optional

      event
      +required

      string

      ServiceOrderSummary

      @schemaLocation
      -optional

      eventDate
      +required

      string

      string (date-time)

      @type
      -optional

      eventId
      +required

      string

      category
      -optional

      Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, …)

      eventType
      +required

      Default : "ServiceOrderStateChangeNotification"

      string
      +
      +
      +

      ServiceOrderSummary

      +
      +

      This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages

      +
      + +++++ + - - - - - - - - + + + + + - - + @@ -1676,48 +3187,6 @@ Not managed in Beijing release.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1727,9 +3196,9 @@ Not managed in Beijing release.

      completionDateTime
      -optional

      Date when the order was completed

      string (date-time)

      description
      -optional

      A free-text description of the service order

      string

      		NameDescriptionSchema

      expectedCompletionDate
      +

      completionDateTime
      optional

      Date when the order was completed

      string (date-time)

      string (date-time)

      orderItem
      -optional

      < ServiceOrderItem > array

      orderRelationship
      -optional

      < OrderRelationship > array

      priority
      -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

      relatedParty
      -optional

      < RelatedParty > array

      requestedCompletionDate
      -optional

      Requested delivery date from the requestor perspective

      string (date-time)

      requestedStartDate
      -optional

      Order start date wished by the requestor

      string (date-time)

      startDate
      -optional

      Date when the order was started for processing

      string (date-time)

      state
      optional
      -

      ServiceOrderItem

      +

      ServiceOrderSummaryWithItem

      -

      An identified part of the order. A service order is decomposed into one or more order items.

      +

      Service order item summary with item description

      @@ -1746,47 +3215,40 @@ Not managed in Beijing release.

      - - - + + - - + - - + - - - - - - + - - + - + - +

      @baseType
      +

      completionDateTime
      optional

      not used in Beijing relase

      string

      Date when the order was completed

      string (date-time)

      @schemaLocation
      +

      externalId
      optional

      not used in Beijing relase

      ID given by the consumer and only understandable by him (to facilitate his searches)

      string

      @type
      +

      href
      optional

      Used to extend the order item. -not used in Beijing relase

      Hyperlink to access the order

      string

      action
      -optional

      ActionType

      id
      required

      Identifier of the line item (generally it is a sequence number 01, 02, 03, …)

      ID created on repository side

      string

      orderItemRelationship
      +

      orderDate
      optional

      < OrderItemRelationship > array

      string (date-time)

      service
      -required

      orderItem
      +optional

      Service

      < ServiceOrderItemSummary > array

      state
      @@ -1937,6 +3399,12 @@ Not used in Beijing release
      +

      SeverityMessage

      +
      +

      Type : enum (information, error)

      +
      +
      +

      StateType

      List of possible state for the order and the orderItem.

      @@ -2028,7 +3496,7 @@ This attribute must be used in Beijing Release to provide characteristic value.<
      diff --git a/docs/offeredapis/serviceOrder/markDown.md b/docs/offeredapis/serviceOrder/markDown.md index b47779b..0c11b20 100644 --- a/docs/offeredapis/serviceOrder/markDown.md +++ b/docs/offeredapis/serviceOrder/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceOrder @@ -10,43 +6,319 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json) +[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json) -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/plantuml&noCache=934804.0) +[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0) -serviceOrder API designed for ONAP Beijing Release. +serviceOrder API designed for ONAP. This API is build from TMF open API18.0 (applying TMF Guideline 3.0); Only operations GET (by id and list) and POST are available. ### Version information -*Version* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*BasePath* : /nbi/api/v3 *Schemes* : HTTPS ### Tags +* Hub +* Notification * 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. -### Consumes +### Produces * `application/json;charset=utf-8` -### Produces + +## Resources + + +### Hub + + +#### Create Hub +``` +POST /hub +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**Hub**
      *required*|[CreateHub](#createhub)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**201**|Success
      **Headers** :
      `location` (string)|file| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + +##### Consumes * `application/json;charset=utf-8` - -## Resources + +#### Retrieve a lits of hub +``` +GET /hub +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Query**|**eventType**
      *optional*|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)| +|**Query**|**id**
      *optional*|string| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Success|< [Hub](#hub) > array| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + +##### Produces + +* `application/json;charset=utf-8` + + + +#### Retrieve an HUB by id +``` +GET /hub/{hubId} +``` + + +##### Description +Retrieve an HUB by id + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Path**|**hubId**
      *required*|string| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Success|[Hub](#hub)| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + +##### Produces + +* `application/json;charset=utf-8` + + + +#### delete hub +``` +DELETE /hub/{hubId} +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Path**|**hubId**
      *required*|string| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + + +### Notification + + +#### Service order creation notification +``` +POST /notification/serviceOrderCreationNotification +``` + + +##### Description +Service order creation notification + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**serviceOrderCreationNotification**
      *required*|[ServiceOrderCreationNotification](#serviceordercreationnotification)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + +##### Consumes + +* `application/json;charset=utf-8` + + + +#### ServiceOrder Item State Change Notification description +``` +POST /notification/serviceOrderItemStateChangeNotification +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**serviceOrderItemStateChangeNotification**
      *required*|[ServiceOrderItemStateChangeNotification](#serviceorderitemstatechangenotification)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + +##### Consumes + +* `application/json;charset=utf-8` + + + +#### Service order state change notification description +``` +POST /notification/serviceOrderStateChangeNotification +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**serviceOrderstateChangeNotification**
      *required*|[ServiceOrderStateChangeNotification](#serviceorderstatechangenotification)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| +|**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| +|**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| +|**404**|Not Found

      List of supported error codes:
      - 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| +|**422**|Unprocessable entity

      Functional error|[ErrorRepresentation](#errorrepresentation)| +|**500**|Internal Server Error

      List of supported error codes:
      - 1: Internal error|[ErrorRepresentation](#errorrepresentation)| +|**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| + + +##### Consumes + +* `application/json;charset=utf-8` + ### ServiceOrder @@ -65,6 +337,11 @@ This operation creates a service order entity. 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. 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. +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. + +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. +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. + Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity @@ -95,7 +372,7 @@ HTTP Response 422 Unprocessable entity |HTTP Code|Description|Schema| |---|---|---| -|**201**|Success|[CreateServiceOrder](#createserviceorder)| +|**201**|Success|[ServiceOrder](#serviceorder)| |**400**|Bad Request

      List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| |**401**|Unauthorized

      List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| |**403**|Forbidden

      List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| @@ -105,6 +382,16 @@ HTTP Response 422 Unprocessable entity |**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| +##### Consumes + +* `application/json;charset=utf-8` + + +##### Produces + +* `application/json;charset=utf-8` + + #### List service orders ``` @@ -150,6 +437,11 @@ HTTP Response 422 Unprocessable entity |**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| +##### Produces + +* `application/json;charset=utf-8` + + #### Retrieve a service order ``` @@ -188,6 +480,11 @@ HTTP Response 422 Unprocessable entity |**503**|Service Unavailable

      List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| +##### Produces + +* `application/json;charset=utf-8` + + ## Definitions @@ -199,6 +496,17 @@ modify is not managed in Beijing release *Type* : enum (add, modify, delete, noChange) + +### CreateHub +This structure is used as a request for POST Hub operation + + +|Name|Description|Schema| +|---|---|---| +|**callback**
      *required*|Address where notification must be send|string| +|**query**
      *required*|The query must have an eventType=notificationName information.
      Optionally a ? could be added to reduce hub.
      query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string| + + ### CreateServiceOrder This structure is used in the operation POST for a serviceOrder request. @@ -254,17 +562,29 @@ Representation of an error. |**status**
      *optional*|http error code extension like 400-2|string| + +### EventType +*Type* : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) + + ### Hub An HUB resource is used by client side to subscribe to notification. Not managed in the Beijing release. -|Name|Schema| -|---|---| -|**callback**
      *required*|string| -|**id**
      *optional*|string| -|**query**
      *optional*|string| +|Name|Description|Schema| +|---|---|---| +|**callback**
      *required*|Address where notification must be send|string| +|**id**
      *optional*|Hub Id|string| +|**query**
      *required*||string| + + + +### Notification +Used to describe notification for this API + +*Type* : object @@ -279,6 +599,20 @@ nbi component used this relationship to sort request to ONAP. |**type**
      *required*||[RelationshipType](#relationshiptype)| + +### OrderMessage +An optional array of messages associated with the Order + + +|Name|Description|Schema| +|---|---|---| +|**code**
      *optional*|A code associated to this message|string| +|**correctionRequired**
      *required*|Indicator that an action is required to allow service order fullfilment to follow up|boolean| +|**field**
      *optional*|Service Order attribute related to this error message|string| +|**messageInformation**
      *optional*|Message related to this order|string| +|**severity**
      *required*||[SeverityMessage](#severitymessage)| + + ### OrderRelationship Linked order to the one containing this attribute. @@ -369,6 +703,7 @@ A Service Order is a type of order which can be used to place an order between a |**id**
      *required*|ID created on repository side|string| |**orderDate**
      *optional*||string (date-time)| |**orderItem**
      *optional*||< [ServiceOrderItem](#serviceorderitem) > array| +|**orderMessage**
      *optional*||< [OrderMessage](#ordermessage) > array| |**orderRelationship**
      *optional*||< [OrderRelationship](#orderrelationship) > array| |**priority**
      *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| |**relatedParty**
      *optional*||< [RelatedParty](#relatedparty) > array| @@ -378,6 +713,19 @@ A Service Order is a type of order which can be used to place an order between a |**state**
      *optional*||[StateType](#statetype)| + +### ServiceOrderCreationNotification +Notification structure for a service order creation notification + + +|Name|Description|Schema| +|---|---|---| +|**event**
      *required*||[ServiceOrderSummary](#serviceordersummary)| +|**eventDate**
      *required*||string (date-time)| +|**eventId**
      *required*||string| +|**eventType**
      *required*|**Default** : `"ServiceOrderCreationNotification"`|string| + + ### ServiceOrderItem An identified part of the order. A service order is decomposed into one or more order items. @@ -390,11 +738,81 @@ An identified part of the order. A service order is decomposed into one or more |**@type**
      *optional*|Used to extend the order item.
      not used in Beijing relase|string| |**action**
      *optional*||[ActionType](#actiontype)| |**id**
      *required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| +|**orderItemMessage**
      *optional*||< [OrderMessage](#ordermessage) > array| |**orderItemRelationship**
      *optional*||< [OrderItemRelationship](#orderitemrelationship) > array| +|**percentProgress**
      *optional*|Progress of the delivery in percentage.|string| |**service**
      *required*||[Service](#service)| |**state**
      *optional*||[StateType](#statetype)| + +### ServiceOrderItemStateChangeNotification + +|Name|Description|Schema| +|---|---|---| +|**event**
      *required*||[ServiceOrderSummaryWithItem](#serviceordersummarywithitem)| +|**eventDate**
      *required*||string (date-time)| +|**eventId**
      *required*||string| +|**eventType**
      *required*|**Default** : `"ServiceOrderStateChangeNotification"`|string| + + + +### ServiceOrderItemSummary +Service Order item summary to be used for notification + + +|Name|Description|Schema| +|---|---|---| +|**action**
      *optional*||[ActionType](#actiontype)| +|**id**
      *required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| +|**service**
      *required*||[Service](#service)| +|**state**
      *optional*||[StateType](#statetype)| + + + +### ServiceOrderStateChangeNotification +Service order state change notification description + + +|Name|Description|Schema| +|---|---|---| +|**event**
      *required*||[ServiceOrderSummary](#serviceordersummary)| +|**eventDate**
      *required*||string (date-time)| +|**eventId**
      *required*||string| +|**eventType**
      *required*|**Default** : `"ServiceOrderStateChangeNotification"`|string| + + + +### ServiceOrderSummary +This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages + + +|Name|Description|Schema| +|---|---|---| +|**completionDateTime**
      *optional*|Date when the order was completed|string (date-time)| +|**externalId**
      *optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| +|**href**
      *optional*|Hyperlink to access the order|string| +|**id**
      *required*|ID created on repository side|string| +|**orderDate**
      *optional*||string (date-time)| +|**state**
      *optional*||[StateType](#statetype)| + + + +### ServiceOrderSummaryWithItem +Service order item summary with item description + + +|Name|Description|Schema| +|---|---|---| +|**completionDateTime**
      *optional*|Date when the order was completed|string (date-time)| +|**externalId**
      *optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| +|**href**
      *optional*|Hyperlink to access the order|string| +|**id**
      *required*|ID created on repository side|string| +|**orderDate**
      *optional*||string (date-time)| +|**orderItem**
      *optional*||< [ServiceOrderItemSummary](#serviceorderitemsummary) > array| +|**state**
      *optional*||[StateType](#statetype)| + + ### ServiceRef Service references @@ -435,6 +853,11 @@ The service specification (these attributes are fetched from the catalogue). |**version**
      *optional*|Version of the service Specification
      Not used in Beijing release|string| + +### SeverityMessage +*Type* : enum (information, error) + + ### StateType List of possible state for the order and the orderItem. -- cgit 1.2.3-korg