Overview

The following table provides an overview of the integration points that are available for exchanging data with Oracle Insurance Gateway:

The list is sorted on alphabetical order.

Click the triangle in front of the name of the integration point to reveal available operations. Click the name of the integration point to go to the description page of the integration point.

Access Tokens

POST	/accesstokens/accesstoken retrieves an OAuth2 access token.
POST	/accesstokens/newaccesstoken retrieves a new OAuth2 access token.
POST	/accesstokens/anticsrftoken retrieves an anticsrf token.

Agents

GET	/agent downloads an Agent jar file
GET	/agent/{version} checks if given Agent version matches the version of Gateway’s Agent jar file.

Base Views

POST	/baseviews (re)generates base views
POST	/baseviews/\{view name}/regenerate (re)generates the base views
DELETE	/baseviews/\{view name} deletes the base views

This a long running operation through REST. See, "HTTP API/IP Concepts" chapter of the Developer Guide for more information on the general concepts of these operations.

This integration point can display PII data in an entity using the property ohi.baseview.exclude.pii.

A POST request on http://[hostName]:[portNumber]/[api-context-root]/generic/baseviews/search retrieves information about the generated base views.

Credentials

GET	/credentials retrieves an overview of the REST clients
GET	/credentials/{code} retrieves the credential with this code.
PUT	/credentials/{code} creates or updates the credential with this code.
DELETE	/credentials/{code} removes the credentials for the credential key with this code.
GET	/credentials/export extracts a JSON file with credentials stored in secret.
POST	/credetials/import uploads a JSON file with credentials to an application.

s] .Data Sets

Details

POST	/import/datasetdefinition/{datasetDefinitionCode}/dataset/{dataSetCode} starts the data exchange import process.
POST	/import/datasetdefinition/{datasetDefinitionCode} starts the data exchange import process.
GET	/export/datasetdefinition/{datasetDefinitionCode}/dataset/{dataSetCode} retrieves the data set content.
POST	/export/datasetdefinition/{datasetDefinitionCode}/dataset/{dataSetCode} starts the data exchange export process.
POST	/createandexport/datasetdefinition/{datasetDefinitionCode}/dataset starts the full config migration and export process.
PATCH	/dataset/{id} updates the selected config migration set based on operation.
PUT	/datasetdefinition/{datasetDefinitionCode}/dataset creates or updates the config migration and export process.

Data File Sets

GET	/datafilesets retrieves all data file sets in the system
POST	/datafilesets creates the data file set with data files
PUT	/datafilesets updates the data file set with data files
POST	/datafilesets#multipart creates the data file set and uploads the zip file to it
GET	/datafilesets/{datafilesetcode} retrieves the data file set
POST	/datafilesets/{datafilesetcode} adds the data file to the data file set
DELETE	/datafilesets/{datafilesetcode} deletes the data file set
GET	/datafilesets/{datafilesetcode}/zip retrieves the zip file of the data file set
POST	/datafilesets/{datafilesetcode}/zip adds the zip file to the data file set
PUT	/datafilesets/{datafilesetcode}/zip zips the contents of all data files in the data file set
PUT	/datafilesets/{datafilesetcode}/unzip unzips the contents of all data files in the data file set
PUT	/datafilesets/{datafilesetcode}/datafiles updates the data file in the data file set
DELETE	/datafilesets/{datafilesetcode}/datafiles/{datafilecode} deletes the data file from the data file set
GET	/datafilesets/{datafilesetcode}/datafiles/{datafilecode}/data retrieves the data file content
POST	/datafilesets/{datafilesetcode}/datafiles/{datafilecode}/data adds the data file content

---

The generic datafilesets API supports, in addition to the standard generic API operations, the GET and the PATCH operation on /generic/datafilesets/key/{key}. This enables retrieving and updating a datafileset based on its datafileset code.

Dynamic Logic

Dynamic Logic Statistics

GET	/dynamiclogicstatistics retrieves the different links to see the dynamic logic statistics.
GET	/dynamiclogicstatistics/{dynamicLogicCode} retrieves the dynamic logic statistics based on provided Dynamic Logic Code.
GET	/dynamiclogicstatistics/elapsed retrieves Dynamic Logic Statistic data sorted over total elapsed time.
GET	/dynamiclogicstatistics/executions retrieves Dynamic Logic Statistics data sorted over total number of dynamic logic executions.
GET	/dynamiclogicstatistics/allocatedmemory retrieves Dynamic Logic Statistics data sorted over over total memory allocated.
GET	/dynamiclogicstatistics/reset clears the cache for Dynamic Logic Statistics data.

