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

Interface PhoneCallActivityService

All Superinterfaces:

BatchService<PhoneCallActivityServiceBatch>

All Known Implementing Classes:

DefaultPhoneCallActivityService

public interface PhoneCallActivityService
extends BatchService<PhoneCallActivityServiceBatch>

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 a phone call activity data, including appropriate checks for restricted values and authorizations. Once the phone call activity has been created or updated, the phone call activity information is sent in the response. If there are any issues when the phone call activity is created or updated, the system returns error messages. In each API call, you can use the following operations: - Retrieve phone call activities. - Create phone call 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 phone call activities. - Update the header, person responsible, text, and attendee for existing phone call activities. - Delete the person responsible, text, and attendee for existing phone call activities. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_ACTIVITY_PHONECALL_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Phone Call 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
PhoneCallActivityCreateFluentHelper	createPhoneCallActivity(PhoneCallActivity phoneCallActivity) Create a new PhoneCallActivity entity and save it to the S/4HANA system.
PhoneCallActivityAttendeeCreateFluentHelper	createPhoneCallActivityAttendee(PhoneCallActivityAttendee phoneCallActivityAttendee) Create a new PhoneCallActivityAttendee entity and save it to the S/4HANA system.
PhoneCallActivityPersonRespCreateFluentHelper	createPhoneCallActivityPersonResp(PhoneCallActivityPersonResp phoneCallActivityPersonResp) Create a new PhoneCallActivityPersonResp entity and save it to the S/4HANA system.
PhoneCallActivityTextCreateFluentHelper	createPhoneCallActivityText(PhoneCallActivityText phoneCallActivityText) Create a new PhoneCallActivityText entity and save it to the S/4HANA system.
PhoneCallActivityAttendeeDeleteFluentHelper	deletePhoneCallActivityAttendee(PhoneCallActivityAttendee phoneCallActivityAttendee) Deletes an existing PhoneCallActivityAttendee entity in the S/4HANA system.
PhoneCallActivityPersonRespDeleteFluentHelper	deletePhoneCallActivityPersonResp(PhoneCallActivityPersonResp phoneCallActivityPersonResp) Deletes an existing PhoneCallActivityPersonResp entity in the S/4HANA system.
PhoneCallActivityTextDeleteFluentHelper	deletePhoneCallActivityText(PhoneCallActivityText phoneCallActivityText) Deletes an existing PhoneCallActivityText entity in the S/4HANA system.
PhoneCallActivityFluentHelper	getAllPhoneCallActivity() Fetch multiple PhoneCallActivity entities.
PhoneCallActivityAttendeeFluentHelper	getAllPhoneCallActivityAttendee() Fetch multiple PhoneCallActivityAttendee entities.
PhoneCallActivityPersonRespFluentHelper	getAllPhoneCallActivityPersonResp() Fetch multiple PhoneCallActivityPersonResp entities.
PhoneCallActivityTextFluentHelper	getAllPhoneCallActivityText() Fetch multiple PhoneCallActivityText entities.
PhoneCallActivityAttendeeByKeyFluentHelper	getPhoneCallActivityAttendeeByKey(String phoneCallActivity, String phoneCallActivityAttendee) Fetch a single PhoneCallActivityAttendee entity using key fields.
PhoneCallActivityByKeyFluentHelper	getPhoneCallActivityByKey(String phoneCallActivity) Fetch a single PhoneCallActivity entity using key fields.
PhoneCallActivityPersonRespByKeyFluentHelper	getPhoneCallActivityPersonRespByKey(String phoneCallActivity, String responsibleEmployee) Fetch a single PhoneCallActivityPersonResp entity using key fields.
PhoneCallActivityTextByKeyFluentHelper	getPhoneCallActivityTextByKey(String phoneCallActivity, String textObjectType, String language) Fetch a single PhoneCallActivityText entity using key fields.
PhoneCallActivityUpdateFluentHelper	updatePhoneCallActivity(PhoneCallActivity phoneCallActivity) Update an existing PhoneCallActivity entity and save it to the S/4HANA system.
PhoneCallActivityAttendeeUpdateFluentHelper	updatePhoneCallActivityAttendee(PhoneCallActivityAttendee phoneCallActivityAttendee) Update an existing PhoneCallActivityAttendee entity and save it to the S/4HANA system.
PhoneCallActivityPersonRespUpdateFluentHelper	updatePhoneCallActivityPersonResp(PhoneCallActivityPersonResp phoneCallActivityPersonResp) Update an existing PhoneCallActivityPersonResp entity and save it to the S/4HANA system.
PhoneCallActivityTextUpdateFluentHelper	updatePhoneCallActivityText(PhoneCallActivityText phoneCallActivityText) Update an existing PhoneCallActivityText entity and save it to the S/4HANA system.
PhoneCallActivityService	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
PhoneCallActivityService 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.

getAllPhoneCallActivity

@Nonnull
PhoneCallActivityFluentHelper getAllPhoneCallActivity()

Fetch multiple PhoneCallActivity entities.

Returns:

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

getPhoneCallActivityByKey

@Nonnull
PhoneCallActivityByKeyFluentHelper getPhoneCallActivityByKey(String phoneCallActivity)

Fetch a single PhoneCallActivity entity using key fields.

Parameters:

phoneCallActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createPhoneCallActivity

@Nonnull
PhoneCallActivityCreateFluentHelper createPhoneCallActivity(@Nonnull
                                                                     PhoneCallActivity phoneCallActivity)

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

Parameters:

phoneCallActivity - PhoneCallActivity entity object that will be created in the S/4HANA system.

Returns:

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

updatePhoneCallActivity

