callbacks DynamicsWebApi.Interface.Config

dynamics-web-api-wiki / DynamicsWebApi / Config

Interface: Config

Properties

Property	Type	Description
dataApi?	ApiConfig	Configuration object for Dataverse Web API. The name is based on the url path "data".
impersonate?	string	A String representing a GUID value for the Dynamics 365 system user id
impersonateAAD?	string	Impersonates the user.A String representing the GUID value for the Azure active directory object id.
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.
maxPageSize?	string	Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
onTokenRefresh?	(callback) => void	A function that is called when a security token needs to be refreshed.
proxy?	ProxyConfig	Proxy configuration
returnRepresentation?	boolean	Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request.
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.
timeout?	number	Sets a number of milliseconds before a request times out
useEntityNames?	boolean	Indicates whether to use Entity Logical Names instead of Collection Logical Names.
webApiUrl?	string	Deprecated use serverUrl together with dataApi (if required) instead
webApiVersion?	string	Deprecated use dataApi.version instead