Skip to main content

CatalogClient.getEntitiesByRefs()

Home > @backstage/catalog-client > CatalogClient > getEntitiesByRefs

Gets a batch of entities, by their entity refs.

Signature:

getEntitiesByRefs(request: GetEntitiesByRefsRequest, options?: CatalogRequestOptions): Promise<GetEntitiesByRefsResponse>;

Parameters

Parameter

Type

Description

request

GetEntitiesByRefsRequest

Request parameters

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

Promise<GetEntitiesByRefsResponse>

Remarks

The output list of entities is of the same size and in the same order as the requested list of entity refs. Entries that are not found are returned as null.