Class ODataBatchRequestBuilder<DeSerializersT>

Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. The retrieve and change sets will be executed in order, while the order within a change set can vary.

Type Parameters

Hierarchy

Constructors

constructor

Properties

defaultBasePath deSerializers requestConfig requests

Methods

addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath build execute executeRaw getEntityToApiMap middleware relativeUrl setBasePath skipCsrfTokenFetching url withSubRequestPathType

Constructors

constructor

Properties

ReadonlydefaultBasePath

defaultBasePath: string

ReadonlydeSerializers

deSerializers: undefined | DeSerializersT

requestConfig

requestConfig: ODataBatchRequestConfig

Readonlyrequests

requests: (
    | BatchChangeSet<DeSerializersT>
    | GetAllRequestBuilderBase<EntityBase, DeSerializersT>
    | GetByKeyRequestBuilderBase<EntityBase, DeSerializersT>
    | Omit<
        OperationRequestBuilderBase<
            DeSerializersT,
            unknown,
            ODataRequestConfig,
        >,
        "execute",
    >
)[]

Methods

addCustomHeaders

  • addCustomHeaders(headers: Record<string, string>): 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: Record<string, string>): 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: CustomRequestConfig): 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: string[],
    ): Omit<ODataBatchRequestBuilder<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

    • ...path: string[]

      Path to be appended.

    Returns Omit<ODataBatchRequestBuilder<DeSerializersT>, "execute">

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

build

execute

executeRaw

ProtectedgetEntityToApiMap

middleware

  • middleware(middlewares: HttpMiddleware | HttpMiddleware[]): 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: HttpMiddleware[]): this

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

    Parameters

    • ...middlewares: HttpMiddleware[]

      Middlewares to be applied to the executeHttpRequest().

    Returns this

    The request builder itself, to facilitate method chaining.

relativeUrl

  • relativeUrl(): string

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

    Returns string

    The relative URL for the request.

setBasePath

  • setBasePath(basePath: string): 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.

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.

url

  • url(destination: HttpDestinationOrFetchOptions): 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.

withSubRequestPathType

  • withSubRequestPathType(subRequestPathType: BatchSubRequestPathType): this

  • Parameters

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods