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

  • Creates an instance of GetAllRequestBuilder.

    Type parameters

    Parameters

    Returns GetAllRequestBuilderBase<EntityT>

Properties

_entity: EntityT
_entityConstructor: Constructable<EntityT, unknown>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer<any>
requestConfig: ODataGetAllRequestConfig<EntityT>

Methods

  • 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.

  • 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

  • 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: Record<string, string>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

    Returns GetAllRequestBuilderBase<EntityT>

    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.

    Parameters

    • Rest ...path: string[]

      Path to be appended.

    Returns Omit<GetAllRequestBuilderBase<EntityT>, "execute">

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

  • Count the number of entities.

    Returns CountRequestBuilder<EntityT>

    A count request builder for execution

  • Execute request.

    Parameters

    Returns Promise<EntityT[]>

    A promise resolving to the requested entities

  • Execute request and return an HttpResponse.

    Parameters

    Returns Promise<HttpResponse>

    A promise resolving to an HttpResponse.

  • 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(): string
  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request

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

  • 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.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining

  • 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

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining.

  • 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

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

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request

  • deprecated

    Since version 1.34.0 Use addCustomHeaders instead. Add custom headers to the request.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining.

  • deprecated

    Since version 1.34.0 Use addCustomQueryParameters instead. Add custom query parameters to the request.

    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.

  • deprecated

    Since version 1.34.0 Use setCustomServicePath instead. 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.

    Parameters

    • servicePath: string

      Path to override the default with.

    Returns GetAllRequestBuilderBase<EntityT>

    The request builder itself, to facilitate method chaining.

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