Interface.CsdlMetadataRequest

dynamics-web-api / CsdlMetadataRequest

Interface: CsdlMetadataRequest

Extends

• BaseRequest

Properties

addAnnotations?

optional addAnnotations: boolean

If set to "true" the document will include many different kinds of annotations that can be useful. Most annotations are not included by default because they increase the total size of the document.

---

async?

optional async: boolean

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

Inherited from

BaseRequest.async

---

headers?

optional headers: HeaderCollection

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

Inherited from

BaseRequest.headers

---

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.

Inherited from

BaseRequest.impersonate

---

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.

Inherited from

BaseRequest.impersonateAAD

---

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.

Inherited from

BaseRequest.inChangeSet

---

noCache?

optional noCache: boolean

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

Inherited from

BaseRequest.noCache

---

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!

Inherited from

BaseRequest.queryParams

---

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.

Inherited from

BaseRequest.signal

---

tag?

optional tag: string

Use this parameter to include a shared variable value that is accessible within a plug-in.

Inherited from

BaseRequest.tag

---

timeout?

optional timeout: number

Sets a number of milliseconds before a request times out.

Inherited from

BaseRequest.timeout

---

token?

optional token: string

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

Inherited from

BaseRequest.token