Settings | Property Options

Start a scroll over all property options matching the supplied filters. Use this when a group has more than ~20,000 options and offset paging via Search is not viable. Take is forced to 1000 and the client paging fields on the request body are ignored.

post/api/PropertyOptions/Scroll

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/PropertyOptions/Scroll
  • Auth: API key in header Authorization

Request body

takeinteger

Number of items per page. Defaults to 50 when zero. Max 1000.

pageinteger

Page to fetch (1-based). Defaults to 1 when zero.

groupstring nullable

Group key (case-insensitive). When set, only options in this group are returned.

querystring nullable

Free text prefix match against the option value (case-insensitive).

idsstring[] nullable

Filter to a specific set of option ids.

createdFromstring date-time nullable

Only return options created at or after this UTC timestamp.

createdTostring date-time nullable

Only return options created at or before this UTC timestamp.

isActiveboolean nullable

Filter by active state. Leave null to include both active and inactive options.

Response

First batch of results and a ScrollId. When ScrollId is null, all results have been returned.

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.