{"componentChunkName":"component---src-templates-default-template-tsx","path":"/documentation/api/DomainObjectApi/Overview/","result":{"data":{"asciidoc":{"id":"a1a5abcb-6ea2-5876-b1b5-9fb53d6bba3a","html":"
\n

HIRO Domain Object API

\n
\n
\n

Overview

\n
\n

This section describes the Domain Object REST API from the point-of-view of a client of the API.

\n
\n
\n

Scope of the Domain Object API

\n
\n
\n\"DoapiConcept\n
\n
\n
\n
\n\"DoapiConcept\n
\n
\n
\n

The Domain Object API enables the client to:

\n
\n
\n
    \n
  • \n

    Write and update complex data structures to HIRO DB were they will be mapped to a graph structure (defined by a view definition). The view is defined in OGIT.

    \n
    • \n
  • \n

    Recieve information on the process of the write transactions (via the transactions endpoint).

    \n
    • \n
  • \n

    Recieve updates in a complex data structure for ticket data (mapped to ogit/Automation/AutomationIssue and the related IssueHistory by a view definition) via the updates endpoint.

    \n
    • \n
\n
\n
\n
\n

Domain Objects

\n
\n

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.

\n
\n
\n
\n

Ongoing writes to domain objects

\n
\n

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>.

\n
\n
\n
\n

Updates to domain objects

\n
\n

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.

\n
\n
\n
Notifications
\n
\n

A client can create a notification subscription using POST /views/<viewid>/notifications, which will allow a client to receive notifications when a transaction or domain object has been updated. Outstanding notifications are handled by the server, thus, a client can disconnect and receive any updates occurring while disconnected upon reconnect.

\n
\n
\n
\n
\n
\n
","document":{"main":"HIRO Domain Object API","title":"HIRO Domain Object API","subtitle":""},"fields":{"toc":false,"location":["documentation","api","DomainObjectApi","Overview"]}},"sidebarYaml":{"id":"6d066bdd-c982-5a69-b909-a31e6fc044e0","showIndex":null}},"pageContext":{"id":"a1a5abcb-6ea2-5876-b1b5-9fb53d6bba3a","parent":"documentation"}},"staticQueryHashes":["1010459453","1010459453","2356112386","2356112386","2603905930","2603905930","3026652197","3026652197","3167850324","3167850324","63159454","63159454"]}