Interface.RetrieveGlobalOptionSetsRequest

dynamics-web-api / RetrieveGlobalOptionSetsRequest

Interface: RetrieveGlobalOptionSetsRequest

Extends

• BaseRequest

Properties

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

---

castType?

optional castType: string

Use this parameter to cast the Global Option Set metadata to a specific type.

---

expand?

optional expand: Expand[]

An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned.

---

filter?

optional filter: string

Use the $filter system query option to set criteria for which entities will be returned.

---

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

---

select?

optional select: string[]

An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned.

---

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