DataFormDto

A custom form definition (list view)

Properties

Name	Type	Description
libraryCode	string	The Code of the library template this entity was imported from, or null if the entity is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".
The Code of the library template this entity was imported from, or null if the entity is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".
libraryStatus	enum	Describes a library-imported entity's relationship to its source library template. NotFromLibrary UpToDate LocallyModified LibraryUpdated
Describes a library-imported entity's relationship to its source library template. NotFromLibrary UpToDate LocallyModified LibraryUpdated
isImported	boolean	True if the tenant has already imported this library item.
True if the tenant has already imported this library item.
code	string	The unique code for this form
The unique code for this form
name	string	The display name of the form
The display name of the form
description	string	Internal description of the form's purpose. Not shown to clients.
Internal description of the form's purpose. Not shown to clients.
introduction	string	Introductory text shown at the top of the form when displayed to clients
Introductory text shown at the top of the form when displayed to clients
category	CodeAndNameDto
status	enum	Draft Published Archived
Draft Published Archived
defaultMessage	string	Default message included in the notification email when this form is sent to a client
Default message included in the notification email when this form is sent to a client
responseCount	integer	Number of requests that have received a response. Used to warn when editing a form that has been used.
Number of requests that have received a response. Used to warn when editing a form that has been used.
sections	array of DataFormSectionDto	The sections and questions belonging to this form. Only populated on detail (GetByCode) responses.
The sections and questions belonging to this form. Only populated on detail (GetByCode) responses.

JSON Example

{
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary",
  "isImported": false,
  "code": "string",
  "name": "string"
}

Used By Operations

Contained in Schemas

DataFormDtoPagedResult