Options
All
  • Public
  • Public/Protected
  • All
Menu

Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4

Type parameters

  • EntityT: EntityBase

    Type of the entity to be requested

Hierarchy

Index

Constructors

constructor

  • Creates an instance of GetAllRequestBuilder.

    Type parameters

    Parameters

    Returns GetAllRequestBuilderBase<EntityT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly dataAccessor

dataAccessor: ResponseDataAccessor

Readonly entityDeserializer

entityDeserializer: EntityDeserializer<any>

requestConfig

requestConfig: ODataGetAllRequestConfig<EntityT>

Methods

addCustomHeaders

  • Add custom headers to the request. Existing headers will be overwritten.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining.

addCustomQueryParameters

  • 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 GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

build

count

  • Count the number of entities.

    Returns CountRequestBuilder<EntityT>

    A count request builder for execution

execute

orderBy

  • Add order-by statements to the request.

    Parameters

    • orderBy: Orderable<EntityT>[]

      OrderBy statements to order the response by

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

  • Parameters

    Returns GetAllRequestBuilderBase<EntityT>

relativeUrl

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

    Returns string

    The relative url for the request

select

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

    Parameters

    • Rest ...selects: Selectable<EntityT>[]

      Fields to select in the request

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

  • Parameters

    Returns GetAllRequestBuilderBase<EntityT>

setCustomServicePath

  • Replace the default service path with the given custom path. In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

skip

  • Skip number of entities.

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

top

  • 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 GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

url

withCustomHeaders

  • Add custom headers to the request.

    deprecated

    Since version 1.34.0 Use addCustomHeaders instead.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

withCustomQueryParameters

  • Add custom query parameters to the request.

    deprecated

    Since version 1.34.0 Use addCustomQueryParameters instead.

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

withCustomServicePath

  • Replace the default service path with the given custom path. In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    deprecated

    Since version 1.34.0 Use setCustomServicePath instead.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining