Interface.SuggestRequest

dynamics-web-api / SuggestRequest

Interface: SuggestRequest

Extends

• BaseRequest

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).	BaseRequest.async
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.	BaseRequest.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.	BaseRequest.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.	BaseRequest.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.	BaseRequest.inChangeSet
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	BaseRequest.noCache
query	Suggest	Suggestion query object	-
queryParams?	string[]	Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!	BaseRequest.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.	BaseRequest.signal
tag?	string	Use this parameter to include a shared variable value that is accessible within a plug-in.	BaseRequest.tag
timeout?	number	Sets a number of milliseconds before a request times out.	BaseRequest.timeout
token?	string	Authorization Token. If set, onTokenRefresh will not be called.	BaseRequest.token