Data Entities API

A data entity is a thing the project keeps records of: a customer, an order, a branch, a shipment. Each carries its fields with their type, flags, validation and an example, the component whose records they are, the member who answers for it, whether it holds personal data and how long it is kept. Entities and fields are the data dictionary: requirements and business rules will name them, the API contracts and the database designs are read against them, and Heimdall reads them when it drafts stories, rules and test data.

The reads here see the entities of the projects the token may see; a client guest's token sees the approved entities only. An entity outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. A listing carries each entity's field count and a single entity carries its fields in order. Every write runs the same action the Data Entities page runs, under the project permissions, and announces itself as a data_entity.* event.

EndpointsCopy Anchor Link

Related

Projects APIThe project an entity belongs to.Components APIThe component whose records an entity's rows are.Glossary APIThe other half of the dictionary, the words the project agrees on.Activity APIWhat changed on an entity and who did it.data_entity.* eventsThe lifecycle of a project's data dictionary: an entity created, changed, moved along its review, its fields replaced and the entity deleted.