REST API for Oracle Communications Unified Inventory Management

All REST Endpoints

Resource

Create, get, and delete UIM resources, such as equipment, logical devices, telephone numbers, and IP networks.

Create a Resource: Method: post
Path: /resource
Delete a Resource: Method: delete
Path: /resource/{id}
Get a Resource by ID: Method: get
Path: /resource/{id}
Get Resources: Method: get
Path: /resource

Resource/Custom Network Address

Create, get, and delete custom network addresses.

Create a Custom Network Address: Method: post
Path: /customNetworkAddress
Delete a Custom Network Address: Method: delete
Path: /customNetworkAddress/{id}
Get a Custom Network Address by ID: Method: get
Path: /customNetworkAddress/{id}
Get Custom Network Addresses: Method: get
Path: /customNetworkAddress

Resource/Custom Object

Create, get, and delete custom objects.

Create a Custom Object: Method: post
Path: /customObject
Delete a Custom Object: Method: delete
Path: /customObject/{id}
Get a Custom Object by ID: Method: get
Path: /customObject/{id}
Get Custom Objects: Method: get
Path: /customObject

Resource/Device Interface

Create, get, and delete device interfaces.

Create Device Interfaces: Method: post
Path: /deviceInterface
Delete a Device Interface: Method: delete
Path: /deviceInterface/{id}
Get a Device Interface by ID: Method: get
Path: /deviceInterface/{id}
Get Device Interfaces: Method: get
Path: /deviceInterface

Resource/Equipment

Create, get, and delete equipment.

Create an Equipment Entity: Method: post
Path: /equipment
Delete an Equipment Entity: Method: delete
Path: /equipment/{id}
Get an Equipment Entity by ID: Method: get
Path: /equipment/{id}
Get Equipment: Method: get
Path: /equipment

Resource/Equipment Holder

Get equipment holders.

Get Equipment Holder by ID: Method: get
Path: /equipmentHolder/{id}
Get Equipment Holders: Method: get
Path: /equipmentHolder

Resource/Equipment/Associated Resources

Get resources associated with equipment.

Get Physical Connectors by Equipment: Method: get
Path: /equipment/{id}/physicalConnectors
Get Physical Ports by Equipment: Method: get
Path: /equipment/{id}/physicalPorts

Resource/Flow Identifier

Create, get, and delete flow identifiers.

Create a Flow Identifier: Method: post
Path: /flowIdentifier
Delete a Flow Identifier: Method: delete
Path: /flowIdentifier/{id}
Get a Flow Identifier by ID: Method: get
Path: /flowIdentifier/{id}
Get Flow Identifiers: Method: get
Path: /flowIdentifier

Resource/IP Address Management/IP Address

Create, get, and delete IP addresses.

Create an IPv6 Address: Method: post
Path: /ipv6Address
Create IPv4 Addresses: Method: post
Path: /ipv4Address
Delete an IPv4 Address: Method: delete
Path: /ipv4Address/{id}
Delete an IPv6 Address: Method: delete
Path: /ipv6Address/{id}
Get an IPv4 Address by ID: Method: get
Path: /ipv4Address/{id}
Get an IPv6 Address by ID: Method: get
Path: /ipv6Address/{id}
Get IPv4 Addresses: Method: get
Path: /ipv4Address
Get IPv6 Addresses: Method: get
Path: /ipv6Address

Resource/IP Address Management/IP Network

Create, get, and delete IP networks.

Create an IP Network: Method: post
Path: /ipNetwork
Delete an IP Network: Method: delete
Path: /ipNetwork/{id}
Get an IP Network by ID: Method: get
Path: /ipNetwork/{id}
Get IP Networks: Method: get
Path: /ipNetwork

Resource/IP Address Management/IP Subnet

Create, get, and delete IP subnets.

Get an IP Subnet by ID: Method: get
Path: /ipSubnet/{id}
Get IP Subnets: Method: get
Path: /ipSubnet

Resource/IP Address Management/IP Subnet/Associated Resources

Get resources associated with IP subnets.

Get IPv4 Addresses by IP Subnet: Method: get
Path: /ipSubnet/IPV4/{id}/ipAddresses
Get IPv6 Addresses by IP Subnet: Method: get
Path: /ipSubnet/IPV6/{id}/ipAddresses

Resource/Logical Device

Create, get, and delete logical devices.

Create Logical Devices: Method: post
Path: /logicalDevice
Delete a Logical Device: Method: delete
Path: /logicalDevice/{id}
Get a Logical Device by ID: Method: get
Path: /logicalDevice/{id}
Get Logical Devices: Method: get
Path: /logicalDevice

Resource/Logical Device Account

Create, get, and delete logical device accounts.

Create Logical Device Accounts: Method: post
Path: /logicalDeviceAccount
Delete a Logical Device Account: Method: delete
Path: /logicalDeviceAccount/{id}
Get a Logical Device Account by ID: Method: get
Path: /logicalDeviceAccount/{id}
Get Logical Device Accounts: Method: get
Path: /logicalDeviceAccount

Resource/Logical Device/Associated Resources

Get resources associated with logical devices.

Get Device Interfaces by Logical Device: Method: get
Path: /logicalDevice/{id}/deviceInterfaces
Get Logical Device Accounts by Logical Device: Method: get
Path: /logicalDevice/{id}/logicalDeviceAccounts

Resource/Network Address Domain

Create, get, and delete network address domains.

Create a Network Address Domain: Method: post
Path: /networkAddressDomain
Delete a Network Address Domain: Method: delete
Path: /networkAddressDomain/{id}
Get a Network Address Domain by ID: Method: get
Path: /networkAddressDomain/{id}
Get Network Address Domains: Method: get
Path: /networkAddressDomain

Resource/Physical Connector

Create, get, and delete physical connectors.

Create a Physical Connector: Method: post
Path: /physicalConnector
Delete a Physical Connector: Method: delete
Path: /physicalConnector/{id}
Get a Physical Connector by ID: Method: get
Path: /physicalConnector/{id}
Get Physical Connectors: Method: get
Path: /physicalConnector

Resource/Physical Device

Create, get, and delete logical devices.

Create a Physical Device: Method: post
Path: /physicalDevice
Delete a Physical Device: Method: delete
Path: /physicalDevice/{id}
Get a Physical Device by ID: Method: get
Path: /physicalDevice/{id}
Get Physical Devices: Method: get
Path: /physicalDevice

Resource/Physical Device/Associated Resources

Get resources associated with physical devices.

Get Physical Connectors by Physical Device: Method: get
Path: /physicalDevice/{id}/physicalConnectors
Get Physical Ports by Physical Device: Method: get
Path: /physicalDevice/{id}/physicalPorts

Resource/Physical Port

Create, get, and delete physical ports.

Create a Physical Port: Method: post
Path: /physicalPort
Delete a Physical Port: Method: delete
Path: /physicalPort/{id}
Get Physical Port by ID: Method: get
Path: /physicalPort/{id}
Get Physical Ports: Method: get
Path: /physicalPort

Resource/Telephone Number

Create, get, and delete telephone numbers.

Create Telephone Numbers: Method: post
Path: /telephoneNumber
Delete a Telephone Number: Method: delete
Path: /telephoneNumber/{id}
Get a Telephone Number by ID: Method: get
Path: /telephoneNumber/{id}
Get All Telephone Numbers: Method: get
Path: /telephoneNumber

Service

Get services.

Get a Service by ID: Method: get
Path: /service/{id}
Get Services: Method: get
Path: /service