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

Interface MeasurementDocumentService

All Known Implementing Classes:

DefaultMeasurementDocumentService

public interface MeasurementDocumentService

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 API Business Hub

Details:

OData Service:	MEASUREMENTDOCUMENT_0001
API Version:	1
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), Service Order processing with SAP Field service management (49X), Service Quotation (4GA), Reactive Maintenance (4HH), Proactive Maintenance (4HI), Improvement Maintenance (4VT), Operational and Overhead Maintenance (4WM), Corrective Maintenance (BH1), Emergency Maintenance (BH2), Preventive Maintenance (BJ2)
Authentication Methods:	Basic, x509, OAuth2
Service Group Name:	API_MEASUREMENTDOCUMENT
Business Object:	MeasurementDocument

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<MeasurementDocument>	countMeasurementDocument() Fetch the number of entries from the MeasurementDocument entity collection matching the filter and search expressions.
CountRequestBuilder<MsmtDocumentLongText>	countMsmtDocumentLongText() Fetch the number of entries from the MsmtDocumentLongText entity collection matching the filter and search expressions.
CreateRequestBuilder<MeasurementDocument>	createMeasurementDocument(MeasurementDocument measurementDocument) Create a new MeasurementDocument entity and save it to the S/4HANA system.
CreateRequestBuilder<MsmtDocumentLongText>	createMsmtDocumentLongText(MsmtDocumentLongText msmtDocumentLongText) Create a new MsmtDocumentLongText entity and save it to the S/4HANA system.
GetAllRequestBuilder<MeasurementDocument>	getAllMeasurementDocument() Fetch multiple MeasurementDocument entities.
GetAllRequestBuilder<MsmtDocumentLongText>	getAllMsmtDocumentLongText() Fetch multiple MsmtDocumentLongText entities.
GetByKeyRequestBuilder<MeasurementDocument>	getMeasurementDocumentByKey(String measurementDocument) Fetch a single MeasurementDocument entity using key fields.
GetByKeyRequestBuilder<MsmtDocumentLongText>	getMsmtDocumentLongTextByKey(String measurementDocument) Fetch a single MsmtDocumentLongText entity using key fields.
UpdateRequestBuilder<MeasurementDocument>	updateMeasurementDocument(MeasurementDocument measurementDocument) Update an existing MeasurementDocument entity and save it to the S/4HANA system.
UpdateRequestBuilder<MsmtDocumentLongText>	updateMsmtDocumentLongText(MsmtDocumentLongText msmtDocumentLongText) Update an existing MsmtDocumentLongText entity and save it to the S/4HANA system.
MeasurementDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

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

getAllMeasurementDocument

@Nonnull
GetAllRequestBuilder<MeasurementDocument> getAllMeasurementDocument()

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()

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(@Nonnull
                                                                                 String measurementDocument)

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)

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)

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()

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()

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(@Nonnull
                                                                                   String measurementDocument)

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)

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)

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.