@Nonnull
PhoneCallActivityUpdateFluentHelper updatePhoneCallActivity(@Nonnull
                                                                     PhoneCallActivity phoneCallActivity)

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

Parameters:

phoneCallActivity - PhoneCallActivity entity object that will be updated in the S/4HANA system.

Returns:

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

getAllPhoneCallActivityAttendee

@Nonnull
PhoneCallActivityAttendeeFluentHelper getAllPhoneCallActivityAttendee()

Fetch multiple PhoneCallActivityAttendee entities.

Returns:

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

getPhoneCallActivityAttendeeByKey

@Nonnull
PhoneCallActivityAttendeeByKeyFluentHelper getPhoneCallActivityAttendeeByKey(String phoneCallActivity,
                                                                                      String phoneCallActivityAttendee)

Fetch a single PhoneCallActivityAttendee entity using key fields.

Parameters:

phoneCallActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

phoneCallActivityAttendee - Business Partner Number

Constraints: Not nullable, Maximum length: 10

Returns:

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

createPhoneCallActivityAttendee

@Nonnull
PhoneCallActivityAttendeeCreateFluentHelper createPhoneCallActivityAttendee(@Nonnull
                                                                                     PhoneCallActivityAttendee phoneCallActivityAttendee)

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

Parameters:

phoneCallActivityAttendee - PhoneCallActivityAttendee entity object that will be created in the S/4HANA system.

Returns:

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

updatePhoneCallActivityAttendee

@Nonnull
PhoneCallActivityAttendeeUpdateFluentHelper updatePhoneCallActivityAttendee(@Nonnull
                                                                                     PhoneCallActivityAttendee phoneCallActivityAttendee)

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

Parameters:

phoneCallActivityAttendee - PhoneCallActivityAttendee entity object that will be updated in the S/4HANA system.

Returns:

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

deletePhoneCallActivityAttendee

@Nonnull
PhoneCallActivityAttendeeDeleteFluentHelper deletePhoneCallActivityAttendee(@Nonnull
                                                                                     PhoneCallActivityAttendee phoneCallActivityAttendee)

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

Parameters:

phoneCallActivityAttendee - PhoneCallActivityAttendee entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPhoneCallActivityPersonResp

@Nonnull
PhoneCallActivityPersonRespFluentHelper getAllPhoneCallActivityPersonResp()

Fetch multiple PhoneCallActivityPersonResp entities.

Returns:

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

getPhoneCallActivityPersonRespByKey

@Nonnull
PhoneCallActivityPersonRespByKeyFluentHelper getPhoneCallActivityPersonRespByKey(String phoneCallActivity,
                                                                                          String responsibleEmployee)

Fetch a single PhoneCallActivityPersonResp entity using key fields.

Parameters:

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

createPhoneCallActivityPersonResp

@Nonnull
PhoneCallActivityPersonRespCreateFluentHelper createPhoneCallActivityPersonResp(@Nonnull
                                                                                         PhoneCallActivityPersonResp phoneCallActivityPersonResp)

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

Parameters:

phoneCallActivityPersonResp - PhoneCallActivityPersonResp entity object that will be created in the S/4HANA system.

Returns:

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

updatePhoneCallActivityPersonResp

@Nonnull
PhoneCallActivityPersonRespUpdateFluentHelper updatePhoneCallActivityPersonResp(@Nonnull
                                                                                         PhoneCallActivityPersonResp phoneCallActivityPersonResp)

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

Parameters:

phoneCallActivityPersonResp - PhoneCallActivityPersonResp entity object that will be updated in the S/4HANA system.

Returns:

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

deletePhoneCallActivityPersonResp

@Nonnull
PhoneCallActivityPersonRespDeleteFluentHelper deletePhoneCallActivityPersonResp(@Nonnull
                                                                                         PhoneCallActivityPersonResp phoneCallActivityPersonResp)

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

Parameters:

phoneCallActivityPersonResp - PhoneCallActivityPersonResp entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPhoneCallActivityText

@Nonnull
PhoneCallActivityTextFluentHelper getAllPhoneCallActivityText()

Fetch multiple PhoneCallActivityText entities.

Returns:

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

getPhoneCallActivityTextByKey

@Nonnull
PhoneCallActivityTextByKeyFluentHelper getPhoneCallActivityTextByKey(String phoneCallActivity,
                                                                              String textObjectType,
                                                                              String language)

Fetch a single PhoneCallActivityText entity using key fields.

Parameters:

phoneCallActivity - Transaction ID

Constraints: Not nullable, Maximum length: 10

textObjectType - Text ID

Constraints: Not nullable, Maximum length: 4

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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

createPhoneCallActivityText

@Nonnull
PhoneCallActivityTextCreateFluentHelper createPhoneCallActivityText(@Nonnull
                                                                             PhoneCallActivityText phoneCallActivityText)

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

Parameters:

phoneCallActivityText - PhoneCallActivityText entity object that will be created in the S/4HANA system.

Returns:

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

updatePhoneCallActivityText

@Nonnull
PhoneCallActivityTextUpdateFluentHelper updatePhoneCallActivityText(@Nonnull
                                                                             PhoneCallActivityText phoneCallActivityText)

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

Parameters:

phoneCallActivityText - PhoneCallActivityText entity object that will be updated in the S/4HANA system.

Returns:

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

deletePhoneCallActivityText

@Nonnull
PhoneCallActivityTextDeleteFluentHelper deletePhoneCallActivityText(@Nonnull
                                                                             PhoneCallActivityText phoneCallActivityText)

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

Parameters:

phoneCallActivityText - PhoneCallActivityText entity object that will be deleted in the S/4HANA system.

Returns:

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