Overview

The following list provides an overview of the integration points that are available for exchanging data with Policies. 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.
POST	/activities/start creates and starts an activity.
POST	/activities/{activityId}/start starts the activity.
POST	/activities/{activityId}/recover recovers the failed activity.
GET	/activities/{activityId} retrieves the status of an activity.
GET	/activities/{activityId}/messages retrieves the result messages of an activity.

---

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

Apply Registrations

POST	/applyregistrations creates a long running operation for apply registration
GET	/applyregistrations/{id} retrieves the apply registration long running operation

Base Views

POST	/baseviews generates the base views.
POST	/{viewname}/regenerate regenerates the base view with given view name.
DELETE	/{viewname} drops the base view with the given view name.

Connector Configurations

POST	/connectorconfigurations/{id}/republishFailedMessages enables failed messages for republishing

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.

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	/credential/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 gets defined data file sets in the system.
POST	/datafilesets creates the data file set with dat files.
PUT	/datafilesets updates the data file set with dat 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

Data Replication synchronizes person data across multiple Oracle Health Insurance applications.

GET	/replicationentities returns an overview of the entities and their configuration details for which the system is able to track changes.
GET	/replicationentities/{entity} retrieves configuration details of the specified business entity.
PUT	/replicationentities/{entity} enables or disables change detection for the specified entity.

---

The integration point ignores GET request for changes to a disabled entity.
The PUT request does not change any detail of the entity. It only enables or disables change detection.

Data Masking Configuration

POST	/deidentificationmetadata creates a new DeIdentification Metadata.
PUT	/deidentificationmetadata/{id} updates an existing DeIdentification Metadata

Dynamic Logic

Invalidate Dynamic Logic
POST	/dynamiclogic/invalidateall invalidates all dynamic logic.
Test Dynamic Logic
POST	/testdynamiclogic/{dynamicLogicCode} executes the dynamic logic of signature Test Unit.

Dynamic Logic Statistics

GET	/dynamiclogicstatistics triggers the execution to get 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 Files

POST	/enrollmentfiles/{id}/accept creates an accept enrollment file entity to start the accept enrollment file processing.
GET	/enrollmentfiles/{id}/accept fetches the accept enrollment file long running operation by id.
POST	/enrollmentfiles/{id}/reject creates a reject enrollment file entity to start the reject enrollment file processing.
GET	/enrollmentfiles/{id}/reject fetches a reject enrollment file entity to start the reject enrollment file processing.
GET	/enrollmentfiles/{id}/operationstatus fetches the last long running operation status performed on the enrolment file.
GET	/enrollmentfiles/{id}/status returns counts of statuses of policies of the update requests of an enrollment file.
GET	/enrollmentfiles/{id}/events returns counts of enrollment events per business event definition display text of an enrollment file".

Extract

