Get Event Filter Fields
get
/api/event/Events/readFields
Gets the event filter fields. They come from either EventDisplayColumns for a particular display or from the Alarm table for all displays.
Request
Query Parameters
-
DisableConversions: integer
Optionally disables event list value conversions. It defaults to the value saved in the display.Example:
0
-
Option: string
Option indicates which list of fields to return - the standard list of the most frequently used fields, or all fields Allowed Values: - standard - advancedExample:
standard
-
id: integer
The display ID. If no ID is provided, it defaults to the DefaultDisplayID.Example:
1002
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
data: array
data
The list of event filter fields.
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or failure (false).Example:
true
-
total: integer
The total number of results regardless of paging.Example:
8
Nested Schema : data
Type:
array
The list of event filter fields.
Show Source
Example:
[
{
"Field":"EventID",
"Type":"Number",
"Null":"NO",
"Key":"PRI",
"Default":"",
"Extra":"auto_increment",
"ColumnName":"EventID",
"Expression":"Number",
"FieldDescription":"EventID - Number"
},
{
"Field":"Node",
"Type":"String",
"Null":"NO",
"Key":"MUL",
"Default":"",
"Extra":" ",
"ColumnName":"Device",
"Expression":"String",
"FieldDescription":"Node - String"
},
{
"Field":"EventType",
"Type":"String",
"Null":"NO",
"Key":"MUL",
"Default":" ",
"Extra":" ",
"ColumnName":"Event Type",
"Expression":"String",
"FieldDescription":"EventType - String"
},
{
"Field":"Summary",
"Type":"String",
"Null":"NO",
"Key":" ",
"Default":" ",
"Extra":" ",
"ColumnName":"Event Text",
"Expression":"String",
"FieldDescription":"Summary - String"
},
{
"Field":"Count",
"Type":"Number",
"Null":"NO",
"Key":" ",
"Default":" ",
"Extra":" ",
"ColumnName":"Count",
"Expression":"Number",
"FieldDescription":"Count - Number"
},
{
"Field":"FirstReported",
"Type":"DateTime",
"Null":"NO",
"Key":" ",
"Default":" ",
"Extra":" ",
"ColumnName":"First Occurred",
"Expression":"String",
"FieldDescription":"FirstReported - DateTime"
},
{
"Field":"LastReported",
"Type":"DateTime",
"Null":"NO",
"Key":" ",
"Default":" ",
"Extra":" ",
"ColumnName":"Last Occurred",
"Expression":"String",
"FieldDescription":"LastReported - DateTime"
},
{
"Field":"LastChanged",
"Type":"DateTime",
"Null":"NO",
"Key":" ",
"Default":" ",
"Extra":" ",
"ColumnName":"Last Changed",
"Expression":"String",
"FieldDescription":"LastChanged - DateTime"
}
]
Nested Schema : eventEventsReadFields
Type:
Show Source
object
-
ColumnName: string
Column name for the field as defined by the display.Example:
EventID
-
Default: string
Default value for the fieldExample:
-
Expression: string
Type of data in the column. Allowed Values- Number, StringExample:
Number
-
Extra: string
Extra information from the database field definition.Example:
auto_increment
-
Field: string
Field NameExample:
EventID
-
FieldDescription: string
Combination of the Field and Type concatenated with a hyphenExample:
EventID - Number
-
Key: string
Type of database index associated with the field.Example:
PRI
-
Null: string
If the field can be null or notExample:
NO
-
Type: string
Type of the particular fieldExample:
Number
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