Interface WithGetAllRestrictions<EntityT, DeSerializersT>

Interface representing options on a getAll request like top or orderBy.

interface WithGetAllRestrictions<
    EntityT extends EntityBase,
    DeSerializersT extends DeSerializers,
> {
    filter: Filterable<EntityT, DeSerializersT>;
    orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[];
    selects: Selectable<EntityT, DeSerializersT>[];
    skip: number;
    top: number;
}

Type Parameters

EntityT extends EntityBase
DeSerializersT extends DeSerializers

Hierarchy (View Summary)

WithSelection<EntityT, DeSerializersT>
- WithGetAllRestrictions

Implemented by

ODataGetAllRequestConfig

Index

Properties

filter orderBy selects skip top

Properties

filter

filter: Filterable<EntityT, DeSerializersT>

Filter the results based on conditions.

orderBy

orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[]

Order the results in, e.g., asc or desc order.

selects

selects: Selectable<EntityT, DeSerializersT>[]

Select a list of fields on the schema property of the entity api.

skip

skip: number

Skip a number of results in the requested set.

top

top: number

Limit the number of results to the given number.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.