entity.update · Umwelt docs

Reference/Commands/entity.update

entity.updatecommandsince 0.1

Changes an entity’s name, aliases, fields or external reference.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.update '{
  "projectId": "ball",
  "entityId": "bob",
  "aliases": ["the masked guest"]
}'

Request

const result = await client.entityUpdate({ projectId: 'ball', entityId: 'bob', aliases: ['the masked guest'] });

Request

var result = engine.EntityUpdate(new UpdateEntityInput
{
    ProjectId = "ball",
    EntityId = "bob",
    Aliases = new() { "the masked guest" },
});

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 write to.
`entityId`required	string	The entity, by its engine id.
`aliases`	string[]	The new list of aliases. It replaces the old one.
`externalRef`	ExternalRef	A new external reference.
`fields`	object	The new field values, validated against the entity’s type.
`name`	string	A new name.

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

Only what is present changes. Its project, type and archived flag cannot be changed.

Names over time are records. This changes the entity itself. To have a name change at a point in the story, write umwelt:name or umwelt:alias Facts and read them with entity.at.

Errors

VALIDATION_FAILEDThe payload is malformed, or a field does not fit the type.

NOT_FOUNDThe project or entity does not exist.

CONFLICTThe external reference already belongs to another entity.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also