Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Eventuate Entities API

The Entities API from Eventuate — 2 operation(s) for entities.

Eventuate Entities API is one of 4 APIs that Eventuate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, {baseUrl}.

3 operations 2 paths 7 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
{baseUrl}
Contact
License
Resource Areas
1

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Entities 3
POST
/entity/{entityType}
Create an entity
createEntity 1 param body → 200
GET
/entity/{entityType}/{entityId}
Get an entity
getEntity 2 params → 200
POST
/entity/{entityType}/{entityId}
Update an entity
updateEntity 2 params body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Event (5 properties), CreateEntityResponse (3 properties), EntityWithEvents (3 properties), UpdateEntityRequest (2 properties). Each schema is shown below with its type and property counts.

EventData
object
2 properties 2 required
CreateEntityRequest
object
2 properties 2 required
UpdateEntityResponse
object
2 properties
EntityWithEvents
object
3 properties
Event
object
5 properties
UpdateEntityRequest
object
2 properties 2 required
CreateEntityResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eventuate-entities-api-openapi.yml Raw ↑

Other APIs Eventuate publishes across the network.

Eventuate Events API
Eventuate Subscriptions API
Eventuate System API