About Work Management API¶
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.
For more information, see About Work Management.
The APIs in Work Management are some of the APIs EnOS provides that cover the core business processes of the system. For more information about EnOS APIs and the different APIs that EnOS provides, see About EnOS API.
For more information about how to invoke EnOS APIs, see Get Started with EnOS API.
API List¶
Refer to the table below for the list of APIs, and whether they can be used by EnOS Cloud and EnOS Edge.
| Operation Name | Description | URL | EnOS Cloud | EnOS Edge |
|---|---|---|---|---|
| Get Service Request List | Get service request list | /work-management/v1.0/service-request/list | √ | √ |
| Get Service Request Details | Get service request details | /work-management/v1.0/s-taskmgmtds/cmms/service-request/detail | √ | √ |
| Get Work Order List | Get work order list | /work-management/v1.0/s-taskmgmtds/cmms/work-order/list | √ | √ |
| Get Work Order Details | Get work order details | /work-management/v1.0/s-taskmgmtds/cmms/work-order/detail | √ | √ |
| Get Relation List/Downtime | Get associated record/downtime record details | /work-management-cmms/v1.0/s-taskmgmtds/cmms/common/issue-relation/search | √ | √ |
API Editions¶
The following table lists the API services included in Work Management Enterprise and Lightweight editions.
| Operation Name | Enterprise | Lightweight |
|---|---|---|
| Get Service Request List | √ | √ |
| Get Service Request Details | √ | √ |
| Get Work Order List | √ | √ |
| Get Work Order Details | √ | √ |
| Get Relation List/Downtime | √ | √ |