REST API for Oracle Communications Unified Inventory Management

Resource Inventory Management

Oracle Communications Unified Inventory Management (UIM) includes a REST API that meets the TMF639 Resource Inventory OPEN API Specification for GET, POST, and DELETE methods.

These UIM resources support the GET, POST, and DELETE methods:

LogicalDevice
DeviceInterface
LogicalDeviceAccount
TelephoneNumber
PhysicalDevice
PhysicalPort
PhysicalConnector
Equipment
EquipmentHolder (only GET)
IPV4Network
IPV6Network
IPV4Subnet
IPV6Subnet
IPV4Address
IPV6Address
FlowIdentifier
NetworkAddressDomain
CustomObject
CustomNetworkAddress

Note the following when working with these resources:

The ID of each resource has a prefix of BusinessIdentifier. Below are the BusinessIdentifiers of each resource:
- LogicalDevice(1),
- PhysicalDevice(4),
- Equipment(8),
- PhysicalConnector(9),
- PhysicalPort(10),
- EquipmentHolder(11),
- CustomObject(12),
- DeviceInterface(20),
- TelephoneNumber(21),
- LogicalDeviceAccount(22),
- IPNetwork(23),
- IPSubnet(24),
- NetworkAddressDomain(25),
- IPv4Address(26),
- IPv6Address(27),
- FlowIdentifier(28),
- CustomNetworkAddress(29)
The Category field applies to the LogicalDevice, TelephoneNumber, and Equipment resources. For LogicalDevice and TeleponeNumber, the Category field is mapped to a resource characteristic and is configured in the system-config.properties file. See Configurations.
Resource Inventory Management follows a polymorphic pattern. Endpoints are exposed on a base resource as well as on concrete resources, which give the same result. For example, these sets of endpoints all give the same result.
```
GET ALL :
	GET /resource?@type=LogicalDevice
	GET /logicalDevice
GET BY ID:
	GET /resource/id
	GET /logicalDevice/id
```
where id is the ID of the logical device.
```
DELETE:
	DELETE /resource/id
	DELETE /logicalDevice/id
```
where id is the ID of the logical device.
```
POST:
	POST /resource
	POST /logicalDevice
```
The request body contains the discriminator "@type" of "LogicalDevice".