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

Interface AppointmentActivityService

All Superinterfaces:

BatchService<AppointmentActivityServiceBatch>

All Known Implementing Classes:

DefaultAppointmentActivityService

public interface AppointmentActivityService
extends BatchService<AppointmentActivityServiceBatch>

The service contains header, attendee, person responsible, and text entities. The information is sent in the request as a payload. All information is used when creating, updating or deleting an appointment activity data, including appropriate checks for restricted values and authorizations. Once the appointment activity has been created or updated, the appointment activity number is sent in the response. If there are any issues when the appointment activity is created or updated, the system returns error messages. In each API call, you can use the following operations: - Retrieve appointment activities. - Create appointment activities. Note: You must use “deep insert” requests (a header plus the following entities: person responsible, text, and attendee). - Create new attendee, person responsible, text for existing appointment activities. - Update the header, person responsible, text, and attendee for existing appointment activities. - Delete the person responsible, text, and attendee for existing appointment activities. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_ACTIVITY_APPOINTMENT_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Appointment Activity

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
AppointmentActivityCreateFluentHelper	createAppointmentActivity(AppointmentActivity appointmentActivity) Create a new AppointmentActivity entity and save it to the S/4HANA system.
AppointmentActivityTextCreateFluentHelper	createAppointmentActivityText(AppointmentActivityText appointmentActivityText) Create a new AppointmentActivityText entity and save it to the S/4HANA system.
AppointmentActyAttendeeCreateFluentHelper	createAppointmentActyAttendee(AppointmentActyAttendee appointmentActyAttendee) Create a new AppointmentActyAttendee entity and save it to the S/4HANA system.
AppointmentActyPersonRespCreateFluentHelper	createAppointmentActyPersonResp(AppointmentActyPersonResp appointmentActyPersonResp) Create a new AppointmentActyPersonResp entity and save it to the S/4HANA system.
AppointmentActivityTextDeleteFluentHelper	deleteAppointmentActivityText(AppointmentActivityText appointmentActivityText) Deletes an existing AppointmentActivityText entity in the S/4HANA system.
AppointmentActyAttendeeDeleteFluentHelper	deleteAppointmentActyAttendee(AppointmentActyAttendee appointmentActyAttendee) Deletes an existing AppointmentActyAttendee entity in the S/4HANA system.
AppointmentActyPersonRespDeleteFluentHelper	deleteAppointmentActyPersonResp(AppointmentActyPersonResp appointmentActyPersonResp) Deletes an existing AppointmentActyPersonResp entity in the S/4HANA system.
AppointmentActivityFluentHelper	getAllAppointmentActivity() Fetch multiple AppointmentActivity entities.
AppointmentActivityTextFluentHelper	getAllAppointmentActivityText() Fetch multiple AppointmentActivityText entities.
AppointmentActyAttendeeFluentHelper	getAllAppointmentActyAttendee() Fetch multiple AppointmentActyAttendee entities.
AppointmentActyPersonRespFluentHelper	getAllAppointmentActyPersonResp() Fetch multiple AppointmentActyPersonResp entities.
AppointmentActivityByKeyFluentHelper	getAppointmentActivityByKey(String appointmentActivity) Fetch a single AppointmentActivity entity using key fields.
AppointmentActivityTextByKeyFluentHelper	getAppointmentActivityTextByKey(String appointmentActivity, String textObjectType) Fetch a single AppointmentActivityText entity using key fields.
AppointmentActyAttendeeByKeyFluentHelper	getAppointmentActyAttendeeByKey(String appointmentActivity, String appointmentActivityAttendee) Fetch a single AppointmentActyAttendee entity using key fields.
AppointmentActyPersonRespByKeyFluentHelper	getAppointmentActyPersonRespByKey(String appointmentActivity, String responsibleEmployee) Fetch a single AppointmentActyPersonResp entity using key fields.
AppointmentActivityUpdateFluentHelper	updateAppointmentActivity(AppointmentActivity appointmentActivity) Update an existing AppointmentActivity entity and save it to the S/4HANA system.
AppointmentActivityTextUpdateFluentHelper	updateAppointmentActivityText(AppointmentActivityText appointmentActivityText) Update an existing AppointmentActivityText entity and save it to the S/4HANA system.
AppointmentActyAttendeeUpdateFluentHelper	updateAppointmentActyAttendee(AppointmentActyAttendee appointmentActyAttendee) Update an existing AppointmentActyAttendee entity and save it to the S/4HANA system.
AppointmentActyPersonRespUpdateFluentHelper	updateAppointmentActyPersonResp(AppointmentActyPersonResp appointmentActyPersonResp) Update an existing AppointmentActyPersonResp entity and save it to the S/4HANA system.
AppointmentActivityService	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
AppointmentActivityService 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.

