Overview

1 Overview

This document provides information that you can use when working with the Oracle Communications Unified Inventory Management (UIM) application programming interfaces (APIs). This document also provides information that you can use when working with NFV Orchestration Java manager APIs which are also UIM APIs. The UIM APIs can be extended through custom code. The APIs, or extended APIs, can be called from various places, such as from custom rulesets, custom web services, or customized portions of the user interface (UI).

This document provides information on common tasks you need to do when working with any of the UIM APIs, such as working with transactions, handling errors, and logging messages. This information is described in Working with Transactions, Exceptions, and Logging.

The bulk of this document is an overview of numerous UIM APIs, which were specifically selected to describe API usage patterns and best practices for implementing common business scenarios. Code samples are provided to show correct usage of the APIs and expectations of implementing the APIs. This information is described in Implementing a Generic Service Fulfillment Scenario and Implementing a Channelized Connectivity Enablement Scenario.

This document also provides a listing of the following:

UIM entity manager classes. See "UIM Entity Managers" for more information.
NFV Orchestration Java managers. See "NFV Orchestration Java Managers" for more information.
Code examples for common utility methods. See "Common Utility Code Examples" for more information.
Frequently used APIs. See "Frequently Used APIs for Design and Assign Methods" for more information.

This document does not cover detailed Javadoc information, nor does it cover model and domain information provided in other UIM documentation. This document assumes that you are familiar with UIM functionality, and are planning to extend UIM functionality by implementing a custom solution based on information provided in UIM Developer's Guide or UIM NFV Orchestration Implementation Guide.