Create an Event Filter
post
/api/event/Filters
Creates a new event filter.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DisplayID: integer
ID of the display to use with the filter.Example:
0
-
Filter: string
Filter Where clauseExample:
Ack=1
-
FilterName: string
Filter NameExample:
Acked Events
-
OwnerUserGroupID: integer
Chosen user group ownerExample:
0
-
OwnerUserID: integer
Chosen user ownerExample:
0
-
ShardID: integer
Shard ID to run the filter againstExample:
1
-
ShowSymptoms: integer
Flag indicating whether or not to show events that have been marked as a symptom.
-
Viewers: array
Viewers
List of user groups that can view
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
The user group ID.
-
UserGroupName: string
The user group name.
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
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
The properties of the new event filter.
-
total: integer
The total number of results regardless of pagingExample:
1
Nested Schema : eventFiltersRead
Type:
Show Source
object
-
DisplayID: integer
ID of the display to use with the filter.Example:
0
-
DisplayName: string
Name of the display to use with the filter.Example:
[User Default]
-
Filter: string
Filter Where clauseExample:
Ack=1
-
FilterID: integer
Filter ID specified for individual CRUD operationsExample:
1
-
FilterName: string
Filter NameExample:
Acked Events
-
Owner: string
Defines the user that owns the display.Example:
[Public to All Users and Groups]
-
OwnerUserGroupID: integer
Chosen user group ownerExample:
0
-
OwnerUserID: integer
Chosen user ownerExample:
0
-
ShardID: integer
Shard ID to run the filter againstExample:
1
-
ShowSymptoms: integer
Flag indicating whether or not to show events that have been marked as a symptom.Example:
0
-
Viewers: array
Viewers
List of user groups that can view
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
The user group ID.
-
UserGroupName: string
The user group name.
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