Update an Event Display
put
/api/event/Displays/{id}
Updates the properties of the event display that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The event display ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DisableConversions: integer
Toggles whether to disable conversions when viewing events with this displayExample:
0
-
DisplayColumns: object
DisplayColumns
Object of Columns and Orders
-
DisplayName: string
The name of displayExample:
Default
-
OwnerUserGroupID:
OwnerUserGroupID
Chosen user group owner
-
OwnerUserID: integer
Chosen user ownerExample:
0
-
Viewers: array
Viewers
List of user groups that can view
Nested Schema : DisplayColumns
Type:
object
Object of Columns and Orders
Show Source
-
Columns: array
Columns
Lists of all the fields available within the Events database.
-
Order: string
SQL sort by clause specifying which fields are sorted in which direction.Example:
[Public to All Users and Groups]
Nested Schema : Columns
Type:
array
Lists of all the fields available within the Events database.
Show Source
Nested Schema : eventDisplayReadColumn
Type:
Show Source
object
-
ColumnAlign: string
Column content alignment, ex. Left, Center or RightExample:
Left
-
ColumnField: boolean
Field name in the Events tableExample:
false
-
ColumnName: string
Custom name specified for the FieldExample:
EventID
-
ColumnType: string
Type in which content is renderedExample:
Number
-
ColumnWidth: number
Column width when the event list is displayedExample:
100
-
Visible: boolean
Checkbox to indicate the field will be visible when the event list is displayed.Example:
false
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 : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated 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 updated event display.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventDisplayRead
Type:
Show Source
object
-
DisableConversions: integer
Toggles whether to disable conversions when viewing events with this displayExample:
0
-
DisplayColumns: object
DisplayColumns
Object of Columns and Orders
-
DisplayColumnsGrid: string
A list of columns visible in the displayExample:
Device <br>Event Type <br>Event Text <br>Count <br>First Occurred <br>Last Occurred
-
DisplayID: integer
Display ID specified for individual CRUD operationsExample:
1
-
DisplayName: string
The name of displayExample:
Default
-
Owner: string
Defines the user that owns the display.Example:
[Public to All Users and Groups]
-
OwnerUserGroupID:
OwnerUserGroupID
Chosen user group owner
-
OwnerUserID: integer
Chosen user ownerExample:
0
-
Viewers: array
Viewers
List of user groups that can view
Nested Schema : DisplayColumns
Type:
object
Object of Columns and Orders
Show Source
-
Columns: array
Columns
Lists of all the fields available within the Events database.
-
Order: string
SQL sort by clause specifying which fields are sorted in which direction.Example:
[Public to All Users and Groups]
Nested Schema : Columns
Type:
array
Lists of all the fields available within the Events database.
Show Source
Nested Schema : eventDisplayReadColumn
Type:
Show Source
object
-
ColumnAlign: string
Column content alignment, ex. Left, Center or RightExample:
Left
-
ColumnField: boolean
Field name in the Events tableExample:
false
-
ColumnName: string
Custom name specified for the FieldExample:
EventID
-
ColumnType: string
Type in which content is renderedExample:
Number
-
ColumnWidth: number
Column width when the event list is displayedExample:
100
-
Visible: boolean
Checkbox to indicate the field will be visible when the event list is displayed.Example:
false
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