Events
HMC REST API Client must use this API to read a feed of events.
Resource
/rest/api/uom/EventEvery Event lists the following properties
| Event Attribute Type | Event Attribute | Definition of the Event Attribute. |
|---|---|---|
| EventTypeEnum | EventType | Defines the type of Event. |
| String | EventID | Defines the abstract unique id for the event. |
| String | EventData | Defines the Primary data for the event. |
| String | EventDetail | Defines the detailed data for the event. |
Event's Generic Purpose would be one among the following:
- INVALID_URI – A resource has been invalidated or replaced in the ElementHandle2Cache, and the client should reload it if they care.
- CACHE_CLEARED – essentially everything invalidated since the cache is cleared.
- MISSING_EVENTS – the client didn’t pull events fast enough.
- ADD_URI – a repository object, mapped to a resource was added.
- MODIFY_URI – a repository object, mapped to a resource was changed.
- DELETE_URI – a repository object, mapped to a resource was deleted.
Event semantics
- Events are Non-persistent.
- Events are timely (not meaningful to read long past when they occurred).
- Most events use a URI to specify which REST Resource they relate to.
- Reading events out of order is not meaningful.
