Interface DocumentComplianceElectronicDocumentFileService
- All Known Implementing Classes:
DefaultDocumentComplianceElectronicDocumentFileService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the
VDM.
This service enables you to download eDocument file data in SAP S/4HANA Cloud that can be used by external applications. The service is based on the OData V4 protocol.
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | ELECTRONICDOCFILE_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Document Compliance - Electronic Document File Integration(SAP_COM_0703) |
| Authentication Methods: | x509 |
| Service Group Name: | API_ELECTRONICDOCFILE |
| Business Object: | Electronic Document |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theElectronicDocFileentity collection matching the filter and search expressions.Deprecated.Fetch multipleElectronicDocFileentities.getElectronicDocFileByKey(UUID electronicDocFileUUID) Deprecated.Fetch a singleElectronicDocFileentity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
@Nonnull DocumentComplianceElectronicDocumentFileService 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.
-
batch
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllElectronicDocFile
Deprecated.Fetch multipleElectronicDocFileentities.- Returns:
- A request builder to fetch multiple
ElectronicDocFileentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countElectronicDocFile
Deprecated.Fetch the number of entries from theElectronicDocFileentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ElectronicDocFileentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getElectronicDocFileByKey
@Nonnull GetByKeyRequestBuilder<ElectronicDocFile> getElectronicDocFileByKey(UUID electronicDocFileUUID) Deprecated.Fetch a singleElectronicDocFileentity using key fields.- Parameters:
electronicDocFileUUID- File GUIDConstraints: Not nullable
- Returns:
- A request builder to fetch a single
ElectronicDocFileentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-