REST Button

Queries an HTTP endpoint and stores the response. Use it to get values from server manually or automatically.

Example

Loading...

Properties

General

Attribute	Type	Description	Category
Model Id	String	This is a unique id for the component.	Every field on a form model needs a unique ID, which is automatically generated but can be changed if needed (e.g. to reference in expressions or for debugging purposes). If the field type supports rendering a label, and most types do, it can be configured here. This label is a displayed on the form to the end user and typically indicates what value is expected in the field. The documentation property holds free-form text that can be used to give more details about this rest button, like its purpose, usage in other models, etc.
Label	Text	The label attribute adds a label to the component.
Label position	Selection: Left Top	The position of the label, you can choose between left or top.
Label tooltip	Text	When it is defined, a question mark icon will appear in the component label. When the user hovers over it it will show this text in a tooltip.
Documentation	Multiline Text	A free-form text to explain the use cases for this form field.
Value	Text	The binding for the form field. Use an appropriate expression to bind the component to its value and specify where the value is written/read. For example, use '{{myVariableName}}' to store the value of the field in a variable named 'myVariableName'. Use prefixes to define the scope of the value, for example, 'root.' for referencing the root case/process to store the value in. Please refer to the section 'Frontend expressions' in the Flowable guide for more information.	The purpose of a form is to either display some value or to have users provide values for the various fields of a form. In both situations, this value needs to be bound to an identifier using the {{myValue}} notation, and the value provided by the user will be stored in a variable with that identifier. If there already was a value bound to the identifier before, for example because another form had a field bound to the same identifier, it will be displayed.
Tab Index	Integer	Determine their relative ordering for sequential focus navigation. Tab index will be ignored if the component is inside a subform.
Button text	Text	Button text.

Button

Attribute	Type	Description	Category
Button alignment	Selection: Left Right	Where the button will be aligned.	Configuration properties for how the rest button is rendered on the form.
Tooltip	Text	When the user hovers the button it will show this text in a tooltip.
Primary	Boolean	Mark the button as primary.
Icon URL	Text	The URL of the icon to show.	Configuration properties for how the icon for the rest button is rendered on the form.
Font Awesome icon name	Text	The icon name to be used for the button icon from Font Awesome.
Icon alignment	Selection: Left Right	The alignment of the icon.

Rest Call

Attribute	Type	Description	Category
REST method	Selection: GET POST PUT PATCH DELETE	Choose the REST method to execute the REST request.	Basic configuration properties for the rest button that determine which REST request is executed.
REST URL	Text	The REST endpoint from where data is retrieved.
Response data path	Text	Where to find data in a JSON response.
Value expression	Text	Expression that returns the value to store. $response keeps the value returned by the REST call. For example {{flw.round($response.returnedValue, 2)}}. If path is defined, $response keeps the value of the REST response in that path.
Send request attributes	List	Map some attributes to be added to the request.	Allows to map data from the response into the form payload for usage in other fields.
Send header properties	List	Define the request headers that should be sent in the HTTP request.
Show full REST response	Boolean	Return the whole payload after the REST call, including the response body, headers and status
Store response attributes	List	Map some attributes from the response into the payload. Please use {{$response.attributeFromResponse}} in the expression column
Handle error response	Boolean	Allows mappings also for the error response.
Hide REST error messages	Boolean	Hide error messages from REST calls.
Store error response attributes	List	Map some attributes from the error response into the payload. Please use {{$response.attributeFromResponse}} in the expression column
Refresh time	Text	The milliseconds interval to execute the button automatically in every tick. If it's not defined it will not be executed automatically	Advanced configuration properties for the rest button that influence how and when the REST request is executed.
Auto execute	Boolean	Auto execute button when rendered.
Execute always	Boolean	Auto execute button when rendered even if disabled.
Loading indicator	Boolean	Show loading indicator next to the button text when the internal promise is in progress.

Validation

Attribute	Type	Description	Category
Validation Panel Display	Selection: Show Only message Hide	Display at validation panel and validation tooltip.	Providing proper data in form fields is important, especially when in process, case, decision or any other models the values provided in the form fields are used in subsequent steps. To make sure that the data is correct, validation is crucial. For this reason, a form can only be submitted when all fields are valid and thus all validation properties configured on the left apply. Check the tooltips on the properties for more information.
Custom validations	List	List of additional validations to apply.	The rest button can have custom validation rules beyond the standard set of validations. Such a rule is written as a frontend expression in the form of {{myExpression}}. If this expression evaluates to false, the submission of the form won't be possible.

Rendering

Attribute	Type	Description	Category
Description	Text	The description attribute adds a description to the component.	Some field types have an extra line of text displayed to give the user more details about the field.
Ignored	Boolean	If true the component will be hidden and the value will not be part of any payload.	Fields can also be shown or hidden based on the visible condition. This can be a frontend expression in the form of {{myExpression}} which can reference other form field values by their IDs. Fields can also be enabled or disabled, and similarly this can be made dynamic based on a frontend expression. Some field types can be ignored (the property is shown here if that's the case), which means that its value won't be taken into account.
Visible	Boolean	Boolean value or expression specifies whether the component is visible or hidden. This expression might include another value in the same form, for instance use a checkbox bound to {{showAdditionalFields}} and use the very same expression as the visible attribute to show or hide the component according the checked state of the checkbox. If you want to only show the component, if the form is not used as the init-form, you can use the expression '{{root.id}}' which evaluates to true only, if there is a current case id which is not the case in an initialization form.
Enabled	Boolean	Boolean value or expression specifies whether component is enabled or disabled.
Style class	Text	Stylesheet class name. Add any style classes to be applied to the component for the desired styling and rendering.	The rest button can get customized CSS classes to customize the default styling. Note that the CSS files needed for the customizations must be available on the runtime system.

Advanced

Attribute	Type	Description	Category
Events	List		The rest button emits low-level events on which can be reacted with a frontend expression to implement various use cases that are not possible with regular modeling. If the expression produces a value, it can be stored in a new variable using the Result variable property.

List Attribute Details

Send request attributes

Attribute	Type	Description
Name	Text	A human-readable name.
Expression	Text	Validation passes when this expression is true.

Send header properties

Attribute	Type	Description
Name	Text	A human-readable name.
Value	Text	The binding for the form field. Use an appropriate expression to bind the component to its value and specify where the value is written/read. For example, use '{{myVariableName}}' to store the value of the field in a variable named 'myVariableName'. Use prefixes to define the scope of the value, for example, 'root.' for referencing the root case/process to store the value in. Please refer to the section 'Frontend expressions' in the Flowable guide for more information.

Store response attributes

Attribute	Type	Description
Name	Text	A human-readable name.
Expression	Text	Validation passes when this expression is true.

Store error response attributes

Attribute	Type	Description
Name	Text	A human-readable name.
Expression	Text	Validation passes when this expression is true.

Custom validations

Attribute	Type	Description
Expression	Text	Validation passes when this expression is true.
Error message	Text	Message to display when the validation fails.

Events

Attribute	Type	Description
Event label	Text	This is a unique id for the component.
Event type	Selection: On value change	The type of event emitted by the form field.
Expression	Text	Validation passes when this expression is true.
Result variable	Text	Capture the result of the expression in a result variable.

Events

Event	When	Additional	Cancellable
Button.click	Any button is clicked	Definition + State	Yes

See section Events for more information.