Get a filter

Returns one list-view filter with its selectable values. Use the filter id (for example status or responsibility) as the key when building a service record search. Values of hierarchical filters, such as categories, carry their children under subValues. The "none" value (id -1) and values without a caption are left out after SysAid has paginated, so a page may hold fewer than limit values. metadata is reported by SysAid on every call; its total is the number of values SysAid fetched (at most offset + limit), not the full number of values of the filter.

Path Params
string
required
length ≥ 1

The filter identifier, as it appears in the list view (for example status, responsibility, priority).

Query Params
string
enum

The entity whose list view the filter belongs to. Defaults to service-record. An entity that has no filters in SysAid is rejected with 400.

Allowed:
integer
≥ 0

Service record type, as a number, that selects the list view to read the filter from.

integer
≥ 0

Number of values to skip. When omitted, the filter's values start from the beginning.

integer
1 to 500

Maximum number of values to return. When omitted, SysAid's own default applies.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json