DataFormDto

A custom form definition (list view)

Properties

Name	Type	Description
code	string	Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
name	string	Display name shown to users in lists, dialogs, and the import browser.
Display name shown to users in lists, dialogs, and the import browser.
description	string	Optional human-readable summary of what this entity is for.
Optional human-readable summary of what this entity is for.
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.
deprecated	boolean	True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
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

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas

DataFormDtoPagedResult