Interface.BoundActionRequest

dynamics-web-api / BoundActionRequest

Interface: BoundActionRequest<TAction>

Extends

• UnboundActionRequest<TAction>.Request

Type Parameters

Type Parameter	Default type
TAction	any

Properties

Property	Type	Description	Inherited from
action?	TAction	An object that represents a Dynamics 365 action.	UnboundActionRequest.action
actionName	string	A name of the Web API action.	UnboundActionRequest.actionName
async?	boolean	XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).	Request.async
backgroundOperationCallbackUrl?	string	A callback URL when the background operation is completed. Dataverse uses this URL to send a POST request.	UnboundActionRequest.backgroundOperationCallbackUrl
collection?	string	A name of the Entity Collection or Entity Logical name.	Request.collection
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
key?	string	A String representing the GUID value for the record.	-
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.	Request.noCache
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
respondAsync?	boolean	Use background operations to send requests that Dataverse processes asynchronously. Background operations are useful when you don't want to maintain a connection while a request runs.	UnboundActionRequest.respondAsync
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