com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface ServiceContractService

All Superinterfaces:

BatchService<ServiceContractServiceBatch>

All Known Implementing Classes:

DefaultServiceContractService

public interface ServiceContractService
extends BatchService<ServiceContractServiceBatch>

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, item object list, and item released order. 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..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SERVICE_CONTRACT_SRV
API Version:	1
Communication Scenario:	Service Contract OData Integration (SAP_COM_0558)
Scope Items:	Service Contract Management (3MO)
Authentication Methods:	Basic
Business Object:	ServiceContract

Field Summary

Fields

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.

Method Summary

Modifier and Type	Method and Description
ServiceContractFluentHelper	getAllServiceContract() Fetch multiple ServiceContract entities.
ServiceContractItemFluentHelper	getAllServiceContractItem() Fetch multiple ServiceContractItem entities.
ServiceContractTextFluentHelper	getAllServiceContractText() Fetch multiple ServiceContractText entities.
ServiceContrItemObjectListFluentHelper	getAllServiceContrItemObjectList() Fetch multiple ServiceContrItemObjectList entities.
ServiceContrItmReleasedOrderFluentHelper	getAllServiceContrItmReleasedOrder() Fetch multiple ServiceContrItmReleasedOrder entities.
ServiceContractByKeyFluentHelper	getServiceContractByKey(String serviceContract) Fetch a single ServiceContract entity using key fields.
ServiceContractItemByKeyFluentHelper	getServiceContractItemByKey(String serviceContract, String serviceContractItem) Fetch a single ServiceContractItem entity using key fields.
ServiceContractTextByKeyFluentHelper	getServiceContractTextByKey(String serviceContract, String language, String longTextID) Fetch a single ServiceContractText entity using key fields.
ServiceContrItemObjectListByKeyFluentHelper	getServiceContrItemObjectListByKey(String serviceContract, String serviceContractItem, String serviceRefObjectSequenceNumber) Fetch a single ServiceContrItemObjectList entity using key fields.
ServiceContrItmReleasedOrderByKeyFluentHelper	getServiceContrItmReleasedOrderByKey(UUID serviceDocumentItmRelationUUID, String serviceDocItmRltnSqncNumber) Fetch a single ServiceContrItmReleasedOrder entity using key fields.
ServiceContractService	withServicePath(String servicePath) 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 Detail

DEFAULT_SERVICE_PATH

static final 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.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
ServiceContractService withServicePath(@Nonnull
                                                String servicePath)

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

@Nonnull
ServiceContractFluentHelper getAllServiceContract()

Fetch multiple ServiceContract entities.

Returns:

A fluent helper to fetch multiple ServiceContract 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.

getServiceContractByKey

@Nonnull
ServiceContractByKeyFluentHelper getServiceContractByKey(String serviceContract)

Fetch a single ServiceContract entity using key fields.

Parameters:

serviceContract - Number that identifies the transaction document. It is unique for each business transaction category.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ServiceContract 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.

getAllServiceContractItem

@Nonnull
ServiceContractItemFluentHelper getAllServiceContractItem()

Fetch multiple ServiceContractItem entities.

Returns:

A fluent helper to fetch multiple ServiceContractItem 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.

getServiceContractItemByKey

@Nonnull
ServiceContractItemByKeyFluentHelper getServiceContractItemByKey(String serviceContract,
                                                                          String serviceContractItem)

Fetch a single ServiceContractItem entity using key fields.

Parameters:

serviceContractItem - Shortened Item Number in Document

Constraints: Not nullable, Maximum length: 6

serviceContract - Number that identifies the transaction document. It is unique for each business transaction category.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ServiceContractItem 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.

getAllServiceContractText

@Nonnull
ServiceContractTextFluentHelper getAllServiceContractText()

Fetch multiple ServiceContractText entities.

Returns:

A fluent helper to fetch multiple ServiceContractText 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.

getServiceContractTextByKey

@Nonnull
ServiceContractTextByKeyFluentHelper getServiceContractTextByKey(String serviceContract,
                                                                          String language,
                                                                          String longTextID)

Fetch a single ServiceContractText entity using key fields.

Parameters:

serviceContract - 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

Returns:

A fluent helper to fetch a single ServiceContractText 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.

getAllServiceContrItemObjectList

@Nonnull
ServiceContrItemObjectListFluentHelper getAllServiceContrItemObjectList()

Fetch multiple ServiceContrItemObjectList entities.

Returns:

A fluent helper to fetch multiple ServiceContrItemObjectList 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.

getServiceContrItemObjectListByKey

@Nonnull
ServiceContrItemObjectListByKeyFluentHelper getServiceContrItemObjectListByKey(String serviceContract,
                                                                                        String serviceContractItem,
                                                                                        String serviceRefObjectSequenceNumber)

Fetch a single ServiceContrItemObjectList entity using key fields.

Parameters:

serviceContractItem - Shortened Item Number in Document

Constraints: Not nullable, Maximum length: 6

serviceContract - Number that identifies the transaction document. It is unique for each business transaction category.

Constraints: Not nullable, Maximum length: 10

serviceRefObjectSequenceNumber - Reference Object Counter

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single ServiceContrItemObjectList 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.

getAllServiceContrItmReleasedOrder

@Nonnull
ServiceContrItmReleasedOrderFluentHelper getAllServiceContrItmReleasedOrder()

Fetch multiple ServiceContrItmReleasedOrder entities.

Returns:

A fluent helper to fetch multiple ServiceContrItmReleasedOrder 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.

getServiceContrItmReleasedOrderByKey

@Nonnull
ServiceContrItmReleasedOrderByKeyFluentHelper getServiceContrItmReleasedOrderByKey(UUID serviceDocumentItmRelationUUID,
                                                                                            String serviceDocItmRltnSqncNumber)

Fetch a single ServiceContrItmReleasedOrder entity using key fields.

Parameters:

serviceDocumentItmRelationUUID - Object Relationship Service : GUID binary link

Constraints: Not nullable

serviceDocItmRltnSqncNumber - Sequential Number of Segment in IDoc Type

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ServiceContrItmReleasedOrder 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.