getPendingEntitiesQuery

Function

Pending entities represent "outgoing" requests that are awaiting "approval". They imply a one-way "connection" between parent/child.

From the parent's perspective: parent: "includes" the child in its association query child: does NOT "reference" the parent via a typeKeyword

From the child's perspective: parent: does NOT "include" the child in its association query child: "references" the parent via a typeKeyword of the form ref||

The following returns a query to view an entity's outgoing requests for association with another entity type

Pending entities represent "outgoing" requests that are awaiting "approval". They imply a one-way "connection" between parent/child.

From the parent's perspective: parent: "includes" the child in its association query child: does NOT "reference" the parent via a typeKeyword

From the child's perspective: parent: does NOT "include" the child in its association query child: "references" the parent via a typeKeyword of the form ref||

The following returns a query to view an entity's outgoing requests for association with another entity type

getPendingEntitiesQuery(entity: HubEntity, associationType: HubEntityType, context: IArcGISContext) : Promise<IQuery>

Parameters

Parameter	Type	Notes
entity Required	HubEntity	Hub entity
associationType Required	HubEntityType	entity type to query for
context Required	IArcGISContext	contextual auth and portal information

Returns

Promise<IQuery>

Property	Type	Notes
filters	IFilter[]	Filters that make up the query
targetEntity	EntityType	What entity is this query targeting. This is used internally to ensure we query the correct API
collection Optional	WellKnownCollection	An id for a well known collection that the query should use.
properties 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/getPendingEntitiesQuery.ts:32