- Url
- /V2.0/services/data/relationQuery
- HTTP Method
GET,POST
- Description
- Retrieve the related entities of an object from a specific Relation
- Parameters
-
Name Type Description entityId* entityId (string) The main entity relationName* string Relation name to retrieve fields string[] A list of field names to retrieve orders orderBy[] Optionaly order the result where condition The query criteria relations relation[] The query relations fromLink boolean The query result of link objects paging paging Paging setting for the query - Result
- An object containing the results from a query
Name Type Description entities entity[] Array of entities returned from this query paging paging Paging information returned from this query. If paging.hasMore
is true, this object should be passed as is, to the same query API in order to retrieve the next pageIn case of failure an error object will be returned
* indicates required fields