Interface ServiceContractService
- All Superinterfaces:
BatchService<ServiceContractServiceBatch>
- All Known Implementing Classes:
DefaultServiceContractService
You can use this service to integrate external applications with service contract processing in SAP S/4HANA Cloud. The service contains entities of service contract header, header text, item text, item, item object list, item product list, item price element, item released order, and billing request line. In each API call, you can use the operation to retrieve service contracts. You can apply any of the filters provided or retrieve all existing data..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_SERVICE_CONTRACT_SRV |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Service Contract OData Integration(SAP_COM_0558) |
| Scope Items: | Service Contract Management(3MO) |
| Authentication Methods: | x509 |
| Business Object: | Service Contract |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Fetch multipleServiceContractentities.Deprecated.Fetch multipleServiceContractItementities.Deprecated.Fetch multipleServiceContractItemTextentities.Deprecated.Fetch multipleServiceContractTextentities.Deprecated.Fetch multipleServiceContrItemObjectListentities.Deprecated.Fetch multipleServiceContrItemPriceElemententities.Deprecated.Fetch multipleServiceContrItmReleasedOrderentities.Deprecated.Fetch multipleSrvcContrBillgReqItmPrcElmntentities.Deprecated.Fetch multipleSrvcContrItemProductentities.Deprecated.Fetch multipleSrvcContrItmBillgReqItementities.getServiceContractByKey(String serviceContract) Deprecated.Fetch a singleServiceContractentity using key fields.getServiceContractItemByKey(String serviceContract, String serviceContractItem) Deprecated.Fetch a singleServiceContractItementity using key fields.getServiceContractItemTextByKey(String serviceContract, String serviceContractItem, String language, String longTextID) Deprecated.Fetch a singleServiceContractItemTextentity using key fields.getServiceContractTextByKey(String serviceContract, String language, String longTextID) Deprecated.Fetch a singleServiceContractTextentity using key fields.getServiceContrItemObjectListByKey(String serviceContract, String serviceContractItem, String serviceRefObjectSequenceNumber) Deprecated.Fetch a singleServiceContrItemObjectListentity using key fields.getServiceContrItemPriceElementByKey(String serviceContract, String serviceContractItem, String pricingProcedureStep, String pricingProcedureCounter) Deprecated.Fetch a singleServiceContrItemPriceElemententity using key fields.getServiceContrItmReleasedOrderByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber) Deprecated.Fetch a singleServiceContrItmReleasedOrderentity using key fields.getSrvcContrBillgReqItmPrcElmntByKey(String serviceContract, String billingRequestItem, String pricingProcedureStep, String pricingProcedureCounter) Deprecated.Fetch a singleSrvcContrBillgReqItmPrcElmntentity using key fields.getSrvcContrItemProductByKey(String serviceContract, String serviceContractItem, String serviceProductListItem) Deprecated.Fetch a singleSrvcContrItemProductentity using key fields.getSrvcContrItmBillgReqItemByKey(String serviceContract, String serviceContractItem, String billingRequestItem) Deprecated.Fetch a singleSrvcContrItmBillgReqItementity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService
batch
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
getAllServiceContract
Deprecated.Fetch multipleServiceContractentities.- Returns:
- A fluent helper to fetch multiple
ServiceContractentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContractByKey
Deprecated.Fetch a singleServiceContractentity using key fields.- Parameters:
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
ServiceContractentity 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 theexecutemethod on the fluent helper object.
-
getAllServiceContractItem
Deprecated.Fetch multipleServiceContractItementities.- Returns:
- A fluent helper to fetch multiple
ServiceContractItementities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContractItemByKey
@Nonnull ServiceContractItemByKeyFluentHelper getServiceContractItemByKey(String serviceContract, String serviceContractItem) Deprecated.Fetch a singleServiceContractItementity using key fields.- Parameters:
serviceContractItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
ServiceContractItementity 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 theexecutemethod on the fluent helper object.
-
getAllServiceContractItemText
Deprecated.Fetch multipleServiceContractItemTextentities.- Returns:
- A fluent helper to fetch multiple
ServiceContractItemTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContractItemTextByKey
@Nonnull ServiceContractItemTextByKeyFluentHelper getServiceContractItemTextByKey(String serviceContract, String serviceContractItem, String language, String longTextID) Deprecated.Fetch a singleServiceContractItemTextentity using key fields.- Parameters:
serviceContractItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
language- Language KeyConstraints: Not nullable, Maximum length: 2
longTextID- Text IDConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
ServiceContractItemTextentity 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 theexecutemethod on the fluent helper object.
-
getAllServiceContractText
Deprecated.Fetch multipleServiceContractTextentities.- Returns:
- A fluent helper to fetch multiple
ServiceContractTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContractTextByKey
@Nonnull ServiceContractTextByKeyFluentHelper getServiceContractTextByKey(String serviceContract, String language, String longTextID) Deprecated.Fetch a singleServiceContractTextentity using key fields.- Parameters:
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
language- Language KeyConstraints: Not nullable, Maximum length: 2
longTextID- Text IDConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
ServiceContractTextentity 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 theexecutemethod on the fluent helper object.
-
getAllServiceContrItemObjectList
Deprecated.Fetch multipleServiceContrItemObjectListentities.- Returns:
- A fluent helper to fetch multiple
ServiceContrItemObjectListentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContrItemObjectListByKey
@Nonnull ServiceContrItemObjectListByKeyFluentHelper getServiceContrItemObjectListByKey(String serviceContract, String serviceContractItem, String serviceRefObjectSequenceNumber) Deprecated.Fetch a singleServiceContrItemObjectListentity using key fields.- Parameters:
serviceContractItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
serviceRefObjectSequenceNumber- Reference Object CounterConstraints: Not nullable, Maximum length: 8
- Returns:
- A fluent helper to fetch a single
ServiceContrItemObjectListentity 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 theexecutemethod on the fluent helper object.
-
getAllServiceContrItemPriceElement
Deprecated.Fetch multipleServiceContrItemPriceElemententities.- Returns:
- A fluent helper to fetch multiple
ServiceContrItemPriceElemententities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContrItemPriceElementByKey
@Nonnull ServiceContrItemPriceElementByKeyFluentHelper getServiceContrItemPriceElementByKey(String serviceContract, String serviceContractItem, String pricingProcedureStep, String pricingProcedureCounter) Deprecated.Fetch a singleServiceContrItemPriceElemententity using key fields.- Parameters:
serviceContractItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
pricingProcedureCounter- Condition CounterConstraints: Not nullable, Maximum length: 3
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
pricingProcedureStep- Step NumberConstraints: Not nullable, Maximum length: 3
- Returns:
- A fluent helper to fetch a single
ServiceContrItemPriceElemententity 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 theexecutemethod on the fluent helper object.
-
getAllServiceContrItmReleasedOrder
Deprecated.Fetch multipleServiceContrItmReleasedOrderentities.- Returns:
- A fluent helper to fetch multiple
ServiceContrItmReleasedOrderentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getServiceContrItmReleasedOrderByKey
@Nonnull ServiceContrItmReleasedOrderByKeyFluentHelper getServiceContrItmReleasedOrderByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber) Deprecated.Fetch a singleServiceContrItmReleasedOrderentity using key fields.- Parameters:
serviceDocumentItmRelationUUID- Object Relationship Service : GUID binary linkConstraints: Not nullable
serviceDocItmRltnSqncNumber- Sequential Number of Segment in IDoc TypeConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
ServiceContrItmReleasedOrderentity 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 theexecutemethod on the fluent helper object.
-
getAllSrvcContrBillgReqItmPrcElmnt
Deprecated.Fetch multipleSrvcContrBillgReqItmPrcElmntentities.- Returns:
- A fluent helper to fetch multiple
SrvcContrBillgReqItmPrcElmntentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSrvcContrBillgReqItmPrcElmntByKey
@Nonnull SrvcContrBillgReqItmPrcElmntByKeyFluentHelper getSrvcContrBillgReqItmPrcElmntByKey(String serviceContract, String billingRequestItem, String pricingProcedureStep, String pricingProcedureCounter) Deprecated.Fetch a singleSrvcContrBillgReqItmPrcElmntentity using key fields.- Parameters:
pricingProcedureCounter- Condition CounterConstraints: Not nullable, Maximum length: 3
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
billingRequestItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
pricingProcedureStep- Step NumberConstraints: Not nullable, Maximum length: 3
- Returns:
- A fluent helper to fetch a single
SrvcContrBillgReqItmPrcElmntentity 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 theexecutemethod on the fluent helper object.
-
getAllSrvcContrItemProduct
Deprecated.Fetch multipleSrvcContrItemProductentities.- Returns:
- A fluent helper to fetch multiple
SrvcContrItemProductentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSrvcContrItemProductByKey
@Nonnull SrvcContrItemProductByKeyFluentHelper getSrvcContrItemProductByKey(String serviceContract, String serviceContractItem, String serviceProductListItem) Deprecated.Fetch a singleSrvcContrItemProductentity using key fields.- Parameters:
serviceContractItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceProductListItem- Counter for CRMS4D_ORDPRP_I product listConstraints: Not nullable, Maximum length: 6
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
SrvcContrItemProductentity 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 theexecutemethod on the fluent helper object.
-
getAllSrvcContrItmBillgReqItem
Deprecated.Fetch multipleSrvcContrItmBillgReqItementities.- Returns:
- A fluent helper to fetch multiple
SrvcContrItmBillgReqItementities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSrvcContrItmBillgReqItemByKey
@Nonnull SrvcContrItmBillgReqItemByKeyFluentHelper getSrvcContrItmBillgReqItemByKey(String serviceContract, String serviceContractItem, String billingRequestItem) Deprecated.Fetch a singleSrvcContrItmBillgReqItementity using key fields.- Parameters:
serviceContractItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceContract- Transaction IDConstraints: Not nullable, Maximum length: 10
billingRequestItem- Billing Request Item NoConstraints: Not nullable, Maximum length: 6
- Returns:
- A fluent helper to fetch a single
SrvcContrItmBillgReqItementity 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 theexecutemethod on the fluent helper object.
-