entity.get · Umwelt docs

Reference/Queries/entity.get

entity.getquerysince 0.1

One entity by its id, as stored.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.get '{
  "projectId": "ball",
  "entityId": "bob"
}'

Request

const result = await client.entityGet({ projectId: 'ball', entityId: 'bob' });

Request

var result = engine.EntityGet(new EntityId { ProjectId = "ball", EntityIdValue = "bob" });

Response

{
  "id": "bob",
  "projectId": "ball",
  "name": "Bob",
  "aliases": ["the masked guest"],
  "typeId": "person",
  "archived": false,
  "createdAt": { "tick": 0 },
  "fields": {}
}

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`entityId`required	string	The entity, by its engine id.

Result

Field	Type	Description
`id`always	string	The entity’s id, given or generated.
`projectId`always	string	The project it belongs to.
`typeId`always	string	Its entity type, which decides whether it can hold knowledge.
`name`always	string	Its name.
`aliases`	string[]	Other names it goes by.
`fields`	object	Values for the fields its type declares.
`externalRef`	ExternalRef	The id another system gives it: `{ system, id }`.
`createdAt`always	Position	The position it exists from. Defaults to `{ "tick": 0 }`.
`archived`always	boolean	Set by `entity.archive`. It changes nothing else.

Rules

The stored entity, not a position. Its own name and aliases. For the names canon gives it at a point in the story, read entity.at.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project or entity does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also