Class GetAllRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

Type Parameters

Hierarchy

Constructors

  • Creates an instance of GetAllRequestBuilder.

    Type Parameters

    • EntityT extends EntityBase<EntityT>

    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>

    Parameters

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

Properties

_deSerializers: DeSerializersT
_entity: EntityT
_entityApi: EntityApi<EntityT, DeSerializersT>
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer
requestConfig: ODataGetAllRequestConfig<EntityT, DeSerializersT>

Methods

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

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • queryParameters: Record<string, string>

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

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

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

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • requestConfiguration: Record<string, string>

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

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

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

    Returns

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

    Parameters

    • Rest ...path: string[]

      Path to be appended.

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

  • Count the number of entities.

    Returns

    A count request builder for execution.

    Returns CountRequestBuilder<EntityT, DeSerializersT>

  • Execute request.

    Returns

    A promise resolving to the requested entities.

    Parameters

    Returns Promise<EntityT[]>

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

    Returns

    The relative URL for the request.

    Returns string

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

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

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

      Fields to select in the request.

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

  • Parameters

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

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

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • servicePath: string

      Path to override the default with.

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

  • Skip number of entities.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

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

    Returns

    The request builder itself, to facilitate method chaining.

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

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

    Returns

    The request builder itself, to facilitate method chaining.

    Deprecated

    Since v2.13.0. The timeout configuration is replaced by the more general middleware approach in version 3.0 of the SAP Cloud SDK.

    Parameters

    • timeout: number

      Value is in milliseconds and default value is 10000 (10 seconds).

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

  • Limit number of returned entities.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • top: number

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

    Returns GetAllRequestBuilderBase<EntityT, DeSerializersT>

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

    Returns

    Promise resolving to the URL for the request.

    Parameters

    Returns Promise<string>

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