Frontend | Backend | Api

Forms\Models\Api\Form

Form

Property Description Returns
availableLayouts Get the available layouts for showing forms Collection
currentSubmission Get the current form submission FormSubmission
fileInput Returns whether form has InputFile at any step. This method can be used to decide whether to add `enctype="multipart/form-data"` to form. bool
steps Get the steps for the active revision of the form. Returns null if the form does not have an active revision. Collection
elements Get the elements for the active revision of the form. Returns null if the form does not have an active revision. Collection
assignedWorkflow Get the workflow assigned to the record or entity Workflow
assignedWorkflow Check whether the record has an assigned workflow bool
branches Get the branches associated with the record Collection
numRevisionsWithoutBranch Get the number of revisions without branch int
revisionsWithoutBranch Get all revisions without branch Collection
id int
name string
identifier string
externalId string
created Date the record was created. DateTime
modified Last modification date for the record. DateTime
published DateTime
site Site
activeRevision FormRevision
published Determines if the record is published. bool
revisions Collection (FormRevision)
submissions Collection (FormSubmission)
lastRevision Model
customFieldValues Collection (FormCustomFieldValue)
customFieldContent Get a serialized representation of the custom fields associated with the record object
customFields Get the custom fields for this entity array