ODS Web Service Guide
The intent of this document is to provide an overview of the web-services and the endpoints used in ODS application. ODS internally interacts with OIPA over a secured REST service call.
Customer Support
If you have any questions about the installation or use of our products, please visit the My Oracle Support website: https://support.oracle.com, or call (800) 223-1711.
Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/us/corporate/accessibility/support/index.html#info
or visit http://www.oracle.com/us/corporate/accessibility/support/index.html#trs if you are hearing impaired.
OIPA REST Endpoints
The purpose of the following OIPA REST endpoints is to provide OIPA data model to ODS without directly accessing the OIPA instance database. The data model that OIPA returns to ODS through these services is based on customer configuration of rules and screens. The intent of these services is to return the configured data structure and not the instance data.
- processLogin - This service provides a mechanism for ODS users to authenticate against OIPA application.The endpoint is responsible to ensure authentication and authorization of the logged in user, before OIPA can send the data structure back to the ODS application. The authentication is done using token based approach of oAuth 1.0. The service ensures that a logged in user is in appropriate security group and has access to execute this service endpoint.
- getOdsMetaData - This service provides a mechanism to retrieve OIPA meta-data and DDL structure based on the defined configuration of business rules and screen rules for OIPA entities. The call is initiated by ODS to OIPA requesting data structure in entirety. An entity is any OIPA business object that maps to the underlying data model, business rules or screen rules.
For example: Policy, Client, Plan, Segments, Agreement etc. Since there are lot of entities in OIPA, each entity is submitted to a thread pool, where a thread is assigned to pull it's meta-data and configured DDL structure based on it's screen rule or business rule configuration in OIPA. Once the thread is ready with an entity's data model, a response is sent back to ODS. This one single response is termed as "Chunk". Once all the chunks of OIPA data structure are received for each entity, that completes the data model.
- validateSession - In order for continuous communication between ODS and OIPA and data-structure exchange, a session is established on the OIPA end. Each time a request is sent to OIPA and a response is sent back it is validated against a session ID. The session ID ensures continuous conversational state between ODS and OIPA.
ODS REST Endpoints
- processLogin - Provides a mechanism for ODS users to authenticate against OIPA application.The endpoint internally invokes OIPA's processLogin endpoint. At ODS level, it just serves as a wrapper end-point.
- processInitializeRun - The services initializes the run detail table, with all the relevant run statuses. A run is an execution task that perform certain activities in ODS.
- processAdd - The service loads and displays various run types, such as "Initial run", "Subsequent run" on screen.
- processOk - The service allows user to select a run type and add it to the system.
- processRun - The service allows to execute or process a particular run type. Each process run depending on run type (Initial or Subsequent ) will internally invoke other service calls to get the data required for that particular run type. Internally, processRun invokes an orchestration layer of ODS whose job is to orchestrate various internal method calls to prepare data required by the run.
Web Service Authentication
As part of web service security each web service URL or endpoint is authenticated. ODSService being a new service, it should have at least one primary company belonging to ODS security group. Any user added to that particular security group would be authorized to login to the ODS application.