getAllAppointmentActivity

@Nonnull
AppointmentActivityFluentHelper getAllAppointmentActivity()

Fetch multiple AppointmentActivity entities.

Returns:

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

getAppointmentActivityByKey

@Nonnull
AppointmentActivityByKeyFluentHelper getAppointmentActivityByKey(String appointmentActivity)

Fetch a single AppointmentActivity entity using key fields.

Parameters:

appointmentActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createAppointmentActivity

@Nonnull
AppointmentActivityCreateFluentHelper createAppointmentActivity(@Nonnull
                                                                         AppointmentActivity appointmentActivity)

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

Parameters:

appointmentActivity - AppointmentActivity entity object that will be created in the S/4HANA system.

Returns:

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

updateAppointmentActivity

@Nonnull
AppointmentActivityUpdateFluentHelper updateAppointmentActivity(@Nonnull
                                                                         AppointmentActivity appointmentActivity)

Update an existing AppointmentActivity entity and save it to the S/4HANA system.

Parameters:

appointmentActivity - AppointmentActivity entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing AppointmentActivity entity. To perform execution, call the execute method on the fluent helper object.

getAllAppointmentActivityText

@Nonnull
AppointmentActivityTextFluentHelper getAllAppointmentActivityText()

Fetch multiple AppointmentActivityText entities.

Returns:

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

getAppointmentActivityTextByKey

@Nonnull
AppointmentActivityTextByKeyFluentHelper getAppointmentActivityTextByKey(String appointmentActivity,
                                                                                  String textObjectType)

Fetch a single AppointmentActivityText entity using key fields.

Parameters:

textObjectType - Text ID

Constraints: Not nullable, Maximum length: 4

appointmentActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createAppointmentActivityText

@Nonnull
AppointmentActivityTextCreateFluentHelper createAppointmentActivityText(@Nonnull
                                                                                 AppointmentActivityText appointmentActivityText)

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

Parameters:

appointmentActivityText - AppointmentActivityText entity object that will be created in the S/4HANA system.

Returns:

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

updateAppointmentActivityText

@Nonnull
AppointmentActivityTextUpdateFluentHelper updateAppointmentActivityText(@Nonnull
                                                                                 AppointmentActivityText appointmentActivityText)

Update an existing AppointmentActivityText entity and save it to the S/4HANA system.

Parameters:

appointmentActivityText - AppointmentActivityText entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing AppointmentActivityText entity. To perform execution, call the execute method on the fluent helper object.

deleteAppointmentActivityText

@Nonnull
AppointmentActivityTextDeleteFluentHelper deleteAppointmentActivityText(@Nonnull
                                                                                 AppointmentActivityText appointmentActivityText)

Deletes an existing AppointmentActivityText entity in the S/4HANA system.

Parameters:

appointmentActivityText - AppointmentActivityText entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing AppointmentActivityText entity. To perform execution, call the execute method on the fluent helper object.

getAllAppointmentActyAttendee

@Nonnull
AppointmentActyAttendeeFluentHelper getAllAppointmentActyAttendee()

