com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface BusinessSituationService

All Superinterfaces:

BatchService<BusinessSituationServiceBatch>

All Known Implementing Classes:

DefaultBusinessSituationService

public interface BusinessSituationService
extends BatchService<BusinessSituationServiceBatch>

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

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BUSINESS_SITUATION_SRV
API Version:	1
Communication Scenario:	Business Situation Integration (SAP_COM_0345)
Scope Items:	Situation Handling (31N)
Authentication Methods:	Basic, x509
Business Object:	BusinessSituation

Field Summary

Fields

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.

Method Summary

Modifier and Type	Method and Description
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.
BusinessSituationService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

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

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
BusinessSituationService withServicePath(@Nonnull
                                                  String servicePath)

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.

getAllSitnDataContext

@Nonnull
SitnDataContextFluentHelper getAllSitnDataContext()

Fetch multiple SitnDataContext entities.

Returns:

A fluent helper to fetch multiple 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.

getSitnDataContextByKey

@Nonnull
SitnDataContextByKeyFluentHelper getSitnDataContextByKey(String sitnDataContextID)

Fetch a single SitnDataContext entity using key fields.

Parameters:

sitnDataContextID - Data Context ID

Constraints: Not nullable, Maximum length: 32

Returns:

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

getAllSitnInstance

@Nonnull
SitnInstanceFluentHelper getAllSitnInstance()

Fetch multiple SitnInstance entities.

Returns:

A fluent helper to fetch multiple 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.

getSitnInstanceByKey

@Nonnull
SitnInstanceByKeyFluentHelper getSitnInstanceByKey(String sitnInstanceID)

Fetch a single SitnInstance entity using key fields.

Parameters:

sitnInstanceID - Instance ID

Constraints: Not nullable, Maximum length: 32

Returns:

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

sendActionStatus

@Nonnull
SendActionStatusFluentHelper sendActionStatus(String sitnActionInstanceID,
                                                       String sitnActionID,
                                                       String sitnActionStatus,
                                                       String sitnInstanceID,
                                                       String sitnInstceTargetStatus)

Creates a fluent helper for the SendActionStatus OData function import.

Parameters:

sitnActionStatus - Action status: SUCCESS or FAILURE

Constraints: Not nullable, Maximum length: 7

Original parameter name from the Odata EDM: SitnActionStatus

sitnActionInstanceID - Unique action instance ID generated by the service client

Constraints: Not nullable, Maximum length: 36

Original parameter name from the Odata EDM: SitnActionInstanceID

sitnInstanceID - Situation instance ID for which the action was performed

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: SitnInstanceID

sitnActionID - ActionID defined by situation template, NO_ACTION or UNKNOWN

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: SitnActionID

sitnInstceTargetStatus - Target instance status: OP(Open) RE(Resolved) UN(Unchanged)

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: SitnInstceTargetStatus

Returns:

A fluent helper object that will execute the SendActionStatus OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.