Type of the entity to be requested.
Creates an instance of GetByKeyRequestBuilder.
Entity API for building and executing the request.
Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value.
Readonly _deDummy property to include also the deserializer type in the strucutre of the entity type.
Readonly _entityDummy property whose type makes structurally identical entities distiguishable in TypeScript.
Readonly _entityReadonly _entityReadonly dataReadonly entityAdd 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.
Protected buildExecute request.
A promise resolving to the requested entity.
Destination or DestinationFetchOptions to execute the request against.
Destination or DestinationFetchOptions to execute the request against.
Gets identifier for the batch request.
Batch request identifier.
Restrict the response to the given selection of properties in the request.
The request builder itself, to facilitate method chaining.
Rest ...selects: Selectable<EntityT, DeSerializersT>[]Fields to select in the request.
Replace 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 an OData request to get a single entity based on its key properties. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields. Note that navigational properties are automatically expanded if they included in a select.