Enterprise APIs
The Originations Data Storage exposes the following business APIs as the REST endpoints. The table below summarizes the APIs.
Version 0.8.0
| Collection Name | Operation ID | URI | API Description | Table Description |
|---|---|---|---|---|
|
ms_entity_definition |
getEntityDefinitionById | /origination/storage/entities/{entityDefId}/ | Retrieves the latest version of an Entity Definition by id |
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. |
| createEntityDefinition | /origination/storage/entityDefinitions/ | Creates a new Entity Definition | ||
| updateEntityDefinitionById | /origination/storage/entities/{entityDefId}/ | Updates an Entity Definition by id | ||
| purgeProcessor | /origination/storage/maintenance/entityItems/purgeProcessor | Iterates through all Entity Definitions deleting Entity Items that are ready to be purged. | ||
| reminderProcessor | /origination/storage/maintenance/entityItems/reminderProcessor | Generate purge reminder event based around specified reminder times. | ||
|
ms_entity_item |
getEntityItemsByCode |
/origination/storage/entityDefinitions/{entityDefCode}/entityItems/ |
Retrieves all Entity Items for an Entity Definition |
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 filesystem, 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. |
| updateEntityItemEntry | /origination/storage/entityDefinitions/{entityDefCode}/entityItems/ | Updates an Entity Item Entry | ||
| deleteEntityItemsByCode |
/origination/storage/entityDefinitions/{entityDefCode}/entityItems/ |
Deletes all Entity Items for an Entity Definition | ||
| getEntityItem | /origination/storage/entityItems/ | Retrieves the Entity Item based on Definition, Key, Name, Type & (optional) Version, also retrieves entity items that were created between give startDate and endDate | ||
| updateEntityItem | /origination/storage/entityItems/ | Updates the latest version of an Entity Item based on Definition, Key, Name, Type | ||
| createEntityItem | /origination/storage/entityItems/ | Creates a new Entity Item | ||
| updateEntityItemsToLatest | /origination/storage/maintenance/entityDefinitions/{entityDefCode} | Updates all entityItems for a given entity Definition to the latest version. | ||
| purgeEntityItemByCodeKeyAndName | /origination/storage/maintenance/entityItem | Deletes an Entity Item based on code, key and name. | ||
| purgeEntityItems | /origination/storage/maintenance/entityItems | Deletes an Entity Items based on EntityDefCode, AnchorPoint & purgeDuration. | ||
| purgeEntityItemsByCodeAndKey | /origination/storage/maintenance/entityItems/{entityDefCode} | Deletes all Entity Items based on code & Key | ||
| ms_search_extract_data | getSearchExtractData | /origination/storage/searchExtracts | Retrieves the Entity Item extract data based on a search criteria. | The Storage Data Microservice 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