This guide provides information that you can use when working with Oracle Communications IP Service Activator application programming interfaces (APIs). The IP Service Activator 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 guide provides information about common things you need to do when working with any of the IP Service Activator APIs, such as working with transactions, handling errors, and logging messages.
The IP Service Activator APIs documented in this guide describe API usage patterns and best practices for implementing common business scenarios. Code samples are provided to show how to use the APIs and what to expect when implementing the APIs.
This guide provides information about managing configuration policies using the APIs, entity manager classes, and examples of code that show common methods.
This guide does not include detailed Javadoc information, nor does it cover model and domain information that are provided in other IP Service Activator documentation. This guide assumes that you are familiar with IP Service Activator functionality, and are planning to extend IP Service Activator functionality by implementing a custom solution based on information provided in IP Service Activator developer documentation.
The following APIs are provided with IP Service Activator and are documented in this guide:
OSS Java Development Library (OJDL) API: Allows you to use Java to develop or customize interfaces, including web-based or intranet-based user interfaces.
REST API: Allows you to create customized Groovy scripts with common REST methods that you can use to make calls through a REST web service interface to retrieve, update, delete, and create resources. You can use this API from Oracle Communications Order and Service Management (OSM) or any client that is capable of using the REST protocol.
Web Services API: Provides a web service interface through which OSM can manage service activation transactions. This web service is usable only from the activation task in OSM.