## On this page

  

 

 # create\_field\_definition

 Last update: 16.07.2026 

<a id="compolyx.Model.create_field_definition"></a>

## Model.create\_field\_definition(name, id=None, field\_variable\_name=None, scope\_entities=None, scalar\_field=None, full\_mapping=False, active=True, locked=False)

Create a new field definition.

### Parameters

- name: The name of the field definition.
- id: The ID of the field definition.
- field\_variable: String identifier of the field.
- scope\_entities: A list of scope entities defining the region of definition.
- scalar\_field: Tabular scalar column defining the field.
- full\_mapping: Boolean for whether offsets are to be included during the interpolation process.

### Returns

The created field definition.