entity.resolve · Umwelt docs

Reference/Queries/entity.resolve

entity.resolvequerysince 0.1

Finds an entity by the id another system gives it.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.resolve '{
  "projectId": "ball",
  "externalRef": { "system": "game", "id": "npc-12" }
}'

Request

const result = await client.entityResolve({ projectId: 'ball', externalRef: { system: 'game', id: 'npc-12' } });

Request

var result = engine.EntityResolve(new ResolveEntityPayload
{
    ProjectId = "ball",
    ExternalRef = new ExternalRef { System = "game", Id = "npc-12" },
});

Response

{
  "id": "guard",
  "projectId": "ball",
  "name": "The guard",
  "aliases": [],
  "typeId": "person",
  "archived": false,
  "createdAt": { "tick": 0 },
  "externalRef": { "id": "npc-12", "system": "game" },
  "fields": {}
}

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`externalRef`required	ExternalRef	The reference: `{ system, 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

One reference, one entity. An external reference is unique per project.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project does not exist, or no entity has the reference.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also