public interface ServiceOrderService extends BatchService<ServiceOrderServiceBatch>
You can use this service to integrate external applications with service order processing in SAP S/4HANA Cloud. In each API call, you can use the following operations: - Retrieve service orders. - Create service orders. Note: You must use “deep insert” requests (a header plus the following entities: header person responsible, header pricing element, header reference object, header defect, header text, and item). - Create new items for existing service orders. - Create an item reference object, item pricing element, and an item text for existing service orders items. - Update the header, header person responsible, header pricing element, header defect, header text, item, item pricing element, and item text for existing service orders. - Delete the header person responsible, header reference object, header defect, header text, item, item reference object, and item text for existing service orders..
Reference: SAP API Business Hub
OData Service: | API_SERVICE_ORDER_SRV |
API Version: | 1 |
Communication Scenario: | Service Order Integration (SAP_COM_0350) |
Scope Items: | Service Order Management and Monitoring (3D2) |
Authentication Methods: | Basic |
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 ServiceOrderService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull ServiceOrderFluentHelper getAllServiceOrder()
ServiceOrder
entities.ServiceOrder
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 ServiceOrderByKeyFluentHelper getServiceOrderByKey(String serviceOrder)
ServiceOrder
entity using key fields.serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
ServiceOrder
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 ServiceOrderCreateFluentHelper createServiceOrder(@Nonnull ServiceOrder serviceOrder)
ServiceOrder
entity and save it to the S/4HANA system.serviceOrder
- ServiceOrder
entity object that will be created in the S/4HANA system.ServiceOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderUpdateFluentHelper updateServiceOrder(@Nonnull ServiceOrder serviceOrder)
ServiceOrder
entity and save it to the S/4HANA system.serviceOrder
- ServiceOrder
entity object that will be updated in the S/4HANA system.ServiceOrder
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderConfirmationFluentHelper getAllServiceOrderConfirmation()
ServiceOrderConfirmation
entities.ServiceOrderConfirmation
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 ServiceOrderConfirmationByKeyFluentHelper getServiceOrderConfirmationByKey(String serviceOrder, String serviceConfirmation)
ServiceOrderConfirmation
entity using key fields.serviceConfirmation
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
ServiceOrderConfirmation
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 ServiceOrderDefectFluentHelper getAllServiceOrderDefect()
ServiceOrderDefect
entities.ServiceOrderDefect
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 ServiceOrderDefectByKeyFluentHelper getServiceOrderDefectByKey(String serviceOrder, String srvcDocTypeDefectCodeProfType, Short serviceDefectSequence)
ServiceOrderDefect
entity using key fields.serviceDefectSequence
- Sort Field
Constraints: Not nullable
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
srvcDocTypeDefectCodeProfType
- Controls characteristics for the subject profile, for example, how many and which catalog categories
are allowed and whether a selection of one or several codes is possible using F1 help.
Constraints: Not nullable, Maximum length: 2
ServiceOrderDefect
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 ServiceOrderDefectCreateFluentHelper createServiceOrderDefect(@Nonnull ServiceOrderDefect serviceOrderDefect)
ServiceOrderDefect
entity and save it to the S/4HANA system.serviceOrderDefect
- ServiceOrderDefect
entity object that will be created in the S/4HANA system.ServiceOrderDefect
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderDefectUpdateFluentHelper updateServiceOrderDefect(@Nonnull ServiceOrderDefect serviceOrderDefect)
ServiceOrderDefect
entity and save it to the S/4HANA system.serviceOrderDefect
- ServiceOrderDefect
entity object that will be updated in the S/4HANA system.ServiceOrderDefect
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderDefectDeleteFluentHelper deleteServiceOrderDefect(@Nonnull ServiceOrderDefect serviceOrderDefect)
ServiceOrderDefect
entity in the S/4HANA system.serviceOrderDefect
- ServiceOrderDefect
entity object that will be deleted in the S/4HANA system.ServiceOrderDefect
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemFluentHelper getAllServiceOrderItem()
ServiceOrderItem
entities.ServiceOrderItem
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 ServiceOrderItemByKeyFluentHelper getServiceOrderItemByKey(String serviceOrder, String serviceOrderItem)
ServiceOrderItem
entity using key fields.serviceOrderItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
ServiceOrderItem
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 ServiceOrderItemCreateFluentHelper createServiceOrderItem(@Nonnull ServiceOrderItem serviceOrderItem)
ServiceOrderItem
entity and save it to the S/4HANA system.serviceOrderItem
- ServiceOrderItem
entity object that will be created in the S/4HANA system.ServiceOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemUpdateFluentHelper updateServiceOrderItem(@Nonnull ServiceOrderItem serviceOrderItem)
ServiceOrderItem
entity and save it to the S/4HANA system.serviceOrderItem
- ServiceOrderItem
entity object that will be updated in the S/4HANA system.ServiceOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemDeleteFluentHelper deleteServiceOrderItem(@Nonnull ServiceOrderItem serviceOrderItem)
ServiceOrderItem
entity in the S/4HANA system.serviceOrderItem
- ServiceOrderItem
entity object that will be deleted in the S/4HANA system.ServiceOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemConfirmationFluentHelper getAllServiceOrderItemConfirmation()
ServiceOrderItemConfirmation
entities.ServiceOrderItemConfirmation
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 ServiceOrderItemConfirmationByKeyFluentHelper getServiceOrderItemConfirmationByKey(String serviceOrder, String serviceOrderItem, String serviceConfirmation, String serviceConfirmationItem)
ServiceOrderItemConfirmation
entity using key fields.serviceConfirmationItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceOrderItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceConfirmation
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
ServiceOrderItemConfirmation
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 ServiceOrderItemPriceElementFluentHelper getAllServiceOrderItemPriceElement()
ServiceOrderItemPriceElement
entities.ServiceOrderItemPriceElement
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 ServiceOrderItemPriceElementByKeyFluentHelper getServiceOrderItemPriceElementByKey(String serviceOrder, String serviceOrderItem, String pricingProcedureStep, String pricingProcedureCounter)
ServiceOrderItemPriceElement
entity using key fields.serviceOrderItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
ServiceOrderItemPriceElement
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 ServiceOrderItemPriceElementCreateFluentHelper createServiceOrderItemPriceElement(@Nonnull ServiceOrderItemPriceElement serviceOrderItemPriceElement)
ServiceOrderItemPriceElement
entity and save it to the S/4HANA system.serviceOrderItemPriceElement
- ServiceOrderItemPriceElement
entity object that will be created in the S/4HANA system.ServiceOrderItemPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemPriceElementUpdateFluentHelper updateServiceOrderItemPriceElement(@Nonnull ServiceOrderItemPriceElement serviceOrderItemPriceElement)
ServiceOrderItemPriceElement
entity and save it to the S/4HANA system.serviceOrderItemPriceElement
- ServiceOrderItemPriceElement
entity object that will be updated in the S/4HANA system.ServiceOrderItemPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemRefObjectFluentHelper getAllServiceOrderItemRefObject()
ServiceOrderItemRefObject
entities.ServiceOrderItemRefObject
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 ServiceOrderItemRefObjectByKeyFluentHelper getServiceOrderItemRefObjectByKey(String serviceOrder, String serviceOrderItem, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceOrderItemRefObject
entity using key fields.serviceOrderItem
- 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
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
serviceReferenceEquipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
ServiceOrderItemRefObject
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 ServiceOrderItemRefObjectCreateFluentHelper createServiceOrderItemRefObject(@Nonnull ServiceOrderItemRefObject serviceOrderItemRefObject)
ServiceOrderItemRefObject
entity and save it to the S/4HANA system.serviceOrderItemRefObject
- ServiceOrderItemRefObject
entity object that will be created in the S/4HANA system.ServiceOrderItemRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemRefObjectDeleteFluentHelper deleteServiceOrderItemRefObject(@Nonnull ServiceOrderItemRefObject serviceOrderItemRefObject)
ServiceOrderItemRefObject
entity in the S/4HANA system.serviceOrderItemRefObject
- ServiceOrderItemRefObject
entity object that will be deleted in the S/4HANA system.ServiceOrderItemRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemTextFluentHelper getAllServiceOrderItemText()
ServiceOrderItemText
entities.ServiceOrderItemText
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 ServiceOrderItemTextByKeyFluentHelper getServiceOrderItemTextByKey(String serviceOrder, String serviceOrderItem, String language, String longTextID)
ServiceOrderItemText
entity using key fields.serviceOrderItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceOrder
- 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
ServiceOrderItemText
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 ServiceOrderItemTextCreateFluentHelper createServiceOrderItemText(@Nonnull ServiceOrderItemText serviceOrderItemText)
ServiceOrderItemText
entity and save it to the S/4HANA system.serviceOrderItemText
- ServiceOrderItemText
entity object that will be created in the S/4HANA system.ServiceOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemTextUpdateFluentHelper updateServiceOrderItemText(@Nonnull ServiceOrderItemText serviceOrderItemText)
ServiceOrderItemText
entity and save it to the S/4HANA system.serviceOrderItemText
- ServiceOrderItemText
entity object that will be updated in the S/4HANA system.ServiceOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderItemTextDeleteFluentHelper deleteServiceOrderItemText(@Nonnull ServiceOrderItemText serviceOrderItemText)
ServiceOrderItemText
entity in the S/4HANA system.serviceOrderItemText
- ServiceOrderItemText
entity object that will be deleted in the S/4HANA system.ServiceOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderPersonRespFluentHelper getAllServiceOrderPersonResp()
ServiceOrderPersonResp
entities.ServiceOrderPersonResp
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 ServiceOrderPersonRespByKeyFluentHelper getServiceOrderPersonRespByKey(String serviceOrder, String personResponsible)
ServiceOrderPersonResp
entity using key fields.personResponsible
- Key identifying a business partner in the SAP system. The key is unique within a client.
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
ServiceOrderPersonResp
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 ServiceOrderPersonRespCreateFluentHelper createServiceOrderPersonResp(@Nonnull ServiceOrderPersonResp serviceOrderPersonResp)
ServiceOrderPersonResp
entity and save it to the S/4HANA system.serviceOrderPersonResp
- ServiceOrderPersonResp
entity object that will be created in the S/4HANA system.ServiceOrderPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderPersonRespUpdateFluentHelper updateServiceOrderPersonResp(@Nonnull ServiceOrderPersonResp serviceOrderPersonResp)
ServiceOrderPersonResp
entity and save it to the S/4HANA system.serviceOrderPersonResp
- ServiceOrderPersonResp
entity object that will be updated in the S/4HANA system.ServiceOrderPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderPersonRespDeleteFluentHelper deleteServiceOrderPersonResp(@Nonnull ServiceOrderPersonResp serviceOrderPersonResp)
ServiceOrderPersonResp
entity in the S/4HANA system.serviceOrderPersonResp
- ServiceOrderPersonResp
entity object that will be deleted in the S/4HANA system.ServiceOrderPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderPriceElementFluentHelper getAllServiceOrderPriceElement()
ServiceOrderPriceElement
entities.ServiceOrderPriceElement
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 ServiceOrderPriceElementByKeyFluentHelper getServiceOrderPriceElementByKey(String serviceOrder, String pricingProcedureStep, String pricingProcedureCounter)
ServiceOrderPriceElement
entity using key fields.pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
ServiceOrderPriceElement
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 ServiceOrderPriceElementCreateFluentHelper createServiceOrderPriceElement(@Nonnull ServiceOrderPriceElement serviceOrderPriceElement)
ServiceOrderPriceElement
entity and save it to the S/4HANA system.serviceOrderPriceElement
- ServiceOrderPriceElement
entity object that will be created in the S/4HANA system.ServiceOrderPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderPriceElementUpdateFluentHelper updateServiceOrderPriceElement(@Nonnull ServiceOrderPriceElement serviceOrderPriceElement)
ServiceOrderPriceElement
entity and save it to the S/4HANA system.serviceOrderPriceElement
- ServiceOrderPriceElement
entity object that will be updated in the S/4HANA system.ServiceOrderPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderRefObjectFluentHelper getAllServiceOrderRefObject()
ServiceOrderRefObject
entities.ServiceOrderRefObject
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 ServiceOrderRefObjectByKeyFluentHelper getServiceOrderRefObjectByKey(String serviceOrder, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceOrderRefObject
entity using key fields.serviceRefFunctionalLocation
- Label that uniquely identifies a functional location.
Constraints: Not nullable, Maximum length: 40
serviceOrder
- Number that identifies the transaction document. It is unique for each business transaction category.
Constraints: Not nullable, Maximum length: 10
serviceReferenceEquipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
ServiceOrderRefObject
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 ServiceOrderRefObjectCreateFluentHelper createServiceOrderRefObject(@Nonnull ServiceOrderRefObject serviceOrderRefObject)
ServiceOrderRefObject
entity and save it to the S/4HANA system.serviceOrderRefObject
- ServiceOrderRefObject
entity object that will be created in the S/4HANA system.ServiceOrderRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderRefObjectDeleteFluentHelper deleteServiceOrderRefObject(@Nonnull ServiceOrderRefObject serviceOrderRefObject)
ServiceOrderRefObject
entity in the S/4HANA system.serviceOrderRefObject
- ServiceOrderRefObject
entity object that will be deleted in the S/4HANA system.ServiceOrderRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderTextFluentHelper getAllServiceOrderText()
ServiceOrderText
entities.ServiceOrderText
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 ServiceOrderTextByKeyFluentHelper getServiceOrderTextByKey(String serviceOrder, String language, String longTextID)
ServiceOrderText
entity using key fields.serviceOrder
- 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
ServiceOrderText
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 ServiceOrderTextCreateFluentHelper createServiceOrderText(@Nonnull ServiceOrderText serviceOrderText)
ServiceOrderText
entity and save it to the S/4HANA system.serviceOrderText
- ServiceOrderText
entity object that will be created in the S/4HANA system.ServiceOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderTextUpdateFluentHelper updateServiceOrderText(@Nonnull ServiceOrderText serviceOrderText)
ServiceOrderText
entity and save it to the S/4HANA system.serviceOrderText
- ServiceOrderText
entity object that will be updated in the S/4HANA system.ServiceOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceOrderTextDeleteFluentHelper deleteServiceOrderText(@Nonnull ServiceOrderText serviceOrderText)
ServiceOrderText
entity in the S/4HANA system.serviceOrderText
- ServiceOrderText
entity object that will be deleted in the S/4HANA system.ServiceOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.