Class GetByKeyRequestBuilderBase<EntityT, DeSerializersT>`Abstract`

Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.

Type Parameters

EntityT extends EntityBase
Type of the entity to be requested
DeSerializersT extends DeSerializers

Hierarchy (view full)

GetRequestBuilderBase<EntityT, DeSerializersT, ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>
- GetByKeyRequestBuilderBase
  - GetByKeyRequestBuilder
  - GetByKeyRequestBuilder

Implements

WithBatchReference

Constructors

constructor

new GetByKeyRequestBuilderBase<EntityT, DeSerializersT>(entityApi, keys, oDataUri, entityDeserializer, dataAccessor): GetByKeyRequestBuilderBase<EntityT, DeSerializersT>
Creates an instance of GetByKeyRequestBuilder.
Type Parameters
- EntityT extends EntityBase
- DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>
Parameters
- entityApi: EntityApi<EntityT, DeSerializersT>
  Entity API for building and executing the request.
- keys: Record<string, any>
  Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value.
- oDataUri: ODataUri<DeSerializersT>
  URI conversion functions.
- entityDeserializer: EntityDeserializer
  Entity deserializer.
- dataAccessor: ResponseDataAccessor
  Object access functions for get requests.
Returns GetByKeyRequestBuilderBase<EntityT, DeSerializersT>
Overrides GetRequestBuilderBase<EntityT, DeSerializersT, ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>.constructor
- Defined in packages/odata-common/dist/request-builder/get-by-key-request-builder-base.d.ts:28

Properties

`Readonly` _deSerializers

_deSerializers: DeSerializersT

`Readonly` _entity

_entity: EntityT

`Readonly` _entityApi

_entityApi: EntityApi<EntityT, DeSerializersT>

`Readonly` _entityConstructor

_entityConstructor: Constructable<EntityT>

`Readonly` dataAccessor

dataAccessor: ResponseDataAccessor

`Readonly` entityDeserializer

entityDeserializer: EntityDeserializer

requestConfig

requestConfig: ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

Methods

addCustomHeaders

addCustomHeaders(headers): this
Add custom headers to the request. Existing headers will be overwritten.
Parameters
- headers: Record<string, string>
  Key-value pairs denoting additional custom headers.
Returns this
The request builder itself, to facilitate method chaining.
Inherited from GetRequestBuilderBase.addCustomHeaders
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:34

addCustomQueryParameters

addCustomQueryParameters(queryParameters): this
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
Parameters
- queryParameters: Record<string, string>
  Key-value pairs denoting additional custom query parameters to be set in the request.
Returns this
The request builder itself, to facilitate method chaining.
Inherited from GetRequestBuilderBase.addCustomQueryParameters
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:47

addCustomRequestConfiguration

addCustomRequestConfiguration(requestConfiguration): this
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.
Parameters
- requestConfiguration: CustomRequestConfig
  Key-value pairs denoting additional custom request configuration options to be set in the request.
Returns this
The request builder itself, to facilitate method chaining.
Inherited from GetRequestBuilderBase.addCustomRequestConfiguration
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:61

appendPath

appendPath(...path): Omit<GetByKeyRequestBuilderBase<EntityT, DeSerializersT>, "execute">
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.
Parameters
- Rest ...path: string[]
  Path to be appended.
Returns Omit<GetByKeyRequestBuilderBase<EntityT, DeSerializersT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
Inherited from GetRequestBuilderBase.appendPath
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:69

`Protected` build

build(): ODataRequest<ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>
Inherited from GetRequestBuilderBase.build
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:75
build(destination): Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>>
Parameters
- destination: HttpDestinationOrFetchOptions
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>>
Inherited from GetRequestBuilderBase.build
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:76

execute

execute(destination): Promise<EntityT>
Execute request.
Parameters
- destination: HttpDestinationOrFetchOptions
  Destination or DestinationFetchOptions to execute the request against.
Returns Promise<EntityT>
A promise resolving to the requested entity.
- Defined in packages/odata-common/dist/request-builder/get-by-key-request-builder-base.d.ts:51

executeRaw

executeRaw(destination): Promise<HttpResponse>
Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.
Parameters
- destination: HttpDestinationOrFetchOptions
  Destination or DestinationFetchOptions to execute the request against.
