retrieve Method - Service Factory Reference

This method retrieves one record of the data model by its ID.

Retrieve a Record#

Code
const post = await postModuleService.retrievePost("123")

Parameters#

Pass the ID of the record to retrieve.

Returns#

The method returns the record as an object.

Retrieve a Record's Relations#

Code
1const post = await postModuleService.retrievePost("123", {2  relations: ["author"],3})

Parameters#

To retrieve the data model with relations, pass as a second parameter of the method an object with the property relations. relations's value is an array of relation names.

Returns#

The method returns the record as an object.

Select Properties to Retrieve#

Code
1const post = await postModuleService.retrievePost("123", {2  select: ["id", "name"],3})

Parameters#

By default, all of the record's properties are retrieved. To select specific ones, pass in the second object parameter a select property. Its value is an array of property names.

Returns#

The method returns the record as an object.