Skip to content

UpdateAttributeRequest

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

Interface: UpdateAttributeRequest

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

Inherited from

CreateAttributeRequest.async


castType

Optional castType: string

Use this parameter to cast the Attribute to a specific type.


data

data: any

Attribute metadata object.

Inherited from

CreateAttributeRequest.data


entityKey

entityKey: string

An Entity MetadataId or Alternate Key (such as LogicalName).

Inherited from

CreateAttributeRequest.entityKey


headers

Optional headers: HeaderCollection

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

Inherited from

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

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

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

CreateAttributeRequest.inChangeSet


mergeLabels

Optional mergeLabels: boolean

Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.


noCache

Optional noCache: boolean

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

Inherited from

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

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

CreateAttributeRequest.signal


timeout

Optional timeout: number

Sets a number of milliseconds before a request times out.

Inherited from

CreateAttributeRequest.timeout


token

Optional token: string

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

Inherited from

CreateAttributeRequest.token

Clone this wiki locally