Invalidate Dynamic Logic

POST	http://<host>:<port>/<context-root>/dynamiclogic/invalidateall Invalidates all dynamic logic.

Test Dynamic Logic

POST	/testdynamiclogic/{dynamicLogicCode} xx

Eclipse

PUT	/eclipse/activate submits a request to activate the eclipse module.
GET	/eclipse/expirytimes gets the device expiry and key expiry for the eclipse module.
GET	/eclipse/pingagency request to ping agency.
GET	/eclipse/healthcheck check whether the eclipse module is activated or not.

Exchanges

POST	/exchanges/{\type}/{code} submits an integration with post parameters or a raw payload.
GET	/exchanges/{type}/{code} submits an integration with query parameters.
POST	/exchanges/{type}/{code}/withParameters submits an integration with parameters key/value pair that can be user defined
POST	/exchanges/{id}/signoff signs off the exchange. Mark the exchange as Completed.
POST	/exchanges/{id}/failure reports failure for the exchange. Mark the exchange as Failed.
POST	/exchanges/{id}/recover recovers a failed exchange. Marks the exchange as Started and resumes from the last failed step.

Events

POST	/events/{eventType} stores an event in the event store.
PUT	/events/{eventType} stores an event in the event store.

Integrations

GET	/integrations/{type}/{code}/validate requests on-line validation of the configuration of an integration with a max duration in seconds.

Key Stores

GET	/keystores/export exports keystore’s data from an older version of an application
POST	/keystores/import imports keystore’s data to the newer version of the application.

Non-Entity Cache

POST	/nonentitycache/invalidateall invalidates all the no-entity caches.

Notifications

POST	/notifications submits a notification to resume a notification based on correlation id.
PUT	/notifications submits a notification to resume a notification based on correlation id.
POST	/notifications/custom submits a notification to resume a notification based on correlation id. The schema is in a custom format.
PUT	/notifications/custom submits a notification to resume a notification based on correlation id. The schema is in a custom format.

OAuth2 Client Configuration

PUT	/{id}/setclientsecret cerates or updates the client secret.

Objects

GET	/objects/generate creates a zip file that is downloaded.

The following options are provided as query parameters to the above endpoint:

• includeDynamicData

• withSerialization

Outbound Integration Point

GET	/outboundintegrationpoints retrieves all endpoints an Oracle Health Insurance application sends messages to. This IP is a runtime catalogue that shows all outbound integration points, their endpoints and the endpoint characteristics.

Properties

Property Definitions

GET	/propertydefinitions returns system property definitions, including the relevant characteristics.
GET	/propertydefinitions?name=<prefix> returns the system property definitions, for which the name starts with the given prefix
GET	/propertydefinitions/<property> returns the system property definition, for which <property> is the exact name of the property

Current Properties

GET	/currentproperties returns all properties
GET	/currentproperties?name=<prefix> returns the properties for which the name starts with the given prefix
GET	/currentproperties/<property> returns the property for which <property> is the exact name of the property

http-integration-points/provider-limit-counter-integration-point.adoc

Unresolved include directive in modules/integration-points/pages/http-integration-points/integration-points-overview-oig.adoc - include::page$http-integration-points/provider-limit-counter-integration-point.adoc[]

Task Processing

GET	/tasksprocessing returns the status and statistics of the queue.
POST	/taskprocessing starts or stops the task queue.
GET	/tasksprocessing/{id}/restart restarts the task with this id.

---

The /generic/tasks API supports only search and retrieval operations.

Purge

POST	/purge/events requests the purge of events.
GET	/purge/events/{id} fetch the purge event resource by id.
POST	/purge/technicaldata requests the purge of technical data.
GET	/purge/technicaldata/{id} fetch the purge technical data resource by id.
POST	/purge/exchanges requests the purge of exchanges.
GET	/purge/exchanges/{id} fetch the purge exchange resource by id.

User Information

GET	http://[hostName]:[portNumber]/[api-context-root]/userinformation fetches the user information of the logged in user
`POST	http://[hostName]:[portNumber]/[api-context-root]/userinformation/userpreference updates the user preferences of the logged in user

User Provisioning

PUT	/users create or update a user
GET	/users/{loginName} retrieve the user
DELETE	/users/{loginName} delete the user