latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Search

Lists search views.

Returns a list of all search views, also known as search filters, matching the given search criteria.<br /> Only search views the logged in user has access to are listed.

get/search/views

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

namestring

The search term for a search view to retrieve.<br /> The query is case sensitive and does not support wildcards.<br /> Use in conjunction with nameMatchMode.

nameMatchMode'START' | 'END' | 'ANYWHERE' | 'EXACT'

The match requirements for name queries.<br /> Works in conjunction with name. The search is case-sensitive.

sortField'NAME'

The reference field for sorting the results.

sortOrder'ASC' | 'DESC'

The order in which the results are sorted.

locationstring

The location for a search view to retrieve.

Response

The list of returned search views.

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.