Overview

The following is a list of integration points available to exchange data with the application:

The list is sorted in 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.

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.

Authorizations

PUT	/authorizations creates or updates an authorization.
PUT	/authorizations/submit creates or updates an authorization and submits it for processing.
GET	/authorizations/{id} retrieves an authorization by its id.
POST	/authorizations/{id}/submit submits an earlier created or updated authorization for processing.
POST	/authorizations/{id}/deny denies a pended authorization.
POST	/authorizations/{id}/tochange brings a pended authorization back into the change status.
POST	/authorizations/{id}/unfinalize brings an approved or denied authorization back into the change status.
GET	/authorizations/{id}/status fetches the current processing state of an particular authorization.
GET	/authorizations/{code}/attachedData fetches attached data for the authorization.
PUT	/authorizations/{code}/attachedData creates or updates attached data on the authorization.

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

In addition to the standard generic API operations, the /generic/authorizations API supports the following operations:

GET	/generic/authorizations/key/{key} retrieves an authorization by its authorization code.
PATCH	/generic/authorizations/key/{key} updates an authorization by its authorization code.

Banks

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

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.

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

Callout

The callout request can only be send as part of authorization processing. The callout only supports synchronous interactions.

Callout Rules and Callout History can be accessed through the generic APIs.

GET	/generic/calloutrules configures the callout rules.
GET	/generic/authorizationcallouthistory retrieves the callout history.

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 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.

Data Replication

GET	/replicationentities returns entities and their configuration.
GET	/replicationentities/{entity} returns configuration details of the specified entity.
PUT	/replicationentities/{entity} changes configuration of the specified entity. Enables or disables change tracking on the specified entity. Does not change any detail of the entity. The integration point ignores requests for changes to any entity’s details.
GET	/replicationevents/{entity} returns the replication events that a source application logs for a specific entity.

Diagnoses

PUT	/diagnoses creates or updates a diagnosis.
GET	/diagnoses/{id} retrieves the diagnosis.

Dynamic Logic

Invalidate Dynamic Logic

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

Test Dynamic Logic

POST	/testdynamiclogic/{dynamicLogicCode} xx

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.

Enrollment

Table 1. Enrollment

GET	/enrollment enables the authorization flow to send a request to a pre-configured URI for enrollment information. The application receives and stores the response to use in the authorizations flow.

Events

Table 2. Events

GET	/events enables the authorization flow to publish event messages to an external application.

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.

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.

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

Organizations

PUT	/organizations creates or updates an organization.
GET	/organizations/{id} retrieves an organization by its ID.

In addition to the standard generic API operations, the generic organizations API supports the GET and the PATCH operations on /generic/organizations/key/{key}. This enables retrieving and updating an organization based on its code (the {key}).

Outbound Integration Points

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

Persons

PUT	/persons creates or updates a person.
GET	/persons/{id} retrieves a person by its id.

In addition to the standard generic API operations, the generic persons API supports the GET and the PATCH operations on /generic/persons/key/{key}. This enables retrieving and updating a person based on its code (the {\key}).

Procedures

PUT	/procedures creates or updates a procedure.
GET	/procedures/{id} retrieves the procedure.

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

Providers

Individual Providers
PUT	individualproviders creates an individual provider.
GET	individualproviders/{id}` retrieves the individual provider.
Organizational Providers
PUT	organizationalproviders creates an individual provider.
GET	organziationalproviders/{id} retrieves the organizational provider.

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.

Relations

The generic relations API supports, in addition to the standard generic API operations, the GET operation on /generic/relations/{id} and /generic/relations/key/{key}. This enables retrieving a relation based on its id or on its code (the key).

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