Interface.BaseRequest

dynamics-web-api / BaseRequest

Interface: BaseRequest

Extended by

• BatchRequest
• Request
• UnboundFunctionRequest
• UnboundActionRequest
• CreateEntityRequest
• RetrieveEntityRequest
• RetrieveEntitiesRequest
• CreateAttributeRequest
• RetrieveAttributesRequest
• RetrieveAttributeRequest
• CreateRelationshipRequest
• DeleteRelationshipRequest
• RetrieveRelationshipsRequest
• RetrieveRelationshipRequest
• CreateGlobalOptionSetRequest
• DeleteGlobalOptionSetRequest
• RetrieveGlobalOptionSetsRequest
• RetrieveGlobalOptionSetRequest
• CsdlMetadataRequest
• QueryRequest
• SuggestRequest
• AutocompleteRequest

Properties

Property	Type	Description
async?	boolean	XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).
headers?	HeaderCollection	Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.
impersonate?	string	Impersonates a user based on their systemuserid by adding "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid.
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.
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.
noCache?	boolean	If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.
queryParams?	string[]	Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!
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.
tag?	string	Use this parameter to include a shared variable value that is accessible within a plug-in.
timeout?	number	Sets a number of milliseconds before a request times out.
token?	string	Authorization Token. If set, onTokenRefresh will not be called.