INPUT_OBJECT

FormInput

# GraphQL Schema definition

1 input FormInput {
5 
2 #   Same as callback, but invoked asynchronously. Recommended for performance 
3 #   reason.
4 async_callback_actions: String
11 
6 #   liquid code which should evaluate to float. Delays invoking the job by specified 
7 #   number of minutes. Useful to invoke code at certain point in time, for example 1 
8 #   hour before something etc. To calculate proper number you can use time_diff 
9 #   filter.
10 async_callback_delay: String
15 
12 #   Defines max number of retrying attempts in case of an error. Usually you do not 
13 #   want to change it.
14 async_callback_max_attempts: Int
18 
16 #   defines the invocaction priority, the higher the quicker timeout
17 async_callback_priority: AsyncCallbackPriority
21 
19 #   ids of authorization policies which should be checked
20 authorization_policy_ids: [ID!]
25 
22 #   liquid code to be invoked after persisting input to DB. If possible, use async 
23 #   callback actions instead
24 callback_actions: String
31 
26 #   whitelist of attributes which can be persisted in the DB. On server side 
27 #   (callbacks, emails etc) you have access to submited values via form variable 
28 #   (for exapmple configuration: properties: my_var is accessible via 
29 #   form.properties.my_var )
30 configuration: HashObject
37 
32 #   liquid code which has to evaluate to JSON. This extends/overwrites user 
33 #   submitted input via form, before validation. Most useful to store in DB 
34 #   sensitive data which you do not want user to modify, for example 
35 #   context.current_user.id
36 default_payload: String
41 
38 #   liquid code which should evaluate to message which you want to display to user 
39 #   upon validation errors. Output is available via context.flash_alert
40 flash_alert: String
45 
42 #   liquid code which should evaluate to message which you want to display to user 
43 #   after successful form submission. Output is available via context.flash_notice
44 flash_notice: String
49 
46 #   liquid code to evaluate to valid form html. You have access to form_builder 
47 #   variable and form tag.
48 liquid_body: String
51 
50 metadata: HashObject
54 
52 #   deprecated - derived from physical_file_path
53 name: String
59 
55 #   defines where the file definition will be available after pull; should start 
56 #   with the module name follow by private/public scope, for example 
57 #   manual/public/forms/my_form
58 physical_file_path: String!
63 
60 #   liquid code which should evaluate to valid path or url to which user should be 
61 #   redirected after successful form submission.
62 redirect_to: String
65 
64 resource: String!
69 
66 #   defines who can submit the form. If set to anyone, please make sure to provide 
67 #   authorization_policies
68 resource_owner: String!
72 
70 #   Response headers for the form
71 response_headers: String
75 
73 #   strategy to protect against spam attacks.
74 spam_protection: SpamProtectionInput
76 }

# Required by

RootMutation null

1	input FormInput {
5
2	# Same as callback, but invoked asynchronously. Recommended for performance
3	# reason.
4	async_callback_actions: String
11
6	# liquid code which should evaluate to float. Delays invoking the job by specified
7	# number of minutes. Useful to invoke code at certain point in time, for example 1
8	# hour before something etc. To calculate proper number you can use time_diff
9	# filter.
10	async_callback_delay: String
15
12	# Defines max number of retrying attempts in case of an error. Usually you do not
13	# want to change it.
14	async_callback_max_attempts: Int
18
16	# defines the invocaction priority, the higher the quicker timeout
17	async_callback_priority: AsyncCallbackPriority
21
19	# ids of authorization policies which should be checked
20	authorization_policy_ids: [ID!]
25
22	# liquid code to be invoked after persisting input to DB. If possible, use async
23	# callback actions instead
24	callback_actions: String
31
26	# whitelist of attributes which can be persisted in the DB. On server side
27	# (callbacks, emails etc) you have access to submited values via form variable
28	# (for exapmple configuration: properties: my_var is accessible via
29	# form.properties.my_var )
30	configuration: HashObject
37
32	# liquid code which has to evaluate to JSON. This extends/overwrites user
33	# submitted input via form, before validation. Most useful to store in DB
34	# sensitive data which you do not want user to modify, for example
35	# context.current_user.id
36	default_payload: String
41
38	# liquid code which should evaluate to message which you want to display to user
39	# upon validation errors. Output is available via context.flash_alert
40	flash_alert: String
45
42	# liquid code which should evaluate to message which you want to display to user
43	# after successful form submission. Output is available via context.flash_notice
44	flash_notice: String
49
46	# liquid code to evaluate to valid form html. You have access to form_builder
47	# variable and form tag.
48	liquid_body: String
51
50	metadata: HashObject
54
52	# deprecated - derived from physical_file_path
53	name: String
59
55	# defines where the file definition will be available after pull; should start
56	# with the module name follow by private/public scope, for example
57	# manual/public/forms/my_form
58	physical_file_path: String!
63
60	# liquid code which should evaluate to valid path or url to which user should be
61	# redirected after successful form submission.
62	redirect_to: String
65
64	resource: String!
69
66	# defines who can submit the form. If set to anyone, please make sure to provide
67	# authorization_policies
68	resource_owner: String!
72
70	# Response headers for the form
71	response_headers: String
75
73	# strategy to protect against spam attacks.
74	spam_protection: SpamProtectionInput
76	}