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..
Reference: SAP API Business Hub
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 |
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 |
---|---|
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.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull EHSIncidentCreateService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull AttachmentCreateFluentHelper createAttachment(@Nonnull Attachment attachment)
Attachment
entity and save it to the S/4HANA system.attachment
- Attachment
entity object that will be created in the S/4HANA system.Attachment
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull IncidentFluentHelper getAllIncident()
Incident
entities.@Nonnull IncidentByKeyFluentHelper getIncidentByKey(UUID incidentUUID)
Incident
entity using key fields.incidentUUID
- NodeID
Constraints: Not nullable
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.@Nonnull IncidentCreateFluentHelper createIncident(@Nonnull Incident incident)
Incident
entity and save it to the S/4HANA system.@Nonnull LocationFluentHelper getAllLocation()
Location
entities.@Nonnull LocationByKeyFluentHelper getLocationByKey(UUID locationUUID)
Location
entity using key fields.locationUUID
- NodeID
Constraints: Not nullable
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.@Nonnull PersonCreateFluentHelper createPerson(@Nonnull Person person)
Person
entity
and save it to the S/4HANA system.Copyright © 2020 SAP SE. All rights reserved.