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

build

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 S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns BatchRequestBuilder

    The request builder itself, to facilitate method chaining

url

withCustomHeaders

  • Add custom headers to the request.

    deprecated

    Since version 1.34.0 Use addCustomHeaders instead.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers

    Returns BatchRequestBuilder

    The request builder itself, to facilitate method chaining

withCustomQueryParameters

  • Add custom query parameters to the request.

    deprecated

    Since version 1.34.0 Use addCustomQueryParameters instead.

    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

  • Replace the default service path with the given custom path. In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    deprecated

    Since version 1.34.0 Use setCustomServicePath instead.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns BatchRequestBuilder

    The request builder itself, to facilitate method chaining

withSubRequestPathType

  • Parameters

    • subRequestPathType: BatchSubRequestPathType

    Returns BatchRequestBuilder