Skip to main content
Version: Next

GetEntitiesByRefsRequest

Home > @backstage/catalog-client > GetEntitiesByRefsRequest

The request type for CatalogClient.getEntitiesByRefs().

Signature:

export interface GetEntitiesByRefsRequest 

Properties

Property

Modifiers

Type

Description

entityRefs

string[]

The list of entity refs to fetch.

fields?

EntityFieldsQuery | undefined

(Optional) If given, return only the parts of each entity that match the field declarations.

filter?

EntityFilterQuery

(Optional) If given, return only entities that match the given filter.