Interface FunctionalLocationHierarchyService

All Known Implementing Classes:
DefaultFunctionalLocationHierarchyService

@Deprecated public interface FunctionalLocationHierarchyService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service allows you to read the hierarchy of a functional location along with the equipment installed on the functional location. The request contains all the information that is necessary to read a functional location 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 Business Accelerator Hub

Details:

OData Service: FUNCNLLOCSTRUCLIST_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_FUNCNLLOC_STRUCLIST
Business Object: Functional Location
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull FunctionalLocationHierarchyService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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()
      Deprecated.
      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.
    • getAllFuncnlLocEquipStrucList

      @Nonnull GetAllRequestBuilder<FuncnlLocEquipStrucList> getAllFuncnlLocEquipStrucList()
      Deprecated.
      Fetch multiple FuncnlLocEquipStrucList entities.
      Returns:
      A request builder to fetch multiple FuncnlLocEquipStrucList 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.
    • countFuncnlLocEquipStrucList

      @Nonnull CountRequestBuilder<FuncnlLocEquipStrucList> countFuncnlLocEquipStrucList()
      Deprecated.
      Fetch the number of entries from the FuncnlLocEquipStrucList entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of FuncnlLocEquipStrucList 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.
    • getFuncnlLocEquipStrucListByKey

      @Nonnull GetByKeyRequestBuilder<FuncnlLocEquipStrucList> getFuncnlLocEquipStrucListByKey(String equipment, LocalDate validityEndDate)
      Deprecated.
      Fetch a single FuncnlLocEquipStrucList 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 FuncnlLocEquipStrucList 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.
    • getAllFunctionalLocationStrucList

      @Nonnull GetAllRequestBuilder<FuncnlLocStrucList> getAllFunctionalLocationStrucList()
      Deprecated.
      Fetch multiple FuncnlLocStrucList entities.
      Returns:
      A request builder to fetch multiple FuncnlLocStrucList 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.
    • countFunctionalLocationStrucList

      @Nonnull CountRequestBuilder<FuncnlLocStrucList> countFunctionalLocationStrucList()
      Deprecated.
      Fetch the number of entries from the FuncnlLocStrucList entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of FuncnlLocStrucList 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.
    • getFunctionalLocationStrucListByKey

      @Nonnull GetByKeyRequestBuilder<FuncnlLocStrucList> getFunctionalLocationStrucListByKey(String functionalLocation)
      Deprecated.
      Fetch a single FuncnlLocStrucList entity using key fields.
      Parameters:
      functionalLocation - Functional location

      Constraints: Not nullable, Maximum length: 30

      Returns:
      A request builder to fetch a single FuncnlLocStrucList 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.