EnOS 工作管理 API 概述¶
工作管理(Work Management)是基于 EnOS Cloud 的设备维护管理系统(Computerized Maintenance Management System,以下简称 CMMS),与 EnOS 原生的集控和高级分析等应用紧密集成。既可作为端到端的原生单据管理工具,也可作为 EnOS 集控和高级分析等应用与第三方 CMMS 之间的集成桥梁。
通过工作管理 API,应用开发人员可以获取当前 OU 服务账号和工单列表和详情,以及关联记录/停机记录的详细信息。关于工作 API 的完整接口列表及功能说明,参见 API 列表。
工作管理 API 分为:
工单系统 API:用于外部应用调取工作管理的工单系统信息。例如:获取工单列表与服务请求列表等。本文档主要介绍工单系统 API 信息。
连接器 API:用于连接 EnOS 原生应用(监控和高级分析应用等)至第三方 CMMS。提供标准 API 和开发框架,支持快速开发适配器,以支持额外的 CMMS 系统。
前提条件¶
确保已获取服务账号,且服务账号拥有调用该 API 的权限。更多信息,参见 API 鉴权。
用户已登录应用门户并选择 OU。
API 列表
¶
你可以通过下表了解可以调用工作管理 API 执行哪些操作,每项操作对应的 URL,以及是否适用于 EnOS Cloud 和 EnOS Edge。
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
---|---|---|---|---|
获取服务请求列表。 |
/work-management/v1.0/s-taskmgmtds/cmms/service-request/list |
√ |
√ |
|
获取服务请求详情。 |
/work-management/v1.0/s-taskmgmtds/cmms/service-request/detail |
√ |
√ |
|
获取工单列表。 |
/work-management/v1.0/s-taskmgmtds/cmms/work-order/list |
√ |
√ |
|
获取工单详情。 |
/work-management/v1.0/s-taskmgmtds/cmms/work-order/detail |
√ |
√ |
|
获取关联记录/停机记录详情。 |
/work-management-cmms/v1.0/s-taskmgmtds/cmms/common/issue-relation/search |
√ |
√ |
|
更新工单。您可通过指定工单ID来更新工单的相关信息,包括工单标题,场站ID等。 |
/work-management-cmms/v1.0/cmms/work-order/update |
√ |
× |