API Reference
The Progress Platform exposes a REST API documenting every public endpoint under FastAPI. The reference below is rendered inline from the project's OpenAPI schema (auto-extracted from FastAPI introspection at build time — no live app required).
API operations are grouped by tag, mirroring the platform domains:
| Tag | Description | URL |
|---|---|---|
| Production | Work orders, jobs, queues, and work session management | /api/production/ |
| Warehouse | Inventory positions, movements, counting sessions | /api/warehouse/ |
| Serial | Serial number lifecycle and Device History Records | /api/serial/ |
| Collaboration | Issues, issue types, messages, tasks | /api/collaboration/ |
| Quality | Form fields, print templates, print jobs | /api/quality/ |
| Traceability | Batch execution records, event recording, WIP | /api/traceability/ |
| Process | Process templates, phases, operations, steps | /api/process/ |
| Product | Product catalogue and BOM management | /api/product/ |
| Organization | Users, departments, API tokens | /api/organization/ |
| Administration | Destructive admin operations, data reset | /api/administration/ |
| Configuration | System config, tags, counters, custom data | /api/configuration/ |
| Attachments | File and media management | /api/attachments/ |
| Security | Authentication, session, password reset | /api/security/ |
| Notification | Server-Sent Events stream | /api/notification/ |
Cross-References
Every operation page links to the events it emits via an "Events Emitted" section. Browse the full event catalogue at Events Reference.
The OpenAPI schema is also available as a static asset at /openapi.json for code-generation tooling.
Schema Status
Note:
openapi.jsonis currently a placeholder populated at CI build time byscripts/export_openapi.py. Operation pages render via<OAOperation>once CI runs and the schema is fully populated.