public interface BusinessEventQueueService extends BatchService<BusinessEventQueueServiceBatch>
The service reads business events from a queue for a given subscriber. The business event contains the type and the key of the object triggering the event and the action. There are appropriate checks for restricted values and authorizations. The system displays a failure message in the response if the entry is invalid..
Reference: SAP API Business Hub
OData Service: | C_BEHQUEUEDATA_CDS |
API Version: | 1 |
Communication Scenario: | Business Event Handling Integration (SAP_COM_0121), OpenText Business Event Integration (SAP_COM_0007) |
Scope Items: | Business Event Handling (1NN) |
Authentication Methods: | Basic, x509 |
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. |
Modifier and Type | Method and Description |
---|---|
BehqueuedataFluentHelper |
getAllBehqueuedata()
Fetch multiple
Behqueuedata entities. |
BusinessObjectKeysFluentHelper |
getAllBusinessObjectKeys()
Fetch multiple
BusinessObjectKeys entities. |
BusObjectsFluentHelper |
getAllBusObjects()
Fetch multiple
BusObjects entities. |
BehqueuedataByKeyFluentHelper |
getBehqueuedataByKey(UUID businessEvent)
Fetch a single
Behqueuedata entity using key fields. |
BusinessObjectKeysByKeyFluentHelper |
getBusinessObjectKeysByKey(String sAPObjectType)
Fetch a single
BusinessObjectKeys entity using key fields. |
BusObjectsByKeyFluentHelper |
getBusObjectsByKey(String sAPObjectType,
String sAPObjectTypeName,
String sAPObjectTaskCode,
String sAPObjectTaskTypeName)
Fetch a single
BusObjects entity using key fields. |
BusinessEventQueueService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull BusinessEventQueueService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BehqueuedataFluentHelper getAllBehqueuedata()
Behqueuedata
entities.Behqueuedata
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 BehqueuedataByKeyFluentHelper getBehqueuedataByKey(UUID businessEvent)
Behqueuedata
entity using key fields.businessEvent
- Indicates the GUID (Globally Unique Identifer) assigned to an event.
Constraints: Not nullable
Behqueuedata
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 BusinessObjectKeysFluentHelper getAllBusinessObjectKeys()
BusinessObjectKeys
entities.BusinessObjectKeys
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 BusinessObjectKeysByKeyFluentHelper getBusinessObjectKeysByKey(String sAPObjectType)
BusinessObjectKeys
entity using key fields.sAPObjectType
- Indicates the name of the business object type.
Constraints: Not nullable, Maximum length: 30
BusinessObjectKeys
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 BusObjectsFluentHelper getAllBusObjects()
BusObjects
entities.BusObjects
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 BusObjectsByKeyFluentHelper getBusObjectsByKey(String sAPObjectType, String sAPObjectTypeName, String sAPObjectTaskCode, String sAPObjectTaskTypeName)
BusObjects
entity using key fields.sAPObjectTaskCode
- Indicates the code for the task that a business object type performs.
Constraints: Not nullable, Maximum length: 18
sAPObjectTypeName
- Indicates the text description of a particular business object type.
Constraints: Not nullable, Maximum length: 80
sAPObjectType
- Indicates the name of the business object type.
Constraints: Not nullable, Maximum length: 30
sAPObjectTaskTypeName
- Indicates the text description of a particular business object task, which is dependent on the
language that you maintain in the text table.
Constraints: Not nullable, Maximum length: 80
BusObjects
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.Copyright © 2021 SAP SE. All rights reserved.