public interface ServiceOrderTemplateService extends BatchService<ServiceOrderTemplateServiceBatch>
You can use this service to integrate external applications with Service Order Template processing in Service in SAP S/4HANA Cloud. In each API call, you can use the following operations: - Retrieve Service Order Template. - Create Service Order Template. Note: You must use “deep insert” requests (a header plus the following entities: Header details, Header text, Service Items and Person responsible). - Create an item reference object, item object list and an item text for existing Service Order Template items. - Update the header, header text, item and item text of existing Service Order Template. - Delete the item, item reference object, item object list and item text of existing Service Order Template..
Reference: SAP API Business Hub
OData Service: | API_SERVICE_ORDER_TEMPLATE_SRV |
API Version: | 1 |
Communication Scenario: | Service Order Template Integration (SAP_COM_0715) |
Scope Items: | Service Order Management and Monitoring (3D2) |
Authentication Methods: | Basic, x509 |
Business Object: | ServiceOrderTemplate |
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
- Number that identifies the transaction document. It is unique for each business transaction category.
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
- Number that identifies the transaction document. It is unique for each business transaction category.
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
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
serviceOrderTemplateItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceRefFunctionalLocation
- Label that uniquely identifies a functional location.
Constraints: Not nullable, Maximum length: 40
serviceReferenceEquipment
- Number by which a piece of equipment can be clearly identified.
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
- Number which identifies the transaction document. It is unique for the respective business transaction
category.
Constraints: Not nullable, Maximum length: 10
serviceOrderTemplateItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
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
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
personResponsible
- Key identifying a business partner in the SAP system. The key is unique within a client.
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
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
serviceRefFunctionalLocation
- Label that uniquely identifies a functional location.
Constraints: Not nullable, Maximum length: 40
serviceReferenceEquipment
- Number by which a piece of equipment can be clearly identified.
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
- Number which identifies the transaction document. It is unique for the respective business transaction
category.
Constraints: Not nullable, Maximum length: 10
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
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.