-
-
Notifications
You must be signed in to change notification settings - Fork 59
Config
- dataApi
- headers
- impersonate
- impersonateAAD
- includeAnnotations
- maxPageSize
- onTokenRefresh
- proxy
- returnRepresentation
- searchApi
- serverUrl
- timeout
- useEntityNames
• Optional dataApi: ApiConfig
Configuration object for Dataverse Web API (with path "data").
• Optional headers: HeaderCollection
Default headers to supply with each request.
• Optional 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.
• Optional 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.
• Optional 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.
• Optional maxPageSize: null | number
Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
• Optional onTokenRefresh: null | () => Promise<null | string | AccessToken>
A function that is called when a security token needs to be refreshed.
• Optional proxy: null | ProxyConfig
Proxy configuration object.
• Optional 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.
• Optional searchApi: ApiConfig
Configuration object for Dataverse Search API (with path "search").
• Optional 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.
• Optional timeout: null | number
Sets a number of milliseconds before a request times out.
• Optional useEntityNames: null | boolean
Indicates whether to use Entity Logical Names instead of Collection Logical Names.