public interface ServiceConfirmationService extends BatchService<ServiceConfirmationServiceBatch>
You can use this service to integrate external applications with service confirmation processing in SAP S/4HANA Cloud. In each API call, you can use the following operations: - Retrieve service confirmations. - Create service confirmations. Note: You must use “deep insert” requests (a header plus the following entities: header person responsible, header reference object, header pricing element, header text, and item). - Create new items for existing service confirmations. - Create an item reference object, item pricing element, and an item text for existing service confirmation items. - Update the header, header person responsible, header reference object, header pricing element, header text, item, item reference object, item pricing element, and item text for existing service confirmations. - Delete the header person responsible, header reference object, header text, item, item reference object, and item text for existing service confirmations. This service enables you to add attachments to service confirmation 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 service confirmation items..
Reference: SAP API Business Hub
OData Service: | API_SERVICE_CONFIRMATION_SRV |
API Version: | 1 |
Communication Scenario: | Service Confirmation Integration (SAP_COM_0352) |
Scope Items: | Service Order Management and Monitoring (3D2) |
Authentication Methods: | Basic |
Business Object: | ServiceConfirmation |
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 ServiceConfirmationService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull ServiceConfirmationFluentHelper getAllServiceConfirmation()
ServiceConfirmation
entities.ServiceConfirmation
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 ServiceConfirmationByKeyFluentHelper getServiceConfirmationByKey(String serviceConfirmation)
ServiceConfirmation
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
ServiceConfirmation
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 ServiceConfirmationCreateFluentHelper createServiceConfirmation(@Nonnull ServiceConfirmation serviceConfirmation)
ServiceConfirmation
entity and save it to the S/4HANA system.serviceConfirmation
- ServiceConfirmation
entity object that will be created in the S/4HANA system.ServiceConfirmation
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationUpdateFluentHelper updateServiceConfirmation(@Nonnull ServiceConfirmation serviceConfirmation)
ServiceConfirmation
entity and save it to the S/4HANA system.serviceConfirmation
- ServiceConfirmation
entity object that will be updated in the S/4HANA system.ServiceConfirmation
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationItemFluentHelper getAllServiceConfirmationItem()
ServiceConfirmationItem
entities.ServiceConfirmationItem
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 ServiceConfirmationItemByKeyFluentHelper getServiceConfirmationItemByKey(String serviceConfirmation, String serviceConfirmationItem)
ServiceConfirmationItem
entity using key fields.serviceConfirmationItem
- 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
ServiceConfirmationItem
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 ServiceConfirmationItemCreateFluentHelper createServiceConfirmationItem(@Nonnull ServiceConfirmationItem serviceConfirmationItem)
ServiceConfirmationItem
entity and save it to the S/4HANA system.serviceConfirmationItem
- ServiceConfirmationItem
entity object that will be created in the S/4HANA system.ServiceConfirmationItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationItemUpdateFluentHelper updateServiceConfirmationItem(@Nonnull ServiceConfirmationItem serviceConfirmationItem)
ServiceConfirmationItem
entity and save it to the S/4HANA system.serviceConfirmationItem
- ServiceConfirmationItem
entity object that will be updated in the S/4HANA system.ServiceConfirmationItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationItemDeleteFluentHelper deleteServiceConfirmationItem(@Nonnull ServiceConfirmationItem serviceConfirmationItem)
ServiceConfirmationItem
entity in the S/4HANA system.serviceConfirmationItem
- ServiceConfirmationItem
entity object that will be deleted in the S/4HANA system.ServiceConfirmationItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationItemTextFluentHelper getAllServiceConfirmationItemText()
ServiceConfirmationItemText
entities.ServiceConfirmationItemText
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 ServiceConfirmationItemTextByKeyFluentHelper getServiceConfirmationItemTextByKey(String serviceConfirmation, String serviceConfirmationItem, String language, String longTextID)
ServiceConfirmationItemText
entity using key fields.serviceConfirmationItem
- Shortened Item Number in Document
Constraints: Not nullable, Maximum length: 6
serviceConfirmation
- 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
ServiceConfirmationItemText
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 ServiceConfirmationItemTextCreateFluentHelper createServiceConfirmationItemText(@Nonnull ServiceConfirmationItemText serviceConfirmationItemText)
ServiceConfirmationItemText
entity and save it to the S/4HANA system.serviceConfirmationItemText
- ServiceConfirmationItemText
entity object that will be created in the S/4HANA system.ServiceConfirmationItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationItemTextUpdateFluentHelper updateServiceConfirmationItemText(@Nonnull ServiceConfirmationItemText serviceConfirmationItemText)
ServiceConfirmationItemText
entity and save it to the S/4HANA system.serviceConfirmationItemText
- ServiceConfirmationItemText
entity object that will be updated in the S/4HANA system.ServiceConfirmationItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationItemTextDeleteFluentHelper deleteServiceConfirmationItemText(@Nonnull ServiceConfirmationItemText serviceConfirmationItemText)
ServiceConfirmationItemText
entity in the S/4HANA system.serviceConfirmationItemText
- ServiceConfirmationItemText
entity object that will be deleted in the S/4HANA system.ServiceConfirmationItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationTextFluentHelper getAllServiceConfirmationText()
ServiceConfirmationText
entities.ServiceConfirmationText
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 ServiceConfirmationTextByKeyFluentHelper getServiceConfirmationTextByKey(String serviceConfirmation, String language, String longTextID)
ServiceConfirmationText
entity using key fields.serviceConfirmation
- 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
ServiceConfirmationText
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 ServiceConfirmationTextCreateFluentHelper createServiceConfirmationText(@Nonnull ServiceConfirmationText serviceConfirmationText)
ServiceConfirmationText
entity and save it to the S/4HANA system.serviceConfirmationText
- ServiceConfirmationText
entity object that will be created in the S/4HANA system.ServiceConfirmationText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationTextUpdateFluentHelper updateServiceConfirmationText(@Nonnull ServiceConfirmationText serviceConfirmationText)
ServiceConfirmationText
entity and save it to the S/4HANA system.serviceConfirmationText
- ServiceConfirmationText
entity object that will be updated in the S/4HANA system.ServiceConfirmationText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfirmationTextDeleteFluentHelper deleteServiceConfirmationText(@Nonnull ServiceConfirmationText serviceConfirmationText)
ServiceConfirmationText
entity in the S/4HANA system.serviceConfirmationText
- ServiceConfirmationText
entity object that will be deleted in the S/4HANA system.ServiceConfirmationText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfItemPriceElementFluentHelper getAllServiceConfItemPriceElement()
ServiceConfItemPriceElement
entities.ServiceConfItemPriceElement
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 ServiceConfItemPriceElementByKeyFluentHelper getServiceConfItemPriceElementByKey(String serviceConfirmation, String serviceConfirmationItem, String pricingProcedureStep, String pricingProcedureCounter)
ServiceConfItemPriceElement
entity using key fields.serviceConfirmationItem
- 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
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
ServiceConfItemPriceElement
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 ServiceConfItemPriceElementCreateFluentHelper createServiceConfItemPriceElement(@Nonnull ServiceConfItemPriceElement serviceConfItemPriceElement)
ServiceConfItemPriceElement
entity and save it to the S/4HANA system.serviceConfItemPriceElement
- ServiceConfItemPriceElement
entity object that will be created in the S/4HANA system.ServiceConfItemPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfItemPriceElementUpdateFluentHelper updateServiceConfItemPriceElement(@Nonnull ServiceConfItemPriceElement serviceConfItemPriceElement)
ServiceConfItemPriceElement
entity and save it to the S/4HANA system.serviceConfItemPriceElement
- ServiceConfItemPriceElement
entity object that will be updated in the S/4HANA system.ServiceConfItemPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfItmRefObjectFluentHelper getAllServiceConfItmRefObject()
ServiceConfItmRefObject
entities.ServiceConfItmRefObject
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 ServiceConfItmRefObjectByKeyFluentHelper getServiceConfItmRefObjectByKey(String serviceConfirmation, String serviceConfirmationItem, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceConfItmRefObject
entity using key fields.serviceConfirmationItem
- 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
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
ServiceConfItmRefObject
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 ServiceConfItmRefObjectCreateFluentHelper createServiceConfItmRefObject(@Nonnull ServiceConfItmRefObject serviceConfItmRefObject)
ServiceConfItmRefObject
entity and save it to the S/4HANA system.serviceConfItmRefObject
- ServiceConfItmRefObject
entity object that will be created in the S/4HANA system.ServiceConfItmRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfItmRefObjectDeleteFluentHelper deleteServiceConfItmRefObject(@Nonnull ServiceConfItmRefObject serviceConfItmRefObject)
ServiceConfItmRefObject
entity in the S/4HANA system.serviceConfItmRefObject
- ServiceConfItmRefObject
entity object that will be deleted in the S/4HANA system.ServiceConfItmRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfPersonRespFluentHelper getAllServiceConfPersonResp()
ServiceConfPersonResp
entities.ServiceConfPersonResp
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 ServiceConfPersonRespByKeyFluentHelper getServiceConfPersonRespByKey(String serviceConfirmation, String personResponsible)
ServiceConfPersonResp
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
personResponsible
- Key identifying a business partner in the SAP system. The key is unique within a client.
Constraints: Not nullable, Maximum length: 10
ServiceConfPersonResp
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 ServiceConfPersonRespCreateFluentHelper createServiceConfPersonResp(@Nonnull ServiceConfPersonResp serviceConfPersonResp)
ServiceConfPersonResp
entity and save it to the S/4HANA system.serviceConfPersonResp
- ServiceConfPersonResp
entity object that will be created in the S/4HANA system.ServiceConfPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfPersonRespUpdateFluentHelper updateServiceConfPersonResp(@Nonnull ServiceConfPersonResp serviceConfPersonResp)
ServiceConfPersonResp
entity and save it to the S/4HANA system.serviceConfPersonResp
- ServiceConfPersonResp
entity object that will be updated in the S/4HANA system.ServiceConfPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfPersonRespDeleteFluentHelper deleteServiceConfPersonResp(@Nonnull ServiceConfPersonResp serviceConfPersonResp)
ServiceConfPersonResp
entity in the S/4HANA system.serviceConfPersonResp
- ServiceConfPersonResp
entity object that will be deleted in the S/4HANA system.ServiceConfPersonResp
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfPriceElementFluentHelper getAllServiceConfPriceElement()
ServiceConfPriceElement
entities.ServiceConfPriceElement
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 ServiceConfPriceElementByKeyFluentHelper getServiceConfPriceElementByKey(String serviceConfirmation, String pricingProcedureStep, String pricingProcedureCounter)
ServiceConfPriceElement
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
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
ServiceConfPriceElement
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 ServiceConfPriceElementCreateFluentHelper createServiceConfPriceElement(@Nonnull ServiceConfPriceElement serviceConfPriceElement)
ServiceConfPriceElement
entity and save it to the S/4HANA system.serviceConfPriceElement
- ServiceConfPriceElement
entity object that will be created in the S/4HANA system.ServiceConfPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfPriceElementUpdateFluentHelper updateServiceConfPriceElement(@Nonnull ServiceConfPriceElement serviceConfPriceElement)
ServiceConfPriceElement
entity and save it to the S/4HANA system.serviceConfPriceElement
- ServiceConfPriceElement
entity object that will be updated in the S/4HANA system.ServiceConfPriceElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfRefObjectFluentHelper getAllServiceConfRefObject()
ServiceConfRefObject
entities.ServiceConfRefObject
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 ServiceConfRefObjectByKeyFluentHelper getServiceConfRefObjectByKey(String serviceConfirmation, String serviceReferenceEquipment, String serviceRefFunctionalLocation)
ServiceConfRefObject
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
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
ServiceConfRefObject
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 ServiceConfRefObjectCreateFluentHelper createServiceConfRefObject(@Nonnull ServiceConfRefObject serviceConfRefObject)
ServiceConfRefObject
entity and save it to the S/4HANA system.serviceConfRefObject
- ServiceConfRefObject
entity object that will be created in the S/4HANA system.ServiceConfRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ServiceConfRefObjectDeleteFluentHelper deleteServiceConfRefObject(@Nonnull ServiceConfRefObject serviceConfRefObject)
ServiceConfRefObject
entity in the S/4HANA system.serviceConfRefObject
- ServiceConfRefObject
entity object that will be deleted in the S/4HANA system.ServiceConfRefObject
entity. To perform execution, call the
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.