-
-
Notifications
You must be signed in to change notification settings - Fork 60
callbacks DynamicsWebApi.Config
DynamicsWebApi.Config
- dataApi
- impersonate
- impersonateAAD
- includeAnnotations
- maxPageSize
- onTokenRefresh
- proxy
- returnRepresentation
- serverUrl
- timeout
- useEntityNames
- webApiUrl
- webApiVersion
• Optional dataApi: ApiConfig
Configuration object for Dataverse Web API. The name is based on the url path "data".
• Optional impersonate: string
A String representing a GUID value for the Dynamics 365 system user id
• Optional impersonateAAD: string
Impersonates the user.A String representing the GUID value for the Azure active directory object id.
• Optional includeAnnotations: string
Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types.
• Optional maxPageSize: string
Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
• Optional onTokenRefresh: (callback: OnTokenAcquiredCallback) => void
▸ (callback): void
A function that is called when a security token needs to be refreshed.
| Name | Type |
|---|---|
callback |
OnTokenAcquiredCallback |
void
• Optional proxy: ProxyConfig
Proxy configuration
• Optional returnRepresentation: boolean
Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request.
• Optional serverUrl: string
The url to Dataverse API server, for example: https://contoso.api.crm.dynamics.com/. It is required when used in Node.js application.
• Optional timeout: number
Sets a number of milliseconds before a request times out
• Optional useEntityNames: boolean
Indicates whether to use Entity Logical Names instead of Collection Logical Names.
• Optional webApiUrl: string
Deprecated
use serverUrl together with dataApi (if required) instead
• Optional webApiVersion: string
Deprecated
use dataApi.version instead