REST API for Unified Assurance Core

Create an Event Filter

post

/api/event/Filters

Creates a new event filter.
The minimum required properties in the request body are:

FilterName
OwnerUserID
OwnerUserGroupID
DisplayID
ShardID (defaults to 1 if not specified, but specify it if you are using database shards)
ShowSymptoms
Filter

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

DisplayID: integer

ID of the display to use with the filter.

Example: 0
Filter: string

Filter Where clause

Example: Ack=1
FilterName: string

The event filter name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

Example: Acked Events
OwnerUserGroupID: integer

Chosen user group owner

Example: 0
OwnerUserID: integer

The ID of the user that owns the event filter. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

Example: 0
ShardID: integer

Shard ID to run the filter against

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

{
    "type":"object",
    "properties":{
        "FilterName":{
            "description":"The event filter name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Acked Events"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the event filter. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"Chosen user group owner",
            "type":"integer",
            "example":"0"
        },
        "Filter":{
            "$ref":"#/components/schemas/eventFiltersRead/properties/Filter"
        },
        "DisplayID":{
            "$ref":"#/components/schemas/eventFiltersRead/properties/DisplayID"
        },
        "ShardID":{
            "$ref":"#/components/schemas/eventFiltersRead/properties/ShardID"
        },
        "ShowSymptoms":{
            "description":"Flag indicating whether or not to show events that have been marked as a symptom.",
            "type":"integer"
        },
        "Viewers":{
            "$ref":"#/components/schemas/eventFiltersRead/properties/Viewers"
        }
    }
}

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 : 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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulAddOperation

The response body for a successful add operation.
object type

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

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

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

{
    "description":"The response body for a successful add operation.",
    "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 filter.
total: integer

The total number of results regardless of paging

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new event filter.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventFiltersRead"
            }
        },
        "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 filter.

Show Source

Array of: object eventFiltersRead

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

Nested Schema : eventFiltersRead

Type: object

Show Source

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 clause

Example: Ack=1
FilterID: integer

Filter ID specified for individual CRUD operations

Example: 1
FilterName: string

Filter Name

Example: Acked Events
Owner: string

Defines the user that owns the display.

Example: [Public to All Users and Groups]
OwnerUserGroupID: integer

Chosen user group owner

Example: 0
OwnerUserID: integer

The ID of the user that owns the event filter. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

Example: 0
ShardID: integer

Shard ID to run the filter against

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

{
    "type":"object",
    "properties":{
        "FilterID":{
            "description":"Filter ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1"
        },
        "FilterName":{
            "description":"Filter Name",
            "type":"string",
            "example":"Acked Events"
        },
        "Filter":{
            "description":"Filter Where clause",
            "type":"string",
            "example":"Ack=1"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the event filter. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"Chosen user group owner",
            "type":"integer",
            "example":"0"
        },
        "ShardID":{
            "description":"Shard ID to run the filter against",
            "type":"integer",
            "example":"1"
        },
        "ShowSymptoms":{
            "description":"Flag indicating whether or not to show events that have been marked as a symptom.",
            "type":"integer",
            "example":"0"
        },
        "DisplayID":{
            "description":"ID of the display to use with the filter.",
            "type":"integer",
            "example":"0"
        },
        "DisplayName":{
            "description":"Name of the display to use with the filter.",
            "type":"string",
            "example":"[User Default]"
        },
        "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":[
            ]
        }
    }
}

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

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":{
                "description":"An error.",
                "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

An error.

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

Nested Schema : items

Type: object

An error.