Get Event Filter Groups for Combo Boxes and Item Selectors
get
/api/event/FilterGroups/readForSelect
Gets event filter groups in a format suitable for combo boxes and item selectors.
Request
Query Parameters
-
id: integer(int32)
The event filter group ID.Example:
1
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventFilterGroupsReadForSelect
Type:
Show Source
object
-
cls: string
Class for the UI decoration.Example:
folder
-
DisplayName: integer
The name of the filter group.Example:
Global
-
FilterGroupID: integer
The filter group ID.Example:
3
-
leaf: boolean
Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).Example:
false
-
text: string
Name of the filter group.Example:
Global
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object