Content

Forms / List

Returns all forms.

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

Method: GET

Authorisation: Minimum role: USER

Request Arguments

Name	Type	Source
filter	DTO_standard_filter	Query

Request body example

Response object

Response status: 200 (OK)

Response type: DTO_form[]

Wrapper: DTO_response_wrap_get_many

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

Response body example

DTO_standard_filter

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

DTO_form

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

DTO_group_access

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

DTO_reference

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

DTO_form_module

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

DTO_form_module_field

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

DTO_form_logic

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

DTO_form_logic_trigger

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

DTO_form_logic_action

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

DTO_reference_user

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

ENUM group_permission

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	READ	Read only
2	EDIT	Edit
3	FULL	Full

ENUM form_module_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	HEADER	HEADER
2	INFORMATION	INFORMATION
3	FIELD	FIELD
4	LINE_SEPARATOR	LINE_SEPARATOR
5	PAGE_SEPARATOR	PAGE_SEPARATOR
6	SUBMIT_MESSAGE	SUBMIT_MESSAGE

ENUM form_logic_operator

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	AND	AND
2	OR	OR

ENUM sort_order

Value	Name	Description
0	ASC	ASC
1	DESC	DESC

ENUM privacy

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	PRIVATE	PRIVATE
2	PUBLIC	PUBLIC

ENUM form_collect_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	TICKET	TICKET
2	LIST	LIST

ENUM form_display_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	CLASSIC	CLASSIC
2	CARD	CARD

PUT Forms / Update

GET Forms / List_ only aggregates