entity.list · Umwelt docs

Reference/Queries/entity.list

entity.listquerysince 0.1

Every entity of a project, archived ones included, by id.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.list '{
  "projectId": "ball",
  "page": { "limit": 2 }
}'

Request

const result = await client.entityList({ projectId: 'ball', page: { limit: 2 } });

Request

var result = engine.EntityList(new PagedProject { ProjectId = "ball", Page = new Page { Limit = 2 } });

Response

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

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`page`	Pagedefault {"limit":100}	How many items to return (`limit`, 1 to 1000) and where to continue (`cursor`, the `nextCursor` of the previous page).

Result

Field	Type	Description
`items`always	Entity[]	The entities, ordered by id.
`nextCursor`	string	More entities follow; pass it as `page.cursor`.

Rules

Ordered by id. The cursor keeps that order, so it stays valid when entities are added.

Errors

VALIDATION_FAILEDThe payload is malformed, or the page limit is outside 1 to 1000.

NOT_FOUNDThe project does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also