Business Entity Services Guide

Back Next

Filter Parameters

You can append parameters to the URL to filter the related records.

The following table lists the filter parameters that you can use:

Parameter	Description
recordStates	A comma-separated list of states of records that you want to retrieve. The supported record states are ACTIVE, PENDING, and DELETED. Default is ACTIVE. For example, the /Party/123?action=related&recordStates=ACTIVE,PENDING query returns records that are active or pending.
entityLabel	Label of the entity.
relationshipLabel	Label of the relationship.
entityType	Comma-separated list of entity types. For example, the entityType=Person,Organization list returns related records of the Person and Organization entity type.
relationshipType	Comma-separated list of relationship types. For example, the relationshipType=Employee,Employer list returns related records of the Employee and Employer relationship types.

If you specify multiple filter conditions, the result contains all the records that satisfy the AND condition.