CMMS API リファレンス
このページは、顧客向けの CMMS 統合インターフェース構造を示します。最終的な endpoint、payload、フィールドマッピングは、顧客デプロイ範囲と実行時 OpenAPI を基準にします。
API サーフェス
現在の API アンカー
アダプタータイプ参照
| タイプ | 用途 |
|---|---|
webhook | 作業指示イベントを下流 endpoint へ push し、inbound webhook で状態 callback を受け取ります。 |
rest | 顧客承認済みの path、認証、field mapping、result parsing で汎用 REST profile を設定します。 |
maximo | Maximo REST profile で IBM Maximo 作業指示に接続します。 |
sap-pm | SAP OData profile で SAP Plant Maintenance maintenance order に接続します。 |
| Forge または顧客 overlay profile | 承認済み overlay wiring と payload contract で Honeywell Forge または顧客固有 provider に接続します。 |
BACnet、Modbus、SNMP は設備コンテキスト用の現場プロトコルアダプターです。下流 CMMS 作業指示アダプターとして設定しません。
| グループ | API |
|---|---|
| CMMS 設定 | GET /api/v1/cmms/adapters, POST /api/v1/cmms/adapters, POST /api/v1/cmms/adapters/{id}/test |
| 資産マッピング | GET /api/v1/cmms/asset-mappings, POST /api/v1/cmms/asset-mappings, POST /api/v1/cmms/asset-mappings/batch |
| 同期ログ | GET /api/v1/cmms/sync/logs |
| CMMS 概要 | GET /api/v1/cmms/dashboard-summary |
| 作業指示 | GET /api/v1/workorders, POST /api/v1/workorders, PUT /api/v1/workorders/{id}/assign-resource, POST /api/v1/workorders/{id}/feedback |
| 作業依頼 | POST /api/v1/platform/worker-issues, POST /api/v1/platform/worker-issues/{id}/triage, POST /api/v1/platform/worker-issues/{id}/convert |
| 予知保全リンク | GET /api/v1/pdm/cmms, POST /api/v1/pdm/cmms, POST /api/v1/pdm/advisory/{id}/work-order, POST /api/v1/pdm/advisory/{id}/outcome |
契約フィールド
| フィールド | 用途 |
|---|---|
common_work_order_id | FactVerse 作業指示参照。 |
provider_id | ソース CMMS、EAM、請負会社システム、統合プロファイル。 |
source_work_order_id | プロバイダーのネイティブ作業指示 ID。 |
asset_ref | MDM 資産、設備、場所、システム参照。 |
source_status / common_status | 元の状態と共通ライフサイクル状態。 |
sync_state | imported、pending、synchronized、retrying、rejected、stale。 |
エラー処理
認証、認可、フィールド検証、資産 ID、競合、プロバイダー停止には、明確なレスポンス、同期ログ、人による処理経路を用意します。
実行インターフェース補足
| 機能 | 代表的なインターフェース |
|---|---|
| 技術者とクルー | GET /api/v1/technicians, GET /api/v1/crews, PUT /api/v1/workorders/id/assign-resource |
| 予防保全 | GET /api/v1/maintenance-schedules, GET /api/v1/maintenance-calendar, POST /api/v1/maintenance-completions |
| 予備品と在庫 | GET /api/v1/spare-parts, GET /api/v1/inventory, POST /api/v1/inventory/transactions |
CMMS Agent と MCP ツールアンカー
CMMS Agent ツールの表面は、テナントの Agent 設定でスコープされます。tools/list には、現在の Agent にバインドされた CMMS ツールだけを表示します。tools/call は、実行前にテナントスコープ、権限確認、リスク上限、冪等性、監査を適用します。
| ツール | 権限 | 契約 |
|---|---|---|
cmms_query_backlog | cmms.read | 作業指示バックログ総数、優先度分布、SLA 違反件数を読み取ります。 |
cmms_query_equipment | cmms.read | 設備または資産記録を読み取り、必要に応じてサイトで絞り込みます。 |
cmms_query_work_orders | cmms.read | 状態、設備、ページ範囲で作業指示を読み取ります。 |
cmms_suggest_technician | cmms.read | 利用可能な技術者候補を返します。割り当ては行いません。 |
cmms_create_work_request | workorders.create | 依頼または現場課題レポートを作成し、監査記録を残します。 |
cmms_create_work_order | workorders.create | 必要なレビューまたは確認後に作業指示を作成します。 |
cmms_assign_work_order | workorders.assign | 確認後、作業指示を技術者またはクルーに割り当てます。 |
cmms_close_work_order | workorders.complete | 確認後に作業指示を完了します。完了は終端の運用アクションです。 |
読み取りツールはスコープと権限確認後に実行されます。作業依頼作成は監査付きの低リスク書き込みです。作業指示作成、割り当て、完了は、責任者が確認するまで確認待ちの状態にします。同じ論理アクションを再試行する場合、呼び出し側は安定した冪等キーを渡します。
正式なプロジェクトでは、導入環境で公開される OpenAPI と顧客側の権限マトリクスを基準にします。