v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
common
v1

GET model form fields description to build UI form for EXISTING object:

 - value: any - object field value
 - field_type: str - CharField, IntegerField, SomeSerializerField - i.e. fields from a serializer
 - ui_element: dict - {type: ("input" | "select" | "checkbox" | ...), data_type: ("string", "integer", "date", ...), ...}
 - label: str - field label declared in a serializer field (default NULL)
 - field_name: str - field name declared in a serializer field (default NULL)
 - help_text: str - field help text declared in a serializer field (default NULL)
 - required: bool - whether field is required
 - read_only: bool - whether field is read only
 - allow_null: bool - whether field is may be null
 - default: bool - default (initial) field value for a new object (default NULL)
 - choices: array - choices to select from [{choice_id1: choice_verbose_name1, ....}] (default NULL)
get/api/v1/common/menu-groups/{id}/form-fields/

Path parameters

idstring required

A unique integer value identifying this user.

Response

object required