Model Fields

Fields define the individual data points within a model — their types, validation rules, resolution policies, and computed expressions. Fields can be managed individually on active models, supporting both UI-driven configuration and programmatic modification without re-pushing the entire model definition.

Scoped endpoints

These endpoints address fields by their human-readable name, which is unique within a model:

Method	Path	Description
POST	/models/{modelId}/fields	Add a field
GET	/models/{modelId}/fields	List all fields on a model
GET	/models/{modelId}/fields/{fieldName}	Get a field by name
PUT	/models/{modelId}/fields/{fieldName}	Update a field
DELETE	/models/{modelId}/fields/{fieldName}	Remove a field

Global endpoints

These endpoints address fields by their UUID-based fieldId, which is globally unique:

Method	Path	Description
GET	/fields	List fields across models
GET	/fields/{fieldId}	Get a field by ID
PUT	/fields/{fieldId}	Update a field
DELETE	/fields/{fieldId}	Remove a field

Both the scoped and global paths reference the same underlying resource. Scoped paths are readable for humans; global paths are unambiguous for machines.

Add a field

POST /models/{modelId}/fields

Request

{
  "name": "dateOfBirth",
  "type": "date",
  "description": "Applicant date of birth",
  "required": true
}

Response 201 Created

{
  "fieldId": "01957c3a-1234-7000-8000-000000000020",
  "name": "dateOfBirth",
  "type": "date",
  "description": "Applicant date of birth",
  "required": true,
  "createdAt": "2026-02-20T10:05:00Z"
}

Each field is assigned an immutable fieldId on creation.

Get a field

GET /models/{modelId}/fields/{fieldName}
GET /fields/{fieldId}

Both return the same response shape.

Response 200 OK

{
  "fieldId": "01957c3a-1234-7000-8000-000000000012",
  "modelId": "01957c3a-1234-7000-8000-000000000001",
  "name": "annualIncome",
  "type": "currency",
  "description": "Gross annual income from primary employment",
  "resolutionPolicy": "highest_confidence",
  "required": false,
  "createdAt": "2026-02-20T10:00:00Z",
  "updatedAt": "2026-02-20T10:00:00Z"
}

List fields

GET /models/{modelId}/fields   # All fields on a model
GET /fields                     # All fields across models

The global endpoint supports filtering: ?filter[modelId][eq]=uuid to narrow by model.

Update a field

PUT /models/{modelId}/fields/{fieldName}
PUT /fields/{fieldId}

Request

{
  "description": "Updated description",
  "resolutionPolicy": "latest_wins"
}

Response 200 OK

Returns the full updated field.

Remove a field

DELETE /models/{modelId}/fields/{fieldName}
DELETE /fields/{fieldId}

Removing a field from an active model is a soft operation — the field is excluded from the compiled model definition, the processing pipeline stops producing it, and existing contributions referencing the field are preserved for audit.

Response 204 No Content

Field naming

The human-readable name is mutable — renaming a field does not break contributions or bindings because the platform references fieldId internally. When you rename a field, all existing data continues to resolve correctly.