-
-
Notifications
You must be signed in to change notification settings - Fork 58
UpdateAttributeRequest
-
↳
UpdateAttributeRequest
- async
- castType
- data
- entityKey
- headers
- impersonate
- impersonateAAD
- inChangeSet
- mergeLabels
- noCache
- queryParams
- signal
- timeout
- token
• Optional async: boolean
XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).
• Optional castType: string
Use this parameter to cast the Attribute to a specific type.
• data: any
Attribute metadata object.
• entityKey: string
An Entity MetadataId or Alternate Key (such as LogicalName).
CreateAttributeRequest.entityKey
• Optional headers: HeaderCollection
Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.
CreateAttributeRequest.headers
• 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.
CreateAttributeRequest.impersonate
• 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.
CreateAttributeRequest.impersonateAAD
• 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.
CreateAttributeRequest.inChangeSet
• 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.
• Optional noCache: boolean
If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.
CreateAttributeRequest.noCache
• Optional queryParams: string[]
Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!
CreateAttributeRequest.queryParams
• 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.
• Optional timeout: number
Sets a number of milliseconds before a request times out.
CreateAttributeRequest.timeout
• Optional token: string
Authorization Token. If set, onTokenRefresh will not be called.