Jump to

• Request
• Response

Create an Event Display

post

/api/event/Displays

Creates a new event display.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DisableConversions: integer
  Toggles whether to disable conversions when viewing events with this display

  Example: 0
• DisplayColumns: object DisplayColumns
  Object of Columns and Orders
• DisplayName: string
  The name of display

  Example: Default
• OwnerUserGroupID: OwnerUserGroupID
  Chosen user group owner
• OwnerUserID: integer
  Chosen user owner

  Example: 0
• Viewers: array Viewers
  List of user groups that can view

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayName"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/OwnerUserGroupID"
        },
        "DisableConversions":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/DisableConversions"
        },
        "DisplayColumns":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayColumns"
        },
        "Viewers":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/Viewers"
        }
    }
}

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]

{
    "description":"Object of Columns and Orders",
    "type":"object",
    "properties":{
        "Order":{
            "description":"SQL sort by clause specifying which fields are sorted in which direction.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Columns":{
            "description":"Lists of all the fields available within the Events database.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventDisplayReadColumn"
            }
        }
    }
}

Nested Schema : OwnerUserGroupID

Chosen user group owner

Match One Schema

Show Source

• integer
• string

{
    "description":"Chosen user group owner",
    "oneOf":[
        {
            "type":"integer"
        },
        {
            "type":"string"
        }
    ],
    "example":"0"
}

Example:

0

Nested Schema : Viewers

Type: array

List of user groups that can view

Show Source

• Array of: object items

{
    "description":"List of user groups that can view",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The user group ID.",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"The user group name.",
                "type":"string"
            }
        }
    },
    "example":[
    ]
}

Nested Schema : Columns

Type: array

Lists of all the fields available within the Events database.

Show Source

• Array of: object eventDisplayReadColumn

{
    "description":"Lists of all the fields available within the Events database.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventDisplayReadColumn"
    }
}

Nested Schema : eventDisplayReadColumn

Type: object

Show Source

• ColumnAlign: string
  Column content alignment, ex. Left, Center or Right

  Example: Left
• ColumnField: boolean
  Field name in the Events table

  Example: false
• ColumnName: string
  Custom name specified for the Field

  Example: EventID
• ColumnType: string
  Type in which content is rendered

  Example: Number
• ColumnWidth: number
  Column width when the event list is displayed

  Example: 100
• Visible: boolean
  Checkbox to indicate the field will be visible when the event list is displayed.

  Example: false

{
    "type":"object",
    "properties":{
        "Visible":{
            "description":"Checkbox to indicate the field will be visible when the event list is displayed.",
            "type":"boolean",
            "example":false
        },
        "ColumnField":{
            "description":"Field name in the Events table",
            "type":"boolean",
            "example":"false"
        },
        "ColumnName":{
            "description":"Custom name specified for the Field",
            "type":"string",
            "example":"EventID"
        },
        "ColumnWidth":{
            "description":"Column width when the event list is displayed",
            "type":"number",
            "example":"100"
        },
        "ColumnAlign":{
            "description":"Column content alignment, ex. Left, Center or Right",
            "type":"string",
            "example":"Left"
        },
        "ColumnType":{
            "description":"Type in which content is rendered",
            "type":"string",
            "example":"Number"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  The user group ID.
• UserGroupName: string
  The user group name.

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new event display.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventDisplayRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new event display.
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new event display.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventDisplayRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new event display.

Show Source

• Array of: object eventDisplayRead

{
    "description":"The properties of the new event display.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventDisplayRead"
    }
}

Nested Schema : eventDisplayRead

Type: object

Show Source

• DisableConversions: integer
  Toggles whether to disable conversions when viewing events with this display

  Example: 0
• DisplayColumns: object DisplayColumns
  Object of Columns and Orders
• DisplayColumnsGrid: string
  A list of columns visible in the display

  Example: Device <br>Event Type <br>Event Text <br>Count <br>First Occurred <br>Last Occurred
• DisplayID: integer
  Display ID specified for individual CRUD operations

  Example: 1
• DisplayName: string
  The name of display

  Example: 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 owner

  Example: 0
• Viewers: array Viewers
  List of user groups that can view

{
    "type":"object",
    "properties":{
        "DisplayID":{
            "description":"Display ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1"
        },
        "DisplayName":{
            "description":"The name of display",
            "type":"string",
            "example":"Default"
        },
        "OwnerUserID":{
            "description":"Chosen user owner",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"Chosen user group owner",
            "oneOf":[
                {
                    "type":"integer"
                },
                {
                    "type":"string"
                }
            ],
            "example":"0"
        },
        "DisableConversions":{
            "description":"Toggles whether to disable conversions when viewing events with this display",
            "type":"integer",
            "example":"0"
        },
        "DisplayColumnsGrid":{
            "description":"A list of columns visible in the display",
            "type":"string",
            "example":"Device\n<br>Event Type\n<br>Event Text\n<br>Count\n<br>First Occurred\n<br>Last Occurred"
        },
        "Owner":{
            "description":"Defines the user that owns the display.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Viewers":{
            "description":"List of user groups that can view",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"The user group ID.",
                        "type":"integer"
                    },
                    "UserGroupName":{
                        "description":"The user group name.",
                        "type":"string"
                    }
                }
            },
            "example":[
            ]
        },
        "DisplayColumns":{
            "description":"Object of Columns and Orders",
            "type":"object",
            "properties":{
                "Order":{
                    "description":"SQL sort by clause specifying which fields are sorted in which direction.",
                    "type":"string",
                    "example":"[Public to All Users and Groups]"
                },
                "Columns":{
                    "description":"Lists of all the fields available within the Events database.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventDisplayReadColumn"
                    }
                }
            }
        }
    }
}

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]

{
    "description":"Object of Columns and Orders",
    "type":"object",
    "properties":{
        "Order":{
            "description":"SQL sort by clause specifying which fields are sorted in which direction.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Columns":{
            "description":"Lists of all the fields available within the Events database.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventDisplayReadColumn"
            }
        }
    }
}

Nested Schema : OwnerUserGroupID

Chosen user group owner

Match One Schema

Show Source

• integer
• string

{
    "description":"Chosen user group owner",
    "oneOf":[
        {
            "type":"integer"
        },
        {
            "type":"string"
        }
    ],
    "example":"0"
}

Example:

0

Nested Schema : Viewers

Type: array

List of user groups that can view

Show Source

• Array of: object items

{
    "description":"List of user groups that can view",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The user group ID.",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"The user group name.",
                "type":"string"
            }
        }
    },
    "example":[
    ]
}

Nested Schema : Columns

Type: array

Lists of all the fields available within the Events database.

Show Source

• Array of: object eventDisplayReadColumn

{
    "description":"Lists of all the fields available within the Events database.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventDisplayReadColumn"
    }
}

Nested Schema : eventDisplayReadColumn

Type: object

Show Source

• ColumnAlign: string
  Column content alignment, ex. Left, Center or Right

  Example: Left
• ColumnField: boolean
  Field name in the Events table

  Example: false
• ColumnName: string
  Custom name specified for the Field

  Example: EventID
• ColumnType: string
  Type in which content is rendered

  Example: Number
• ColumnWidth: number
  Column width when the event list is displayed

  Example: 100
• Visible: boolean
  Checkbox to indicate the field will be visible when the event list is displayed.

  Example: false

{
    "type":"object",
    "properties":{
        "Visible":{
            "description":"Checkbox to indicate the field will be visible when the event list is displayed.",
            "type":"boolean",
            "example":false
        },
        "ColumnField":{
            "description":"Field name in the Events table",
            "type":"boolean",
            "example":"false"
        },
        "ColumnName":{
            "description":"Custom name specified for the Field",
            "type":"string",
            "example":"EventID"
        },
        "ColumnWidth":{
            "description":"Column width when the event list is displayed",
            "type":"number",
            "example":"100"
        },
        "ColumnAlign":{
            "description":"Column content alignment, ex. Left, Center or Right",
            "type":"string",
            "example":"Left"
        },
        "ColumnType":{
            "description":"Type in which content is rendered",
            "type":"string",
            "example":"Number"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  The user group ID.
• UserGroupName: string
  The user group name.

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top