Work Management API Overview¶
Work Management is a computerized maintenance management system (CMMS) based on EnOS Cloud, and is tightly integrated with the EnOS native Monitoring & Control and Advanced Analytics applications. It can be used both as an end-to-end native ticket management tool, and also as an integration bridge between EnOS Monitoring & Control and Advanced Analytics applications and third-party CMMSs.
Through Work Management APIs, application developers can retrieve the current OU service account, work order lists and details, as well as associated records/outage record details. For a complete list of interfaces and functional descriptions of Work Management API, see API List.
Work Management API is classified as follows.
CMMS API: help external applications retrieve ticket information of work management. For example: get the work order list and service request list. This document covers the work order system API information.
Connector API: used to connect EnOS native applications (Monitoring & Control and Advanced Analytics, etc.) to a third-party CMMS. It provides a standard API and development framework to support rapid development of adapters to support the integration of additional CMMSs.
Prerequisites¶
Ensure that you have obtained a service account, and the service account has the permission to call the Work Management APIs. For more information, see API Authentication.
The user has logged in to Application Portal and entered an OU.
API List
¶
You can see what operations can be used via these APIs, the URL corresponding to each operation, and whether it is applicable to EnOS Cloud and EnOS Edge in the following table.
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
|---|---|---|---|---|
Get service request list |
/work-management/v1.0/service-request/list |
√ |
√ |
|
Get service request details |
/work-management/v1.0/s-taskmgmtds/cmms/service-request/detail |
√ |
√ |
|
Get work order list |
/work-management/v1.0/s-taskmgmtds/cmms/work-order/list |
√ |
√ |
|
Get work order details |
/work-management/v1.0/s-taskmgmtds/cmms/work-order/detail |
√ |
√ |
|
Get associated record/downtime record details |
/work-management-cmms/v1.0/s-taskmgmtds/cmms/common/issue-relation/search |
√ |
√ |
|
Update work order. You can update relevant information of the work order, including the work order title, site IDs, etc., by specifying the woId. |
/work-management-cmms/v1.0/cmms/work-order/update |
√ |
× |