entity.archive · Umwelt docs

Reference/Commands/entity.archive

entity.archivecommandsince 0.1

Marks an entity as archived.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.archive '{
  "projectId": "ball",
  "entityId": "guard"
}'

Request

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

Request

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

Response

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

Payload

Field	Type	Description
`projectId`required	string	The project to write to.
`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

Archiving changes nothing else. The entity keeps its records, stays listed and readable, and can still be referenced. What archived means is your application’s decision.

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