Class BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

Create OData request to execute a action or function import.

Type Parameters

  • EntityT extends EntityBase

    Type of the function import return value.

  • DeSerializersT extends DeSerializers

  • ParametersT

  • ReturnT

Hierarchy

Constructors

constructor

Properties

requestConfig responseTransformer

Methods

addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath build execute executeRaw getBatchReference relativeUrl setBatchId setCustomServicePath skipCsrfTokenFetching timeout url

Constructors

constructor

  • Type Parameters

    • EntityT extends EntityBase<EntityT>

    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>

    • ParametersT

    • ReturnT

    Parameters

    • entityApi: EntityApi<EntityT, DeSerializersT>
    • entity: EntityT
    • actionImportName: string
    • responseTransformer: ((data: any) => ReturnT)
        • (data: any): ReturnT

        • Parameters

          • data: any

          Returns ReturnT

    • parameters: ActionImportParameters<ParametersT>
    • deSerializers: DeSerializersT

    Returns BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

Properties

requestConfig

requestConfig: ODataBoundActionImportRequestConfig<EntityT, DeSerializersT, 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.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

addCustomQueryParameters

  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

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.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • requestConfiguration: Record<string, string>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

    Returns BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

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.

    Returns

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

    Parameters

    • Rest ...path: string[]

      Path to be appended.

    Returns Omit<BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>, "execute">

Protected build

execute

  • Execute request.

    Returns

    A promise resolving to the requested return type.

    Parameters

    • destination: DestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

    • Optional dataAccessor: ((data: any) => any)

      A function to modify the received response data.

        • (data: any): any

        • Parameters

          • data: any

          Returns any

    Returns Promise<ReturnT>

executeRaw

getBatchReference

relativeUrl

  • Create the relative URL based on configuration of the given builder.

    Returns

    The relative URL for the request.

    Returns string

setBatchId

  • Sets user-defined identifier for the batch reference.

    Parameters

    • id: string

      User-defined batch reuest identifier.

    Returns void

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.

    Returns

    The request builder itself, to facilitate method chaining.

    Parameters

    • servicePath: string

      Path to override the default with.

    Returns BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

skipCsrfTokenFetching

timeout

  • Set timeout for requests towards the target system given in the destination.

    Returns

    The request builder itself, to facilitate method chaining.

    Deprecated

    Since v2.13.0. The timeout configuration is replaced by the more general middleware approach in version 3.0 of the SAP Cloud SDK.

    Parameters

    • timeout: number

      Value is in milliseconds and default value is 10000 (10 seconds).

    Returns BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

url

  • Create the URL based on configuration of the given builder.

    Returns

    Promise resolving to the URL for the request.

    Parameters

    Returns Promise<string>

Settings

Member Visibility

Theme

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