Reads one record by its ID.
- 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
- Open one record you know the ID of. See How it works.
Example prompts
- “Open shipment TFY000000001.”
- “Show the details of this driver.”
Reference
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
entity | string | yes | The object, as entities-list names it. |
id | string | yes | The record’s public ID, or its UUID for a data model record. |
Returns
id, display_value and data with the record’s fields.
Errors
- “Record not found.” The public ID is case-sensitive:
TFY…, nottfy…. - “Unknown entity.” with a hint.
- A refusal for an object that cannot be read.