Overview

The following list provides an overview of the integration points that are available for exchanging data with Oracle Health Insurance Product Definition:

The list is sorted on alphabetical order.

Notes

POST	/notes/{subject} creates a note.
POST	/notes/{subject}/{id} creates a new version of the note ('updates' the note).
GET	/generic/notes/{subject} retrieves the latest version of all notes for the subject.
GET	/generic/notes/{subject}/search enables a search within the subject.
GET	/generic/notes/{subject}/{id} retrieves the specific note for the subject.
GET	/generic/notes/{subject}/{masterId}/audit retrieves all versions of the note.

The {subject} is the technical id of the claim, the gid of the policy or the code of the authorization.

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.

Activities

POST	/activities creates an activity but does not start it.
POST	/activities/start creates and starts an activity.
POST	/activities/{activityId}/start starts the previously-created activity.
POST	/activities/{activityId}/recover recovers the failed activity.
GET	/activities/{activityId} retrieves the status of the activity.
GET	/activities/{activityId}/messages retrieves the result messages of an activity.

Oracle Health Insurance supports a generic activities API and a specific activities API.

The generic activities API supports the standard generic operations.
Oracle Health Insurance also supports generic APIs on

• /generic/groupaccountactivities

• /generic/basefinancialobjectactivities

• /generic/groupclientactivities

• /generic/financialtransactionsetactivities

• /generic/policyactivities

• /generic/connectorconfigurationactivities

• /generic/globalactivities.

These are all subsets of the data returned by the generic /activities API.

Add Product Service Definitions

POST	/addproductservicedefinitions creates or updates a product service definition.

Benefit specifications

POST	/benefitspecifications/purge purges unused benefit specifications.

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.

Data Sets

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

Extracts

POST	/extracts starts the extraction process.
GET	/extracts/{id} returns the status of the extraction process:.

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.

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 Points

GET	/outboundintegrationpoints retrieves the integration points with a configured endpoint.

Product Building Blocks

• This is a data file set integration point.

Products

POST	/createproductcopy creates a copy of the source product.
GET	/products/{id}/status fetches the status and validation status of a product.
GET	/products/{id}/validationstatus fetches the status of the validation process for the product.
GET	/products/{id}/buildstatus fetches the status of the build process for the product.
POST	/products/{id}/build builds the product.
POST	/products/{id}/validate validates the product.
PUT	/products/{id}/edit changes the status of the product to EDIT.
PUT	/products/{id}/test changes the status of the product to TEST.
PUT	/products/{id}/approve changes the status of the product to APPROVE.

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

Reference Sheet Lines

GET	/generic/referencesheetlines fetches the definition of the referencesheet resources including metadata and definition links for further details.
GET, PUT, DELETE, and PATCH	/generic/referencesheetlines/{reference-sheet-resource-name}/{id} support the standard functionality.
POST	/generic/referencesheetlines/{reference-sheet-resource-name}/search supports searching for reference sheet lines.

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.

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 creates or updates a person.
GET	/persons/{loginName} retrieves the user.
DELETE	/persons/{loginName} deletes the user