Xrm.WebApi (Client API reference)

Provides properties and methods to use Web API to create and manage records and execute Web API actions and functions in model-driven apps.

Properties

Property Description
online Provides methods to use Web API to create and manage records and execute Web API actions and functions in model-driven apps when connected to the model-driven apps server (online mode).
offline Provides methods to create and manage records in model-driven apps in mobile clients while working in the offline mode.

Methods

With mobile offline configured, the source for these records depends on the current client state. In offline mode, the source is the offline data store. In online mode, the source is the server. If the client is offline-first (in preview), the methods in online can be used to access tables and records that aren't part of the offline profile, as long as the client has network connectivity.

Method Description
createRecord Creates a table record.
deleteRecord Deletes a table record.
retrieveRecord Retrieves a table record.
retrieveMultipleRecords Retrieves a collection of table records.
updateRecord Updates a table record.
isAvailableOffline Returns a boolean value indicating whether an entity is present in user’s profile and is currently available for use in offline mode.
execute Execute a single action, function, or CRUD operation.
executeMultiple Execute a collection of action, function, or CRUD operations.

Use the Microsoft Dataverse Web API
Client API Xrm object