Interface.FetchXmlRequest

dynamics-web-api / FetchXmlRequest

Interface: FetchXmlRequest

Extends

• FetchAllRequest

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).	FetchAllRequest.async
collection?	string	A name of the Entity Collection or Entity Logical name.	FetchAllRequest.collection
fetchXml	string	Sets FetchXML - a proprietary query language that provides capabilities to perform aggregation.	FetchAllRequest.fetchXml
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.	FetchAllRequest.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.	FetchAllRequest.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.	FetchAllRequest.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.	FetchAllRequest.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. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie	FetchAllRequest.includeAnnotations
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	FetchAllRequest.noCache
pageNumber?	number	Page number.	-
pagingCookie?	string	Paging cookie. To retrive the first page, pagingCookie must be null.	-
queryParams?	string[]	Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!	FetchAllRequest.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.	FetchAllRequest.signal
tag?	string	Use this parameter to include a shared variable value that is accessible within a plug-in.	FetchAllRequest.tag
timeout?	number	Sets a number of milliseconds before a request times out.	FetchAllRequest.timeout
token?	string	Authorization Token. If set, onTokenRefresh will not be called.	FetchAllRequest.token