Get a single collection based on the collection name and entity type


Parameter Type Default Notes
i18nScope Required string
entityType Required EntityType
collectionName Required WellKnownCollection

Name of the collection requested


An IHubCollection definition JSON object

Property Type Notes
key string

Unique key, used for query params and telemetry

label string

String to show in the UI. translated.

scope IQuery

Default query for the Collection

targetEntity EntityType

What entity is this query targeting. This is used internally to ensure we query the correct API

include Optional string[]

Specify the includes to be requested when working with this collection

sortDirection Optional "asc" | "desc"

Default sort direction for the Collection

sortField Optional string

Default sort field for the Collection

Function defined in common/src/search/wellKnownCatalog.ts:546