HIRO Domain Object API

The Domain Object API enables the client to:

The Domain Object API exposes the content of the HIRO Graph in terms of high-level domain-specific objects, such as Incident, House, etc, rather than in terms of low-level vertices and edges. In other words, a domain object is a sub-graph of the HIRO graph expressed as a JSON object. Domain objects are identified by an identifier that is guaranteed by the client to be unique on the client’s side. Through this identifier, objects can be created/updated and deleted.

As writing a domain object (that is, calling PUT /views/<viewid>/objects/<object-id>) can take a long time, these operations return a transaction. A transaction is a representation of the package of work implied by the operation, e.g., create vertex A, create vertex B, connect A with B through verb C. To get the current status of a transaction do GET /views/<viewid>/transaction/<transaction-id>.

Updates made to domain objects (made by some other user than the client) are readable at the /views/<viewid>/updates/<index> end-point on the REST API. This end-point can be read in three different ways. Either by explicitly indexing the update, e.g., GET /views/<viewid>/updates/<index>, or using a server-managed iterator, e.g., GET /views/<viewid>/updates/?iterator=<iterator-id>, or finally using websockets through the notification meachanism (see below). If the client needs to read updates in a random-access manner, use explicit indexing. If you prefer to read updates in a single bulk, use the iterator interface. Finally, if you wish to minimize latency use the websockets.