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

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT
_entity: EntityT
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

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 this

    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 this

    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, any>

      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.

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

  • Execute request.

    Parameters

    Returns Promise<EntityT>

    A promise resolving to the requested entity.

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

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

  • Parameters

    Returns this

  • 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

    Returns this

    The request builder itself, to facilitate method chaining.

  • Parameters

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

  • Sets user-defined identifier for the batch reference.

    Parameters

    • id: string

      User-defined batch request identifier.

    Returns void

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

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