Overview

The following list provides an overview of the integration points that are available for exchanging data with {vbpComponent}:

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.

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.

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.

Capitation Contracts

GET	/capitationcontracts/{id}/summary returns a summary on calculation results per contract.

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.

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.

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

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.

Extract

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

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.

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.

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.

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.

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

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.