Content

Forms / External

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/forms/external

Method: GET

Authorisation: No authentication needed

Name	Type	Source
input	DTO_form_external_input	Query

Request body example

Response status: 200 (OK)

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

Response body example

Name	Type	ReadOnly	Description
key	String		Key
lang	String		Lang

Name	Type	Description
fields	DTO_field[]	Fields
group	DTO_reference	Group
main_language	DTO_translation_language	Main language
required_field_ids	Int32[]	Required field ids
color_primary	String	Color primary
color_secondary	String	Color secondary
language	String	For backwards compability. Remove in the future

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

Name	Type	ReadOnly	Description
id	Int32	ReadOnly	Leave empty on input
name	String		Name
code	String		Code
icon	String	ReadOnly	Icon
icon_sqare	String	ReadOnly	Icon sqare

GET Forms / External dynamic

POST Groups / Create