Skip to content

Single Step Retrieval

Important

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:

GET http://api.backendless.com/[application-id]/[REST-api-key]/data/[TABLE-NAME]/[OBJECT-ID]?loadRelations=[RELATED-PROPERTY-NAME][,RELATED-PROPERTY-NAME]

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

Retrieve multiple objects from the table with relations:

GET http://api.backendless.com/[application-id]/[REST-api-key]/data/[TABLE-NAME]?loadRelations=[RELATED-PROPERTY-NAME]

where:

Argument                Description
[application-id] the ID of your application generated upon its creation. You can obtain the value in the Manage > App Settings section of the Backendless Console.
[REST-api-key] REST API key of your application. You can obtain the value in the Manage > App Settings section of the Backendless Console.
[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 homeAddress.country 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