Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

The entry field allows you to search for and reference another entry. The submitted value will be the ID of the selected entry.

See also EntryField if you need further fields of a selected Entry in your form.

Field options

Name

Type

Description

name

string

The name by which the field will internally be referenced

displayText

string

The main field label displayed above the field

description

string

An additional description displayed below the main label

defaultValue

string

The value the field should initially be filled with. This field needs to be a valid id of an existing entry.

options

object

Additional field options (see below)

options.required

boolean

Whether the field must be filled to advance

options.readOnly

boolean

Whether it’s allowed to change the field value

options.sectionId

string

Optionally restrict the allowed entries to a specific section.

options.primaryFieldKey

string

The key that should be used to retrieve the primary text field (shown above in the option list as the black text). Falls back to the entries name field

options.secondaryFieldKey

string

The key that should be used for the secondary text field (shown above as the gray text). If empty, no secondary field will be used.

JSON Example

{
  "name": "Inventory",
  "displayText": "Inventory",
  "description": "Select an item from the inventory",
  "type": "Entry",
  "defaultValue": "INV17",
  "options": {
    "required": true,
    "sectionId": "src-inventory",
    "primaryFieldKey": "Title",
    "secondaryFieldKey": "Number"
  }
},
  • No labels