Skip to main content
GET
The columns a form may ask for, generated from the model, with where the tenant arranged them.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

entity
string
column_name
string
label
string
data_type
string
is_required
string
requires_answer
string
requires_leaf
string
is_nullable
string
default_value
string
is_immutable
string
server_assigned
string
references_entity
string
references_title_column
string
references_label
string
references_allows_create
string
scope_column
string
scope_target_column
string
references_by_name
string
files_against
string
allowed_values
string
sort_order
string
section
string
section_label
string
section_hint
string
hint
string
widget
string
companion_column
string
is_hidden
string
hidden_by_tenant
string
frozen_by_tenant
string
visible_when_column
string
visible_when_values
string
visible_when_empty
string
owned_by_action
string
companion_references_entity
string
is_scannable
string
references_is_scannable
string
contributes_defaults
string
may_edit
string
hidden_from_caller
string
on_create_form
string
on_edit_form
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

allowed_values
string[]
column_name
string<character varying>
Maximum string length: 63
companion_column
string<character varying>
Maximum string length: 63
companion_references_entity
string<character varying>
Maximum string length: 80
contributes_defaults
boolean<boolean>
data_type
string<character varying>
Maximum string length: 40
default_value
string<text>
entity
string<character varying>

Note: This is a Foreign Key to custom_field_entities.entity.

Maximum string length: 80
files_against
boolean<boolean>
frozen_by_tenant
boolean<boolean>
hidden_by_tenant
boolean<boolean>
hidden_from_caller
boolean<boolean>
hint
string<text>
is_hidden
boolean<boolean>
is_immutable
boolean<boolean>
is_nullable
boolean<boolean>
is_required
boolean<boolean>
is_scannable
boolean<boolean>
label
string<text>
may_edit
boolean<boolean>
on_create_form
boolean<boolean>
on_edit_form
boolean<boolean>
owned_by_action
string<text>
references_allows_create
boolean<boolean>
references_by_name
boolean<boolean>
references_entity
string<character varying>
Maximum string length: 80
references_is_scannable
boolean<boolean>
references_label
string<text>
references_title_column
string<character varying>
Maximum string length: 63
requires_answer
boolean<boolean>
requires_leaf
boolean<boolean>
scope_column
string<character varying>
Maximum string length: 63
scope_target_column
string<character varying>
Maximum string length: 63
section
string<character varying>
Maximum string length: 60
section_hint
string<text>
section_label
string<text>
server_assigned
boolean<boolean>
sort_order
integer<integer>
visible_when_column
string<character varying>
Maximum string length: 63
visible_when_empty
boolean<boolean>
visible_when_values
string[]
widget
string<character varying>
Maximum string length: 30