@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultBusinessSituationService") public class DefaultBusinessSituationService extends Object implements BusinessSituationService
This API is based on the OData protocol. It provides the situation instance and context data in the payload’s response. This includes the situation instance ID, situation creation time, situation status, situation type ID, situation template ID, situation anchor and trigger object key, anchor object, data context ID, data context, data context creation time, situation activity ID, and situation activity. The payload data can then be consumed, for example, by advanced analytics or automation. It also updates the situation action status for automation. .
Reference: SAP API Business Hub
OData Service: | OP_API_BUSINESS_SITUATION_SRV_0001 |
API Version: | 1 |
Minimum ERP Version: | 2020 |
Authentication Methods: | Basic, x509 |
Business Object: | Business Situation |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultBusinessSituationService()
Creates a service using
BusinessSituationService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultBusinessSituationServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
SitnDataContextFluentHelper |
getAllSitnDataContext()
Fetch multiple
SitnDataContext entities. |
SitnInstanceFluentHelper |
getAllSitnInstance()
Fetch multiple
SitnInstance entities. |
SitnDataContextByKeyFluentHelper |
getSitnDataContextByKey(String sitnDataContextID)
Fetch a single
SitnDataContext entity using key fields. |
SitnInstanceByKeyFluentHelper |
getSitnInstanceByKey(String sitnInstanceID)
Fetch a single
SitnInstance entity using key fields. |
SendActionStatusFluentHelper |
sendActionStatus(String sitnActionInstanceID,
String sitnActionID,
String sitnActionStatus,
String sitnInstanceID,
String sitnInstceTargetStatus)
Creates a fluent helper for the SendActionStatus OData function import.
|
DefaultBusinessSituationService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultBusinessSituationService()
BusinessSituationService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultBusinessSituationService withServicePath(@Nonnull String servicePath)
BusinessSituationService
withServicePath
in interface BusinessSituationService
servicePath
- Service path that will override the default.@Nonnull public DefaultBusinessSituationServiceBatch batch()
batch
in interface BatchService<BusinessSituationServiceBatch>
@Nonnull public SitnDataContextFluentHelper getAllSitnDataContext()
BusinessSituationService
SitnDataContext
entities.getAllSitnDataContext
in interface BusinessSituationService
SitnDataContext
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 public SitnDataContextByKeyFluentHelper getSitnDataContextByKey(String sitnDataContextID)
BusinessSituationService
SitnDataContext
entity using key fields.getSitnDataContextByKey
in interface BusinessSituationService
sitnDataContextID
- Data Context ID
Constraints: Not nullable, Maximum length: 32
SitnDataContext
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 public SitnInstanceFluentHelper getAllSitnInstance()
BusinessSituationService
SitnInstance
entities.getAllSitnInstance
in interface BusinessSituationService
SitnInstance
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 public SitnInstanceByKeyFluentHelper getSitnInstanceByKey(String sitnInstanceID)
BusinessSituationService
SitnInstance
entity using key fields.getSitnInstanceByKey
in interface BusinessSituationService
sitnInstanceID
- Instance ID
Constraints: Not nullable, Maximum length: 32
SitnInstance
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 public SendActionStatusFluentHelper sendActionStatus(String sitnActionInstanceID, String sitnActionID, String sitnActionStatus, String sitnInstanceID, String sitnInstceTargetStatus)
BusinessSituationService
Creates a fluent helper for the SendActionStatus OData function import.
sendActionStatus
in interface BusinessSituationService
sitnActionInstanceID
- Constraints: Not nullable, Maximum length: 36
Original parameter name from the Odata EDM: SitnActionInstanceID
sitnActionID
- Constraints: Not nullable, Maximum length: 32
Original parameter name from the Odata EDM: SitnActionID
sitnActionStatus
- Constraints: Not nullable, Maximum length: 7
Original parameter name from the Odata EDM: SitnActionStatus
sitnInstanceID
- Constraints: Not nullable, Maximum length: 32
Original parameter name from the Odata EDM: SitnInstanceID
sitnInstceTargetStatus
- Constraints: Not nullable, Maximum length: 2
Original parameter name from the Odata EDM: SitnInstceTargetStatus
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.