Skip to content

API Form: Reference

Reference for API Form in Web Framework References. Key properties: ID, Url, Method, Post Type.

Use this reference to understand what API Form is for and which component-specific inspector group matters most when you configure it.

Inspector Property Groups

API Form Properties

Property Type Details
IDtextHTML id for the form.
Sets the form element id . Use it to link labels/controls, target CSS, or reference the form in scripts. Bootstrap docs: Forms overview
Required in common setups.
Attribute: id
UrltextAttribute: action
MethoddroplistSubmit method used by the handler.
Controls which HTTP method is used for the form submission when using a handler. Common values are GET and POST depending on your API configuration. Bootstrap docs: Forms overview
Attribute: method
Options: get, post
Post TypedroplistAttribute: post-data
Options: Form, JSON
Auto SubmitbooleanAttribute: autosubmit
Define API Schemabutton 

Actions

Submit

Submit API Form

Configuration group Controls
Query ParametersAction configuration group

Reset

Reset API Form

Dynamic Attributes

Url

Attribute property Type Details
Url:textChoose dynamic data binding.

Query Parameters

Attribute property Type Details
Params:gridChoose dynamic data binding.

API Headers

Attribute property Type Details
Headers:gridChoose dynamic data binding.

Dynamic Events

Start

Event option Type Details
Action:textChoose the action to execute.

Done

Event option Type Details
Action:textChoose the action to execute.

Error

Event option Type Details
Action:textChoose the action to execute.

Unauthorized

Event option Type Details
Action:textChoose the action to execute.

Forbidden

Event option Type Details
Action:textChoose the action to execute.