entityType.list · Umwelt docs

Reference/Queries/entityType.list

entityType.listquerysince 0.1

Every entity type of a project.

Command lineTypeScript.NET

Request

umwelt call story.umw entityType.list '{
  "projectId": "ball"
}'

Request

const result = await client.entityTypeList({ projectId: 'ball' });

Request

var result = engine.EntityTypeList(new ProjectId { ProjectIdValue = "ball" });

Response

[
  {
    "kind": "agent",
    "id": "person",
    "projectId": "ball",
    "name": "Person",
    "fields": []
  },
  {
    "kind": "group",
    "id": "staff",
    "projectId": "ball",
    "name": "Staff",
    "fields": []
  },
  {
    "kind": "other",
    "id": "thing",
    "projectId": "ball",
    "name": "Thing",
    "fields": []
  }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.

Result

A list of EntityType, each with:

Field	Type	Description
`id`always	string	The type’s id.
`projectId`always	string	The project it belongs to.
`name`always	string	Its name.
`kind`always	"agent" \| "group" \| "other"	`agent` and `group` can hold knowledge; `other` can only be talked about.
`fields`	FieldDef[]	The fields its entities carry.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Errors

See also