Skip to main content

DynamicFormDto

Dynamic form structure with configurable fields

fieldCountinteger<int32>

Total number of fields in the dynamic form

Example: 3
fieldList object[]

List of fields in the dynamic form

  • Array [
  • dataLabelstring

    The label of the form field displayed to the user, e.g., 'First Name'.

    Example: First Name
    dataNamestring

    The internal name used to identify the form field, e.g., 'firstName'.

    Example: firstName
    dataTypestring

    The type of data expected in the form field, e.g., 'text', 'number', or 'email'.

    Example: text
    dataValueList object[]

    A list of select values if the field is a dropdown type.

  • Array [
  • valuestring

    The unique value to represent the option

    Example: 123
    labelstring

    The display label for the option

    Example: Option A
  • ]
  • dataFormatstring

    The data format or pattern expected for the field, e.g., 'yyyy-MM-dd' for a date field.

    Example: yyyy-MM-dd
    sizeMininteger<int32>

    The minimum size or length for the data entered in the form field.

    Example: 3
    sizeMaxinteger<int32>

    The maximum size or length for the data entered in the form field.

    Example: 50
  • ]
  • criteriaCountinteger<int32>
    criteriaList object[]
  • Array [
  • dataLabelstring

    Label describing the criteria

    Example: Reference
    dataValuestring

    Value associated with the criteria

    Example: ref
    attachedFieldsstring[]

    List of fields attached to this criteria

    Example: ["payment reference"]
  • ]
  • DynamicFormDto
    {
    "fieldCount": 3,
    "fieldList": [
    {
    "dataLabel": "First Name",
    "dataName": "firstName",
    "dataType": "text",
    "dataValueList": [
    {
    "key": "1",
    "value": "Option 1"
    },
    {
    "key": "2",
    "value": "Option 2"
    }
    ],
    "dataFormat": "yyyy-MM-dd",
    "sizeMin": 3,
    "sizeMax": 50
    }
    ],
    "criteriaCount": 0,
    "criteriaList": [
    {
    "dataLabel": "Reference",
    "dataValue": "ref",
    "attachedFields": [
    "payment reference"
    ]
    }
    ]
    }