Choose a version:

MetaobjectFieldDefinition

object

Defines a field for a MetaobjectDefinition with properties such as the field's data type and validations.

Anchor to FieldsFields

Anchor to descriptiondescription • String: The administrative description.
Anchor to keykey • String!non-null: A key name used to identify the field within the metaobject composition.
Anchor to namename • String!non-null: The human-readable name.
Anchor to requiredrequired • Boolean!non-null: Required status of the field within the metaobject composition.
Anchor to typetype • MetafieldDefinitionType!non-null: The type of data that the field stores.
Anchor to validationsvalidations • [MetafieldDefinitionValidation!]!non-null: A list of validation options for the field. For example, a field with the type date can set a minimum date requirement.

Was this section helpful?