Interface MeasurementDocumentService

All Known Implementing Classes:
DefaultMeasurementDocumentService

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

The data transferred to the system after a measurement has been taken at a measuring point or a counter is described in the SAP system as a measurement document. The payload used to create a measurement document through this API is sent in JSON format as a request object. The long text for the measurement document is included within as a nested object. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: MEASUREMENTDOCUMENT_0001
API Version: 1.1.0
Minimum ERP Version: 2302
Communication Scenario: Plant Maintenance Execution Integration(SAP_COM_0398)
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_MEASUREMENTDOCUMENT
Business Object: Measurement Document
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull MeasurementDocumentService 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.
    • getAllFailedMeasurementReading

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

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

      @Nonnull GetByKeyRequestBuilder<FailedMeasurementReading> getFailedMeasurementReadingByKey(LocalDate msmtRdngDate, LocalTime msmtRdngTime, String msmtRdngSourceMeasurementDoc, String measuringPoint)
      Deprecated.
      Fetch a single FailedMeasurementReading entity using key fields.
      Parameters:
      msmtRdngDate - Date of the Measurement

      Constraints: Not nullable

      measuringPoint - Measuring Point

      Constraints: Not nullable, Maximum length: 12

      msmtRdngTime - Time of Measurement

      Constraints: Not nullable

      msmtRdngSourceMeasurementDoc - Source Document for Measurement Reading Transfer

      Constraints: Not nullable, Maximum length: 20

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

      @Nonnull CreateRequestBuilder<FailedMeasurementReading> createFailedMeasurementReading(@Nonnull FailedMeasurementReading failedMeasurementReading)
      Deprecated.
      Create a new FailedMeasurementReading entity and save it to the S/4HANA system.
      Parameters:
      failedMeasurementReading - FailedMeasurementReading entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new FailedMeasurementReading entity. To perform execution, call the execute method on the request builder object.
    • getAllMeasurementDocument

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

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

      @Nonnull GetByKeyRequestBuilder<MeasurementDocument> getMeasurementDocumentByKey(String measurementDocument)
      Deprecated.
      Fetch a single MeasurementDocument entity using key fields.
      Parameters:
      measurementDocument - Measurement Document

      Constraints: Not nullable, Maximum length: 20

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

      @Nonnull CreateRequestBuilder<MeasurementDocument> createMeasurementDocument(@Nonnull MeasurementDocument measurementDocument)
      Deprecated.
      Create a new MeasurementDocument entity and save it to the S/4HANA system.
      Parameters:
      measurementDocument - MeasurementDocument entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new MeasurementDocument entity. To perform execution, call the execute method on the request builder object.
    • updateMeasurementDocument

      @Nonnull UpdateRequestBuilder<MeasurementDocument> updateMeasurementDocument(@Nonnull MeasurementDocument measurementDocument)
      Deprecated.
      Update an existing MeasurementDocument entity and save it to the S/4HANA system.
      Parameters:
      measurementDocument - MeasurementDocument entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing MeasurementDocument entity. To perform execution, call the execute method on the request builder object.
    • getAllMsmtDocumentLongText

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

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

      @Nonnull GetByKeyRequestBuilder<MsmtDocumentLongText> getMsmtDocumentLongTextByKey(String measurementDocument)
      Deprecated.
      Fetch a single MsmtDocumentLongText entity using key fields.
      Parameters:
      measurementDocument - Measurement Document

      Constraints: Not nullable, Maximum length: 20

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

      @Nonnull CreateRequestBuilder<MsmtDocumentLongText> createMsmtDocumentLongText(@Nonnull MsmtDocumentLongText msmtDocumentLongText)
      Deprecated.
      Create a new MsmtDocumentLongText entity and save it to the S/4HANA system.
      Parameters:
      msmtDocumentLongText - MsmtDocumentLongText entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new MsmtDocumentLongText entity. To perform execution, call the execute method on the request builder object.
    • updateMsmtDocumentLongText

      @Nonnull UpdateRequestBuilder<MsmtDocumentLongText> updateMsmtDocumentLongText(@Nonnull MsmtDocumentLongText msmtDocumentLongText)
      Deprecated.
      Update an existing MsmtDocumentLongText entity and save it to the S/4HANA system.
      Parameters:
      msmtDocumentLongText - MsmtDocumentLongText entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing MsmtDocumentLongText entity. To perform execution, call the execute method on the request builder object.