Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BatchRequestBuilder

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

Properties

Readonly defaultServicePath

defaultServicePath: string

Service path

Readonly entityToConstructorMap

entityToConstructorMap: Record<string, Constructable<EntityBase>>

A map that holds the entity type to constructor mapping

requestConfig

Request configuration to initialize with

Readonly requests

An array of retrieve requests or change sets

Methods

addCustomHeaders

  • addCustomHeaders(headers: Record<string, string>): this

addCustomQueryParameters

  • addCustomQueryParameters(queryParameters: Record<string, string>): this

build

relativeUrl

  • relativeUrl(): string

setCustomServicePath

  • setCustomServicePath(servicePath: string): this

url

withCustomHeaders

  • withCustomHeaders(headers: Record<string, string>): this

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: Record<string, string>): this

withCustomServicePath

  • withCustomServicePath(servicePath: string): this

withSubRequestPathType