public interface ServiceOrderService extends BatchService<ServiceOrderServiceBatch>
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 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. This service enables you to add attachments to a service order header and service order 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 header and service order items..
Reference: SAP API Business Hub
OData Service: | OP_API_SERVICE_ORDER_SRV_0001 |
API Version: | 1 |
Minimum ERP Version: | 2020 |
Authentication Methods: | Basic, x509 |
Business Object: | Service Order |
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
- Transaction ID
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
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Transaction ID
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
- Transaction ID
Constraints: Not nullable, Maximum length: 10
srvcDocTypeDefectCodeProfType
- Subject Profile Category
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
- Transaction ID
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
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Transaction ID
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
- Condition Counter
Constraints: Not nullable, Maximum length: 3
serviceOrder
- Transaction ID
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Step Number
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
- Functional Location
Constraints: Not nullable, Maximum length: 40
serviceOrder
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceReferenceEquipment
- Equipment Number
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
- 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
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
- Business Partner Number
Constraints: Not nullable, Maximum length: 10
serviceOrder
- Transaction ID
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
- Condition Counter
Constraints: Not nullable, Maximum length: 3
serviceOrder
- Transaction ID
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Step Number
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
- Functional Location
Constraints: Not nullable, Maximum length: 40
serviceOrder
- Transaction ID
Constraints: Not nullable, Maximum length: 10
serviceReferenceEquipment
- Equipment Number
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
- 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
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 © 2021 SAP SE. All rights reserved.