Content

Fields / List_ only aggregates

Returns unique values to be used in filter input.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/fields/aggregate

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source
field_keys	String[]	Query
filter	DTO_standard_filter	Query

Request body example

Response status: 200 (OK)

Response type: DTO_field[]

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	Description
sort_by_key	String	Sort by key
response_field_keys	String[]	Only return the fields specified
filters	String[]	Each string needs to be structured: filters=field_key:operator:value1\|value2\|value3 Only used to store filters for passing along as querystring
include_aggregations	Boolean	Include aggregations
include_imported	Boolean	Include imported
search	String	Search
sort_order	ENUM sort_order	Sort order
take	Int32	Take
page	Int32	Page

Name	Type	ReadOnly	Description
multi_option	DTO_field_multi_option		Used only when field type supports selection
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
id	Int32	ReadOnly	Leave empty when Creating object
label	String		Label
unique_key	String		Unique key
data_type	ENUM field_data_type		Data type
type	ENUM field_type		Type
validation_regex	String		RegEx pattern for client side validation
validation_error_message	String		Client side validation message if RexEx fails
icon_id	Int32		Icon id
icon_file	String		Icon file
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated
min_value	Double (nullable)		Used for Integers, Doubles, DateTimes (UnixTimeStamp)
max_value	Double (nullable)		Used for Integers, Doubles, DateTimes (UnixTimeStamp)
favorite	Boolean		Favorite
allow_in_external_forms	Boolean		Allow in external forms

Name	Type	Description
options	DTO_reference[]	Options
type	ENUM field_multi_option_type	Type
list_id	Int32	List id
field_id	Int32	Field id

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

Value	Name	Description
0	ASC	ASC
1	DESC	DESC

GET Fields / List

GET Fields / Get one by key