Interface MeasurementDocumentService
- All Known Implementing Classes:
DefaultMeasurementDocumentService
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. .
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theFailedMeasurementReadingentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theMeasurementDocumententity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theMsmtDocumentLongTextentity collection matching the filter and search expressions.createFailedMeasurementReading(FailedMeasurementReading failedMeasurementReading) Deprecated.Create a newFailedMeasurementReadingentity and save it to the S/4HANA system.createMeasurementDocument(MeasurementDocument measurementDocument) Deprecated.Create a newMeasurementDocumententity and save it to the S/4HANA system.createMsmtDocumentLongText(MsmtDocumentLongText msmtDocumentLongText) Deprecated.Create a newMsmtDocumentLongTextentity and save it to the S/4HANA system.Deprecated.Fetch multipleFailedMeasurementReadingentities.Deprecated.Fetch multipleMeasurementDocumententities.Deprecated.Fetch multipleMsmtDocumentLongTextentities.getFailedMeasurementReadingByKey(LocalDate msmtRdngDate, LocalTime msmtRdngTime, String msmtRdngSourceMeasurementDoc, String measuringPoint) Deprecated.Fetch a singleFailedMeasurementReadingentity using key fields.getMeasurementDocumentByKey(String measurementDocument) Deprecated.Fetch a singleMeasurementDocumententity using key fields.getMsmtDocumentLongTextByKey(String measurementDocument) Deprecated.Fetch a singleMsmtDocumentLongTextentity using key fields.updateMeasurementDocument(MeasurementDocument measurementDocument) Deprecated.Update an existingMeasurementDocumententity and save it to the S/4HANA system.updateMsmtDocumentLongText(MsmtDocumentLongText msmtDocumentLongText) Deprecated.Update an existingMsmtDocumentLongTextentity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
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
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllFailedMeasurementReading
Deprecated.Fetch multipleFailedMeasurementReadingentities.- Returns:
- A request builder to fetch multiple
FailedMeasurementReadingentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countFailedMeasurementReading
Deprecated.Fetch the number of entries from theFailedMeasurementReadingentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
FailedMeasurementReadingentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getFailedMeasurementReadingByKey
@Nonnull GetByKeyRequestBuilder<FailedMeasurementReading> getFailedMeasurementReadingByKey(LocalDate msmtRdngDate, LocalTime msmtRdngTime, String msmtRdngSourceMeasurementDoc, String measuringPoint) Deprecated.Fetch a singleFailedMeasurementReadingentity using key fields.- Parameters:
msmtRdngDate- Date of the MeasurementConstraints: Not nullable
measuringPoint- Measuring PointConstraints: Not nullable, Maximum length: 12
msmtRdngTime- Time of MeasurementConstraints: Not nullable
msmtRdngSourceMeasurementDoc- Source Document for Measurement Reading TransferConstraints: Not nullable, Maximum length: 20
- Returns:
- A request builder to fetch a single
FailedMeasurementReadingentity 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 theexecutemethod on the request builder object.
-
createFailedMeasurementReading
@Nonnull CreateRequestBuilder<FailedMeasurementReading> createFailedMeasurementReading(@Nonnull FailedMeasurementReading failedMeasurementReading) Deprecated.Create a newFailedMeasurementReadingentity and save it to the S/4HANA system.- Parameters:
failedMeasurementReading-FailedMeasurementReadingentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
FailedMeasurementReadingentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllMeasurementDocument
Deprecated.Fetch multipleMeasurementDocumententities.- Returns:
- A request builder to fetch multiple
MeasurementDocumententities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countMeasurementDocument
Deprecated.Fetch the number of entries from theMeasurementDocumententity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
MeasurementDocumententities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getMeasurementDocumentByKey
@Nonnull GetByKeyRequestBuilder<MeasurementDocument> getMeasurementDocumentByKey(String measurementDocument) Deprecated.Fetch a singleMeasurementDocumententity using key fields.- Parameters:
measurementDocument- Measurement DocumentConstraints: Not nullable, Maximum length: 20
- Returns:
- A request builder to fetch a single
MeasurementDocumententity 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 theexecutemethod on the request builder object.
-
createMeasurementDocument
@Nonnull CreateRequestBuilder<MeasurementDocument> createMeasurementDocument(@Nonnull MeasurementDocument measurementDocument) Deprecated.Create a newMeasurementDocumententity and save it to the S/4HANA system.- Parameters:
measurementDocument-MeasurementDocumententity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
MeasurementDocumententity. To perform execution, call theexecutemethod on the request builder object.
-
updateMeasurementDocument
@Nonnull UpdateRequestBuilder<MeasurementDocument> updateMeasurementDocument(@Nonnull MeasurementDocument measurementDocument) Deprecated.Update an existingMeasurementDocumententity and save it to the S/4HANA system.- Parameters:
measurementDocument-MeasurementDocumententity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
MeasurementDocumententity. To perform execution, call theexecutemethod on the request builder object.
-
getAllMsmtDocumentLongText
Deprecated.Fetch multipleMsmtDocumentLongTextentities.- Returns:
- A request builder to fetch multiple
MsmtDocumentLongTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countMsmtDocumentLongText
Deprecated.Fetch the number of entries from theMsmtDocumentLongTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
MsmtDocumentLongTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getMsmtDocumentLongTextByKey
@Nonnull GetByKeyRequestBuilder<MsmtDocumentLongText> getMsmtDocumentLongTextByKey(String measurementDocument) Deprecated.Fetch a singleMsmtDocumentLongTextentity using key fields.- Parameters:
measurementDocument- Measurement DocumentConstraints: Not nullable, Maximum length: 20
- Returns:
- A request builder to fetch a single
MsmtDocumentLongTextentity 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 theexecutemethod on the request builder object.
-
createMsmtDocumentLongText
@Nonnull CreateRequestBuilder<MsmtDocumentLongText> createMsmtDocumentLongText(@Nonnull MsmtDocumentLongText msmtDocumentLongText) Deprecated.Create a newMsmtDocumentLongTextentity and save it to the S/4HANA system.- Parameters:
msmtDocumentLongText-MsmtDocumentLongTextentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
MsmtDocumentLongTextentity. To perform execution, call theexecutemethod on the request builder object.
-
updateMsmtDocumentLongText
@Nonnull UpdateRequestBuilder<MsmtDocumentLongText> updateMsmtDocumentLongText(@Nonnull MsmtDocumentLongText msmtDocumentLongText) Deprecated.Update an existingMsmtDocumentLongTextentity and save it to the S/4HANA system.- Parameters:
msmtDocumentLongText-MsmtDocumentLongTextentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
MsmtDocumentLongTextentity. To perform execution, call theexecutemethod on the request builder object.
-