Interface.UpdateSinglePropertyRequest

dynamics-web-api / UpdateSinglePropertyRequest

Interface: UpdateSinglePropertyRequest

Extends

• CRUDRequest

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).	CRUDRequest.async
collection?	string	A name of the Entity Collection or Entity Logical name.	CRUDRequest.collection
contentId?	string	BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set.	-
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.	-
fieldValuePair	object	Object with a logical name of the field as a key and a value to update with. Example: {subject: "Update Record"}	-
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.	CRUDRequest.headers
ifmatch?	string	Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.	-
impersonate?	string	Impersonates a user based on their systemuserid by adding "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid.	CRUDRequest.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.	CRUDRequest.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.	CRUDRequest.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.	-
key?	string	A String representing collection record's Primary Key (GUID) or Alternate Key(s).	CRUDRequest.key
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	CRUDRequest.noCache
queryParams?	string[]	Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!	CRUDRequest.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.	-
select?	string[]	An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned.	-
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.	CRUDRequest.signal
tag?	string	Use this parameter to include a shared variable value that is accessible within a plug-in.	CRUDRequest.tag
timeout?	number	Sets a number of milliseconds before a request times out.	CRUDRequest.timeout
token?	string	Authorization Token. If set, onTokenRefresh will not be called.	CRUDRequest.token