Content

Forms / Get one

Return specific form by id.

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

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source
id	Int32

Request body example

Response status: 200 (OK)

Response type: DTO_form

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

Response body example

Name	Type	ReadOnly	Description
group_access	DTO_group_access[]		Group access
sys_tags	DTO_reference[]		Label can be used on POST/PUT to create new tags
collect_to_list	DTO_reference		Collect to list
collect_to_group	DTO_reference		Collect to group
modules	DTO_form_module[]		Modules
logics	DTO_form_logic[]		Logics
language	DTO_reference		Language
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
id	Int32	ReadOnly	Leave empty on input
highest_group_permission	ENUM group_permission	ReadOnly	Highest group permission
name	String		Name
unique_key	String		Unique key
privacy	ENUM privacy		Privacy
collect_type	ENUM form_collect_type		Collect type
display_type	ENUM form_display_type		Display type
submit_text	String		Submit text
ticket_subject	String		Ticket subject
primary_color	String		Primary color
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Name	Type	ReadOnly	Description
permission	ENUM group_permission		Permission
id	Int32		Id
label	Object	ReadOnly	Label

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

Name	Type	Description
module_field	DTO_form_module_field	Module field
type	ENUM form_module_type	Type
text_primary	String	Text primary
text_secondary	String	Text secondary
enabled	Boolean	Enabled

Name	Type	Description
id	Int32	Id
label	String	Label
required	Boolean	Required

Name	Type	Description
triggers	DTO_form_logic_trigger[]	Triggers
action	DTO_form_logic_action	Action
logic_operator	ENUM form_logic_operator	Logic operator

Name	Type	ReadOnly	Description
module_field	DTO_reference		Module field
field_values	DTO_reference[]		Field values

Name	Type	Description
forward_to_module_field	DTO_reference	Forward to module field
forward_to_form	DTO_reference	Forward to form
hide_module_fields	DTO_reference[]	Hide module fields
show_module_fields	DTO_reference[]	Show module fields

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

GET Forms / List_ only aggregates

GET Forms / Get one by key