Skip to content

Terminology

Some terms we use to define pieces of the API, but which are not actually exposed in the API.

Objects

Top-Level Types

Any of the most critical top-level types this API is centered around, like Parties, Venues, and EventSeries

Owned-Nodes

Any Object type which under-the-hood maps to a Neo4j Node that is created specifically for supporting the "owner" node, as in the case of a Venue and an attached Name.

The Name node is considered an "Owned Node" because it is created specifically for a particular Venue, and is not available to connect to any other object. If the Venue were to be deleted, the Name could also safely be deleted based on this convention.

Hyper Edges

A Node created as a nexus point for multiple relationships, where a single relationship would suffice in a simpler version of the model. Representation, Appointment and Assignment are a few examples.

Category Nodes

Duplicative of the data-model definitions. Any of a group of Nodes which are created to be reused via connections, as in the case of Countries, or VenueTypes. These are not directly definable by Users, but Users are generally allowed to define connectivity to these Nodes.

Confidential. For internal use only.