Interface ServiceContractTemplateService
- All Known Implementing Classes:
DefaultServiceContractTemplateService
You can read the details of service contract templates. The service contains entities of service contract template header, item, item object list, and item product list. In each API call, you can use the operation to retrieve service contract templates. You can use the provided filters to retrieve specific service contract templates or retrieve all existing data..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | CE_SRVCCONTRTEMPLATE_0001 |
| API Version: | 1.1.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Service Contract Template Integration(SAP_COM_0788) |
| Scope Items: | Service Contract Management(3MO) |
| Authentication Methods: | x509 |
| Service Group Name: | API_SRVCCONTRACTTEMPLATE |
| Business Object: | Service Contract Template |
-
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 TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theServiceContractTemplateentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theServiceContractTemplateItementity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSrvcContrTmplItemLongTextentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theServiceContractItemProductListentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theServiceContractItemObjectListentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSrvcContrTmplLongTextentity collection matching the filter and search expressions.Deprecated.Fetch multipleServiceContractTemplateentities.Deprecated.Fetch multipleServiceContractTemplateItementities.Deprecated.Fetch multipleSrvcContrTmplItemLongTextentities.Deprecated.Fetch multipleServiceContractItemProductListentities.Deprecated.Fetch multipleServiceContractItemObjectListentities.Deprecated.Fetch multipleSrvcContrTmplLongTextentities.getServiceContractTemplateByKey(String serviceContractTemplate) Deprecated.Fetch a singleServiceContractTemplateentity using key fields.getServiceContractTemplateItemByKey(String serviceContractTemplate, String serviceContractTemplateItem) Deprecated.Fetch a singleServiceContractTemplateItementity using key fields.getSrvcContrTmplItemLongTextByKey(String serviceContractTemplate, String serviceContractTemplateItem, String textObjectType, String language, String srvcDocLogTextIdentifier) Deprecated.Fetch a singleSrvcContrTmplItemLongTextentity using key fields.getSrvcContrTmplItemProductByKey(String serviceContractTemplate, String serviceContractTemplateItem, String serviceProductListItem) Deprecated.Fetch a singleServiceContractItemProductListentity using key fields.getSrvcContrTmplItmRefObjectByKey(String serviceContractTemplate, String serviceContractTemplateItem, String serviceRefObjectSequenceNumber) Deprecated.Fetch a singleServiceContractItemObjectListentity using key fields.getSrvcContrTmplLongTextByKey(String serviceContractTemplate, String textObjectType, String language, String srvcDocLogTextIdentifier) Deprecated.Fetch a singleSrvcContrTmplLongTextentity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
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.
-
batch
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllServiceContractTemplate
Deprecated.Fetch multipleServiceContractTemplateentities.- Returns:
- A request builder to fetch multiple
ServiceContractTemplateentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countServiceContractTemplate
Deprecated.Fetch the number of entries from theServiceContractTemplateentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ServiceContractTemplateentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getServiceContractTemplateByKey
@Nonnull GetByKeyRequestBuilder<ServiceContractTemplate> getServiceContractTemplateByKey(String serviceContractTemplate) Deprecated.Fetch a singleServiceContractTemplateentity using key fields.- Parameters:
serviceContractTemplate- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
ServiceContractTemplateentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllServiceContractTemplateItem
Deprecated.Fetch multipleServiceContractTemplateItementities.- Returns:
- A request builder to fetch multiple
ServiceContractTemplateItementities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countServiceContractTemplateItem
Deprecated.Fetch the number of entries from theServiceContractTemplateItementity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ServiceContractTemplateItementities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getServiceContractTemplateItemByKey
@Nonnull GetByKeyRequestBuilder<ServiceContractTemplateItem> getServiceContractTemplateItemByKey(String serviceContractTemplate, String serviceContractTemplateItem) Deprecated.Fetch a singleServiceContractTemplateItementity using key fields.- Parameters:
serviceContractTemplateItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceContractTemplate- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
ServiceContractTemplateItementity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllSrvcContrTmplItemLongText
Deprecated.Fetch multipleSrvcContrTmplItemLongTextentities.- Returns:
- A request builder to fetch multiple
SrvcContrTmplItemLongTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSrvcContrTmplItemLongText
Deprecated.Fetch the number of entries from theSrvcContrTmplItemLongTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SrvcContrTmplItemLongTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSrvcContrTmplItemLongTextByKey
@Nonnull GetByKeyRequestBuilder<SrvcContrTmplItemLongText> getSrvcContrTmplItemLongTextByKey(String serviceContractTemplate, String serviceContractTemplateItem, String textObjectType, String language, String srvcDocLogTextIdentifier) Deprecated.Fetch a singleSrvcContrTmplItemLongTextentity using key fields.- Parameters:
textObjectType- Text IDConstraints: Not nullable, Maximum length: 4
serviceContractTemplateItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
srvcDocLogTextIdentifier- Identifier (truncated timestamp) of a log textConstraints: Not nullable, Maximum length: 17
language- Language KeyConstraints: Not nullable, Maximum length: 2
serviceContractTemplate- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
SrvcContrTmplItemLongTextentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllSrvcContrTmplItemProduct
Deprecated.Fetch multipleServiceContractItemProductListentities.- Returns:
- A request builder to fetch multiple
ServiceContractItemProductListentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSrvcContrTmplItemProduct
Deprecated.Fetch the number of entries from theServiceContractItemProductListentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ServiceContractItemProductListentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSrvcContrTmplItemProductByKey
@Nonnull GetByKeyRequestBuilder<ServiceContractItemProductList> getSrvcContrTmplItemProductByKey(String serviceContractTemplate, String serviceContractTemplateItem, String serviceProductListItem) Deprecated.Fetch a singleServiceContractItemProductListentity using key fields.- Parameters:
serviceContractTemplateItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceProductListItem- Counter for CRMS4D_ORDPRP_I product listConstraints: Not nullable, Maximum length: 6
serviceContractTemplate- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
ServiceContractItemProductListentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllSrvcContrTmplItmRefObject
Deprecated.Fetch multipleServiceContractItemObjectListentities.- Returns:
- A request builder to fetch multiple
ServiceContractItemObjectListentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSrvcContrTmplItmRefObject
Deprecated.Fetch the number of entries from theServiceContractItemObjectListentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ServiceContractItemObjectListentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSrvcContrTmplItmRefObjectByKey
@Nonnull GetByKeyRequestBuilder<ServiceContractItemObjectList> getSrvcContrTmplItmRefObjectByKey(String serviceContractTemplate, String serviceContractTemplateItem, String serviceRefObjectSequenceNumber) Deprecated.Fetch a singleServiceContractItemObjectListentity using key fields.- Parameters:
serviceContractTemplateItem- Shortened Item Number in DocumentConstraints: Not nullable, Maximum length: 6
serviceRefObjectSequenceNumber- Reference Object CounterConstraints: Not nullable, Maximum length: 8
serviceContractTemplate- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
ServiceContractItemObjectListentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllSrvcContrTmplLongText
Deprecated.Fetch multipleSrvcContrTmplLongTextentities.- Returns:
- A request builder to fetch multiple
SrvcContrTmplLongTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSrvcContrTmplLongText
Deprecated.Fetch the number of entries from theSrvcContrTmplLongTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SrvcContrTmplLongTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSrvcContrTmplLongTextByKey
@Nonnull GetByKeyRequestBuilder<SrvcContrTmplLongText> getSrvcContrTmplLongTextByKey(String serviceContractTemplate, String textObjectType, String language, String srvcDocLogTextIdentifier) Deprecated.Fetch a singleSrvcContrTmplLongTextentity using key fields.- Parameters:
textObjectType- Text IDConstraints: Not nullable, Maximum length: 4
srvcDocLogTextIdentifier- Identifier (truncated timestamp) of a log textConstraints: Not nullable, Maximum length: 17
language- Language KeyConstraints: Not nullable, Maximum length: 2
serviceContractTemplate- Transaction IDConstraints: Not nullable, Maximum length: 10
- Returns:
- A request builder to fetch a single
SrvcContrTmplLongTextentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-