Shows one object’s fields, relations, what your role allows on it and its business actions, with the input each action takes. The assistant reads it before it creates or changes a record.
- Changes data: no
- Who can use it: Your role’s rights on that object in the “Entities” group of the role: “Read”.
What it is for
- Learn the fields, required values and list options before creating a record. See How it works.
- See how two data models are linked. See Data models.
Example prompts
- “Which fields does a shipment have?”
- “What can I do with a record of ‘Demo: Shipment request’?”
Reference
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
entity | string | yes | The object: a system name such as shipment, truck, facility, or dm:<data model> for your data model. entities-list gives the names. |
Returns
slug, label, fields, capabilities (what you can do with the object and the permission each needs), operations (each action with its input) and, for a data model, relationships with the ID to pass when linking.
Errors
- “Unknown entity.” with a hint to the right name.
- A refusal with the missing permission when your role cannot read the object.