com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services

Interface ServiceRequestService

All Superinterfaces:

BatchService<ServiceRequestServiceBatch>

All Known Implementing Classes:

DefaultServiceRequestService

public interface ServiceRequestService
extends BatchService<ServiceRequestServiceBatch>

The service contains header, reference object, person responsible, reason, order, defect, and text entities. The information is sent in the request as a payload. All information is used when creating, updating or deleting a service request data, including appropriate checks for restricted values and authorizations. Once the service request has been created or updated, the service request information is sent in the response. If there are any issues when the service request is created or updated, the system returns error messages. In each API call, you can use the following operations: - Retrieve service requests. - Create service requests. Note: You must use “deep insert” requests (a header plus the following entities: person responsible, text, reason, defect, and reference object). - Create new reference object, person responsible, text, reason, defect, for existing service requests. - Update the header, person responsible, text, reason, and defect for existing service requests. - Delete the person responsible, text, reason, defect, and reference object for existing service requests. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_SERVICE_REQUEST_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Service Request

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
ServiceRequestCreateFluentHelper	createServiceRequest(ServiceRequest serviceRequest) Create a new ServiceRequest entity and save it to the S/4HANA system.
ServiceRequestDefectCreateFluentHelper	createServiceRequestDefect(ServiceRequestDefect serviceRequestDefect) Create a new ServiceRequestDefect entity and save it to the S/4HANA system.
ServiceRequestPersonRespCreateFluentHelper	createServiceRequestPersonResp(ServiceRequestPersonResp serviceRequestPersonResp) Create a new ServiceRequestPersonResp entity and save it to the S/4HANA system.
ServiceRequestReasonCreateFluentHelper	createServiceRequestReason(ServiceRequestReason serviceRequestReason) Create a new ServiceRequestReason entity and save it to the S/4HANA system.
ServiceRequestRefObjectCreateFluentHelper	createServiceRequestRefObject(ServiceRequestRefObject serviceRequestRefObject) Create a new ServiceRequestRefObject entity and save it to the S/4HANA system.
ServiceRequestTextCreateFluentHelper	createServiceRequestText(ServiceRequestText serviceRequestText) Create a new ServiceRequestText entity and save it to the S/4HANA system.
ServiceRequestDefectDeleteFluentHelper	deleteServiceRequestDefect(ServiceRequestDefect serviceRequestDefect) Deletes an existing ServiceRequestDefect entity in the S/4HANA system.
ServiceRequestPersonRespDeleteFluentHelper	deleteServiceRequestPersonResp(ServiceRequestPersonResp serviceRequestPersonResp) Deletes an existing ServiceRequestPersonResp entity in the S/4HANA system.
ServiceRequestReasonDeleteFluentHelper	deleteServiceRequestReason(ServiceRequestReason serviceRequestReason) Deletes an existing ServiceRequestReason entity in the S/4HANA system.
ServiceRequestRefObjectDeleteFluentHelper	deleteServiceRequestRefObject(ServiceRequestRefObject serviceRequestRefObject) Deletes an existing ServiceRequestRefObject entity in the S/4HANA system.
ServiceRequestTextDeleteFluentHelper	deleteServiceRequestText(ServiceRequestText serviceRequestText) Deletes an existing ServiceRequestText entity in the S/4HANA system.
ServiceRequestFluentHelper	getAllServiceRequest() Fetch multiple ServiceRequest entities.
ServiceRequestDefectFluentHelper	getAllServiceRequestDefect() Fetch multiple ServiceRequestDefect entities.
ServiceRequestOrderFluentHelper	getAllServiceRequestOrder() Fetch multiple ServiceRequestOrder entities.
ServiceRequestPersonRespFluentHelper	getAllServiceRequestPersonResp() Fetch multiple ServiceRequestPersonResp entities.
ServiceRequestReasonFluentHelper	getAllServiceRequestReason() Fetch multiple ServiceRequestReason entities.
ServiceRequestRefObjectFluentHelper	getAllServiceRequestRefObject() Fetch multiple ServiceRequestRefObject entities.
ServiceRequestTextFluentHelper	getAllServiceRequestText() Fetch multiple ServiceRequestText entities.
ServiceRequestByKeyFluentHelper	getServiceRequestByKey(String serviceRequest) Fetch a single ServiceRequest entity using key fields.
ServiceRequestDefectByKeyFluentHelper	getServiceRequestDefectByKey(String serviceRequest, String srvcDocTypeDefectCodeProfType, Short serviceDefectSequence) Fetch a single ServiceRequestDefect entity using key fields.
ServiceRequestOrderByKeyFluentHelper	getServiceRequestOrderByKey(String serviceRequest, String serviceOrder) Fetch a single ServiceRequestOrder entity using key fields.
ServiceRequestPersonRespByKeyFluentHelper	getServiceRequestPersonRespByKey(String serviceRequest, String personResponsible) Fetch a single ServiceRequestPersonResp entity using key fields.
ServiceRequestReasonByKeyFluentHelper	getServiceRequestReasonByKey(String serviceRequest) Fetch a single ServiceRequestReason entity using key fields.
ServiceRequestRefObjectByKeyFluentHelper	getServiceRequestRefObjectByKey(String serviceRequest, String serviceReferenceEquipment, String serviceRefFunctionalLocation) Fetch a single ServiceRequestRefObject entity using key fields.
ServiceRequestTextByKeyFluentHelper	getServiceRequestTextByKey(String serviceRequest, String language, String longTextID) Fetch a single ServiceRequestText entity using key fields.
ServiceRequestUpdateFluentHelper	updateServiceRequest(ServiceRequest serviceRequest) Update an existing ServiceRequest entity and save it to the S/4HANA system.
ServiceRequestDefectUpdateFluentHelper	updateServiceRequestDefect(ServiceRequestDefect serviceRequestDefect) Update an existing ServiceRequestDefect entity and save it to the S/4HANA system.
ServiceRequestPersonRespUpdateFluentHelper	updateServiceRequestPersonResp(ServiceRequestPersonResp serviceRequestPersonResp) Update an existing ServiceRequestPersonResp entity and save it to the S/4HANA system.
ServiceRequestReasonUpdateFluentHelper	updateServiceRequestReason(ServiceRequestReason serviceRequestReason) Update an existing ServiceRequestReason entity and save it to the S/4HANA system.
ServiceRequestTextUpdateFluentHelper	updateServiceRequestText(ServiceRequestText serviceRequestText) Update an existing ServiceRequestText entity and save it to the S/4HANA system.
ServiceRequestService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

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
ServiceRequestService 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.