Fetch multiple AppointmentActyAttendee entities.

Returns:

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

getAppointmentActyAttendeeByKey

@Nonnull
AppointmentActyAttendeeByKeyFluentHelper getAppointmentActyAttendeeByKey(String appointmentActivity,
                                                                                  String appointmentActivityAttendee)

Fetch a single AppointmentActyAttendee entity using key fields.

Parameters:

appointmentActivityAttendee - Business Partner Number

Constraints: Not nullable, Maximum length: 10

appointmentActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createAppointmentActyAttendee

@Nonnull
AppointmentActyAttendeeCreateFluentHelper createAppointmentActyAttendee(@Nonnull
                                                                                 AppointmentActyAttendee appointmentActyAttendee)

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

Parameters:

appointmentActyAttendee - AppointmentActyAttendee entity object that will be created in the S/4HANA system.

Returns:

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

updateAppointmentActyAttendee

@Nonnull
AppointmentActyAttendeeUpdateFluentHelper updateAppointmentActyAttendee(@Nonnull
                                                                                 AppointmentActyAttendee appointmentActyAttendee)

Update an existing AppointmentActyAttendee entity and save it to the S/4HANA system.

Parameters:

appointmentActyAttendee - AppointmentActyAttendee entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing AppointmentActyAttendee entity. To perform execution, call the execute method on the fluent helper object.

deleteAppointmentActyAttendee

@Nonnull
AppointmentActyAttendeeDeleteFluentHelper deleteAppointmentActyAttendee(@Nonnull
                                                                                 AppointmentActyAttendee appointmentActyAttendee)

Deletes an existing AppointmentActyAttendee entity in the S/4HANA system.

Parameters:

appointmentActyAttendee - AppointmentActyAttendee entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing AppointmentActyAttendee entity. To perform execution, call the execute method on the fluent helper object.

getAllAppointmentActyPersonResp

@Nonnull
AppointmentActyPersonRespFluentHelper getAllAppointmentActyPersonResp()

Fetch multiple AppointmentActyPersonResp entities.

Returns:

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

getAppointmentActyPersonRespByKey

@Nonnull
AppointmentActyPersonRespByKeyFluentHelper getAppointmentActyPersonRespByKey(String appointmentActivity,
                                                                                      String responsibleEmployee)

Fetch a single AppointmentActyPersonResp entity using key fields.

Parameters:

appointmentActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

responsibleEmployee - Business Partner Number

Constraints: Not nullable, Maximum length: 10

Returns:

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

createAppointmentActyPersonResp

@Nonnull
AppointmentActyPersonRespCreateFluentHelper createAppointmentActyPersonResp(@Nonnull
                                                                                     AppointmentActyPersonResp appointmentActyPersonResp)

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

Parameters:

appointmentActyPersonResp - AppointmentActyPersonResp entity object that will be created in the S/4HANA system.

Returns:

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

updateAppointmentActyPersonResp

@Nonnull
AppointmentActyPersonRespUpdateFluentHelper updateAppointmentActyPersonResp(@Nonnull
                                                                                     AppointmentActyPersonResp appointmentActyPersonResp)

Update an existing AppointmentActyPersonResp entity and save it to the S/4HANA system.

Parameters:

appointmentActyPersonResp - AppointmentActyPersonResp entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing AppointmentActyPersonResp entity. To perform execution, call the execute method on the fluent helper object.

deleteAppointmentActyPersonResp

@Nonnull
AppointmentActyPersonRespDeleteFluentHelper deleteAppointmentActyPersonResp(@Nonnull
                                                                                     AppointmentActyPersonResp appointmentActyPersonResp)

Deletes an existing AppointmentActyPersonResp entity in the S/4HANA system.

Parameters:

appointmentActyPersonResp - AppointmentActyPersonResp entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing AppointmentActyPersonResp entity. To perform execution, call the execute method on the fluent helper object.