axis.list · Umwelt docs

Reference/Queries/axis.list

axis.listquerysince 0.1

Every additional time axis of a project.

Command lineTypeScript.NET

Request

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

Request

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

Request

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

Response

[
  { "id": "reading", "label": "Reading order" }
]

Payload

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

A list of AxisDef, each with:

Field	Type	Description
`id`always	string	The axis id, used in `on` and in `at.axis`.
`label`always	string	How it reads, such as “Reading order”.

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.