Get Event Filter Groups for Tree Combos
get
/api/event/FilterGroups/readForTreeCombo
Gets the event filter groups in a format suitable for tree combos.
Request
Query Parameters
-
id(required): integer(int32)
The event filter group ID.Example:
1
-
node(required): string
The node of the tree to get.Example:
root
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 : eventFilterGroupsReadByID
Type:
Show Source
object
-
FilterGroupID: integer
Filter Group IDExample:
1
-
FilterGroupName: string
Filter Group NameExample:
Global
-
Filters: array
Filters
Array of filters belonging to the filter group.
-
OwnerUserGroupID: integer
Chosen user group ownerExample:
0
-
OwnerUserID: integer
Chosen user ownerExample:
0
-
ParentFilterGroupID:
ParentFilterGroupID
FilterGroupID of Parent Group, can be "root" or an int.
-
RestrictionFilter: string
Restriction filterExample:
Nested Schema : Filters
Type:
array
Array of filters belonging to the filter group.
Show Source
Example:
[
{
"FilterID":"1",
"FilterName":"All Events"
},
{
"FilterID":"2",
"FilterName":"Syslogs"
}
]
Nested Schema : ParentFilterGroupID
FilterGroupID of Parent Group, can be "root" or an int.
Match One Schema
Show Source
Example:
1
Nested Schema : items
Type:
Show Source
object
-
FilterID: integer
Filter IDExample:
1
-
FilterName: string
Filter NameExample:
All Events
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