Jump to

• Request
• Response

Get an Event Filter Group by ID

get

/api/event/FilterGroups/{id}

Gets the event filter group that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The event filter group ID.

Query Parameters

• readChildren: boolean
  Whether to return only the properties of the children of the event group for a tree display (true) or the properties of the requested group for a form display (false).

  Example:

  false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

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

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• 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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Nested Schema : data

Type: array

Show Source

• Array of: object eventFilterGroupsReadByID

{
    "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
  Chosen user owner

  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":"Chosen user owner",
            "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":{
                "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