Models

Models define the schema for records — the fields, their types, validation rules, resolution policies, computed field expressions, and relationship declarations. Every record in the system belongs to exactly one model.

Endpoints

Method	Path	Description
POST	/models	Create a model
GET	/models	List models
GET	/models/{modelId}	Get a model
PATCH	/models/{modelId}	Update model properties
PUT	/models/{modelId}/status/{targetStatus}	Lifecycle transition
DELETE	/models/{modelId}	Delete a model

Lifecycle

Models progress through three states:

draft → active → archived

• Draft — the model is being configured. Records cannot be created against it.

• Active — the model is live. Records can be created, read, updated, and deleted. Fields can be added and modified individually.

• Archived — the model is frozen. Existing records remain accessible, but no new records can be created and the field schema cannot be modified.

Transitions are one-directional. A model cannot move from archived back to draft.

Create a model

POST /models

Accepts a complete definition — model metadata and the fields array — and creates everything in a single transaction.

Request

{
  "name": "Applicant",
  "description": "Mortgage applicant profile",
  "fields": [
    {
      "name": "firstName",
      "type": "text",
      "description": "Applicant legal first name",
      "required": true
    },
    {
      "name": "lastName",
      "type": "text",
      "description": "Applicant legal last name",
      "required": true
    },
    {
      "name": "annualIncome",
      "type": "currency",
      "description": "Gross annual income from primary employment",
      "resolutionPolicy": "highest_confidence"
    }
  ]
}

Response 201 Created

{
  "modelId": "01957c3a-1234-7000-8000-000000000001",
  "name": "Applicant",
  "description": "Mortgage applicant profile",
  "status": "draft",
  "fields": [
    {
      "fieldId": "01957c3a-1234-7000-8000-000000000010",
      "name": "firstName",
      "type": "text",
      "description": "Applicant legal first name",
      "required": true
    },
    {
      "fieldId": "01957c3a-1234-7000-8000-000000000011",
      "name": "lastName",
      "type": "text",
      "description": "Applicant legal last name",
      "required": true
    },
    {
      "fieldId": "01957c3a-1234-7000-8000-000000000012",
      "name": "annualIncome",
      "type": "currency",
      "description": "Gross annual income from primary employment",
      "resolutionPolicy": "highest_confidence"
    }
  ],
  "createdAt": "2026-02-20T10:00:00Z",
  "updatedAt": "2026-02-20T10:00:00Z",
  "createdBy": "user_01957c3a-..."
}

The model is created in draft status. Server-assigned fields (modelId, fieldId, createdAt) are populated in the response.

Get a model

GET /models/{modelId}

Returns the complete definition including all fields.

Response 200 OK

Same shape as the create response.

List models

GET /models

Returns a paginated list of models. Supports standard filtering and sorting.

Useful filters

GET /models?filter[status][eq]=active           # Active models only
GET /models?filter[name][contains]=Applicant    # Search by name
GET /models?sortBy=createdAt:desc               # Newest first

Update a model

PATCH /models/{modelId}

Partial update — only the provided properties are changed. Lifecycle status is not modified through PATCH; use the dedicated lifecycle endpoint.

Request

{
  "description": "Updated description for the applicant model"
}

Response 200 OK

Returns the full updated model.

Lifecycle transition

PUT /models/{modelId}/status/{targetStatus}

Transitions the model's lifecycle. The server validates that the transition is permitted.

Examples

# Activate a draft model
PUT /models/{modelId}/status/active

# Archive an active model
PUT /models/{modelId}/status/archived

Response 200 OK

Returns the model with the new status.

Error cases

Scenario	Status
Invalid transition (e.g., archived → draft)	422 Unprocessable Entity

Activating a model triggers compilation of the definition used by the platform's processing pipeline.

Delete a model

DELETE /models/{modelId}

Performs a soft delete — the model is excluded from list results and system operations but retained for auditing.

Preconditions

Deletion is guarded by two preconditions:

1. The model must be in archived status

2. The model must have no active (non-deleted) records

If either condition is not met, the request is rejected with 409 Conflict.

Error cases

Scenario	Status
Model is not in archived status	409 Conflict
Model has active (non-deleted) records	409 Conflict

Response 204 No Content

No response body on successful deletion.