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

Interface CustomerDataReturnFileDownloadService

All Superinterfaces:

BatchService<CustomerDataReturnFileDownloadServiceBatch>

All Known Implementing Classes:

DefaultCustomerDataReturnFileDownloadService

@Deprecated
public interface CustomerDataReturnFileDownloadService
extends BatchService<CustomerDataReturnFileDownloadServiceBatch>

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service can be consumed by external application to download all business data from SAP S/4HANA Cloud systems, prepared using Customer Data Return - Extraction app, to a local machine or third party storage. You can use this service to: - Download prepared files in compressed format - Retrieve list of prepared files - Retrieve download status details of files It returns an appropriate success or error response while performing the operations. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	API_CDR_FILE_DOWNLOAD_SRV
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Customer Data Return Integration(SAP_COM_0589)
Scope Items:	Customer Data Return(5I9)
Authentication Methods:	x509

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. 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	Description
FileDownloadStatusFluentHelper	getAllFileDownloadStatus()	Deprecated. Fetch multiple FileDownloadStatus entities.
ListFileFluentHelper	getAllListFile()	Deprecated. Fetch multiple ListFile entities.
DownloadFileByKeyFluentHelper	getDownloadFileByKey(String packageName, String fileName)	Deprecated. Fetch a single DownloadFile entity using key fields.
CustomerDataReturnFileDownloadService	withServicePath(String servicePath)	Deprecated. 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 Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

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 Details

withServicePath

@Nonnull
CustomerDataReturnFileDownloadService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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.

getAllListFile

@Nonnull
ListFileFluentHelper getAllListFile()

Deprecated.

Fetch multiple ListFile entities.

Returns:

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

getDownloadFileByKey

@Nonnull
DownloadFileByKeyFluentHelper getDownloadFileByKey(String packageName,
 String fileName)

Deprecated.

Fetch a single DownloadFile entity using key fields.

Parameters:

fileName - ZIP File Name

Constraints: Not nullable, Maximum length: 60

packageName - Package Name

Constraints: Not nullable, Maximum length: 32

Returns:

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

getAllFileDownloadStatus

@Nonnull
FileDownloadStatusFluentHelper getAllFileDownloadStatus()

Deprecated.

Fetch multiple FileDownloadStatus entities.

Returns:

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