Interface.Config

dynamics-web-api / Config

Interface: Config

Properties

Property	Type	Description
backgroundOperationCallbackUrl?	string	A default callback URL when the background operation is completed. Dataverse uses this URL to send a POST request. You can also set a callback URL per request.
dataApi?	ApiConfig<any>	Configuration object for Dataverse Web API (with path "data").
headers?	HeaderCollection	Default headers to supply with each request.
impersonate?	null | string	Impersonates a user based on their systemuserid by adding "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid.
impersonateAAD?	null | 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.
includeAnnotations?	null | 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?	null | number	Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
onTokenRefresh?	null | () => Promise<null | string | AccessToken>	A function that is called when a security token needs to be refreshed.
proxy?	null | ProxyConfig	Proxy configuration object.
returnRepresentation?	null | boolean	Sets Prefer header request with value "return=representation".Use this property to return just created or updated entity in a single request.
searchApi?	ApiConfig<SearchApiOptions>	Configuration object for Dataverse Search API (with path "search").
serverUrl?	null | 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?	null | number	Sets a number of milliseconds before a request times out.
useEntityNames?	null | boolean	Indicates whether to use Entity Logical Names instead of Collection Logical Names.