Skip to content

callbacks DynamicsWebApi.DeleteRequest

Aleksandr Rogov edited this page Apr 13, 2024 · 2 revisions

Interface: DeleteRequest

DynamicsWebApi.DeleteRequest

Hierarchy

Table of contents

Properties

Properties

async

Optional async: boolean

XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).

Inherited from

CRUDRequest.async


bypassCustomPluginExecution

Optional bypassCustomPluginExecution: boolean

v.1.7.5+ If set to true, the request bypasses custom business logic, all synchronous plug-ins and real-time workflows are disabled. Check for special exceptions in Microsft Docs.


collection

Optional collection: string

The name of the Entity Collection or Entity Logical name.

Inherited from

CRUDRequest.collection


contentId

Optional contentId: string

BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set.


fieldName

Optional fieldName: string

Field name that needs to be cleared (for example File Field)


id

Optional id: string

Deprecated

Use "key" instead. A String representing the Primary Key(GUID) of the record.

Inherited from

CRUDRequest.id


ifmatch

Optional ifmatch: string

Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.


impersonate

Optional impersonate: string

Impersonates the user.A String representing the GUID value for the Dynamics 365 system user id.

Inherited from

CRUDRequest.impersonate


impersonateAAD

Optional impersonateAAD: string

Impersonates the user.A String representing the GUID value for the Azure active directory object id.

Inherited from

CRUDRequest.impersonateAAD


key

Optional key: string

A String representing collection record's Primary Key (GUID) or Alternate Key(s).

Inherited from

CRUDRequest.key


noCache

Optional noCache: boolean

If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.

Inherited from

CRUDRequest.noCache


partitionId

Optional partitionId: string

v.1.7.7+ A unique partition key value of a logical partition for non-relational custom entity data stored in NoSql tables of Azure heterogenous storage.


skipNameCheck

Optional skipNameCheck: boolean

Skips the collection name check in DynamicsWebApi.

Inherited from

CRUDRequest.skipNameCheck


timeout

Optional timeout: number

Sets a number of milliseconds before a request times out.

Inherited from

CRUDRequest.timeout


token

Optional token: string

Authorization Token. If set, onTokenRefresh will not be called.

Inherited from

CRUDRequest.token

dynamics-web-api-wiki

Namespaces

Clone this wiki locally