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, PATCH, and DELETE methods.

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

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

Note:

PipeTerminationPoints support only GET and PATCH methods.

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)
- Pipe(30)
- PipeTerminationPoints(32)
- Connectivity(31)
The Category field applies to the LogicalDevice, TelephoneNumber, and Equipment resources. For LogicalDevice and TelephoneNumber, 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
```
where id is the ID of the logical device.
```
PATCH:
	PATCH /resource/id
	PATCH /logicalDevice/id
```
where id is the ID of the logical device.

The request body contains the discriminator "@type" of "LogicalDevice".
Processing a Connectivity Design version is an explicit operation for Connectivity resource. Therefore, these task APIs are not supported on the /resource URL.
The PATCH operations are performed as Merge patch and JSON patch. See "Supported Methods" for the corresponding content types. The request formats for the Merge patch and JSON patch operations are different. See the corresponding examples for the sample formats. A JSON patch request supports sequential ADD, REMOVE, and REPLACE operations on the individual attributes. The JSON patch request is always an array, irrespective of the number of update operations performed.

Note:

The REPLACE and REMOVE operations cannot be performed on the attributes with NULL values.