Create OData query to delete an entity.

Type Parameters

Hierarchy

Constructors

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

    Type Parameters

    • EntityT extends Entity<EntityT>

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

    Parameters

    • entityApi: EntityApi<EntityT, DeSerializersT>

      Entity API for building and executing the request.

    • keysOrEntity: Record<string, any> | EntityT

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

    Returns DeleteRequestBuilder<EntityT, DeSerializersT>

Properties

_deSerializers: DeSerializersT

Dummy property to include also the deserializer type in the strucutre of the entity type.

_entity: EntityT

Dummy property whose type makes structurally identical entities distiguishable in TypeScript.

_entityApi: EntityApi<EntityT, DeSerializersT>
requestConfig: ODataDeleteRequestConfig<EntityT, DeSerializersT>

Methods

  • 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 DeleteRequestBuilder<EntityT, DeSerializersT>

  • 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 DeleteRequestBuilder<EntityT, DeSerializersT>

  • 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 DeleteRequestBuilder<EntityT, DeSerializersT>

  • 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<DeleteRequestBuilder<EntityT, DeSerializersT>, "execute">

  • Execute query.

    Returns

    A promise resolving once the entity was deleted.

    Parameters

    Returns Promise<void>

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

    Returns

    The request itself to ease chaining while executing the request.

    Returns DeleteRequestBuilder<EntityT, DeSerializersT>

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

    Returns

    The relative URL for the request.

    Returns string

  • Sets user-defined identifier for the batch reference.

    Parameters

    • id: string

      User-defined batch reuest identifier.

    Returns void

  • 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 DeleteRequestBuilder<EntityT, DeSerializersT>

  • Add ETag version identifier in the delete request header.

    Returns

    The builder itself, to facilitate method chaining.

    Parameters

    • etag: string

      The version identifier of the entity.

    Returns DeleteRequestBuilder<EntityT, DeSerializersT>

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

    Returns

    The request builder itself, to facilitate method chaining.

    Returns DeleteRequestBuilder<EntityT, DeSerializersT>

  • 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 DeleteRequestBuilder<EntityT, DeSerializersT>

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

    Returns

    Promise resolving to the URL for the request.

    Parameters

    Returns Promise<string>

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