Order Management System REST API - Event Audit Controller
The event/audit/fromposition URL provides access to the events generated by OMS views.
Retrieve events between a position and a timestamp
Section titled “Retrieve events between a position and a timestamp”GET /event/audit/fromposition
Retrieves the events between a position and a timestamp in the event stream for the requested views.
Requires the Audit feature permission.
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
from[<seq>] | Optional | An integer. The starting position of a sequence (exclusive). Repeat for each feed involved in OMS. If omitted, defaults to 0 for all feeds. |
| to | Optional | An ISO8601 date and time. The most recent timestamp to return (inclusive). If omitted, defaults to now. |
| count | Optional | An integer. The maximum number of records to return. If omitted, returns every record. |
| for | Optional | The SubscriptionType to return events for. Repeat for additional views. If omitted, supplies events for all views. |
| snapshot | Optional | True to include starting snapshot events for the requested views. If omitted or false, no snapshot is supplied. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is an array of AuditRecord objects. |
| 403 | Failure | You do not have permission to read the update stream. |
Examples
Section titled “Examples”In this example, we retrieve the first 100 Transaction events between the most recent events seen for each sequence, and a set timestamp.
curl --oauth2-bearer $AccessToken http://oms.hub/event/audit/fromposition?from[prodigy]=1&from[oms]=100&from[foundry]=10&to=20050101T123000Z&count=100&for=Transactions