Skip to content

BaseRequest

Jump to bottom
Aleksandr Rogov edited this page Apr 13, 2024 · 3 revisions

Interface: BaseRequest

Hierarchy

Table of contents

Properties

Properties

async

• Optional async: boolean

XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).

headers

• Optional headers: HeaderCollection

Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.

impersonate

• 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.

impersonateAAD

• 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.

inChangeSet

• 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.

noCache

• Optional noCache: boolean

If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.

queryParams

• Optional queryParams: string[]

Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!

signal

• 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.

timeout

• Optional timeout: number

Sets a number of milliseconds before a request times out.

token

• Optional token: string

Authorization Token. If set, onTokenRefresh will not be called.

Clone this wiki locally