Interface.RetrieveMultipleRequest

dynamics-web-api / RetrieveMultipleRequest

Interface: RetrieveMultipleRequest

Extends

• Request

Properties

Property	Type	Description	Overrides	Inherited from
apply?	string	Use the $apply to aggregate and group your data dynamically	-	-
async?	boolean	XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).	-	Request.async
collection	string	A name of the Entity Collection or Entity Logical name.	Request.collection	-
count?	boolean	Boolean that sets the $count system query option with a value of true to include a count of entities that match the filter criteria up to 5000(per page).Do not use $top with $count!	-	-
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.	-	-
filter?	string	Use the $filter system query option to set criteria for which entities will be returned.	-	-
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.	-	Request.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.	-	Request.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.	-	Request.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.	-	Request.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.	-	-
maxPageSize?	number	Sets the odata.maxpagesize preference value to request the number of entities returned in the response.	-	-
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	-	Request.noCache
orderBy?	string[]	An Array(of string) representing the order in which items are returned using the $orderby system query option.Use the asc or desc suffix to specify ascending or descending order respectively.The default is ascending if the suffix isn't applied.	-	-
partitionId?	string	A unique partition key value of a logical partition for non-relational custom entity data stored in NoSql tables of Azure heterogenous storage.	-	-
queryParams?	string[]	Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!	-	Request.queryParams
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.	-	Request.signal
tag?	string	Use this parameter to include a shared variable value that is accessible within a plug-in.	-	Request.tag
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
top?	number	Limit the number of results returned by using the $top system query option.Do not use $top with $count!	-	-
trackChanges?	boolean	Sets Prefer header with value 'odata.track-changes' to request that a delta link be returned which can subsequently be used to retrieve entity changes.	-	-