Service Inventory Management

Oracle Communications Unified Inventory Management (UIM) includes a REST API that meets the TMF638 Service Inventory OPEN API Specification for the GET method. This API updates the existing resources of the services with new resources provided in the input.

This shows the supported service structures as well as the relationships between customer-facing services (CFSs), resource-facing services (RFSs), resources, and places.


CFS and RFS


Service structure

Follow these guidelines when creating your service specifications:

  1. Include the Category enum characteristic, indicating either CFS or RFS.

  2. Add links to other services in the inventory by using the serviceRelnumber and serviceRelationshipTypenumber string characteristics. This is useful for describing relies-on or relies-from relationship between CFSs.

    For example, serviceRel1 could include the name of the related service, and serviceRelationshipType1 could indicate the type of relationship such as relies-on or relies-from.

State Mapping

The predefined TM forum (TMF) states have been extended to include additional states for UIM. This table shows the mapping between the TMF states and the UIM states. The UIM REST API includes these TMF states in its responses.
SI No TMF State UIM State
1 feasibilityCheck N/A
2 designed PENDING
3 active IN_SERVICE
4 inactive SUSPENDED
5 terminated DISCONNECTED
6 pendingCancel (added) PENDING_CANCEL
7 Cancelled (added) CANCELLED
8 pendingDisconnect (added) PENDING_DISCONNECT
9 cancelPendingDisconnect (added) CANCEL_PENDING_DISCONNECT
10 reserved N/A