/v1/relations

Mount Point: /api/v1/relations

GET

Retrieves all relations of the types specified associated to the specified entities where the entity plays one of the specified roles.

Parameters

name description type default
entityIds A Set of entity identifiers to retrieve the relations of. query
types The RelationshipTypes to retrieve for the specified entities. query
roles The RelationshipRoles the specified entities should play in the returned relations. query

Response Body

element: (custom)

A list of relations matching the specified criteria.