Planning runs
A material plan for one manufacturing site.
- API name:
manufacturingplanningruns - Domain: Manufacturing
- Modules: Manufacturing analytics, 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 | |
| Number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Kind | kind | Constant | Yes | Base plan feeds execution; simulation is a what-if scenario until you approve it. |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event manufacturingplanningruns.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new planning run. | App · API · MCP · CLI |
| Edit | update | Save changes to this planning run. | App · API · MCP · CLI |
| Approve | approve | Approve this planning run so the next step can run. | App · API · MCP · CLI |
| Process | process | Calculate the make and buy lines. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this planning run. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this planning run again. | App · API · MCP · CLI |
| Archive | archive | Retire this planning run from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this planning run to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this planning run and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.