Options
All
  • Public
  • Public/Protected
  • All
Menu

Create OData query to delete an entity.

Type parameters

  • EntityT: Entity

    Type of the entity to be deleted

Hierarchy

Index

Constructors

constructor

  • Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.

    Type parameters

    Parameters

    • entityConstructor: Constructable<EntityT, unknown>

      Constructor type of the entity to be deleted

    • keysOrEntity: Entity | Record<string, FieldType>

      Entity or Key-value pairs of key properties for the given entity

    Returns DeleteRequestBuilder<EntityT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

requestConfig

requestConfig: ODataDeleteRequestConfig<EntityT>

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 DeleteRequestBuilder<EntityT>

    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 DeleteRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining

addCustomRequestConfiguration

  • addCustomRequestConfiguration(requestConfiguration: Record<string, string>): DeleteRequestBuilder<EntityT>
  • 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 DeleteRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining.

appendPath

  • appendPath(...path: string[]): Pick<DeleteRequestBuilder<EntityT>, "_entityConstructor" | "_entity" | "executeRaw" | "requestConfig" | "url" | "relativeUrl" | "withCustomHeaders" | "addCustomHeaders" | "withCustomQueryParameters" | "addCustomQueryParameters" | "withCustomServicePath" | "setCustomServicePath" | "addCustomRequestConfiguration" | "appendPath" | "skipCsrfTokenFetching" | "build" | "setVersionIdentifier" | "ignoreVersionIdentifier">
  • 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<DeleteRequestBuilder<EntityT>, "_entityConstructor" | "_entity" | "executeRaw" | "requestConfig" | "url" | "relativeUrl" | "withCustomHeaders" | "addCustomHeaders" | "withCustomQueryParameters" | "addCustomQueryParameters" | "withCustomServicePath" | "setCustomServicePath" | "addCustomRequestConfiguration" | "appendPath" | "skipCsrfTokenFetching" | "build" | "setVersionIdentifier" | "ignoreVersionIdentifier">

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

build

execute

executeRaw

ignoreVersionIdentifier

  • Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

    Returns DeleteRequestBuilder<EntityT>

    this The request itself to ease chaining while executing the request

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 DeleteRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining

setVersionIdentifier

  • Add an eTag version identifier in the delete request header.

    Parameters

    • eTag: string

      The version identifier of the entity

    Returns DeleteRequestBuilder<EntityT>

    The 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 DeleteRequestBuilder<EntityT>

    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 DeleteRequestBuilder<EntityT>

    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 DeleteRequestBuilder<EntityT>

    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 DeleteRequestBuilder<EntityT>

    The request builder itself, to facilitate method chaining