Skip to main content
Version: 1.x

Interface: ODataQueryOptions

Query options for entity set retrieval.

Example​

const opts: ODataQueryOptions = {
  filter: "Price gt 10",
  select: "Name,Price",
  top: 20,
  skip: 0,
};

Extends​

Properties​

csrfToken?​

readonly optional csrfToken?: string

CSRF token for write operations (POST/PATCH/DELETE).

Inherited from​

ODataHttpOptions.csrfToken

expand?​

readonly optional expand?: string

OData $expand expression (comma-separated navigation properties).

filter?​

readonly optional filter?: string

OData $filter expression.

headers?​

readonly optional headers?: Readonly<Record<string, string>>

Additional custom headers to include in the request.

Inherited from​

ODataHttpOptions.headers

orderby?​

readonly optional orderby?: string

OData $orderby expression.

select?​

readonly optional select?: string

OData $select expression (comma-separated property names).

skip?​

readonly optional skip?: number

OData $skip value (number of entities to skip).

timeout?​

readonly optional timeout?: number

Timeout in ms for the HTTP request.

Inherited from​

ODataHttpOptions.timeout

top?​

readonly optional top?: number

OData $top value (maximum number of entities to return).