Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Constructors

constructor

  • Creates an instance of ODataBatchRequestBuilder.

    Parameters

    • defaultServicePath: string

      Service path

    • requests: (BatchChangeSet<any> | MethodRequestBuilder<any>)[]

      An array of retrieve requests or change sets

    • entityToConstructorMap: Record<string, Constructable<EntityBase, unknown>>

      A map that holds the entity type to constructor mapping

    Returns BatchRequestBuilder

Properties

Readonly defaultServicePath

defaultServicePath: string

Readonly entityToConstructorMap

entityToConstructorMap: Record<string, Constructable<EntityBase, unknown>>

requestConfig

Readonly requests

requests: (BatchChangeSet<any> | MethodRequestBuilder<any>)[]

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 BatchRequestBuilder

    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 BatchRequestBuilder

    The request builder itself, to facilitate method chaining

addCustomRequestConfiguration

  • addCustomRequestConfiguration(requestConfiguration: Record<string, string>): BatchRequestBuilder
  • 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 BatchRequestBuilder

    The request builder itself, to facilitate method chaining.

appendPath

  • 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<BatchRequestBuilder, "execute">

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

build

executeRaw

relativeUrl

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

    Returns string

    The relative URL for the request

setCustomServicePath

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

    The request builder itself, to facilitate method chaining

skipCsrfTokenFetching

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

    Returns BatchRequestBuilder

    The request builder itself, to facilitate method chaining.

url

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

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request

withCustomHeaders

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

    The request builder itself, to facilitate method chaining.

withCustomQueryParameters

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

    The request builder itself, to facilitate method chaining.

withCustomServicePath

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

    The request builder itself, to facilitate method chaining.

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

withSubRequestPathType

  • Parameters

    • subRequestPathType: BatchSubRequestPathType

    Returns BatchRequestBuilder