Interface ServiceContractService

All Superinterfaces:
BatchService<ServiceContractServiceBatch>
All Known Implementing Classes:
DefaultServiceContractService

@Deprecated public interface ServiceContractService extends BatchService<ServiceContractServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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

Business Documentation

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 Details

  • Method Details

    • withServicePath

      @Nonnull ServiceContractService withServicePath(@Nonnull String servicePath)
      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

      @Nonnull ServiceContractFluentHelper getAllServiceContract()
      Deprecated.
      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)
      Deprecated.
      Fetch a single ServiceContract entity using key fields.
      Parameters:
      serviceContract - Transaction ID

      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single ServiceContractItem entity using key fields.
      Parameters:
      serviceContractItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

      serviceContract - Transaction ID

      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.
    • getAllServiceContractItemText

      @Nonnull ServiceContractItemTextFluentHelper getAllServiceContractItemText()
      Deprecated.
      Fetch multiple ServiceContractItemText entities.
      Returns:
      A fluent helper to fetch multiple ServiceContractItemText 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.
    • getServiceContractItemTextByKey

      @Nonnull ServiceContractItemTextByKeyFluentHelper getServiceContractItemTextByKey(String serviceContract, String serviceContractItem, String language, String longTextID)
      Deprecated.
      Fetch a single ServiceContractItemText entity using key fields.
      Parameters:
      serviceContractItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

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

      Returns:
      A fluent helper to fetch a single ServiceContractItemText 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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single ServiceContractText entity using key fields.
      Parameters:
      serviceContract - 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

      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single ServiceContrItemObjectList entity using key fields.
      Parameters:
      serviceContractItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

      serviceContract - Transaction ID

      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.
    • getAllServiceContrItemPriceElement

      @Nonnull ServiceContrItemPriceElementFluentHelper getAllServiceContrItemPriceElement()
      Deprecated.
      Fetch multiple ServiceContrItemPriceElement entities.
      Returns:
      A fluent helper to fetch multiple ServiceContrItemPriceElement 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.
    • getServiceContrItemPriceElementByKey

      @Nonnull ServiceContrItemPriceElementByKeyFluentHelper getServiceContrItemPriceElementByKey(String serviceContract, String serviceContractItem, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single ServiceContrItemPriceElement entity using key fields.
      Parameters:
      serviceContractItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

      pricingProcedureCounter - Condition Counter

      Constraints: Not nullable, Maximum length: 3

      serviceContract - Transaction ID

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A fluent helper to fetch a single ServiceContrItemPriceElement 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()
      Deprecated.
      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)
      Deprecated.
      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.
    • getAllSrvcContrBillgReqItmPrcElmnt

      @Nonnull SrvcContrBillgReqItmPrcElmntFluentHelper getAllSrvcContrBillgReqItmPrcElmnt()
      Deprecated.
      Fetch multiple SrvcContrBillgReqItmPrcElmnt entities.
      Returns:
      A fluent helper to fetch multiple SrvcContrBillgReqItmPrcElmnt 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.
    • getSrvcContrBillgReqItmPrcElmntByKey

      @Nonnull SrvcContrBillgReqItmPrcElmntByKeyFluentHelper getSrvcContrBillgReqItmPrcElmntByKey(String serviceContract, String billingRequestItem, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single SrvcContrBillgReqItmPrcElmnt entity using key fields.
      Parameters:
      pricingProcedureCounter - Condition Counter

      Constraints: Not nullable, Maximum length: 3

      serviceContract - Transaction ID

      Constraints: Not nullable, Maximum length: 10

      billingRequestItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A fluent helper to fetch a single SrvcContrBillgReqItmPrcElmnt 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.
    • getAllSrvcContrItemProduct

      @Nonnull SrvcContrItemProductFluentHelper getAllSrvcContrItemProduct()
      Deprecated.
      Fetch multiple SrvcContrItemProduct entities.
      Returns:
      A fluent helper to fetch multiple SrvcContrItemProduct 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.
    • getSrvcContrItemProductByKey

      @Nonnull SrvcContrItemProductByKeyFluentHelper getSrvcContrItemProductByKey(String serviceContract, String serviceContractItem, String serviceProductListItem)
      Deprecated.
      Fetch a single SrvcContrItemProduct entity using key fields.
      Parameters:
      serviceContractItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

      serviceProductListItem - Counter for CRMS4D_ORDPRP_I product list

      Constraints: Not nullable, Maximum length: 6

      serviceContract - Transaction ID

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single SrvcContrItemProduct 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.
    • getAllSrvcContrItmBillgReqItem

      @Nonnull SrvcContrItmBillgReqItemFluentHelper getAllSrvcContrItmBillgReqItem()
      Deprecated.
      Fetch multiple SrvcContrItmBillgReqItem entities.
      Returns:
      A fluent helper to fetch multiple SrvcContrItmBillgReqItem 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.
    • getSrvcContrItmBillgReqItemByKey

      @Nonnull SrvcContrItmBillgReqItemByKeyFluentHelper getSrvcContrItmBillgReqItemByKey(String serviceContract, String serviceContractItem, String billingRequestItem)
      Deprecated.
      Fetch a single SrvcContrItmBillgReqItem entity using key fields.
      Parameters:
      serviceContractItem - Shortened Item Number in Document

      Constraints: Not nullable, Maximum length: 6

      serviceContract - Transaction ID

      Constraints: Not nullable, Maximum length: 10

      billingRequestItem - Billing Request Item No

      Constraints: Not nullable, Maximum length: 6

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