Help

restore Method - Service Factory Reference

This method of a module's service restores one or more records of a data model that were soft-deleted.

The method's name is of the format restoreDataModel, where DataModel is the plural pascal-case name of the data model.

Restore One Record#

Code
const restoredPosts = await postModuleService.restorePosts("123")

To restore one record, pass its ID as a parameter to the method.

The method returns an object, whose keys are of the format {camel_case_data_model_name}_id, and their values are arrays of restored records' IDs.

For example, the returned object of the above example is:

Code
{
  "post_id": ["123"],
}

Code
const restoredPosts = await postModuleService.restorePosts([
  "123",
  "321",
])

To restore multiple records, pass an array of IDs as a parameter to the method.

The method returns an object, whose keys are of the format {camel_case_data_model_name}_id, and their values are arrays of restored records' IDs.

For example, the returned object of the above example is:

Code
{
  "post_id": [
    "123",
    "321",
  ],
}

Code
const restoredPosts = await postModuleService.restorePosts({
  name: "My Post",
})

To restore records matching a set of filters, pass an object of filters as a parameter to the method.

Note: Refer to the Filtering reference for more information on accepted filters and examples.

The method returns an object, whose keys are of the format {camel_case_data_model_name}_id, and their values are arrays of restored records' IDs.

For example, the returned object of the above example is:

Code
{
  "post_id": [
    "123",
  ],
}

Was this page helpful?