getAllServiceRequest

@Nonnull
ServiceRequestFluentHelper getAllServiceRequest()

Fetch multiple ServiceRequest entities.

Returns:

A fluent helper to fetch multiple ServiceRequest entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestByKey

@Nonnull
ServiceRequestByKeyFluentHelper getServiceRequestByKey(String serviceRequest)

Fetch a single ServiceRequest entity using key fields.

Parameters:

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createServiceRequest

@Nonnull
ServiceRequestCreateFluentHelper createServiceRequest(@Nonnull
                                                               ServiceRequest serviceRequest)

Create a new ServiceRequest entity and save it to the S/4HANA system.

Parameters:

serviceRequest - ServiceRequest entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ServiceRequest entity. To perform execution, call the execute method on the fluent helper object.

updateServiceRequest

@Nonnull
ServiceRequestUpdateFluentHelper updateServiceRequest(@Nonnull
                                                               ServiceRequest serviceRequest)

Update an existing ServiceRequest entity and save it to the S/4HANA system.

Parameters:

serviceRequest - ServiceRequest entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ServiceRequest entity. To perform execution, call the execute method on the fluent helper object.

getAllServiceRequestDefect

@Nonnull
ServiceRequestDefectFluentHelper getAllServiceRequestDefect()

Fetch multiple ServiceRequestDefect entities.

Returns:

A fluent helper to fetch multiple ServiceRequestDefect entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestDefectByKey

@Nonnull
ServiceRequestDefectByKeyFluentHelper getServiceRequestDefectByKey(String serviceRequest,
                                                                            String srvcDocTypeDefectCodeProfType,
                                                                            Short serviceDefectSequence)

Fetch a single ServiceRequestDefect entity using key fields.

Parameters:

serviceDefectSequence - Sort Field

Constraints: Not nullable

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

srvcDocTypeDefectCodeProfType - Subject Profile Category

Constraints: Not nullable, Maximum length: 2

Returns:

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

createServiceRequestDefect

@Nonnull
ServiceRequestDefectCreateFluentHelper createServiceRequestDefect(@Nonnull
                                                                           ServiceRequestDefect serviceRequestDefect)

Create a new ServiceRequestDefect entity and save it to the S/4HANA system.

Parameters:

serviceRequestDefect - ServiceRequestDefect entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ServiceRequestDefect entity. To perform execution, call the execute method on the fluent helper object.

updateServiceRequestDefect

