用途:这是 MaintainX 的入门示例,演示如何用 REST API 创建第一张工单,工单是 CMMS 运维的核心构建块。适合开始新的 MaintainX 集成、测试环境配置或学习基本操作。
前提条件:已完成 maintainx-install-auth 配置;有效的 MAINTAINX_API_KEY 环境变量;Node.js 18+ 或 curl。
主要能力与用法:
- 用 curl 创建工单:向 https://api.getmaintainx.com/v1/workorders 发送 POST 请求,携带 Authorization: Bearer $MAINTAINX_API_KEY 和 Content-Type: application/json,请求体包含 title、description、priority、status 等字段。
- 用 TypeScript 创建:通过 MaintainXClient 的 createWorkOrder 方法创建工单,再用 getWorkOrder 回读确认,用 getWorkOrders 列出开放工单。
- 验证与清理:列出最近工单确认创建成功,再用 DELETE 请求删除测试工单。
- 进阶示例:可创建关联资产(assetId)、位置(locationId)、指派人(assignees)、截止日期(dueDate)的工单,或基于预防性维护模板(procedureId、categories)创建工单。
错误处理:400 表示缺少必填 title;401 表示 API 密钥无效;403 表示订阅计划限制;422 表示枚举值无效,priority 需使用 NONE、LOW、MEDIUM、HIGH。
限制:需有效的 API 密钥与相应订阅权限;具体收费、价格与平台支持情况暂未提供。下一步可参考 maintainx-local-dev-loop 进行开发工作流配置。