Click or drag to resize

IDataApi Methods

The IDataApi type exposes the following members.

Methods
  Name Description
Public method Code example Add Add a new Data Object.
Public method Code example AddExternalDO Add a new external data object.
Public method Code example Any Determines whether any element of a Data Collection exists or satisfies a condition.
Public method Code example ChangeCreator Update the CreatedBy attribute value of an Data object
Public method Code example Clone Clone new object and add to database.
Public method Code example Copy Copy data from one existing data object to another. Only properties that exist in both Data Classes are copied.
Public method Code example Count Count the Data Objects that satisfies a condition.
Public method Code example Delete Delete a Data Object.
Public method Code example DeleteMany(DataObjectApiQuery, Boolean) Delete multiple existing data objects based on a specified search query.
Public method Code example DeleteMany(String, Boolean) Delete multiple existing data objects based on a specified array of data object IDs.
Public method Code example DeleteMany(DataEnumerationQuery, CancellationToken, Boolean) Delete multiple existing data objects based on a specified enumeration data object query.
Public method Code example Enumerate(DataEnumerationQuery, CancellationToken) Query and loop through an extensive collection without writing a lot of code for data paging, Which is also inefficient when dealing with 100k+ records.
Public method Code example Enumerate(DataSourceEnumerationQuery, CancellationToken) Query and loop through an extensive collection without writing a lot of code for data paging, Which is also inefficient when dealing with 100k+ records.
Public method Code example EscapeSearchPhrase Escape the search phrase1. Use this method when you build the search phrase without FilterBuilder.
Public method Code example GetDataClass Get data class by name
Public method Code example GetSchema Load schema of a Data Source by name. This is useful for get data schema of a data source.
Public method Code example HardDelete Remove any events and data of the data objects by their identifiers.
Public method Code example Inc Increase value of an attribute by specified increment amount.
Public method Code example Load(String) Load a Data Object by id.
Public method Code example Load(String, Boolean) Force load a Data Object by id from the Database and update it to the cache.
Public method Code example Load(String, String) Load a Data Object from a Data Source by id. This is useful for custom data loading e.g. query including related data objects.
Public method Code example Migrate(String, Object, DslMigrationOption) Migrate an Data Object with a specified ID. This method allows add or update a data object with a specified ID without using generated ID from system.
Public method Code example Migrate(String, Object, Boolean) Obsolete.
Migrate an Data Object with a specified ID. This method allows add or update a data object with a specified ID without using generated ID from system. Note: if canUpdateIfExist = false then the method will throw exception the specified ID already exits in DB
Public method Code example MoveToCase Move data object to a specific case.
Public method Code example Pull Pull data from an array attribute. This method is thread-safe. Schema elements that are equal to the input values will be removed.
Public method Code example Push Push data to an array attribute. This method is thread-safe.
Public method Code example Search(DataObjectApiQuery) Search Data Objects.
Public method Code example Search(DataSourceApiQuery) Search Data Objects from a Data Source.
Public method Code example Update Update an existing Data Object.
Public method Code example UpdateMany(DataObjectApiQuery, Object, Boolean) Updates multiple existing data objects based on a specified search query with patch data.
Public method Code example UpdateMany(String, Object, Boolean) Updates multiple existing data objects based on an array of IDs with patch data.
Public method Code example UpdateMany(DataEnumerationQuery, Object, CancellationToken, Boolean) Update multiple existing data objects based on a specified enumeration data object query with patch data.
Top
See Also