ビジネスエンティティサービスガイド

前へ次へ

フィルタパラメータ

URLにパラメータを付加して、関連するレコードをフィルタリングできます。

次の表に、使用できるフィルタパラメータを示します。

パラメータ	説明
recordStates	取得するレコードの状態のカンマ区切りリスト。サポートされるレコードの状態は、ACTIVE、PENDING、およびDELETEDです。デフォルトはACTIVEです。例えば、 /Party/123?action=related&recordStates=ACTIVE,PENDING というクエリは、アクティブまたは保留中のレコードを返します。
entityLabel	エンティティのラベル。
relationshipLabel	リレーションのラベル。
entityType	エンティティタイプのカンマ区切りリスト。例えば、 entityType=Person,Organization リストは Person および Organization エンティティタイプに関連するレコードを返します。
relationshipType	リレーションタイプのカンマ区切りリスト。例えば、 relationshipType=Employee,Employer リストは Employee および Employer リレーションタイプに関連するレコードを返します。

複数のフィルタ条件を指定すると、結果にはAND条件を満たすすべてのレコードが含まれます。