Jump to

• Request
• Response

Create an Event Filter Group

post

/api/event/FilterGroups

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

• FilterGroupName
• OwnerUserID
• OwnerUserGroupID
• ParentFilterGroupID
• Filters

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

• FilterGroupName: string
  The event filter group 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: Global
• Filters: array Filters
  List of Filters IDs
• OwnerUserGroupID: integer
  Chosen user group owner

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

  Example: 0
• ParentFilterGroupID: ParentFilterGroupID
  FilterGroupID of Parent Group, can be "root" or an int.
• Remove: boolean
  Whether to remove the filters from other event filter groups (1 for true) or not (0 for false).

  Example: 1
• RestrictionFilter: string
  Restriction filter

  Example:

{
    "type":"object",
    "properties":{
        "FilterGroupName":{
            "description":"The event filter group 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":"Global"
        },
        "ParentFilterGroupID":{
            "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/ParentFilterGroupID"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/OwnerUserGroupID"
        },
        "RestrictionFilter":{
            "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/RestrictionFilter"
        },
        "Filters":{
            "description":"List of Filters IDs",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1,
                2
            ]
        },
        "Remove":{
            "description":"Whether to remove the filters from other event filter groups (<b>1</b> for true) or not (<b>0</b> for false).",
            "type":"boolean",
            "example":"1"
        }
    }
}

Nested Schema : Filters

Type: array

List of Filters IDs

Show Source

• Array of: integer

{
    "description":"List of Filters IDs",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1,
        2
    ]
}

Example:

[
    1,
    2
]

Nested Schema : ParentFilterGroupID

FilterGroupID of Parent Group, can be "root" or an int.

Match One Schema

Show Source

• string
• integer

{
    "description":"FilterGroupID of Parent Group, can be \"root\" or an int.",
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"integer"
        }
    ],
    "example":"1"
}

Example:

1

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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 group.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventFilterGroupsReadByID"
                    }
                }
            }
        }
    ]
}

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 group.

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

Nested Schema : data

Type: array

The properties of the new event filter group.

Show Source

• Array of: object eventFilterGroupsReadByID

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

Nested Schema : eventFilterGroupsReadByID

Type: object

Show Source

• FilterGroupID: integer
  Filter Group ID

  Example: 1
• FilterGroupName: string
  Filter Group Name

  Example: Global
• Filters: array Filters
  Array of filters belonging to the filter group.
• OwnerUserGroupID: integer
  Chosen user group owner

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

  Example: 0
• ParentFilterGroupID: ParentFilterGroupID
  FilterGroupID of Parent Group, can be "root" or an int.
• RestrictionFilter: string
  Restriction filter

  Example:

{
    "type":"object",
    "properties":{
        "FilterGroupName":{
            "description":"Filter Group Name",
            "type":"string",
            "example":"Global"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the event filter group. 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"
        },
        "RestrictionFilter":{
            "description":"Restriction filter",
            "type":"string",
            "example":""
        },
        "FilterGroupID":{
            "description":"Filter Group ID",
            "type":"integer",
            "example":"1"
        },
        "ParentFilterGroupID":{
            "description":"FilterGroupID of Parent Group, can be \"root\" or an int.",
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"integer"
                }
            ],
            "example":"1"
        },
        "Filters":{
            "description":"Array of filters belonging to the filter group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "FilterID":{
                        "description":"Filter ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "FilterName":{
                        "description":"Filter Name",
                        "type":"string",
                        "example":"All Events"
                    }
                }
            },
            "example":[
                {
                    "FilterID":"1",
                    "FilterName":"All Events"
                },
                {
                    "FilterID":"2",
                    "FilterName":"Syslogs"
                }
            ]
        }
    }
}

Nested Schema : Filters

Type: array

Array of filters belonging to the filter group.

Show Source

• Array of: object items

{
    "description":"Array of filters belonging to the filter group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "FilterID":{
                "description":"Filter ID",
                "type":"integer",
                "example":"1"
            },
            "FilterName":{
                "description":"Filter Name",
                "type":"string",
                "example":"All Events"
            }
        }
    },
    "example":[
        {
            "FilterID":"1",
            "FilterName":"All Events"
        },
        {
            "FilterID":"2",
            "FilterName":"Syslogs"
        }
    ]
}

Example:

[
    {
        "FilterID":"1",
        "FilterName":"All Events"
    },
    {
        "FilterID":"2",
        "FilterName":"Syslogs"
    }
]

Nested Schema : ParentFilterGroupID

FilterGroupID of Parent Group, can be "root" or an int.

Match One Schema

Show Source

• string
• integer

{
    "description":"FilterGroupID of Parent Group, can be \"root\" or an int.",
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"integer"
        }
    ],
    "example":"1"
}

Example:

1

Nested Schema : items

Type: object

Show Source

• FilterID: integer
  Filter ID

  Example: 1
• FilterName: string
  Filter Name

  Example: All Events

{
    "type":"object",
    "properties":{
        "FilterID":{
            "description":"Filter ID",
            "type":"integer",
            "example":"1"
        },
        "FilterName":{
            "description":"Filter Name",
            "type":"string",
            "example":"All Events"
        }
    }
}

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":{
                "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.

Back to Top