public interface ServiceOrderTemplateService extends BatchService<ServiceOrderTemplateServiceBatch>
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 |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull ServiceOrderTemplateService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull ServiceOrderTemplateFluentHelper getAllServiceOrderTemplate()
ServiceOrderTemplate
entities.ServiceOrderTemplate
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 ServiceOrderTemplateByKeyFluentHelper getServiceOrderTemplateByKey(String serviceOrderTemplate)
ServiceOrderTemplate
entity using key fields.serviceOrderTemplate
- 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 ServiceOrderTemplateCreateFluentHelper createServiceOrderTemplate(@Nonnull ServiceOrderTemplate serviceOrderTemplate)
ServiceOrderTemplate
entity and save it to the S/4HANA system.serviceOrderTemplate
- 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 ServiceOrderTemplateUpdateFluentHelper updateServiceOrderTemplate(@Nonnull ServiceOrderTemplate serviceOrderTemplate)
ServiceOrderTemplate
entity and save it to the S/4HANA system.serviceOrderTemplate
- 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 ServiceOrderTemplateItemFluentHelper getAllServiceOrderTemplateItem()
ServiceOrderTemplateItem
entities.ServiceOrderTemplateItem
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 ServiceOrderTemplateItemByKeyFluentHelper getServiceOrderTemplateItemByKey(String serviceOrderTemplate, String serviceOrderTemplateItem)
ServiceOrderTemplateItem
entity using key fields.serviceOrderTemplate
- 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 ServiceOrderTemplateItemCreateFluentHelper createServiceOrderTemplateItem(@Nonnull ServiceOrderTemplateItem serviceOrderTemplateItem)
ServiceOrderTemplateItem
entity and save it to the S/4HANA system.serviceOrderTemplateItem
- 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 ServiceOrderTemplateItemUpdateFluentHelper updateServiceOrderTemplateItem(@Nonnull ServiceOrderTemplateItem serviceOrderTemplateItem)
ServiceOrderTemplateItem
entity and save it to the S/4HANA system.serviceOrderTemplateItem
- 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 ServiceOrderTemplateItemDeleteFluentHelper deleteServiceOrderTemplateItem(@Nonnull ServiceOrderTemplateItem serviceOrderTemplateItem)
ServiceOrderTemplateItem
entity in the S/4HANA system.serviceOrderTemplateItem
- 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 ServiceOrderTmplItemRefObjFluentHelper getAllServiceOrderTmplItemRefObj()
ServiceOrderTmplItemRefObj
entities.ServiceOrderTmplItemRefObj
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 ServiceOrderTmplItemRefObjByKeyFluentHelper getServiceOrderTmplItemRefObjByKey(String serviceOrderTemplate, String serviceOrderTemplateItem, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceOrderTmplItemRefObj
entity using key fields.serviceOrderTemplate
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrderTemplateItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceRefFunctionalLocation
- Functional Location
Constraints: Not nullable, Maximum length: 40
serviceReferenceEquipment
- Equipment Number
Constraints: Not nullable, Maximum length: 18
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 ServiceOrderTmplItemRefObjCreateFluentHelper createServiceOrderTmplItemRefObj(@Nonnull ServiceOrderTmplItemRefObj serviceOrderTmplItemRefObj)
ServiceOrderTmplItemRefObj
entity and save it to the S/4HANA system.serviceOrderTmplItemRefObj
- 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 ServiceOrderTmplItemRefObjDeleteFluentHelper deleteServiceOrderTmplItemRefObj(@Nonnull ServiceOrderTmplItemRefObj serviceOrderTmplItemRefObj)
ServiceOrderTmplItemRefObj
entity in the S/4HANA system.serviceOrderTmplItemRefObj
- 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 ServiceOrderTmplItemTextFluentHelper getAllServiceOrderTmplItemText()
ServiceOrderTmplItemText
entities.ServiceOrderTmplItemText
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 ServiceOrderTmplItemTextByKeyFluentHelper getServiceOrderTmplItemTextByKey(String serviceOrderTemplate, String serviceOrderTemplateItem, String language, String longTextID)
ServiceOrderTmplItemText
entity using key fields.serviceOrderTemplate
- 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 ServiceOrderTmplItemTextCreateFluentHelper createServiceOrderTmplItemText(@Nonnull ServiceOrderTmplItemText serviceOrderTmplItemText)
ServiceOrderTmplItemText
entity and save it to the S/4HANA system.serviceOrderTmplItemText
- 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 ServiceOrderTmplItemTextUpdateFluentHelper updateServiceOrderTmplItemText(@Nonnull ServiceOrderTmplItemText serviceOrderTmplItemText)
ServiceOrderTmplItemText
entity and save it to the S/4HANA system.serviceOrderTmplItemText
- 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 ServiceOrderTmplItemTextDeleteFluentHelper deleteServiceOrderTmplItemText(@Nonnull ServiceOrderTmplItemText serviceOrderTmplItemText)
ServiceOrderTmplItemText
entity in the S/4HANA system.serviceOrderTmplItemText
- 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 ServiceOrderTmplPersonRespFluentHelper getAllServiceOrderTmplPersonResp()
ServiceOrderTmplPersonResp
entities.ServiceOrderTmplPersonResp
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 ServiceOrderTmplPersonRespByKeyFluentHelper getServiceOrderTmplPersonRespByKey(String serviceOrderTemplate, String personResponsible)
ServiceOrderTmplPersonResp
entity using key fields.serviceOrderTemplate
- 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 ServiceOrderTmplPersonRespCreateFluentHelper createServiceOrderTmplPersonResp(@Nonnull ServiceOrderTmplPersonResp serviceOrderTmplPersonResp)
ServiceOrderTmplPersonResp
entity and save it to the S/4HANA system.serviceOrderTmplPersonResp
- 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 ServiceOrderTmplPersonRespUpdateFluentHelper updateServiceOrderTmplPersonResp(@Nonnull ServiceOrderTmplPersonResp serviceOrderTmplPersonResp)
ServiceOrderTmplPersonResp
entity and save it to the S/4HANA system.serviceOrderTmplPersonResp
- 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 ServiceOrderTmplPersonRespDeleteFluentHelper deleteServiceOrderTmplPersonResp(@Nonnull ServiceOrderTmplPersonResp serviceOrderTmplPersonResp)
ServiceOrderTmplPersonResp
entity in the S/4HANA system.serviceOrderTmplPersonResp
- 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 ServiceOrderTmplRefObjectFluentHelper getAllServiceOrderTmplRefObject()
ServiceOrderTmplRefObject
entities.ServiceOrderTmplRefObject
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 ServiceOrderTmplRefObjectByKeyFluentHelper getServiceOrderTmplRefObjectByKey(String serviceOrderTemplate, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceOrderTmplRefObject
entity using key fields.serviceOrderTemplate
- 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
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 ServiceOrderTmplRefObjectCreateFluentHelper createServiceOrderTmplRefObject(@Nonnull ServiceOrderTmplRefObject serviceOrderTmplRefObject)
ServiceOrderTmplRefObject
entity and save it to the S/4HANA system.serviceOrderTmplRefObject
- 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 ServiceOrderTmplRefObjectDeleteFluentHelper deleteServiceOrderTmplRefObject(@Nonnull ServiceOrderTmplRefObject serviceOrderTmplRefObject)
ServiceOrderTmplRefObject
entity in the S/4HANA system.serviceOrderTmplRefObject
- 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 ServiceOrderTmplTextFluentHelper getAllServiceOrderTmplText()
ServiceOrderTmplText
entities.ServiceOrderTmplText
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 ServiceOrderTmplTextByKeyFluentHelper getServiceOrderTmplTextByKey(String serviceOrderTemplate, String language, String longTextID)
ServiceOrderTmplText
entity using key fields.serviceOrderTemplate
- 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 ServiceOrderTmplTextCreateFluentHelper createServiceOrderTmplText(@Nonnull ServiceOrderTmplText serviceOrderTmplText)
ServiceOrderTmplText
entity and save it to the S/4HANA system.serviceOrderTmplText
- 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 ServiceOrderTmplTextUpdateFluentHelper updateServiceOrderTmplText(@Nonnull ServiceOrderTmplText serviceOrderTmplText)
ServiceOrderTmplText
entity and save it to the S/4HANA system.serviceOrderTmplText
- 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 ServiceOrderTmplTextDeleteFluentHelper deleteServiceOrderTmplText(@Nonnull ServiceOrderTmplText serviceOrderTmplText)
ServiceOrderTmplText
entity in the S/4HANA system.serviceOrderTmplText
- 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.