BSS / External API
- David Perez Caparros
- michail salichos
- Adrian OSullivan
Owned by David Perez Caparros
BSS Portal to External API Framework Interface Design
Register BBS External OSS/BSS Listener
Register BBS External OSS/BSS Listener to Service Order State Notifications
POST
http://xx.yy.tt.rr:30274/nbi/api/v4/hub
{
"callback": "http://bbsportalhost:port/serviceOrderStateListener/listener/v1/",
"query":"eventType = ServiceOrderStateChangeNotification,ServiceOrderCreationNotification,ServiceOrderItemStateChangeNotification"
}Service Order Notifications
Note: Use @JsonIgnoreProperties(ignoreUnknown = true) to ignore fields that are not needed.
ServiceOrderItemStateChangeNotification
{
"eventType": "ServiceOrderItemStateChangeNotification",
"eventDate": "2019-02-21T14:21:31.740Z",
"eventId": "34556",
"event": {"id":"5c77b3bafdddde03cf30cde6","href":"serviceOrder/5c77b3bafdddde03cf30cde6","externalId":"extid2","state":"acknowledged","orderDate":"2019-02-28T10:11:06.410Z","completionDateTime":"2019-01-24T22:52:32.789Z","orderItem":[{"orderMessage":[],"id":"A","action":"add","state":"acknowledged","percentProgress":"0","@type":null,"@schemaLocation":null,"@baseType":null,"orderItemRelationship":[],"service":{"id":null,"href":null,"name":null,"serviceState":null,"@type":null,"@schemaLocation":null,"serviceCharacteristic":null,"serviceRelationship":null,"relatedParty":null,"serviceSpecification":{"id":"1e3feeb0-8e36-46c6-862c-236d9c626439","href":null,"name":null,"version":null,"targetServiceSchema":null,"@type":null,"@schemaLocation":null,"@baseType":null}},"orderItemMessage":[]},{"orderMessage":[],"id":"B","action":"add","state":"acknowledged","percentProgress":"0","@type":null,"@schemaLocation":null,"@baseType":null,"orderItemRelationship":[{"type":"reliesOn","id":"A"}],"service":{"id":null,"href":null,"name":null,"serviceState":null,"@type":null,"@schemaLocation":null,"serviceCharacteristic":null,"serviceRelationship":null,"relatedParty":null,"serviceSpecification":{"id":"1e3feeb0-8e36-46c6-862c-236d9c626439","href":null,"name":null,"version":null,"targetServiceSchema":null,"@type":null,"@schemaLocation":null,"@baseType":null}},"orderItemMessage":[]}]}
}ServiceOrderStateChangeNotification
{
"eventType": "ServiceOrderStateChangeNotification",
"eventDate": "2019-02-21T14:21:31.740Z",
"eventId": "34556",
"event": {"id": "5af2e0914bf3d66721c09c3f",
"href": "serviceOrder/5af2e0914bf3d66721c09c3f",
"externalId": "BBS_BSS_TrackindId3584 ",
"state": "COMPLETED",
"orderDate": "2019-02-21T13:39:20.540Z"
}
}Mapping of AAI-EVENT regarding service-instance to eventType
AAI-EVENT (Service-instance) | eventType |
|---|---|
CREATE | ServiceCreationNotification |
DELETE | ServiceRemoveNotification |
UPDATE | ServiceAtributeValueChangeNotification |
ServiceAtributeValueChangeNotification
{
"eventType": "ServiceAtributeValueChangeNotification",
"eventDate": "2019-02-26T13:78:89.564Z",
"eventId": "9c55b3bafdddde03cf30cde6",
"event": {"id": "506ba850-9c03-4f98-8bab-2f684a89fafb",
"name" : "bbs-cfs-1276",
"href": "service/506ba850-9c03-4f98-8bab-2f684a89fafb",
"state": "assigned",
"relatedParty": {
"id": "BBSCFSCustomerID1",
"name": "Joe Bob"
},
"type": "service-instance"
}
}