Abstract
Type of the (de-)serializers.
Type of the function import return value.
Type of the request config.
Protected
constructorBase class for function and actions imports.
Transformation function for the response.
Request config for a action or function import.
(De-)serializers used for transformation.
Readonly
_deReadonly
responseAdd custom headers to the request. Existing headers will be overwritten.
Key-value pairs denoting additional custom headers.
The request builder itself, to facilitate method chaining.
Add 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.
Protected
buildExecute request.
Destination or DestinationFetchOptions to execute the request against.
Optional
dataAccessor: ((data) => any)A function to modify the received response data.
A promise resolving to the requested return type.
Execute request and return an HttpResponse.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to an HttpResponse.
Gets identifier for the batch request.
Batch request identifier.
Set 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.
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.
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 Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.
Create OData request to execute a action or function import.