Options
All
  • Public
  • Public/Protected
  • All
Menu

Create OData request to execute a action or function import.

Type parameters

  • ParametersT

    Type of the function import parameters

  • ReturnT

    Type of the function import return value

Hierarchy

Index

Constructors

Protected constructor

  • Base class for function and actions imports

    Type parameters

    • ParametersT

    • ReturnT

    Parameters

    • responseTransformer: (data: any) => ReturnT

      Transformation function for the response

        • (data: any): ReturnT
        • Parameters

          • data: any

          Returns ReturnT

    • requestConfig: ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>

      Request config for a action or funciton import

    Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

Properties

requestConfig

requestConfig: ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>

Readonly responseTransformer

responseTransformer: (data: any) => ReturnT

Type declaration

    • (data: any): ReturnT
    • Parameters

      • data: any

      Returns ReturnT

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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    The request builder itself, to facilitate method chaining

addCustomRequestConfiguration

  • 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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    The request builder itself, to facilitate method chaining.

appendPath

  • appendPath(...path: string[]): Pick<ActionFunctionImportRequestBuilder<ParametersT, ReturnT>, "executeRaw" | "requestConfig" | "url" | "relativeUrl" | "withCustomHeaders" | "addCustomHeaders" | "withCustomQueryParameters" | "addCustomQueryParameters" | "withCustomServicePath" | "setCustomServicePath" | "addCustomRequestConfiguration" | "appendPath" | "skipCsrfTokenFetching" | "build" | "responseTransformer">
  • 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 Pick<ActionFunctionImportRequestBuilder<ParametersT, ReturnT>, "executeRaw" | "requestConfig" | "url" | "relativeUrl" | "withCustomHeaders" | "addCustomHeaders" | "withCustomQueryParameters" | "addCustomQueryParameters" | "withCustomServicePath" | "setCustomServicePath" | "addCustomRequestConfiguration" | "appendPath" | "skipCsrfTokenFetching" | "build" | "responseTransformer">

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

build

execute

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 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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    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 ActionFunctionImportRequestBuilder<ParametersT, ReturnT>

    The request builder itself, to facilitate method chaining