Get Event Severities
get
/api/event/Events/readSeverities
Gets the event severities.
Request
Query Parameters
-
DateFrom: string
The beginning of the date range in the format yyyy-mm-dd.
-
DateTo: string
The end of the date range in the format yyyy-mm-dd.
-
DisableConversions: boolean
Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.
-
DisplayID: integer
The ID of the display used to determine the columns selected.Example:
1
-
FilterGroupID: integer
The filter group of the filter. This parameter is required when FilterType is set to FilterId or MetaTag, otherwise it is optional.
-
FilterType: string
The type of filter. Possible values are:
- FilterID
- DeviceName
- MetaTag
- TEL
-
FilterValue: string
The value of the filter. You can use a filter ID, a device name, metadata with the MetaType FilterGroupID, or an SQL where clause.
-
QuerySort: string
This parameter indicates the way the event field values are sorted. The allowed values are frequency and alphanumeric values.
-
ReadSeveritiesOnly: integer
Read severities only and prevent returning events. The default value is 0.Example:
1
-
ShardID: integer
The shard ID to query. Default value is 1.Example:
1
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
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
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
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: object
data
The list of all severity types and the number of events of each severity.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
object
The list of all severity types and the number of events of each severity.
Example:
{
"normal":5,
"unknown":0,
"info":1,
"minor":1589,
"major":809,
"critical":171,
"all":2575,
"sum":3608082
}
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