...
- serialNumber allows a client to pull new changes by indicating the last change it saw. As such, the value must be comparable, with later events having later serial numbers.
- sor designates the system of record that triggered the change.
- entity is a reference to a resource obtainable via the Read API.
- timestamp is when the event was recorded, which is not necessarily when the change happened.
- comment is an optional human readable comment describing the change.
- TBD: Can a client send a filter to restrict the events it wishes to see?
An individual event can be retrieved by ID, or via a special request for the latest event.
Code Block |
---|
GET /v1/events/<serialnumber>
200 OK
{
"serialNumber":103,
"sor":"registry",
"entity":"/v1/people/enterprise/49873",
"timestamp":"2012-10-04T03:10:14.123Z",
"comment":"Updated name"
} |
Code Block |
---|
GET /v1/events/latest
200 OK
{
"serialNumber":103,
"sor":"registry",
"entity":"/v1/people/enterprise/49873",
"timestamp":"2012-10-04T03:10:14.123Z",
"comment":"Updated name"
} |
Push
In push operation, the Registry sends changes to an endpoint (presumably a message queue or something similar):
...