GetEntitiesRequest
Home > @backstage/catalog-client > GetEntitiesRequest
The request type for CatalogClient.getEntities().
Signature:
export interface GetEntitiesRequest
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| after? | string | (Optional) If given, skips over all items before that cursor as returned by a previous request. | |
| fields? | EntityFieldsQuery | (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. | |
| limit? | number | (Optional) If given, returns at most N items from the result set. | |
| offset? | number | (Optional) If given, skips over the first N items in the result set. | |
| order? | EntityOrderQuery | (Optional) If given, order the result set by those directives. |