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_Dummy property to also include the deserializer type in the structure of the entity type.
Readonly_Dummy property whose type makes structurally identical entities distinguishable in TypeScript.
Readonly_Readonly_ReadonlydataReadonlyentityAdd 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.
Path to be appended.
The request builder itself without "execute" function, to facilitate method chaining.
ProtectedbuildExecute request.
Destination or DestinationFetchOptions to execute the request against.
A promise resolving to the requested entity.
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.
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.
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.
Create the relative URL based on configuration of the given builder.
The relative URL for the request.
Restrict the response to the given selection of properties in the request.
Fields to select in the request.
The request builder itself, to facilitate method chaining.
Restrict the response to the given selection of properties in the request.
Fields to select in the request.
The request builder itself, to facilitate method chaining.
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.
Sets user-defined identifier for the batch reference.
User-defined batch request identifier.
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 Ⓒ 2025 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.