DataFieldText

Sample shape for DataFieldText.

Sample shape for DataFieldText.

Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response.

{
  "fieldType": "example",
  "contentType": "example",
  "maximum": 0,
  "defaultValue": "example",
  "name": "Example name",
  "prompt": "example",
  "description": "Example description.",
  "isCore": false,
  "isFeature": false,
  "featureName": "example",
  "placement": [
    "<field-placement>"
  ],
  "usage": [
    "<field-usage>"
  ],
  "listEditable": false
}

Fields

Field	Type	Required	Notes
entity	string • nullable	Server-set	Set by the server. Read-only on writes.
fieldType	string • nullable	Optional
contentType	string	Optional
maximum	integer	Optional
defaultValue	string	Optional
name	string	Optional
prompt	string	Optional
description	string	Optional
isCore	boolean	Optional
isFeature	boolean	Optional
featureName	string	Optional
placement	array<FieldPlacement>	Optional
usage	array<FieldUsage>	Optional
listEditable	boolean	Optional
tenantId	string	Server-set	Set by the server. Read-only on writes.
id	string	Server-set	Set by the server. Read-only on writes.
created	string (date-time)	Server-set	Set by the server. Read-only on writes.
createdBy	string	Server-set	Set by the server. Read-only on writes.
updated	string (date-time)	Server-set	Set by the server. Read-only on writes.
updatedBy	string	Server-set	Set by the server. Read-only on writes.
deleted	boolean	Server-set	Set by the server. Read-only on writes.

Used by

Request body

• POST /api/field/text
• PUT /api/field/text