Skip to content

Single Step Retrieval


Single Step Retrieval loads only a partial set of the related objects (default size of the retrieved related collection is 10). To load additional related objects, use the Relation Paging API .

This approach allows retrieval of a partial set of the related objects along with the parent object in a single findor findById request. Each relationship property (column) must be uniquely identified by name using the API documented below.

Retrieve a specific object with relations:

The is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.


The comma between the RELATED-PROPERTY-NAME names must be URL-encoded as %2C.

Retrieve multiple objects from the table with relations:



Argument                Description
[TABLE-NAME] Name of the table from which the data is to be loaded.
[OBJECT-ID] objectId of the object to retrieve.
[RELATED-PROPERTY-NAME] Name of the related property to load. For example, if table Person has a relation column homeAddress pointing to an object in the Address table, the value of the prameter would be homeAddress. The syntax allows to add relations of relations. For example, if the same Address table has a relation country pointing to the Country table, then would instruct the backend to load the related Country object. It is possible to specify multiple related property names. In this case they must be separated by URL-encoded (%2C) commas