Skip to content

Retrieval with Relation Depth

The Data Service API supports a mechanism for loading related objects without identifying each by its name. Instead, the API includes a parameter which specifies the "depth" of the relations to include into the response. Consider the following diagram:

relation-depth

The diagram shows a hierarchy for class structure - the Order class has two relations: with OrderItem and Customer classes. Each in turn has a relation to the Manufacturer and Address classes. When an instance or a collection of Order objects is retrieved from Backendless, the API may include a parameter specifying the depth of relations to include into the response. If the relation depth is 1, then all related instances of OrderItem and Customer will be included into each Order object. If the relation depth is 2, then not only OrderItem and Customer instances will be included, but the corresponding Manufacturer and Address objects as well.

Important

Loading relations with relation depth retrieves 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.

API methods supporting relations depth

GET http://api.backendless.com/[application-id]/[REST-api-key]/data/[TABLE-NAME]?relationsDepth=[RELATIONS-DEPTH-VALUE]

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.
[RELATIONS-DEPTH-VALUE] depth of the relations to include into the response.