Create a custom field | Distru Documentation

Adds a custom field to one entity type, e.g. a Lab dropdown on packages; it then appears on every record of that type.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
entityType	enum `ASSEMBLYBATCHCOMPANYCONTACTINVOICEPACKAGEPRODUCTPURCHASE_ORDERRETURNSALES_ORDERSTOCK_TRANSFERTASK`	Yes
name	string	Yes	Up to 70 characters; unique within the entity type.
fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Yes	DATE: a day, no time. DROPDOWN: one option. CHECKBOX: any number of options. Cannot be changed later.
description	string	No	Up to 100 characters.
required	boolean	No	Must be filled in on every record.
options	string[]	No	Required for DROPDOWN and CHECKBOX, not allowed otherwise. Unique; no commas.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
customField	object	Always
customField.id	string	Always
customField.name	string	Always
customField.description	string	Can be null
customField.entityType	enum `ASSEMBLYBATCHCOMPANYCONTACTINVOICEPACKAGEPRODUCTPURCHASE_ORDERRETURNSALES_ORDERSTOCK_TRANSFERTASK`	Can be null
customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
customField.required	boolean	Always
customField.options	object[]	Always
customField.options[].name	string	Always
customField.options[].disabled	boolean	Always

What the AI reads

Adds a custom field to one entity type, e.g. a Lab dropdown on packages; it then appears on every record of that type. It defines the field only: it sets no value on any record. Check distru-search-custom-fields first so you don't add a field that already exists; to change one use distru-update-custom-field. Requires the custom fields settings permission.