public interface LegalTransactionService extends BatchService<LegalTransactionServiceBatch>
This synchronous inbound service is based on the OData protocol and helps you to create, read, and update legal transactions through an API call. Legal Transactions are business objects that are used to manage the lifecycle of legal content. The service contains legal transactions, categories, category groups, parent categories, dates, entities, external contacts, internal contacts, linked objects, and relationships nodes. The information sent in the request as a payload, is used when creating a legal transaction, including appropriate checks for restricted values and authorizations. Once the legal transaction has been created, the legal transaction ID is sent in the response with the data included in the legal transaction. If there are any issues when the legal transaction is created, the system displays error messages in the response. Note that we support only deep create for the legal transaction node..
Reference: SAP API Business Hub
OData Service: | API_LEGAL_TRANSACTION_SRV |
API Version: | 1 |
Communication Scenario: | Legal Transaction Integration (SAP_COM_0140) |
Scope Items: | SAP S/4HANA for Enterprise Contract Management (1XV) |
Authentication Methods: | Basic, x509 |
Business Object: | LegalTransaction |
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 LegalTransactionService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull LegalTransactionFluentHelper getAllLegalTransaction()
LegalTransaction
entities.LegalTransaction
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 LegalTransactionByKeyFluentHelper getLegalTransactionByKey(UUID legalTransactionUUID)
LegalTransaction
entity using key fields.legalTransactionUUID
- Universal Unique Identifier
Constraints: Not nullable
LegalTransaction
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 LegalTransactionCreateFluentHelper createLegalTransaction(@Nonnull LegalTransaction legalTransaction)
LegalTransaction
entity and save it to the S/4HANA system.legalTransaction
- LegalTransaction
entity object that will be created in the S/4HANA system.LegalTransaction
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LegalTransactionUpdateFluentHelper updateLegalTransaction(@Nonnull LegalTransaction legalTransaction)
LegalTransaction
entity and save it to the S/4HANA system.legalTransaction
- LegalTransaction
entity object that will be updated in the S/4HANA system.LegalTransaction
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransCategoryFluentHelper getAllLglTransCategory()
LglTransCategory
entities.LglTransCategory
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 LglTransCategoryByKeyFluentHelper getLglTransCategoryByKey(UUID legalTransactionCategoryUUID)
LglTransCategory
entity using key fields.legalTransactionCategoryUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransCategory
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 LglTransCategoryGroupFluentHelper getAllLglTransCategoryGroup()
LglTransCategoryGroup
entities.LglTransCategoryGroup
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 LglTransCategoryGroupByKeyFluentHelper getLglTransCategoryGroupByKey(UUID legalTransactionCatGroupUUID)
LglTransCategoryGroup
entity using key fields.legalTransactionCatGroupUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransCategoryGroup
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 LglTransDateFluentHelper getAllLglTransDate()
LglTransDate
entities.LglTransDate
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 LglTransDateByKeyFluentHelper getLglTransDateByKey(UUID legalTransactionDateUUID)
LglTransDate
entity using key fields.legalTransactionDateUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransDate
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 LglTransDateCreateFluentHelper createLglTransDate(@Nonnull LglTransDate lglTransDate)
LglTransDate
entity and save it to the S/4HANA system.lglTransDate
- LglTransDate
entity object that will be created in the S/4HANA system.LglTransDate
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransDateUpdateFluentHelper updateLglTransDate(@Nonnull LglTransDate lglTransDate)
LglTransDate
entity and save it to the S/4HANA system.lglTransDate
- LglTransDate
entity object that will be updated in the S/4HANA system.LglTransDate
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransDateDeleteFluentHelper deleteLglTransDate(@Nonnull LglTransDate lglTransDate)
LglTransDate
entity in the S/4HANA system.lglTransDate
- LglTransDate
entity object that will be deleted in the S/4HANA system.LglTransDate
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransEntityFluentHelper getAllLglTransEntity()
LglTransEntity
entities.LglTransEntity
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 LglTransEntityByKeyFluentHelper getLglTransEntityByKey(UUID legalTransactionEntityUUID)
LglTransEntity
entity using key fields.legalTransactionEntityUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransEntity
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 LglTransEntityCreateFluentHelper createLglTransEntity(@Nonnull LglTransEntity lglTransEntity)
LglTransEntity
entity and save it to the S/4HANA system.lglTransEntity
- LglTransEntity
entity object that will be created in the S/4HANA system.LglTransEntity
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransEntityUpdateFluentHelper updateLglTransEntity(@Nonnull LglTransEntity lglTransEntity)
LglTransEntity
entity and save it to the S/4HANA system.lglTransEntity
- LglTransEntity
entity object that will be updated in the S/4HANA system.LglTransEntity
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransEntityDeleteFluentHelper deleteLglTransEntity(@Nonnull LglTransEntity lglTransEntity)
LglTransEntity
entity in the S/4HANA system.lglTransEntity
- LglTransEntity
entity object that will be deleted in the S/4HANA system.LglTransEntity
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransExternalContactFluentHelper getAllLglTransExternalContact()
LglTransExternalContact
entities.LglTransExternalContact
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 LglTransExternalContactByKeyFluentHelper getLglTransExternalContactByKey(UUID legalTransactionExtCntctUUID)
LglTransExternalContact
entity using key fields.legalTransactionExtCntctUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransExternalContact
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 LglTransExternalContactCreateFluentHelper createLglTransExternalContact(@Nonnull LglTransExternalContact lglTransExternalContact)
LglTransExternalContact
entity and save it to the S/4HANA system.lglTransExternalContact
- LglTransExternalContact
entity object that will be created in the S/4HANA system.LglTransExternalContact
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransExternalContactUpdateFluentHelper updateLglTransExternalContact(@Nonnull LglTransExternalContact lglTransExternalContact)
LglTransExternalContact
entity and save it to the S/4HANA system.lglTransExternalContact
- LglTransExternalContact
entity object that will be updated in the S/4HANA system.LglTransExternalContact
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransExternalContactDeleteFluentHelper deleteLglTransExternalContact(@Nonnull LglTransExternalContact lglTransExternalContact)
LglTransExternalContact
entity in the S/4HANA system.lglTransExternalContact
- LglTransExternalContact
entity object that will be deleted in the S/4HANA system.LglTransExternalContact
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransInternalContactFluentHelper getAllLglTransInternalContact()
LglTransInternalContact
entities.LglTransInternalContact
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 LglTransInternalContactByKeyFluentHelper getLglTransInternalContactByKey(UUID legalTransactionIntCntctUUID)
LglTransInternalContact
entity using key fields.legalTransactionIntCntctUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransInternalContact
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 LglTransInternalContactCreateFluentHelper createLglTransInternalContact(@Nonnull LglTransInternalContact lglTransInternalContact)
LglTransInternalContact
entity and save it to the S/4HANA system.lglTransInternalContact
- LglTransInternalContact
entity object that will be created in the S/4HANA system.LglTransInternalContact
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransInternalContactUpdateFluentHelper updateLglTransInternalContact(@Nonnull LglTransInternalContact lglTransInternalContact)
LglTransInternalContact
entity and save it to the S/4HANA system.lglTransInternalContact
- LglTransInternalContact
entity object that will be updated in the S/4HANA system.LglTransInternalContact
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransInternalContactDeleteFluentHelper deleteLglTransInternalContact(@Nonnull LglTransInternalContact lglTransInternalContact)
LglTransInternalContact
entity in the S/4HANA system.lglTransInternalContact
- LglTransInternalContact
entity object that will be deleted in the S/4HANA system.LglTransInternalContact
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransLinkedObjectsFluentHelper getAllLglTransLinkedObjects()
LglTransLinkedObjects
entities.LglTransLinkedObjects
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 LglTransLinkedObjectsByKeyFluentHelper getLglTransLinkedObjectsByKey(UUID legalTransactionLinkdObjUUID)
LglTransLinkedObjects
entity using key fields.legalTransactionLinkdObjUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransLinkedObjects
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 LglTransLinkedObjectsCreateFluentHelper createLglTransLinkedObjects(@Nonnull LglTransLinkedObjects lglTransLinkedObjects)
LglTransLinkedObjects
entity and save it to the S/4HANA system.lglTransLinkedObjects
- LglTransLinkedObjects
entity object that will be created in the S/4HANA system.LglTransLinkedObjects
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransLinkedObjectsUpdateFluentHelper updateLglTransLinkedObjects(@Nonnull LglTransLinkedObjects lglTransLinkedObjects)
LglTransLinkedObjects
entity and save it to the S/4HANA system.lglTransLinkedObjects
- LglTransLinkedObjects
entity object that will be updated in the S/4HANA system.LglTransLinkedObjects
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransLinkedObjectsDeleteFluentHelper deleteLglTransLinkedObjects(@Nonnull LglTransLinkedObjects lglTransLinkedObjects)
LglTransLinkedObjects
entity in the S/4HANA system.lglTransLinkedObjects
- LglTransLinkedObjects
entity object that will be deleted in the S/4HANA system.LglTransLinkedObjects
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransParentCategoryFluentHelper getAllLglTransParentCategory()
LglTransParentCategory
entities.LglTransParentCategory
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 LglTransParentCategoryByKeyFluentHelper getLglTransParentCategoryByKey(UUID legalTransactionParCatUUID)
LglTransParentCategory
entity using key fields.legalTransactionParCatUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransParentCategory
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 LglTransRelationshipFluentHelper getAllLglTransRelationship()
LglTransRelationship
entities.LglTransRelationship
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 LglTransRelationshipByKeyFluentHelper getLglTransRelationshipByKey(UUID legalTransactionRelshpUUID)
LglTransRelationship
entity using key fields.legalTransactionRelshpUUID
- Universal Unique Identifier
Constraints: Not nullable
LglTransRelationship
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 LglTransRelationshipCreateFluentHelper createLglTransRelationship(@Nonnull LglTransRelationship lglTransRelationship)
LglTransRelationship
entity and save it to the S/4HANA system.lglTransRelationship
- LglTransRelationship
entity object that will be created in the S/4HANA system.LglTransRelationship
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransRelationshipUpdateFluentHelper updateLglTransRelationship(@Nonnull LglTransRelationship lglTransRelationship)
LglTransRelationship
entity and save it to the S/4HANA system.lglTransRelationship
- LglTransRelationship
entity object that will be updated in the S/4HANA system.LglTransRelationship
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull LglTransRelationshipDeleteFluentHelper deleteLglTransRelationship(@Nonnull LglTransRelationship lglTransRelationship)
LglTransRelationship
entity in the S/4HANA system.lglTransRelationship
- LglTransRelationship
entity object that will be deleted in the S/4HANA system.LglTransRelationship
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CancelFluentHelper cancel(UUID legalTransactionUUID)
Creates a fluent helper for the Cancel OData function import.
legalTransactionUUID
- Universal Unique ID
Constraints: none
Original parameter name from the Odata EDM: LegalTransactionUUID
execute
method on the fluent helper object.@Nonnull TerminateFluentHelper terminate(UUID legalTransactionUUID)
Creates a fluent helper for the Terminate OData function import.
legalTransactionUUID
- Universal Unique ID
Constraints: none
Original parameter name from the Odata EDM: LegalTransactionUUID
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.