POST	/extracts starts the extract process.`
GET	/extracts/{id} retrieves status information on the extract process.

Enrollment Status Response

GET	/enrollments inquires about a person or object, including the time window and the line of business that the calling system is interested in.

Financial Messages

This integration point sends a notification message to an external system once the financial messages for a financial transaction set are written to the data file (see Generate Financial Message).
The financial message data file can be downloaded by using the "Get details of a data file" request from the Data File Set Integration Point.

Group Clients

PUT	/groupclients creates or updates a group client.
PUT	/groupclients/submit creates or updates a group client and submits for processing.
POST	/groupclients/{id}/submit submits the group client for processing.
POST	/groupclients/{id}/validate validates the group client for processing.
GET	/groupclients/{id} fetches a group client by id.
GET	/groupclients/{id}/status retrieves the status of the group client.

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

Group Hierarchy

GET	/grouphierarchy/groupclient/{id} returns the upward grouphierarchy for the group client.
GET	/grouphierarchy/groupaccount/{id} returns the upward grouphierarchy for the group account.
GET	/grouphierarchy/groupaccountproduct/{id} returns the upward grouphierarchy for the group account product.

Key Stores

POST	/keystores creates a keystore.
GET	/keystores retrieves a keystore.
DELETE	/keystores/{keystorename} deletes the keystore.
GET	/keystores/{keystorename}/keys retrieves the list of keys that are configured for the given keystore.
POST	/keystores/{keystorename}/keys creates a private and public key pair.
GET	/keystores/{keystorename}/keys/{alias} retrieves the PEM string representation of the public key certificate.
DELETE	/keystores/{keystorename}/keys/{alias} deletes a key pair form the key store.
POST	/keystores/{keystorename}/keys/{alias} imports a new certificate.
GET	/keystores/export extracts a JSON file with keystores stored in secret.
POST	/keystores/import uploads a JSON file with keystore to an application.

Macro Integration Point

POST	/macros invoke a macro.

Non-Entity Cache

POST

/nonentitycache/invalidateall invalidates and re-populates no-entity caches, such as Flex Code System Setup, Dynamic Field Setup, Field Details Setup, Dynamic Record Setup. Since these no-entities are cached during application startup, this is important for scenarios where there is a mismatch between the data in the Database and in the cache.

Notes, Group Account Notes, Group Client Notes

POST	/notes/{subject} creates a note.
POST	/notes/{subject}/{id} creates a new version of the note.
GET	/generic/notes/{subject} retrieves 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.
Group Account Notes
POST	/groupaccountnotes/{subject} creates a note.
POST	/groupaccountnotes/{subject}/{id} creates a new version of the note.
Group Client Notes
POST	/groupclientnotes/{subject} creates a note.
POST	/groupclietnotes/{subject}/{id} creates a new version of the note.

OAuth2 Client Configuration

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

Objects

GET	/objects/generate returns the object skeleton file.

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.

Policies

PUT	/policies creates or updates a policy.
PUT	/policies/submit creates or updates a policy and submits it for processing.
GET	/policies/{code}/attachedData fetches attached policy data on the policy.
PUT	/policies/{code}/attachedData updates attached policy data on the policy.
GET	/policies/{id} retrieves a policy by its unique identification.
POST	/policies/{id}/cancel provides the ability to cancel a policy.
POST	/policies/{id}/cancelwithinvoice provides the ability to cancel a policy and immediately produce an invoice for the cancelled policy.
GET	/policies/{id}/examplecalculation/{calculationInputDate} returns the calculations results of a policy valid on calculation input date, without storing the results of the calculation.
POST	/policies/{id}/fee generates fees and invoices for the policy.
POST	/policies/{id}/invoice calculates premium and creates invoices for the specified policy.
POST	/policies/{id}/mutation creates a mutation for a policy if it does not exist.
GET	/policies/{id}/nextcalculationcycles/{calculationInputDate} gets the information about next calculation cycles for a policy that uses policy calculation period based on premium calculation.
POST	/policies/{id}/processandapplyregistrations processes and applies registrations for a policy if applicable.
PUT	/policies/quote/{calculationInputDate} returns the calculations results of the policy request valid on calculation input date.
POST	/policies/{id}/revert reverts the policy.
POST	/policies/{id}/sampleinvoice calculates premium and creates invoices for the specified policy without persisting the results.
POST	/policies/{id}/sampleprocessandapplyregistrations sample processes and applies registrations for a policy if applicable.
GET	/policies/{id}/status returns the status of policy.
POST	/policies/{id}/submit submits a policy for processing.
POST	/policies/{id}/toedit brings the policy status to Edit.
POST	/policies/{id}/validate validates the policy

Policy Accounts

PUT	/policyaccounts creates or updates a policy account.
GET	/policyaccounts retrieves a policy account and its balance.

Policy Account Transactions

PUT	/policyaccounttransactions creates a policy account transaction.
GET	/policyaccounttransactions retrieves policy account transactions.
GET	/policyaccounttransactions/{id} retrieves the policy account transaction with this id.

The generic policy account transactions API supports, in addition to the standard generic API operations, the GET and the PATCH operation on /generic/policyaccounttransactions/key/{key}. This enables retrieving and updating a policy account transaction based on its authorization code (the {key}).

Policy Account Transaction List

This integration point creates policy account transactions from a data file. It requires sending in a data file and loading the file through the Load Policy Account Transactions activity.

Policy Enrollment Events

POST	/policyenrollmentevents creates one or more policy enrollment events.

Policy Update Request

PUT	/policyupdaterequests creates a policy update request with the payload of the Policy In Request.
PUT	/policyupdaterequests/{id}/apply applies a policy update request.
PUT	/policyupdaterequests/{id}/reject rejects a policy update request.
PUT	/policyupdaterequests/{id}/requeue re-queues a policy update request.

Properties

Properties The generic properties API supports, the standard generic API operations on properties.
Property definitions
GET	/properydefinitions/{propertyName} retrieves an overview of the Oracle Health Insurance system property definitions. Query parameters are: ** ?name=<prefix> (optional) Returning only the system property definitions that have their name starting with the given prefix.
GET	/properydefinitions/{propertyName} resource retrieves the system property definition with the given property name.
Current Properties
GET	/currentproperties retrieves all the properties currently set to value Query parameters are: ** ?name=<prefix> (optional) Returning only the properties that have their name starting with the given prefix.
GET	/currentproperties/{propertyName} retrieves the property with the given propertyName.

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.

Purge Policies

NOTE

The use of this resource in a production environment is strongly discouraged, as it may cause having financial messages in the system without the originating policies and policy changes.

POST	/purge/policies/id/{id} purges the policy.
POST	/purge/policies/code/{code} purges the policy.

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.

Registrations

The registration import is a long-running operation, a global activity which processes a data file.

Apply Registrations
POST	/applyregistrations creates the long running operation.
GET	/applyregistrations/{id} fetched=s the long-running operation
Process Registrations
POST	/processregistrations creates the long running operation.
GET	/processregistrations/{id} fetches the long-running operation

Relations (Persons, Organizations, and Banks)

Persons, organizations and banks use the same underlying data object, relations.

Persons

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

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

Organizations

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

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

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

Relations

The generic relations API supports, 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}). The generic relations API also supports, the POST operation on /generic/relations/search.

Replication Entities

GET	/replicationentities returns an overview of the entities and their configuration details for which the system is able to track changes.
GET	/replicationentities/{entity} retrieves configuration details for a specific business entity
PUT	/replicationentities/{entity} update the configuration details for a specific business entity

Replication Events

GET	/replicationevents/{id} retrieves the replication events that the source system logged for the given entity.

Revert Policy

POST	/revertpolicies creates a revert policy entity to start the reversal of multiple policies.
GET	/revertpolicies/{id} fetches the revert policy long running operation by id

User Information

GET	/userinformation retrieves the userinformation of the logged in user.
PUT	/userinformation/userpreference updates a user’s preferences.

User Provisioning

PUT	/users creates or updates a user.
GET	/users/{loginName} retrieves the user.
DELETE	/users/{loginName} deletes the user.

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

Workflow Event

The application sends out a "fire and forget" task event when a policy pends.
See Policy Workflow Integration Point (Fixed Payload) and Policy Workflow Integration Point (Configurable Payload).

Write Policies

POST	/writepolicies creates a write policy entity to start the fie processing.
GET	/writepolicies/{id} fetches import policy long running operation by id.
GET	/writepolicies/payload/definition fetches the structure of the file payload of policy import

Policy Update Requests

POST	/writepolicyupdaterequests creates a write policy update requestentity to start the fie processing.
GET	/writepolicyupdaterequests/{id} fetches the write policy update request long running operation by id.
GET	/writepolicyupdaterequests/payload/definition fetches the structure of the policy update request import