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

Interface WarehouseResourceService

All Superinterfaces:

BatchService<WarehouseResourceServiceBatch>

All Known Implementing Classes:

DefaultWarehouseResourceService

public interface WarehouseResourceService
extends BatchService<WarehouseResourceServiceBatch>

You can use this service to integrate external applications with warehouse resources in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve warehouse resources. Apply any of the filters provided or retrieve all existing data. - You can create and delete warehouse resources. - You can update existing warehouse resources (log on, log off)..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WAREHOUSE_RESOURCE
API Version:	1
Communication Scenario:	Warehousing - Process Warehouse Task Integration (SAP_COM_0353)
Scope Items:	Resource Management in Warehousing (3W0)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	WarehouseResource

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
WarehouseResourceCreateFluentHelper	createWarehouseResource(WarehouseResource warehouseResource) Create a new WarehouseResource entity and save it to the S/4HANA system.
WarehouseResourceDeleteFluentHelper	deleteWarehouseResource(WarehouseResource warehouseResource) Deletes an existing WarehouseResource entity in the S/4HANA system.
WarehouseResourceFluentHelper	getAllWarehouseResource() Fetch multiple WarehouseResource entities.
WarehouseResourceByKeyFluentHelper	getWarehouseResourceByKey(String warehouse, String warehouseResource) Fetch a single WarehouseResource entity using key fields.
LogoffFromWarehouseResourceFluentHelper	logoffFromWarehouseResource(String warehouse, String warehouseResource) Creates a fluent helper for the LogoffFromWarehouseResource OData function import.
LogonToWarehouseResourceFluentHelper	logonToWarehouseResource(String warehouse, String warehouseResource) Creates a fluent helper for the LogonToWarehouseResource OData function import.
WarehouseResourceService	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
WarehouseResourceService 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.

getAllWarehouseResource

@Nonnull
WarehouseResourceFluentHelper getAllWarehouseResource()

Fetch multiple WarehouseResource entities.

Returns:

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

getWarehouseResourceByKey

@Nonnull
WarehouseResourceByKeyFluentHelper getWarehouseResourceByKey(String warehouse,
                                                                      String warehouseResource)

Fetch a single WarehouseResource entity using key fields.

Parameters:

warehouseResource - Resource (Means of Transportation or User)

Constraints: Not nullable, Maximum length: 18

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

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

createWarehouseResource

@Nonnull
WarehouseResourceCreateFluentHelper createWarehouseResource(@Nonnull
                                                                     WarehouseResource warehouseResource)

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

Parameters:

warehouseResource - WarehouseResource entity object that will be created in the S/4HANA system.

Returns:

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

deleteWarehouseResource

@Nonnull
WarehouseResourceDeleteFluentHelper deleteWarehouseResource(@Nonnull
                                                                     WarehouseResource warehouseResource)

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

Parameters:

warehouseResource - WarehouseResource entity object that will be deleted in the S/4HANA system.

Returns:

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

logoffFromWarehouseResource

@Nonnull
LogoffFromWarehouseResourceFluentHelper logoffFromWarehouseResource(String warehouse,
                                                                             String warehouseResource)

Creates a fluent helper for the LogoffFromWarehouseResource OData function import.

Parameters:

warehouseResource - Resource

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: WarehouseResource

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

Returns:

A fluent helper object that will execute the LogoffFromWarehouseResource OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

logonToWarehouseResource

@Nonnull
LogonToWarehouseResourceFluentHelper logonToWarehouseResource(String warehouse,
                                                                       String warehouseResource)

Creates a fluent helper for the LogonToWarehouseResource OData function import.

Parameters:

warehouseResource - Resource

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: WarehouseResource

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

Returns:

A fluent helper object that will execute the LogonToWarehouseResource OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.