Skip to content

Interface: ODataQuery

Defined in: packages/core/src/query/odata-query.types.ts:39

Typed OData query object produced by ODataQueryPipe. All optional fields are only present when the corresponding query option was supplied in the request.

Per D-14: entitySetName is required for context URL and validation.

Properties

apply?

readonly optional apply?: ApplyNode

Defined in: packages/core/src/query/odata-query.types.ts:54

Parsed $apply value — aggregation/transformation pipeline


count?

readonly optional count?: boolean

Defined in: packages/core/src/query/odata-query.types.ts:46

True when $count=true was present in the query string


entitySetName

readonly entitySetName: string

Defined in: packages/core/src/query/odata-query.types.ts:48

Name of the entity set — required for context URL construction and field validation


expand?

readonly optional expand?: ExpandNode

Defined in: packages/core/src/query/odata-query.types.ts:50

Parsed $expand value — navigation properties to expand


filter?

readonly optional filter?: FilterNode

Defined in: packages/core/src/query/odata-query.types.ts:40


orderBy?

readonly optional orderBy?: OrderByItem[]

Defined in: packages/core/src/query/odata-query.types.ts:42


readonly optional search?: SearchNode

Defined in: packages/core/src/query/odata-query.types.ts:52

Parsed $search value — full-text search expression


select?

readonly optional select?: SelectNode

Defined in: packages/core/src/query/odata-query.types.ts:41


skip?

readonly optional skip?: number

Defined in: packages/core/src/query/odata-query.types.ts:44


top?

readonly optional top?: number

Defined in: packages/core/src/query/odata-query.types.ts:43