REST API reference
Generated from the OpenAPI document at build time: 129 paths. A running instance serves the interactive version at /docs and the raw document at /openapi.json. Sign in at POST /auth/login and send Authorization: Bearer <token>; every write needs a role.
adjustments
Method
Path
Summary
GET/adjustmentsList Adjustments
POST/adjustmentsPropose
GET/adjustments/{code}Get Adjustment
POST/adjustments/{code}/approveApprove
POST/adjustments/{code}/rejectReject
administration
Method
Path
Summary
GET/admin/capabilitiesList Capabilities
GET/admin/rolesList Roles
POST/admin/rolesCreate Role
DELETE/admin/roles/{code}Delete Role
PUT/admin/roles/{code}Update Role
GET/admin/usersList Users
PUT/admin/users/{code}/roleSet User Role
analysis
Method
Path
Summary
GET/analysis/downtimeDowntime
GET/analysis/linesLines
GET/analysis/oeeOee
GET/analysis/productionProduction
GET/analysis/tag/{equipment_code}Tag
GET/analysis/timelineTimeline
assistant
Method
Path
Summary
POST/assist/agentAgent Message
POST/assist/agent/confirmAgent Confirm
POST/assist/agent/declineAgent Decline
GET/assist/agent/statusAgent Status
POST/assist/askAsk
GET/assist/guidesGuides
GET/assist/guides/{guide_id}Guide
GET/assist/suggestionsAgent Suggestions
auth
Method
Path
Summary
POST/auth/loginLogin
POST/auth/logoutLogout
GET/auth/meMe
POST/auth/usersCreate User
POST/auth/users/{code}/passwordSet Password
certificates
Method
Path
Summary
GET/coaCertificates
GET/coa/pallet/{serial}Pallet Certificate
POST/coa/pallet/{serial}Issue Pallet Certificate
GET/coa/pallet/{serial}/dataPallet Certificate Data
GET/coa/{order}Certificate
POST/coa/{order}Issue
GET/coa/{order}/dataCertificate Data
dashboard
Method
Path
Summary
GET/dashboard/summarySummary
design partner
Method
Path
Summary
POST/design/chatChat
GET/design/conversationsList Conversations
GET/design/conversations/{conversation_id}Read Conversation
GET/design/statusStatus
equipment
Method
Path
Summary
GET/equipment/alarmsAll Alarms
GET/equipment/statesCurrent States
GET/equipment/tagsAll Tags
GET/equipment/treeEquipment Tree
GET/equipment/{code}Machine Head
GET/equipment/{code}/alarmsMachine Alarms
GET/equipment/{code}/oeeOee
POST/equipment/{code}/stateSet State
GET/equipment/{code}/tagsMachine Tags
erp
Method
Path
Summary
GET/erp/outboxOutbox
POST/erp/outbox/{message_id}/retryRetry
execution
Method
Path
Summary
GET/execution/bom/{material_code}Bom
POST/execution/consumeConsume
GET/execution/genealogy/{order_code}Genealogy
GET/execution/lotsList Lots
POST/execution/lotsCreate Lot
POST/execution/reportReport
GET/execution/staging/{order_code}Staging
kpis
Method
Path
Summary
GET/kpis/oee/{equipment_code}Oee
GET/kpis/ordersOrder Progress
line view
Method
Path
Summary
GET/line/eventsEvents
GET/line/layoutLayout
GET/line/wipWip
maintenance
Method
Path
Summary
POST/maintenance/correctiveCorrective
GET/maintenance/dueDue
GET/maintenance/ordersOrders
POST/maintenance/orders/{code}/completeComplete
POST/maintenance/orders/{code}/startStart
GET/maintenance/plansPlans
POST/maintenance/plansCreate Plan
POST/maintenance/raiseRaise Due
master data
Method
Path
Summary
GET/masterdata/equipmentList Equipment
POST/masterdata/equipmentCreate Equipment
GET/masterdata/materialsList Materials
POST/masterdata/materialsCreate Material
GET/masterdata/materials/{code}/bomGet Bom
POST/masterdata/materials/{code}/bomAdd Bom Item
GET/masterdata/personnelList Personnel
POST/masterdata/personnelCreate Person
GET/masterdata/routingsList Routings
POST/masterdata/routingsCreate Routing
operations
Method
Path
Summary
GET/ops/activityActivity
GET/ops/logs/{component}Logs
GET/ops/retentionRetention Status
GET/ops/servicesServices
quality
Method
Path
Summary
GET/quality/checksList Checks
POST/quality/checksRecord Check
GET/quality/gaugesGauges
POST/quality/gaugesRegister Gauge
POST/quality/gauges/{code}/calibrateCalibrate
GET/quality/gauges/{code}/impactGauge Impact
GET/quality/gauges/{code}/resolutionGauge Resolution
GET/quality/nonconformancesList Ncs
POST/quality/nonconformances/{code}/closeClose Nc
GET/quality/spc/{material}/{characteristic}Spc
GET/quality/specsList Specs
POST/quality/specsCreate Spec
scheduling
Method
Path
Summary
GET/scheduling/boardBoard
GET/scheduling/calendarShow Calendar
POST/scheduling/calendar/exceptionsAdd Exception
POST/scheduling/calendar/shiftsCreate Shift
POST/scheduling/planPlan All
POST/scheduling/plan/{code}Plan Order
GET/scheduling/promise/{code}Promise
system
Method
Path
Summary
GET/aiLocal Ai
GET/auditAudit Trail
GET/healthHealth
GET/metricsMetrics
traceability
Method
Path
Summary
POST/trace/unitsProduce
POST/trace/units/batchProduce Batch
POST/trace/units/packPack
GET/trace/units/{serial}Contents
POST/trace/units/{serial}/statusSet Status
GET/trace/units/{serial}/traceTrace
GET/trace/where-used/{lot_code}Where Used
triggers
Method
Path
Summary
GET/triggersList Triggers
POST/triggersCreate Trigger
GET/triggers/catalogCatalog
GET/triggers/firingsRecent Firings
GET/triggers/{code}Get Trigger
POST/triggers/{code}/approveApprove Trigger
GET/triggers/{code}/firingsTrigger Firings
POST/triggers/{code}/withdrawWithdraw Trigger
work instructions
Method
Path
Summary
GET/documentsCatalogue
POST/documentsCreate
GET/documents/forFor Context
GET/documents/{code}Read
POST/documents/{code}/approve/{revision}Approve
POST/documents/{code}/reviseRevise
GET/documents/{code}/revisionsHistory
POST/documents/{code}/withdrawWithdraw
work orders
Method
Path
Summary
GET/workordersList Orders
POST/workordersCreate Order
GET/workorders/dispatchDispatch
GET/workorders/summaryOrder Summary
GET/workorders/{code}Get Order
POST/workorders/{code}/cancelCancel
POST/workorders/{code}/closeClose
POST/workorders/{code}/holdHold
POST/workorders/{code}/operations/{seq}/completeComplete Operation
POST/workorders/{code}/operations/{seq}/startStart Operation
POST/workorders/{code}/releaseRelease
POST/workorders/{code}/resumeResume
GET/workorders/{code}/wipOrder Wip