ODataConfig

Configuration object for api requests.

Properties

expands?

optional expands: string[]

Add expanded properties to include related resources in the response

Supports both direct (first-level) relationships and nested relationships.

Example

expands: ["person", "job", "comments", "report/reportChartSeriesList"]

---

filters?

optional filters: BaseODataFilter<unknown>[]

BaseODataFilter data filters

---

orderBys?

optional orderBys: ODataOrderBy[]

ODataOrderBy Properties that data can be ordered by

---

selects?

optional selects: string[]

Limit selected properties to return only specific fields

Can specify properties of the root object or properties of related resources using the format "relationName/propertyName". Only supports properties directly available on the root object or its first-level relationships.

Example

select: ["id", "name", "person/id", "person/name"]

---

skip?

optional skip: number

Number of records to skip

---

top?

optional top: number

Number of records to return