v1 DynamicsWebApi.Interface.CRUDRequest

dynamics-web-api-wiki / DynamicsWebApi / CRUDRequest

Interface: CRUDRequest

Extends

• Request

Extended by

• CreateRequest
• UpdateRequestBase
• DeleteRequest
• RetrieveRequest
• UploadRequest
• DownloadRequest

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).	Request.async
collection?	string	The name of the Entity Collection or Entity Logical name.	Request.collection
id?	string	Deprecated Use "key" instead. A String representing the Primary Key(GUID) of the record.	-
impersonate?	string	Impersonates the user.A String representing the GUID value for the Dynamics 365 system user id.	Request.impersonate
impersonateAAD?	string	Impersonates the user.A String representing the GUID value for the Azure active directory object id.	Request.impersonateAAD
key?	string	A String representing collection record's Primary Key (GUID) or Alternate Key(s).	-
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	Request.noCache
skipNameCheck?	boolean	Skips the collection name check in DynamicsWebApi.	Request.skipNameCheck
timeout?	number	Sets a number of milliseconds before a request times out.	Request.timeout
token?	string	Authorization Token. If set, onTokenRefresh will not be called.	Request.token