Creates an instance of ODataBatchRequestBuilder.
Base path.
An array of retrieve requests or change sets.
Readonly
defaultReadonly
deReadonly
requestsAdd custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
Key-value pairs denoting additional custom query parameters to be set in the request.
The request builder itself, to facilitate method chaining.
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.
Key-value pairs denoting additional custom request configuration options to be set in the request.
The request builder itself, to facilitate method chaining.
Append the given path to the URL.
This can be used for querying navigation properties of an entity.
To execute a request with an appended path use executeRaw
to avoid errors during deserialization. When using this, the execute
method is omitted from the return type.
Rest
...path: string[]Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.
Targeted destination or DestinationFetchOptions on which the request is performed.
Promise resolving to the requested data.
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.
Protected
getSet middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
Rest
...middlewares: HttpMiddleware[]Replace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
Path to override the default with.
The request builder itself, to facilitate method chaining.
Create the URL based on configuration of the given builder.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. The retrieve and change sets will be executed in order, while the order within a change set can vary.