-
-
Notifications
You must be signed in to change notification settings - Fork 60
FetchXmlRequest
-
↳
FetchXmlRequest
- async
- collection
- fetchXml
- headers
- impersonate
- impersonateAAD
- inChangeSet
- includeAnnotations
- noCache
- pageNumber
- pagingCookie
- queryParams
- signal
- timeout
- token
• Optional async: boolean
XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).
• Optional collection: string
A name of the Entity Collection or Entity Logical name.
• fetchXml: string
Sets FetchXML - a proprietary query language that provides capabilities to perform aggregation.
• Optional headers: HeaderCollection
Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.
• Optional impersonate: string
Impersonates a user based on their systemuserid by adding "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid.
• Optional 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
• Optional 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.
• Optional 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
• Optional noCache: boolean
If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.
• Optional pageNumber: number
Page number.
• Optional pagingCookie: string
Paging cookie. To retrive the first page, pagingCookie must be null.
• Optional queryParams: string[]
Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!
• Optional 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.
• Optional timeout: number
Sets a number of milliseconds before a request times out.
• Optional token: string
Authorization Token. If set, onTokenRefresh will not be called.