Class GetAllRequestBuilderBase<EntityT, DeSerializersT>Abstract

Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

_deSerializers _entity _entityApi _entityConstructor dataAccessor entityDeserializer requestConfig

Methods

addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath build count execute executeRaw middleware orderBy relativeUrl select setBasePath skip skipCsrfTokenFetching top url

Constructors

constructor

Properties

Readonly_deSerializers

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

Readonly_entity

_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

Readonly_entityApi

_entityApi: EntityApi<EntityT, DeSerializersT>

Readonly_entityConstructor

_entityConstructor: Constructable<EntityT>

ReadonlydataAccessor

dataAccessor: ResponseDataAccessor

ReadonlyentityDeserializer

entityDeserializer: EntityDeserializer

requestConfig

requestConfig: ODataGetAllRequestConfig<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.

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.

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.

appendPath

  • appendPath(...path): Omit<GetAllRequestBuilderBase<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<GetAllRequestBuilderBase<EntityT, DeSerializersT>, "execute">

    The request builder itself without "execute" function, to facilitate method chaining.

Protectedbuild

count

execute

  • execute(destination): Promise<EntityT[]>

  • Execute request.

    Parameters

    Returns Promise<EntityT[]>

    A promise resolving to the requested entities.

executeRaw

middleware

  • middleware(middlewares): this

  • Set middleware for requests towards the target system given in the destination.

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

  • middleware(...middlewares): this

  • Parameters

    Returns this

orderBy

relativeUrl

  • relativeUrl(): string

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

select

  • select(...selects): this

  • Restrict the response to the given selection of properties in the request.

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

  • select(selects): this

  • Parameters

    Returns this

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.

skip

  • skip(skip): this

  • Skip number of entities.

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

    Returns this

    The request builder itself, to facilitate method chaining.

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.

top

  • top(top): this

  • Limit number of returned entities.

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

    Returns this

    The request builder itself, to facilitate method chaining.

url

  • url(destination): Promise<string>

  • Create the URL based on configuration of the given builder.

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods