@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultServiceOrderTemplateService") public class DefaultServiceOrderTemplateService extends Object implements ServiceOrderTemplateService
You can use this service to integrate external applications with service order processing in SAP S/4HANA. In each API call, you can use the following operations: - Retrieve service order templates. - Create service order templates. Note: You must use “deep insert” requests (a header plus the following entities: header person responsible, header text, and item). - Create new items for existing service order templates. - Create an item reference object, and an item text for existing service order template items. - Update the header, header person responsible, header text, item, and item text for existing service order templates. - Delete the header person responsible, header reference object, header text, item, item reference object, and item text for existing service order templates. This service enables you to add attachments to a service order template header and service order template items by making an API call to the service Attachments (API_CV_ATTACHMENT_SRV). You can also use the service Attachments to download and delete attachments from a service order template header and service order template items..
Reference: SAP API Business Hub
| OData Service: | OP_API_SERVICE_ORDER_TEMPLATE_SRV_0001 |
| API Version: | 1 |
| Minimum ERP Version: | 2020 |
| Authentication Methods: | Basic, x509 |
| Business Object: | Service Order Template |
DEFAULT_SERVICE_PATH| Constructor and Description |
|---|
DefaultServiceOrderTemplateService()
Creates a service using
ServiceOrderTemplateService.DEFAULT_SERVICE_PATH to send the requests. |
public DefaultServiceOrderTemplateService()
ServiceOrderTemplateService.DEFAULT_SERVICE_PATH to send the requests.@Nonnull public DefaultServiceOrderTemplateService withServicePath(@Nonnull String servicePath)
ServiceOrderTemplateServicewithServicePath in interface ServiceOrderTemplateServiceservicePath - Service path that will override the default.@Nonnull public DefaultServiceOrderTemplateServiceBatch batch()
batch in interface BatchService<ServiceOrderTemplateServiceBatch>@Nonnull public ServiceOrderTemplateFluentHelper getAllServiceOrderTemplate()
ServiceOrderTemplateServiceServiceOrderTemplate entities.getAllServiceOrderTemplate in interface ServiceOrderTemplateServiceServiceOrderTemplate 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.@Nonnull public ServiceOrderTemplateByKeyFluentHelper getServiceOrderTemplateByKey(String serviceOrderTemplate)
ServiceOrderTemplateServiceServiceOrderTemplate entity using key fields.getServiceOrderTemplateByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - Transaction ID
Constraints: Not nullable, Maximum length: 10
ServiceOrderTemplate 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.@Nonnull public ServiceOrderTemplateCreateFluentHelper createServiceOrderTemplate(@Nonnull ServiceOrderTemplate serviceOrderTemplate)
ServiceOrderTemplateServiceServiceOrderTemplate entity and save it to the S/4HANA system.createServiceOrderTemplate in interface ServiceOrderTemplateServiceserviceOrderTemplate - ServiceOrderTemplate entity object that will be created in the S/4HANA system.ServiceOrderTemplate entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTemplateUpdateFluentHelper updateServiceOrderTemplate(@Nonnull ServiceOrderTemplate serviceOrderTemplate)
ServiceOrderTemplateServiceServiceOrderTemplate entity and save it to the S/4HANA system.updateServiceOrderTemplate in interface ServiceOrderTemplateServiceserviceOrderTemplate - ServiceOrderTemplate entity object that will be updated in the S/4HANA system.ServiceOrderTemplate entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTemplateItemFluentHelper getAllServiceOrderTemplateItem()
ServiceOrderTemplateServiceServiceOrderTemplateItem entities.getAllServiceOrderTemplateItem in interface ServiceOrderTemplateServiceServiceOrderTemplateItem 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.@Nonnull public ServiceOrderTemplateItemByKeyFluentHelper getServiceOrderTemplateItemByKey(String serviceOrderTemplate, String serviceOrderTemplateItem)
ServiceOrderTemplateServiceServiceOrderTemplateItem entity using key fields.getServiceOrderTemplateItemByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrderTemplateItem - Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
ServiceOrderTemplateItem 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.@Nonnull public ServiceOrderTemplateItemCreateFluentHelper createServiceOrderTemplateItem(@Nonnull ServiceOrderTemplateItem serviceOrderTemplateItem)
ServiceOrderTemplateServiceServiceOrderTemplateItem entity and save it to the S/4HANA system.createServiceOrderTemplateItem in interface ServiceOrderTemplateServiceserviceOrderTemplateItem - ServiceOrderTemplateItem entity object that will be created in the S/4HANA system.ServiceOrderTemplateItem entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTemplateItemUpdateFluentHelper updateServiceOrderTemplateItem(@Nonnull ServiceOrderTemplateItem serviceOrderTemplateItem)
ServiceOrderTemplateServiceServiceOrderTemplateItem entity and save it to the S/4HANA system.updateServiceOrderTemplateItem in interface ServiceOrderTemplateServiceserviceOrderTemplateItem - ServiceOrderTemplateItem entity object that will be updated in the S/4HANA system.ServiceOrderTemplateItem entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTemplateItemDeleteFluentHelper deleteServiceOrderTemplateItem(@Nonnull ServiceOrderTemplateItem serviceOrderTemplateItem)
ServiceOrderTemplateServiceServiceOrderTemplateItem entity in the S/4HANA system.deleteServiceOrderTemplateItem in interface ServiceOrderTemplateServiceserviceOrderTemplateItem - ServiceOrderTemplateItem entity object that will be deleted in the S/4HANA system.ServiceOrderTemplateItem entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplItemRefObjFluentHelper getAllServiceOrderTmplItemRefObj()
ServiceOrderTemplateServiceServiceOrderTmplItemRefObj entities.getAllServiceOrderTmplItemRefObj in interface ServiceOrderTemplateServiceServiceOrderTmplItemRefObj 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.@Nonnull public ServiceOrderTmplItemRefObjByKeyFluentHelper getServiceOrderTmplItemRefObjByKey(String serviceOrderTemplate, String serviceOrderTemplateItem, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceOrderTemplateServiceServiceOrderTmplItemRefObj entity using key fields.getServiceOrderTmplItemRefObjByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrderTemplateItem - Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceReferenceEquipment - Equipment Number
Constraints: Not nullable, Maximum length: 18
serviceRefFunctionalLocation - Functional Location
Constraints: Not nullable, Maximum length: 40
ServiceOrderTmplItemRefObj 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.@Nonnull public ServiceOrderTmplItemRefObjCreateFluentHelper createServiceOrderTmplItemRefObj(@Nonnull ServiceOrderTmplItemRefObj serviceOrderTmplItemRefObj)
ServiceOrderTemplateServiceServiceOrderTmplItemRefObj entity and save it to the S/4HANA system.createServiceOrderTmplItemRefObj in interface ServiceOrderTemplateServiceserviceOrderTmplItemRefObj - ServiceOrderTmplItemRefObj entity object that will be created in the S/4HANA system.ServiceOrderTmplItemRefObj entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplItemRefObjDeleteFluentHelper deleteServiceOrderTmplItemRefObj(@Nonnull ServiceOrderTmplItemRefObj serviceOrderTmplItemRefObj)
ServiceOrderTemplateServiceServiceOrderTmplItemRefObj entity in the S/4HANA system.deleteServiceOrderTmplItemRefObj in interface ServiceOrderTemplateServiceserviceOrderTmplItemRefObj - ServiceOrderTmplItemRefObj entity object that will be deleted in the S/4HANA system.ServiceOrderTmplItemRefObj entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplItemTextFluentHelper getAllServiceOrderTmplItemText()
ServiceOrderTemplateServiceServiceOrderTmplItemText entities.getAllServiceOrderTmplItemText in interface ServiceOrderTemplateServiceServiceOrderTmplItemText 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.@Nonnull public ServiceOrderTmplItemTextByKeyFluentHelper getServiceOrderTmplItemTextByKey(String serviceOrderTemplate, String serviceOrderTemplateItem, String language, String longTextID)
ServiceOrderTemplateServiceServiceOrderTmplItemText entity using key fields.getServiceOrderTmplItemTextByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrderTemplateItem - Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
language - Language Key
Constraints: Not nullable, Maximum length: 2
longTextID - Text ID
Constraints: Not nullable, Maximum length: 4
ServiceOrderTmplItemText 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.@Nonnull public ServiceOrderTmplItemTextCreateFluentHelper createServiceOrderTmplItemText(@Nonnull ServiceOrderTmplItemText serviceOrderTmplItemText)
ServiceOrderTemplateServiceServiceOrderTmplItemText entity and save it to the S/4HANA system.createServiceOrderTmplItemText in interface ServiceOrderTemplateServiceserviceOrderTmplItemText - ServiceOrderTmplItemText entity object that will be created in the S/4HANA system.ServiceOrderTmplItemText entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplItemTextUpdateFluentHelper updateServiceOrderTmplItemText(@Nonnull ServiceOrderTmplItemText serviceOrderTmplItemText)
ServiceOrderTemplateServiceServiceOrderTmplItemText entity and save it to the S/4HANA system.updateServiceOrderTmplItemText in interface ServiceOrderTemplateServiceserviceOrderTmplItemText - ServiceOrderTmplItemText entity object that will be updated in the S/4HANA system.ServiceOrderTmplItemText entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplItemTextDeleteFluentHelper deleteServiceOrderTmplItemText(@Nonnull ServiceOrderTmplItemText serviceOrderTmplItemText)
ServiceOrderTemplateServiceServiceOrderTmplItemText entity in the S/4HANA system.deleteServiceOrderTmplItemText in interface ServiceOrderTemplateServiceserviceOrderTmplItemText - ServiceOrderTmplItemText entity object that will be deleted in the S/4HANA system.ServiceOrderTmplItemText entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplPersonRespFluentHelper getAllServiceOrderTmplPersonResp()
ServiceOrderTemplateServiceServiceOrderTmplPersonResp entities.getAllServiceOrderTmplPersonResp in interface ServiceOrderTemplateServiceServiceOrderTmplPersonResp 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.@Nonnull public ServiceOrderTmplPersonRespByKeyFluentHelper getServiceOrderTmplPersonRespByKey(String serviceOrderTemplate, String personResponsible)
ServiceOrderTemplateServiceServiceOrderTmplPersonResp entity using key fields.getServiceOrderTmplPersonRespByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - Transaction ID
Constraints: Not nullable, Maximum length: 10
personResponsible - Business Partner Number
Constraints: Not nullable, Maximum length: 10
ServiceOrderTmplPersonResp 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.@Nonnull public ServiceOrderTmplPersonRespCreateFluentHelper createServiceOrderTmplPersonResp(@Nonnull ServiceOrderTmplPersonResp serviceOrderTmplPersonResp)
ServiceOrderTemplateServiceServiceOrderTmplPersonResp entity and save it to the S/4HANA system.createServiceOrderTmplPersonResp in interface ServiceOrderTemplateServiceserviceOrderTmplPersonResp - ServiceOrderTmplPersonResp entity object that will be created in the S/4HANA system.ServiceOrderTmplPersonResp entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplPersonRespUpdateFluentHelper updateServiceOrderTmplPersonResp(@Nonnull ServiceOrderTmplPersonResp serviceOrderTmplPersonResp)
ServiceOrderTemplateServiceServiceOrderTmplPersonResp entity and save it to the S/4HANA system.updateServiceOrderTmplPersonResp in interface ServiceOrderTemplateServiceserviceOrderTmplPersonResp - ServiceOrderTmplPersonResp entity object that will be updated in the S/4HANA system.ServiceOrderTmplPersonResp entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplPersonRespDeleteFluentHelper deleteServiceOrderTmplPersonResp(@Nonnull ServiceOrderTmplPersonResp serviceOrderTmplPersonResp)
ServiceOrderTemplateServiceServiceOrderTmplPersonResp entity in the S/4HANA system.deleteServiceOrderTmplPersonResp in interface ServiceOrderTemplateServiceserviceOrderTmplPersonResp - ServiceOrderTmplPersonResp entity object that will be deleted in the S/4HANA system.ServiceOrderTmplPersonResp entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplRefObjectFluentHelper getAllServiceOrderTmplRefObject()
ServiceOrderTemplateServiceServiceOrderTmplRefObject entities.getAllServiceOrderTmplRefObject in interface ServiceOrderTemplateServiceServiceOrderTmplRefObject 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.@Nonnull public ServiceOrderTmplRefObjectByKeyFluentHelper getServiceOrderTmplRefObjectByKey(String serviceOrderTemplate, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceOrderTemplateServiceServiceOrderTmplRefObject entity using key fields.getServiceOrderTmplRefObjectByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceReferenceEquipment - Equipment Number
Constraints: Not nullable, Maximum length: 18
serviceRefFunctionalLocation - Functional Location
Constraints: Not nullable, Maximum length: 40
ServiceOrderTmplRefObject 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.@Nonnull public ServiceOrderTmplRefObjectCreateFluentHelper createServiceOrderTmplRefObject(@Nonnull ServiceOrderTmplRefObject serviceOrderTmplRefObject)
ServiceOrderTemplateServiceServiceOrderTmplRefObject entity and save it to the S/4HANA system.createServiceOrderTmplRefObject in interface ServiceOrderTemplateServiceserviceOrderTmplRefObject - ServiceOrderTmplRefObject entity object that will be created in the S/4HANA system.ServiceOrderTmplRefObject entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplRefObjectDeleteFluentHelper deleteServiceOrderTmplRefObject(@Nonnull ServiceOrderTmplRefObject serviceOrderTmplRefObject)
ServiceOrderTemplateServiceServiceOrderTmplRefObject entity in the S/4HANA system.deleteServiceOrderTmplRefObject in interface ServiceOrderTemplateServiceserviceOrderTmplRefObject - ServiceOrderTmplRefObject entity object that will be deleted in the S/4HANA system.ServiceOrderTmplRefObject entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplTextFluentHelper getAllServiceOrderTmplText()
ServiceOrderTemplateServiceServiceOrderTmplText entities.getAllServiceOrderTmplText in interface ServiceOrderTemplateServiceServiceOrderTmplText 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.@Nonnull public ServiceOrderTmplTextByKeyFluentHelper getServiceOrderTmplTextByKey(String serviceOrderTemplate, String language, String longTextID)
ServiceOrderTemplateServiceServiceOrderTmplText entity using key fields.getServiceOrderTmplTextByKey in interface ServiceOrderTemplateServiceserviceOrderTemplate - 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
ServiceOrderTmplText 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.@Nonnull public ServiceOrderTmplTextCreateFluentHelper createServiceOrderTmplText(@Nonnull ServiceOrderTmplText serviceOrderTmplText)
ServiceOrderTemplateServiceServiceOrderTmplText entity and save it to the S/4HANA system.createServiceOrderTmplText in interface ServiceOrderTemplateServiceserviceOrderTmplText - ServiceOrderTmplText entity object that will be created in the S/4HANA system.ServiceOrderTmplText entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplTextUpdateFluentHelper updateServiceOrderTmplText(@Nonnull ServiceOrderTmplText serviceOrderTmplText)
ServiceOrderTemplateServiceServiceOrderTmplText entity and save it to the S/4HANA system.updateServiceOrderTmplText in interface ServiceOrderTemplateServiceserviceOrderTmplText - ServiceOrderTmplText entity object that will be updated in the S/4HANA system.ServiceOrderTmplText entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public ServiceOrderTmplTextDeleteFluentHelper deleteServiceOrderTmplText(@Nonnull ServiceOrderTmplText serviceOrderTmplText)
ServiceOrderTemplateServiceServiceOrderTmplText entity in the S/4HANA system.deleteServiceOrderTmplText in interface ServiceOrderTemplateServiceserviceOrderTmplText - ServiceOrderTmplText entity object that will be deleted in the S/4HANA system.ServiceOrderTmplText entity. To perform execution, call the
execute method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.