Interface.UpdateRequest

dynamics-web-api / UpdateRequest

Interface: UpdateRequest<T>

Extends

• UpdateRequestBase<T>

Type Parameters

Type Parameter	Default type
T	any

Properties

Property	Type	Description	Inherited from
async?	boolean	XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).	UpdateRequestBase.async
bypassCustomPluginExecution?	boolean	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.	UpdateRequestBase.bypassCustomPluginExecution
collection?	string	A name of the Entity Collection or Entity Logical name.	UpdateRequestBase.collection
contentId?	string	BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set.	UpdateRequestBase.contentId
data?	T	A JavaScript object with properties corresponding to the logical name of entity attributes(exceptions are lookups and single-valued navigation properties).	UpdateRequestBase.data
duplicateDetection?	boolean	Web API v9+ only! Boolean that enables duplicate detection.	UpdateRequestBase.duplicateDetection
expand?	Expand[]	An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned.	UpdateRequestBase.expand
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.	UpdateRequestBase.headers
ifmatch?	string	Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.	UpdateRequestBase.ifmatch
impersonate?	string	Impersonates a user based on their systemuserid by adding "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid.	UpdateRequestBase.impersonate
impersonateAAD?	string	Impersonates a user based on their Azure Active Directory (AAD) object id by passing that value along with the header "CallerObjectId". A String should represent a GUID value.	UpdateRequestBase.impersonateAAD
inChangeSet?	boolean	Indicates if an operation must be included in a Change Set or not. Works in Batch Operations only. By default, it's "true", except for GET operations - they are not allowed in Change Sets.	UpdateRequestBase.inChangeSet
includeAnnotations?	string	Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types.	UpdateRequestBase.includeAnnotations
key?	string	A String representing collection record's Primary Key (GUID) or Alternate Key(s).	UpdateRequestBase.key
mergeLabels?	boolean	If set to 'true', DynamicsWebApi adds a request header 'MSCRM.MergeLabels: true'. Default value is 'false'	-
metadataAttributeType?	string	Casts the AttributeMetadata to a specific type. (Used in requests to Attribute Metadata).	UpdateRequestBase.metadataAttributeType
navigationProperty?	string	A String representing the name of a single - valued navigation property. Useful when needed to retrieve information about a related record in a single request.	UpdateRequestBase.navigationProperty
navigationPropertyKey?	string	A String representing navigation property's Primary Key (GUID) or Alternate Key(s). (For example, to retrieve Attribute Metadata).	UpdateRequestBase.navigationPropertyKey
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	UpdateRequestBase.noCache
partitionId?	string	A unique partition key value of a logical partition for non-relational custom entity data stored in NoSql tables of Azure heterogenous storage.	UpdateRequestBase.partitionId
queryParams?	string[]	Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!	UpdateRequestBase.queryParams
returnRepresentation?	boolean	Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request.	UpdateRequestBase.returnRepresentation
select?	string[]	An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned.	UpdateRequestBase.select
signal?	AbortSignal	The AbortSignal interface represents a signal object that allows you to communicate with a DOM request and abort it if required via an AbortController object.	UpdateRequestBase.signal
tag?	string	Use this parameter to include a shared variable value that is accessible within a plug-in.	UpdateRequestBase.tag
timeout?	number	Sets a number of milliseconds before a request times out.	UpdateRequestBase.timeout
token?	string	Authorization Token. If set, onTokenRefresh will not be called.	UpdateRequestBase.token