Class BoundFunctionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

Readonly_deSerializers

requestConfig

addCustomHeaders

• addCustomHeaders(headers: Record<string, string>): this

• Add custom headers to the request. Existing headers will be overwritten.

  Parameters

  • headers: Record<string, string>

    Key-value pairs denoting additional custom headers.

  Returns this

  The request builder itself, to facilitate method chaining.

addCustomQueryParameters

• addCustomQueryParameters(queryParameters: Record<string, string>): this

• 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 this

  The request builder itself, to facilitate method chaining.

addCustomRequestConfiguration

• addCustomRequestConfiguration(requestConfiguration: CustomRequestConfig): this

• 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: CustomRequestConfig

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

  Returns this

  The request builder itself, to facilitate method chaining.

appendPath

• appendPath(
      ...path: string[],
  ): Omit<
      BoundFunctionImportRequestBuilder<
          EntityT,
          DeSerializersT,
          ParametersT,
          ReturnT,
      >,
      "execute",
  >

• 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

  • ...path: string[]

    Path to be appended.

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

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

execute

• execute(
      destination: HttpDestinationOrFetchOptions,
      dataAccessor?: (data: any) => any,
  ): Promise<ReturnT>

• Execute request.

  Parameters

  • destination: HttpDestinationOrFetchOptions

    Destination or DestinationFetchOptions to execute the request against.
  • OptionaldataAccessor: (data: any) => any

    A function to modify the received response data.

  Returns Promise<ReturnT>

  A promise resolving to the requested return type.

executeRaw

• executeRaw(destination: HttpDestinationOrFetchOptions): Promise<HttpResponse>

• Execute request and return an @sap-cloud-sdk/http-client!HttpResponse.

  Parameters

  • destination: HttpDestinationOrFetchOptions

    Destination or DestinationFetchOptions to execute the request against.

  Returns Promise<HttpResponse>

  A promise resolving to an @sap-cloud-sdk/http-client!HttpResponse.

getBatchReference

• getBatchReference(): BatchReference

• Gets identifier for the batch request.

  Returns BatchReference

  Batch request identifier.

middleware

• middleware(middlewares: HttpMiddleware | HttpMiddleware[]): this

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

  Parameters

  • middlewares: HttpMiddleware | HttpMiddleware[]

    Middlewares to be applied to the executeHttpRequest().

  Returns this

  The request builder itself, to facilitate method chaining.
• middleware(...middlewares: HttpMiddleware[]): this

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

  Parameters

  • ...middlewares: HttpMiddleware[]

    Middlewares to be applied to the executeHttpRequest().

  Returns this

  The request builder itself, to facilitate method chaining.

relativeUrl

• relativeUrl(): string

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

  Returns string

  The relative URL for the request.

setBasePath

• setBasePath(basePath: string): this

• Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

  Parameters

  • basePath: string

    Path to override the default with.

  Returns this

  The request builder itself, to facilitate method chaining.

setBatchId

• setBatchId(id: string): void

• Sets user-defined identifier for the batch reference.

  Parameters

  • id: string

    User-defined batch request identifier.

  Returns void

skipCsrfTokenFetching

• skipCsrfTokenFetching(): this

• Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

  Returns this

  The request builder itself, to facilitate method chaining.

url

• url(destination: HttpDestinationOrFetchOptions): Promise<string>

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

  Parameters

  • destination: HttpDestinationOrFetchOptions

    Destination or DestinationFetchOptions to execute the request against.

  Returns Promise<string>

  Promise resolving to the URL for the request.

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