Optimisations

The query performance (response times) naturally depends on the shape and amount of query relevant data.

For example, a domain specification with many optional properties and/or deep nested elements requires a more expensive query which might result in a larger amount of query relevant data. In contrast, a query that should only return the name of an object will be considerably faster.

Also large page sizes will increase the response time of the operation.

As such, some use cases require a more sophisticates interaction with the APIs.

Reduce the page size for pagination

Using a smaller page size (e.g. 5) will reduce the amount of data that is retrieved for one call and as such also the query and response times.

Restrict the number of hops for the attributes that are returned

By using the HTTP HEADER X-HOP one can define the depth of information returned for an object.
For example,

• a value of X-HOP:0 would return only the ids, their domain specification and their type
• a value of X-HOP:1 would return only the ids, their domain specification and their type and all outgoing property value pairs for each result.
• by specifying X-HOP:2 the response would contain property path of length 2.

Afterwards, one can request the information of nested objects.