Enterprise APIs
The Originations Data Storage exposes the following business APIs as the REST endpoints. The table below summarizes the APIs.
Version 0.9.0
| Collection Name | Operation ID | URI | API Description | Table Description |
|---|---|---|---|---|
|
ms_entity_definition |
deleteEntityDefinitionByCode |
/origination/storage/entityDefinitions/ |
Deletes an Entity Definition based on code if there are no associated Entity Items. |
Intended for design time usage, an Entity Definition is first created to enable the persistence of Entity Items and also contains details on the maintenance such as purging details, reminders, etc. Entity Items are grouped within a single Entity Definition - Entity Definitions cannot be deleted if they have Entity Items associated with them. |
| deleteEntityDefinitionById | /origination/storage/entityDefinitions/{entityDefId}/ |
Deletes an Entity Definition based on Id if there are no associated Entity Items. |
||
| getEntityDefinitionByCode | /origination/storage/entityDefinitions/ |
Retrieves the latest version of an Entity Definition based on code. |
||
| getEntityDefinitionById | /origination/storage/entityDefinitions/{entityDefId}/ |
Retrieves the latest version of an Entity Definition by Id. |
||
| updateEntityDefinitionByCode | /origination/storage/entityDefinitions/ |
Updates an Entity Definition by code. |
||
| updateEntityDefinitionById | /origination/storage/entityDefinitions/{entityDefId}/ |
Updates an Entity Definition. |
||
| purgeProcessor | /origination/storage/maintenance/processors/ | Iterates through all Entity Definitions deleting Entity Items that are ready to be purged. | ||
| reminderProcessor | /origination/storage/maintenance/processors/ | Generate purge reminder event based around specified reminder times. | ||
|
ms_entity_item |
createEntityItem |
/origination/storage/entityItems/ |
Creates a new version of an Entity Item. |
Entity Items are intended to be used at runtime - they facilitate the persistence of in-flight date and are bound by the rules specified within the associated Entity Definition. An Entity Item cannot exist without a valid associated Entity Definition and version and it is similar to a file in a file system, they are grouped together via the composite [key, name, type] and will always have a valid Entity Definition relationship. When an Entity Item is first created, the Entity Item Entry can be included - for further Entity Item Entry changes the 'updateEntityItemEntry' specific endpoint must be used, calling 'updateEntityItem' and specifying an 'entry' will result in an error. |
| deleteEntityItems |
/origination/storage/entityDefinitions/{entityDefCode}/entityItems/ |
Deletes an Entity Items based on Definition, Key, Name, Type & (optional) Version. |
||
| deleteEntityItemById |
/origination/storage/entityItems/{entityItemId}/ |
Deletes an Entity Item by Id. |
||
| getEntityItemGroupByKey |
/origination/storage/entityItemGroup/{key} |
Retrieves an Entity Item Group by key. |
||
| getEntityItems |
/origination/storage/entityDefinitions/{entityDefCode}/entityItems/ |
Retrieves the Entity Items based on Definition, Keys, Names, Type & (optional) Version. |
||
| getEntityItemById |
/origination/storage/entityItems/{entityItemId}/ |
Retrieves the an Entity Item by Id. |
||
| updateEntityItemById |
/origination/storage/entityItems/{entityItemId}/ |
Updates an Entity Item by Id. |
||
| updateEntityItemEntry |
/origination/storage/entityItems/{entityItemId}/entry/ |
Updates an Entity Item Entry. |
||
| updateEntityItemsToLatest |
/origination/storage/maintenance/entityItems |
Updates all entityItems for a given entity Definition to the latest version. |
||
| purgeEntityItems |
/origination/storage/maintenance/entityItems |
Deletes an Entity Items based on EntityDefCode, AnchorPoint & purgeDuration. |
||
| ms_search_extract_data | getSearchExtractData | /origination/storage/entityItems/searchExtract | Retrieves the Entity Item extract data based on a search criteria. | The ODMS for performance allows specific fields within the Entity Item Entry payload to be extracted and used within searching, this is performed by specifying the Entity Definition searchpaths and stored within the ms_search_extract_data collection. |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
In this topic