Static Forms
Last updated
Last updated
This is the official documentation of the forestadmin-agent-django
and forestadmin-agent-flask
Python agents.
Very often, you will need to ask for user inputs before triggering the logic behind an action.
For example, you might want to specify a reason if you want to block a user account. Or set the amount to charge a user’s credit card.
Fields are configurable using the following properties:
When using the Collection
type, you can create a reference to a record of any collection.
The value of the field will be the primary key of the selected record.
Note that the value will be stored in an array as the target collection may be using a composite primary key. When not using a composite primary key, the array can be assumed to contain a single value.
Property | Expected value | Description |
---|---|---|
type
Boolean
, Date
, Dateonly
, Enum
, Json
, Number
, String
, NumberList
, EnumList
, StringList
, FileList
and Collection
}
Set the type of the field.
label
string
Set the label of the field.
id
string
Set the id of the field. The is used internally and to access values from the context. If not set the label will be used.
description
string
Set the description of the field.
is_required
boolean
Make the field required (default false).
is_read_only
boolean
Make the field read-only (default false).
default_value
any
Set the default value of the field.
enum_values
array of strings
Change the list of possible values of the field when type is Enum
.