Extracting Data from the Platform
Overview of Data Extraction
Integrators may want to extract data from the Corastone platform to synchronize with their back-office systems or to generate reports. Corastone records all events that occur on a node with our event sequencer engine. Each event is timestamped and categorized as one of the following types:
transaction: event that causes a change to data and can trigger background jobs
error: event generated when an action fails
job: event that performs a task
orchestration: event that coordinates transaction execution
Use Corastone API endpoints to access this event log. The Sequencer API provides filters that enable you to specify criteria for fetching these events. You can then use the corresponding getters to extract the event details.
Using the Sequencer API
To synchronize your back-office systems to reflect changes made today, you could use the Sequencer API to return all events meeting the following criteria:
fromDate = <start date>
toDate = <end date>
transactionStatusFilter = success
The sequence of entries returned would include the IDs for all affected entities.
To extract the changed data, you would use:
Get <Entity> Details to retrieve the current snapshot of entity data
Get <Entity> History to retrieve the series of changes that led to the current state
Last updated
Was this helpful?