Options
All
  • Public
  • Public/Protected
  • All
Menu

Base class for all request builders.

typeparam EntityT

Type of the entity to create a request for.

Type parameters

  • RequestConfigT: ODataRequestConfig = any

Hierarchy

Index

Constructors

constructor

  • new MethodRequestBuilder<RequestConfigT>(requestConfig: RequestConfigT): MethodRequestBuilder<RequestConfigT>
  • Creates an instance of MethodRequestBuilder.

    Type parameters

    • RequestConfigT: ODataRequestConfig<RequestConfigT> = any

    Parameters

    • requestConfig: RequestConfigT

      Request configuration to initialize with.

    Returns MethodRequestBuilder<RequestConfigT>

Properties

requestConfig

requestConfig: RequestConfigT

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 MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining.

addCustomQueryParameters

  • addCustomQueryParameters(queryParameters: Record<string, string>): MethodRequestBuilder<RequestConfigT>
  • 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 MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining

addCustomRequestConfiguration

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

    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<MethodRequestBuilder<RequestConfigT>, "execute">

    The request builder itself without "execute" function, 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 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 MethodRequestBuilder<RequestConfigT>

    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 MethodRequestBuilder<RequestConfigT>

    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 MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining.

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: Record<string, string>): MethodRequestBuilder<RequestConfigT>
  • 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 MethodRequestBuilder<RequestConfigT>

    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 MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining.

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