-
-
Notifications
You must be signed in to change notification settings - Fork 60
BoundFunctionRequest
-
↳
BoundFunctionRequest
- async
- collection
- functionName
- impersonate
- impersonateAAD
- inChangeSet
- key
- noCache
- parameters
- signal
- timeout
- token
• Optional
async: boolean
XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).
• collection: string
A name of the Entity Collection or Entity Logical name.
• functionName: string
Name of the function.
UnboundFunctionRequest.functionName
• 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.
• 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
key: string
A String representing the GUID value for the record.
• Optional
noCache: boolean
If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.
• Optional
parameters: any
Function's input parameters. Example: { param1: "test", param2: 3 }.
UnboundFunctionRequest.parameters
• 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.