SAP Cloud SDK for JavaScript - v4.1.1
    Preparing search index...

    Interface ODataBoundActionRequestConfig<EntityT, DeSerializersT, ParametersT>

    Action request configuration for an entity type.

    interface ODataBoundActionRequestConfig<
        EntityT extends EntityBase,
        DeSerializersT extends DeSerializers,
        ParametersT,
    > {
        actionName: string;
        basePath: string;
        defaultBasePath: string;
        defaultHeaders: Record<string, any>;
        entityApi: EntityApi<EntityT, DeSerializersT>;
        keys: Record<string, any>;
        method: RequestMethodType;
        oDataUri: ODataUri<DeSerializersT>;
        parameterEncoder: ParameterEncoder;
        parameters: OperationParameters<ParametersT>;
        payload: string | Record<string, any>;
        get appendedPaths(): string[];
        get customHeaders(): Record<string, string>;
        set customHeaders(headers: Record<string, string>): void;
        get customQueryParameters(): Record<string, string>;
        set customQueryParameters(queryParameters: Record<string, string>): void;
        get customRequestConfiguration(): Record<string, string>;
        set customRequestConfiguration(
            requestConfiguration: CustomRequestConfig,
        ): void;
        get fetchCsrfToken(): boolean;
        set fetchCsrfToken(fetchCsrfToken: boolean): void;
        get middlewares(): HttpMiddleware[];
        set middlewares(middlewares: HttpMiddleware[]): void;
        addCustomHeaders(headers: Record<string, string>): void;
        addCustomQueryParameters(queryParameters: Record<string, string>): void;
        addCustomRequestConfiguration(
            requestConfiguration: Record<string, any>,
        ): void;
        appendPath(...path: string[]): void;
        prependDollarToQueryParameters(
            params: Record<string, any>,
        ): Record<string, any>;
        queryParameters(): Record<string, any>;
        resourcePath(): string;
    }

    Type Parameters

    • EntityT extends EntityBase
    • DeSerializersT extends DeSerializers

      Type of the deserializer use on the request

    • ParametersT

      Type of the parameter to setup a request with

    Hierarchy (View Summary)

    Implements

    Index

    Properties

    actionName basePath defaultBasePath defaultHeaders entityApi keys method oDataUri parameterEncoder parameters payload

    Accessors

    appendedPaths customHeaders customQueryParameters customRequestConfiguration fetchCsrfToken middlewares

    Methods

    addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath prependDollarToQueryParameters queryParameters resourcePath

    Properties

    actionName: string
    basePath: string
    defaultBasePath: string
    defaultHeaders: Record<string, any>
    entityApi: EntityApi<EntityT, DeSerializersT>
    keys: Record<string, any>

    Map containing the key name and value.

    method: RequestMethodType
    oDataUri: ODataUri<DeSerializersT>
    parameterEncoder: ParameterEncoder
    parameters: OperationParameters<ParametersT>
    payload: string | Record<string, any>

    Accessors

    • get appendedPaths(): string[]

      Returns string[]

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

      Returns Record<string, string>

    • set customHeaders(headers: Record<string, string>): void

      Parameters

      • headers: Record<string, string>

      Returns void

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

      Returns Record<string, string>

    • set customQueryParameters(queryParameters: Record<string, string>): void

      Parameters

      • queryParameters: Record<string, string>

      Returns void

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

      Returns Record<string, string>

    • set customRequestConfiguration(requestConfiguration: CustomRequestConfig): void

      Parameters

      Returns void

    • get fetchCsrfToken(): boolean

      Returns boolean

    • set fetchCsrfToken(fetchCsrfToken: boolean): void

      Parameters

      • fetchCsrfToken: boolean

      Returns void

    • get middlewares(): HttpMiddleware[]

      Returns HttpMiddleware[]

    • set middlewares(middlewares: HttpMiddleware[]): void

      Parameters

      Returns void

    Methods

    • 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

    • 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

    • 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 Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.

      Returns void

    • Parameters

      • ...path: string[]

      Returns void

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    • Internal

      Returns Record<string, any>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods