Maintenance plans
A preventive maintenance plan for a work center, with an interval in days and a next due date.
- API name:
maintenanceplans - Domain: Maintenance
- Modules: Manufacturing
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text I18n | ||
| Object | object | Constant | Yes | Fixed option from the allowed set for this field. |
| Work center | workcenterId | Reference | ||
| Vehicle | vehicleId | Reference | ||
| Next date | dateNext | Date | Yes | Next date the plan is due. |
| Interval days | intervalDays | Whole Number | Yes | Days between due dates. At least 1. |
| Tasks | tasks | Markdown I18n | ||
| Tags | tagIds | Tags | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event maintenanceplans.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new maintenance plan. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this maintenance plan. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this maintenance plan. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this maintenance plan again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this maintenance plan from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this maintenance plan to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this maintenance plan and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |