getAvailableToRequestEntitiesQuery
An entity can send an "outgoing" request to associate itself with another entity. The following query returns a set of entities that the requesting entity can still request:
from a parent perspective: returns a set of children that are NOT "included" in the parent's association group
from a child perspective: returns a set of parents that
the child does not "reference" with via a typeKeyword of
the form ref|
An entity can send an "outgoing" request to associate itself with another entity. The following query returns a set of entities that the requesting entity can still request:
from a parent perspective: returns a set of children that are NOT "included" in the parent's association group
from a child perspective: returns a set of parents that
the child does not "reference" with via a typeKeyword of
the form ref|
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
| entity Required | HubEntity |
entity requesting association |
|
| associationType Required | HubEntityType |
type of entity the requesting entity wants to associate with |
Returns
| Property | Type | Notes |
|---|---|---|
| IFilter[] |
Filters that make up the query |
|
| EntityType |
What entity is this query targeting. This is used internally to ensure we query the correct API |
|
| Optional | WellKnownCollection |
An id for a well known collection that the query should use. |
| Optional | Record<stringany> |
Additional properties. Useful for groupMember queries where we need to send in the groupId to construct the url |
Function defined in common/src/associations/getAvailableToRequestEntitiesQuery.ts:32