Browse the tools
Entities
An entity is one record of an entity type, such as one animal, kept in a vault. Its values follow the template version it was written with, which a correction never changes.
Tools
List the records of one entity type in one vault, such as the animals, a page at a time, by name, each with its values.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many records a page holds: 25 unless asked, 100 at most.
Look one record of an entity type up in a vault, such as an animal, with every value its template holds.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
entitystringrequired - The id of the record, as list-entities gives it.
Write down a new record of an entity type in a vault, such as an animal, on the template the vault uses for that type unless another template of the type is named. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.
-
namestringrequired - What the record is called.
-
structure_version_idintegeroptional - The id of the published version of one of your active templates for this entity type, as list-template-versions gives it, which says what the record holds. Left out, the record starts from the template the vault uses for that type.
-
fieldsobjectoptional - Values keyed by the field id get-template-version gives for the template the record starts from. A repeating group takes a list of repetitions, each as {values}, keyed by the ids of the fields inside the group. A field left out starts with its default.
Correct a record of an entity type, such as an animal: its name and the values of its template. The record stays on the template version it uses. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
entitystringrequired - The id of the record, as list-entities gives it.
-
namestringoptional - What the record is called.
-
fieldsobjectoptional - Values keyed by the field id get-entity gives. A repeating group takes a list of repetitions, each as {id, values}: the id is the row get-entity gives, and the values are keyed by the ids of the fields inside the group.