Interface.DownloadRequest

dynamics-web-api / DownloadRequest

Interface: DownloadRequest

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
fieldName?	string	File Field Name Deprecated Use "property".	-
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.	CRUDRequest.headers
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
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
property?	string	The name of File Column (field)	-
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
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