APIs: Maintenance Management
An application programming interface (API) is an interface that lets software systems communicate with each other and exchange data. By offering an API for your system, you can define which data should be exposed and thereby maintain control. As the consumer of an API, you don’t have to know how the other system works. Instead, you can focus on how it's integrated into your system. You can use the APIs available for SAP S/4HANA Cloud for these scenarios:
- Connect business processes across your system landscape
- Integrate with external systems
- Develop your own dependent extensions or custom applications
Inbound and Outbound Services
APIs can either be inbound or outbound services.
With respect to SAP S/4HANA Cloud as the source system, inbound means that SAP S/4HANA Cloud provides a service that another system can consume.
Outbound means that SAP S/4HANA Cloud consumes a service that is provided by another system.
Synchronous and Asynchronous Services
APIs can either be synchronous or asynchronous services.
Synchronous means that when a system sends a request it waits for the receiving system to send a response. This approach is useful if an immediate and real-time response is required. However, both systems need to be online the entire time and if there’s an error, the request has to be sent again.
Asynchronous means that when a system sends a request it waits for the receiving system to acknowledge receipt of the message. However, it doesn’t wait for the receiving system to send a response. This way you can loosely couple systems and there’s less dependency on the availability of the other system. Additionally, the sender system isn’t blocked after sending a request and can send further requests. With this approach, you get no immediate response and a response message needs to be implemented and routed separately.
The following table contains all APIs available in Maintenance Management.
APIs In Maintenance Management
Name | Type | Communication Scenario |
---|---|---|
Equipment | ODATA | Asset Management Master Data Integration (SAP_COM_0395) |
Functional Location | ODATA | Asset Management Master Data Integration (SAP_COM_0395) |
Measuring Point | ODATA | Asset Management Master Data Integration (SAP_COM_0395) |
Measurement Document | ODATA | Plant Maintenance Execution Integration (SAP_COM_0398) |
Maintenance Notification | ODATA | Maintenance Processing Integration (SAP_COM_0397) |
Maintenance Order Operation Confirmation | ODATA | Plant Maintenance Execution Integration (SAP_COM_0398) |
Maintenance Task List | ODATA | Asset Management Master Data Integration (SAP_COM_0395) |
Maintenance Plan | ODATA | Maintenance Planning Integration (SAP_COM_0396) |
Maintenance Item | ODATA | Maintenance Planning Integration (SAP_COM_0396) |
Catalog Type Coding - Read | ODATA | Maintenance Processing Integration (SAP_COM_0397) |
Catalog Type Overview of Damage - Read | ODATA | Maintenance Processing Integration (SAP_COM_0397) |
Catalog Type Object Parts- Read | ODATA | Maintenance Processing Integration (SAP_COM_0397) |
For more details on the APIs refer to the link Equipment | SAP Help Portal