@Nonnull
ServiceRequestDefectUpdateFluentHelper updateServiceRequestDefect(@Nonnull
                                                                           ServiceRequestDefect serviceRequestDefect)

Update an existing ServiceRequestDefect entity and save it to the S/4HANA system.

Parameters:

serviceRequestDefect - ServiceRequestDefect entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ServiceRequestDefect entity. To perform execution, call the execute method on the fluent helper object.

deleteServiceRequestDefect

@Nonnull
ServiceRequestDefectDeleteFluentHelper deleteServiceRequestDefect(@Nonnull
                                                                           ServiceRequestDefect serviceRequestDefect)

Deletes an existing ServiceRequestDefect entity in the S/4HANA system.

Parameters:

serviceRequestDefect - ServiceRequestDefect entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ServiceRequestDefect entity. To perform execution, call the execute method on the fluent helper object.

getAllServiceRequestOrder

@Nonnull
ServiceRequestOrderFluentHelper getAllServiceRequestOrder()

Fetch multiple ServiceRequestOrder entities.

Returns:

A fluent helper to fetch multiple ServiceRequestOrder entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestOrderByKey

@Nonnull
ServiceRequestOrderByKeyFluentHelper getServiceRequestOrderByKey(String serviceRequest,
                                                                          String serviceOrder)

Fetch a single ServiceRequestOrder entity using key fields.

Parameters:

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

serviceOrder - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllServiceRequestPersonResp

@Nonnull
ServiceRequestPersonRespFluentHelper getAllServiceRequestPersonResp()

Fetch multiple ServiceRequestPersonResp entities.

Returns:

A fluent helper to fetch multiple ServiceRequestPersonResp entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestPersonRespByKey

@Nonnull
ServiceRequestPersonRespByKeyFluentHelper getServiceRequestPersonRespByKey(String serviceRequest,
                                                                                    String personResponsible)

Fetch a single ServiceRequestPersonResp entity using key fields.

Parameters:

personResponsible - Business Partner Number

Constraints: Not nullable, Maximum length: 10

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createServiceRequestPersonResp

@Nonnull
ServiceRequestPersonRespCreateFluentHelper createServiceRequestPersonResp(@Nonnull
                                                                                   ServiceRequestPersonResp serviceRequestPersonResp)

Create a new ServiceRequestPersonResp entity and save it to the S/4HANA system.

Parameters:

serviceRequestPersonResp - ServiceRequestPersonResp entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ServiceRequestPersonResp entity. To perform execution, call the execute method on the fluent helper object.

updateServiceRequestPersonResp

@Nonnull
ServiceRequestPersonRespUpdateFluentHelper updateServiceRequestPersonResp(@Nonnull
                                                                                   ServiceRequestPersonResp serviceRequestPersonResp)

Update an existing ServiceRequestPersonResp entity and save it to the S/4HANA system.

Parameters:

serviceRequestPersonResp - ServiceRequestPersonResp entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ServiceRequestPersonResp entity. To perform execution, call the execute method on the fluent helper object.

deleteServiceRequestPersonResp

@Nonnull
ServiceRequestPersonRespDeleteFluentHelper deleteServiceRequestPersonResp(@Nonnull
                                                                                   ServiceRequestPersonResp serviceRequestPersonResp)

Deletes an existing ServiceRequestPersonResp entity in the S/4HANA system.

Parameters:

serviceRequestPersonResp - ServiceRequestPersonResp entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ServiceRequestPersonResp entity. To perform execution, call the execute method on the fluent helper object.

getAllServiceRequestReason

@Nonnull
ServiceRequestReasonFluentHelper getAllServiceRequestReason()

Fetch multiple ServiceRequestReason entities.

Returns:

A fluent helper to fetch multiple ServiceRequestReason entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestReasonByKey

@Nonnull
ServiceRequestReasonByKeyFluentHelper getServiceRequestReasonByKey(String serviceRequest)

Fetch a single ServiceRequestReason entity using key fields.

Parameters:

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createServiceRequestReason

@Nonnull
ServiceRequestReasonCreateFluentHelper createServiceRequestReason(@Nonnull
                                                                           ServiceRequestReason serviceRequestReason)

Create a new ServiceRequestReason entity and save it to the S/4HANA system.

Parameters:

serviceRequestReason - ServiceRequestReason entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ServiceRequestReason entity. To perform execution, call the execute method on the fluent helper object.

updateServiceRequestReason