Returns Promise<HttpResponse>
A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.
Inherited from GetRequestBuilderBase.executeRaw
- Defined in packages/odata-common/dist/request-builder/get-request-builder-base.d.ts:36

getBatchReference

getBatchReference(): BatchReference
Gets identifier for the batch request.

Returns BatchReference
Batch request identifier.
Implementation of WithBatchReference.getBatchReference
- Defined in packages/odata-common/dist/request-builder/get-by-key-request-builder-base.d.ts:33

middleware

middleware(middlewares): this
Set middleware for requests towards the target system given in the destination.
Parameters
- middlewares: HttpMiddleware | HttpMiddleware[]
  Middlewares to be applied to the executeHttpRequest().
Returns this
The request builder itself, to facilitate method chaining.
Inherited from GetRequestBuilderBase.middleware
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:40
middleware(...middlewares): this
Parameters
- Rest ...middlewares: HttpMiddleware[]
Returns this
Inherited from GetRequestBuilderBase.middleware
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:41

relativeUrl

relativeUrl(): string
Create the relative URL based on configuration of the given builder.

Returns string
The relative URL for the request.
Inherited from GetRequestBuilderBase.relativeUrl
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:28

select

select(...selects): this
Restrict the response to the given selection of properties in the request.
Parameters
- Rest ...selects: Selectable<EntityT, DeSerializersT>[]
  Fields to select in the request.
Returns this
The request builder itself, to facilitate method chaining.
Overrides GetRequestBuilderBase.select
- Defined in packages/odata-common/dist/request-builder/get-by-key-request-builder-base.d.ts:44
select(selects): this
Parameters
- selects: Selectable<EntityT, DeSerializersT>[]
Returns this
Overrides GetRequestBuilderBase.select
- Defined in packages/odata-common/dist/request-builder/get-by-key-request-builder-base.d.ts:45

setBasePath

setBasePath(basePath): this
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.
Parameters
- basePath: string
  Path to override the default with.
Returns this
The request builder itself, to facilitate method chaining.
Inherited from GetRequestBuilderBase.setBasePath
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:54

setBatchId

setBatchId(id): void
Sets user-defined identifier for the batch reference.
Parameters
- id: string
  User-defined batch request identifier.
Returns void
Implementation of WithBatchReference.setBatchId
- Defined in packages/odata-common/dist/request-builder/get-by-key-request-builder-base.d.ts:38

skipCsrfTokenFetching

skipCsrfTokenFetching(): this
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

Returns this
The request builder itself, to facilitate method chaining.
Inherited from GetRequestBuilderBase.skipCsrfTokenFetching
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:74

url

url(destination): Promise<string>
Create the URL based on configuration of the given builder.
Parameters
- destination: HttpDestinationOrFetchOptions
  Destination or DestinationFetchOptions to execute the request against.
Returns Promise<string>
Promise resolving to the URL for the request.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Inherited from GetRequestBuilderBase.url
- Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:23

Class GetByKeyRequestBuilderBase<EntityT, DeSerializersT>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GetByKeyRequestBuilderBase<EntityT, DeSerializersT>

Properties

Readonly _deSerializers

Readonly _entity

Readonly _entityApi

Readonly _entityConstructor

Readonly dataAccessor

Readonly entityDeserializer

requestConfig

Methods

addCustomHeaders

Parameters

Returns this

addCustomQueryParameters

Parameters

Returns this

addCustomRequestConfiguration

Parameters

Returns this

appendPath

Parameters

Returns Omit<GetByKeyRequestBuilderBase<EntityT, DeSerializersT>, "execute">

Protected build

Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>

Parameters

Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT, DeSerializersT>>>

execute

Parameters

Returns Promise<EntityT>

executeRaw

Parameters

Returns Promise<HttpResponse>

getBatchReference

Returns BatchReference

middleware

Parameters

Returns this

Parameters

Returns this

relativeUrl

Returns string

select

Parameters

Returns this

Parameters

Returns this

setBasePath

Parameters

Returns this

setBatchId

Parameters

Returns void

skipCsrfTokenFetching

Returns this

url

Parameters

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Class GetByKeyRequestBuilderBase<EntityT, DeSerializersT>`Abstract`

`Readonly` _deSerializers

`Readonly` _entity

`Readonly` _entityApi

`Readonly` _entityConstructor

`Readonly` dataAccessor

`Readonly` entityDeserializer

`Protected` build