Backstage
    Preparing search index...

    Interface GetEntitiesByRefsRequest

    The request type for CatalogApi.getEntitiesByRefs.

    interface GetEntitiesByRefsRequest {
        entityRefs: string[];
        fields?: EntityFieldsQuery;
        filter?: EntityFilterQuery;
        query?: FilterPredicate;
    }
    Index

    Properties

    entityRefs fields? filter? query?

    Properties

    entityRefs: string[]

    The list of entity refs to fetch.

    The returned list of entities will be in the same order as the refs, and undefined will be returned in those positions that were not found.

    fields?: EntityFieldsQuery

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

    filter?: EntityFilterQuery

    If given, return only entities that match the given filter.

    query?: FilterPredicate

    If given, return only entities that match the given predicate query.

    Supports operators like $all, $any, $not, $exists, $in, $contains, and $hasPrefix. When both filter and query are provided, they are combined with $all.

    Settings

    Member Visibility

    On This Page

    Properties