@Nonnull
ServiceRequestReasonUpdateFluentHelper updateServiceRequestReason(@Nonnull
                                                                           ServiceRequestReason serviceRequestReason)

Update an existing ServiceRequestReason entity and save it to the S/4HANA system.

Parameters:

serviceRequestReason - ServiceRequestReason entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ServiceRequestReason entity. To perform execution, call the execute method on the fluent helper object.

deleteServiceRequestReason

@Nonnull
ServiceRequestReasonDeleteFluentHelper deleteServiceRequestReason(@Nonnull
                                                                           ServiceRequestReason serviceRequestReason)

Deletes an existing ServiceRequestReason entity in the S/4HANA system.

Parameters:

serviceRequestReason - ServiceRequestReason entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ServiceRequestReason entity. To perform execution, call the execute method on the fluent helper object.

getAllServiceRequestRefObject

@Nonnull
ServiceRequestRefObjectFluentHelper getAllServiceRequestRefObject()

Fetch multiple ServiceRequestRefObject entities.

Returns:

A fluent helper to fetch multiple ServiceRequestRefObject entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestRefObjectByKey

@Nonnull
ServiceRequestRefObjectByKeyFluentHelper getServiceRequestRefObjectByKey(String serviceRequest,
                                                                                  String serviceReferenceEquipment,
                                                                                  String serviceRefFunctionalLocation)

Fetch a single ServiceRequestRefObject entity using key fields.

Parameters:

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

serviceRefFunctionalLocation - Functional Location

Constraints: Not nullable, Maximum length: 40

serviceReferenceEquipment - Equipment Number

Constraints: Not nullable, Maximum length: 18

Returns:

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

createServiceRequestRefObject

@Nonnull
ServiceRequestRefObjectCreateFluentHelper createServiceRequestRefObject(@Nonnull
                                                                                 ServiceRequestRefObject serviceRequestRefObject)

Create a new ServiceRequestRefObject entity and save it to the S/4HANA system.

Parameters:

serviceRequestRefObject - ServiceRequestRefObject entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ServiceRequestRefObject entity. To perform execution, call the execute method on the fluent helper object.

deleteServiceRequestRefObject

@Nonnull
ServiceRequestRefObjectDeleteFluentHelper deleteServiceRequestRefObject(@Nonnull
                                                                                 ServiceRequestRefObject serviceRequestRefObject)

Deletes an existing ServiceRequestRefObject entity in the S/4HANA system.

Parameters:

serviceRequestRefObject - ServiceRequestRefObject entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ServiceRequestRefObject entity. To perform execution, call the execute method on the fluent helper object.

getAllServiceRequestText

@Nonnull
ServiceRequestTextFluentHelper getAllServiceRequestText()

Fetch multiple ServiceRequestText entities.

Returns:

A fluent helper to fetch multiple ServiceRequestText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getServiceRequestTextByKey

@Nonnull
ServiceRequestTextByKeyFluentHelper getServiceRequestTextByKey(String serviceRequest,
                                                                        String language,
                                                                        String longTextID)

Fetch a single ServiceRequestText entity using key fields.

Parameters:

serviceRequest - Transaction ID

Constraints: Not nullable, Maximum length: 10

language - Language Key

Constraints: Not nullable, Maximum length: 2

longTextID - Text ID

Constraints: Not nullable, Maximum length: 4

Returns:

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

createServiceRequestText

@Nonnull
ServiceRequestTextCreateFluentHelper createServiceRequestText(@Nonnull
                                                                       ServiceRequestText serviceRequestText)

Create a new ServiceRequestText entity and save it to the S/4HANA system.

Parameters:

serviceRequestText - ServiceRequestText entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ServiceRequestText entity. To perform execution, call the execute method on the fluent helper object.

updateServiceRequestText

@Nonnull
ServiceRequestTextUpdateFluentHelper updateServiceRequestText(@Nonnull
                                                                       ServiceRequestText serviceRequestText)

Update an existing ServiceRequestText entity and save it to the S/4HANA system.

Parameters:

serviceRequestText - ServiceRequestText entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ServiceRequestText entity. To perform execution, call the execute method on the fluent helper object.

deleteServiceRequestText

@Nonnull
ServiceRequestTextDeleteFluentHelper deleteServiceRequestText(@Nonnull
                                                                       ServiceRequestText serviceRequestText)

Deletes an existing ServiceRequestText entity in the S/4HANA system.

Parameters:

serviceRequestText - ServiceRequestText entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing ServiceRequestText entity. To perform execution, call the execute method on the fluent helper object.