callbacks DynamicsWebApi.Interface.RetrieveMultipleRequest

dynamics-web-api-wiki / DynamicsWebApi / RetrieveMultipleRequest

Interface: RetrieveMultipleRequest

Extends

• Request

Properties

Property	Type	Description	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	The 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.	-
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
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	v.1.7.7+ 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[]	v.1.7.7+ Additional query parameters that either have not been implemented yet or they are parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!	-
select?	string[]	An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned.	-
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
top?	number	Limit the number of results returned by using the $top system query option.Do not use $top with $count!	-