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

Interface EHSIncidentCreateService

All Superinterfaces:

BatchService<EHSIncidentCreateServiceBatch>

All Known Implementing Classes:

DefaultEHSIncidentCreateService

public interface EHSIncidentCreateService
extends BatchService<EHSIncidentCreateServiceBatch>

This service contains the basic information about an incident as the main entity, and persons involved, location, and attachments as dependent entities. For create operations, the information is sent in the request as a payload, except for attachment-related data. You can add attachments to the newly created incident in separate calls. Once the incident has been created, the incident data and global identification are sent in the response. For read operations, filter information can be sent according to the OData protocol. While creating an incident or retrieving incident data, the system performs checks for restricted values and authorization. If there are any issues, the system displays error messages in the response..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_EHS_REPORT_INCIDENT_SRV
API Version:	1
Communication Scenario:	Environment, Health and Safety - Incident Reporting Integration (SAP_COM_0369)
Scope Items:	Lean Incident Management Reporting (3FP)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	EHSIncident

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
AttachmentCreateFluentHelper	createAttachment(Attachment attachment) Create a new Attachment entity and save it to the S/4HANA system.
IncidentCreateFluentHelper	createIncident(Incident incident) Create a new Incident entity and save it to the S/4HANA system.
PersonCreateFluentHelper	createPerson(Person person) Create a new Person entity and save it to the S/4HANA system.
IncidentFluentHelper	getAllIncident() Fetch multiple Incident entities.
LocationFluentHelper	getAllLocation() Fetch multiple Location entities.
IncidentByKeyFluentHelper	getIncidentByKey(UUID incidentUUID) Fetch a single Incident entity using key fields.
LocationByKeyFluentHelper	getLocationByKey(UUID locationUUID) Fetch a single Location entity using key fields.
EHSIncidentCreateService	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.s4hana.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
EHSIncidentCreateService 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.

createAttachment

@Nonnull
AttachmentCreateFluentHelper createAttachment(@Nonnull
                                                       Attachment attachment)

Create a new Attachment entity and save it to the S/4HANA system.

Parameters:

attachment - Attachment entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new Attachment entity. To perform execution, call the execute method on the fluent helper object.

getAllIncident

@Nonnull
IncidentFluentHelper getAllIncident()

Fetch multiple Incident entities.

Returns:

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

getIncidentByKey

@Nonnull
IncidentByKeyFluentHelper getIncidentByKey(UUID incidentUUID)

Fetch a single Incident entity using key fields.

Parameters:

incidentUUID - NodeID

Constraints: Not nullable

Returns:

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

createIncident

@Nonnull
IncidentCreateFluentHelper createIncident(@Nonnull
                                                   Incident incident)

Create a new Incident entity and save it to the S/4HANA system.

Parameters:

incident - Incident entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new Incident entity. To perform execution, call the execute method on the fluent helper object.

getAllLocation

@Nonnull
LocationFluentHelper getAllLocation()

Fetch multiple Location entities.

Returns:

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

getLocationByKey

@Nonnull
LocationByKeyFluentHelper getLocationByKey(UUID locationUUID)

Fetch a single Location entity using key fields.

Parameters:

locationUUID - NodeID

Constraints: Not nullable

Returns:

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

createPerson

@Nonnull
PersonCreateFluentHelper createPerson(@Nonnull
                                               Person person)

Create a new Person entity and save it to the S/4HANA system.

Parameters:

person - Person entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new Person entity. To perform execution, call the execute method on the fluent helper object.