Class ODataRequestConfigAbstract

constructor

• new ODataRequestConfig(method, defaultBasePath, defaultHeaders?): ODataRequestConfig

• Creates an instance of ODataRequest.

  Parameters

  • method: RequestMethodType

    HTTP method of the request.
  • defaultBasePath: string

    Default path of the according service.
  • Optional defaultHeaders: Record<string, any>

    The default headers of the given request as an object.

  Returns ODataRequestConfig

basePath

Readonly defaultBasePath

Readonly defaultHeaders

method

Readonly parameterEncoder

payload

appendedPaths

• get appendedPaths(): string[]

• Returns string[]

customHeaders

• get customHeaders(): Record<string, string>

• Returns Record<string, string>

• set customHeaders(headers): void

• Parameters

  • headers: Record<string, string>

  Returns void

customQueryParameters

• get customQueryParameters(): Record<string, string>

• Returns Record<string, string>

• set customQueryParameters(queryParameters): void

• Parameters

  • queryParameters: Record<string, string>

  Returns void

customRequestConfiguration

• get customRequestConfiguration(): Record<string, string>

• Returns Record<string, string>

• set customRequestConfiguration(requestConfiguration): void

• Parameters

  • requestConfiguration: CustomRequestConfig

  Returns void

fetchCsrfToken

• get fetchCsrfToken(): boolean

• Returns boolean

• set fetchCsrfToken(fetchCsrfToken): void

• Parameters

  • fetchCsrfToken: boolean

  Returns void

middlewares

• get middlewares(): HttpMiddleware[]

• Returns HttpMiddleware[]

• set middlewares(middlewares): void

• Parameters

  • middlewares: HttpMiddleware[]

  Returns void

addCustomHeaders

• addCustomHeaders(headers): void

• Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

  Parameters

  • headers: Record<string, string>

    Key-value pairs where the key is the name of a header property and the value is the respective value.

  Returns void

addCustomQueryParameters

• addCustomQueryParameters(queryParameters): void

• Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

  Parameters

  • queryParameters: Record<string, string>

    Key-value pairs where the key is the name of a query parameter and the value is the respective value.

  Returns void

addCustomRequestConfiguration

• addCustomRequestConfiguration(requestConfiguration): void

• Add custom request configuration to the request.

  Parameters

  • requestConfiguration: Record<string, any>

    Key-value pairs where the key is the name of a request configuration and the value is the respective value.

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

  Returns void

appendPath

• appendPath(...path): void

• Parameters

  • Rest ...path: string[]

  Returns void

Abstract queryParameters

• queryParameters(): Record<string, any>
• Internal

  Returns Record<string, any>

Abstract resourcePath

• resourcePath(): string
• Internal

  Returns string