Describe the workspace database's built-in tables, columns, keys and the API resource behind each
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”Success
object
How each logical kind is stored.
object
object
object
The full path of the collection, for example /api/v1/tasks.
The sorts the list accepts, in the order it accepts them (convention first, then the natural fields); empty when the list takes no sort.
object
A value the list’s sort parameter accepts: a column of the record or a derived field.
The logical kind of the sort value (see kinds): timestamp, uuid, text or integer.
True when an index serves this sort. False is a stated cost: the database sorts the organisation’s live rows in a temporary b-tree.
object
The declared SQL type, as the database reports it (TEXT, INTEGER).
The logical kind (see kinds), or null if the code does not know the column.
The declared default expression, or null.
The allowed values when the record schema declares an enum for the field.
True when the column is a field of the API record of the table’s resource.
The table and primary-key column this column points at.
object
Record fields computed from other tables when read; not columns.
object
The logical kind of the value (see kinds).
Derived fields are computed when the record is read and can never be written.
The scope needed to see the field (it is absent from the record without it), or null.
The list filters on this field.
Whether the list can be sorted by this field.