Creates an instance of ODataBatchRequestBuilder.
Service path.
An array of retrieve requests or change sets.
Readonly
deReadonly
defaultReadonly
requestsAdd custom headers to the request. Existing headers will be overwritten.
The request builder itself, to facilitate method chaining.
Key-value pairs denoting additional custom headers.
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
The request builder itself, to facilitate method chaining.
Key-value pairs denoting additional custom query parameters to be set in the request.
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.
The request builder itself, to facilitate method chaining.
Key-value pairs denoting additional custom request configuration options to be set in the request.
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.
The request builder itself without "execute" function, to facilitate method chaining.
Rest
...path: string[]Path to be appended.
Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.
Promise resolving to the requested data.
Targeted destination or DestinationFetchOptions on which the request is performed.
Destination or DestinationFetchOptions to execute the request against.
Protected
getReplace the default service path with the given custom path.
In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME>
and can be overwritten here.
The request builder itself, to facilitate method chaining.
Path to override the default with.
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
The request builder itself, to facilitate method chaining.
Set timeout for requests towards the target system given in the destination.
The request builder itself, to facilitate method chaining.
Since v2.13.0. The timeout configuration is replaced by the more general middleware approach in version 3.0 of the SAP Cloud SDK.
Value is in milliseconds and default value is 10000 (10 seconds).
Create the URL based on configuration of the given builder.
Promise resolving to the URL for the request.
Destination or DestinationFetchOptions to execute the request against.
Copyright Ⓒ 2023 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.