Service Order Management: Release notes
Release Ella:
Readiness status: Starting Call for Comments Ballot #3
Summary - Synchronization with Sonata API patterns
- Changed files' organization to align with Sonata patterns. Now there are only 2 individual files:
serviceInventoryManagement.api.yaml
serviceInventoryNotification.api.yaml
- applied API patterns used in Sonata and Cantata APIs
List of changes in the API:
serviceOrderingManagement.api.yaml:
ServiceOrder
- modified:
id
- marked as requiredstate
- marked as requiredorderDate
- marked as requiredserviceOrderItem
- marked as required, added minItems=1
ServiceOrder_Common
:- added:
coordinatedAction
relatedContactInformation
- modified:
requestedStartDate
- marked as requiredrequestedCompletionDate
- marked as required- removed:
notificationContact
- to be provided viarelatedContactInformation
relatedParty
- replaced withrelatedContactInformation
ServiceOrder
:serviceOrderItem
- added minItems=1
Note
: renamed toNote_BusSof
- added:
id
source
- removed:
system
- all attributes marked as required
ServiceOrderItem_Common
note
- addedservice
- changed toServiceValue
- marked as required:
id
action
service
ServiceOrderItem
:state
- marked as requiredterminationError
- added
ServiceOrderRelationship
:relationshipType
- changed to string instead of enum.serviceOrder
- renamed toserviceOrderItem
ServiceRelationship
:relationshipType
- removed enum, marked as required,service
- marked as required
ServiceValue
:- added:
relatedContactInformation
externalId
- removed:
category
relatedParty
serviceOrderItem
supportingService
supportingResource
- modified:
place
- ref type changed toRelatedPlaceRefOrValue
- Added types:
Note_BusSof
RelatedContactInformation
RelatedPlaceRefOrValue
FieldedAddress
FieldedAddressValue
FormattedAddress
GeographicAddressLabel
GeographicAddressRef
GeographicSiteRef
OrderCoordinatedAction
OrderItemCoordinatedAction
OrderItemCoordinationDependencyType
Duration
TerminationError
TimeUnit
ServiceActionType
- Removed types:
ActionType
- replace with ServiceActionTypeAddressable
Extensible
OrderRelationshipType
OrderItemRelationshipType
Place
Referenceable
RelatedPartyRef
ResourceRef
ServiceCreate
- replaced withServiceValue
ServiceRelationshipType
ServiceSpecificationRef
serviceOrderingNotification.api.yaml:
- paths:
/listener/serviceOrderCreateNotification
- renamed to/listener/serviceOrderCreateEvent
/listener/serviceOrderStateChangeNotification
- renamed to/listener/serviceOrderStateChangeEvent
/listener/serviceOrderItemStateChangeNotification
- renamed to/listener/serviceOrderItemStateChangeEvent
/listener/serviceOrderInformationRequiredEvent
- added
ServiceOrderCreateNotification
- replaced withServiceOrderEvent
ServiceOrderStateChangeNotification
- replaced withServiceOrderEvent
ServiceOrderItemStateChangeNotification
- replaced withServiceOrderEvent
ServiceOrderEventPayload
- addedServiceOrderEventType
- added