Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Interface EquipmentHierarchyService

All Known Implementing Classes:
DefaultEquipmentHierarchyService
public interface EquipmentHierarchyService

This service allows you to read the hierarchy of an equipment along with a list of subequipment that is installed on the superior equipment. The request contains all the information that is necessary to read an equipment hierarchy. If the input in the request is not as expected, the system displays appropriate error or warning messages in the response. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service: EQUIPMENTSTRUCLIST_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Asset Management Master Data Integration(SAP_COM_0395)
Scope Items: Service Order Management and Monitoring(3D2), Service Contract Management(3MO), In-House Repair(3XK), Reactive Maintenance(4HH), Proactive Maintenance(4HI), Improvement Maintenance(4VT), Operational and Overhead Maintenance(4WM), Corrective Maintenance(BH1), Emergency Maintenance(BH2), Preventive Maintenance(BJ2), Reactive Maintenance(OHH), Proactive Maintenance(OHI), PSM: Preventive Maintenance(OJ2), Improvement Maintenance(OVT), Operational and Overhead Maintenance(OWM), Service Order Processing with SAP Field Service Management(49X), Service Quotation(4GA)
Authentication Methods: x509
Service Group Name: API_EQUIPMENT_STRUCLIST
Business Object: Equipment

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull EquipmentHierarchyService withServicePath(@Nonnull String servicePath)
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • batch

      @Nonnull BatchRequestBuilder batch()
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

    • getAllEquipmentStructureList

      @Nonnull GetAllRequestBuilder<EquipmentStrucList> getAllEquipmentStructureList()
      Fetch multiple EquipmentStrucList entities.
      Returns:
      A request builder to fetch multiple EquipmentStrucList entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • countEquipmentStructureList

      @Nonnull CountRequestBuilder<EquipmentStrucList> countEquipmentStructureList()
      Fetch the number of entries from the EquipmentStrucList entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of EquipmentStrucList entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

    • getEquipmentStructureListByKey

      @Nonnull GetByKeyRequestBuilder<EquipmentStrucList> getEquipmentStructureListByKey(String equipment, LocalDate validityEndDate)
      Fetch a single EquipmentStrucList entity using key fields.
      Parameters:
      equipment - Equipment Number

      Constraints: Not nullable, Maximum length: 18

      validityEndDate - Valid To Date

      Constraints: Not nullable

      Returns:
      A request builder to fetch a single EquipmentStrucList entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.