REST API for Unified Assurance Core

Get Event Filters under a Specific Node

get

/api/eventNavigation/Events/readForTree

Gets event filter groups in a format suitable for tree grids.

Request

Query Parameters

node(required): string
The node ID in event filter group tree. The ID value can be special values such as root (Global folder), private (Private Filters folder), meta (MetaTags folder) or event filter group ID.
Example:
```
root
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of event filter groups.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The unique identifier for the filter.",
                                "type":"string",
                                "example":"Filter-1-7"
                            },
                            "text":{
                                "description":"The display text for the filter.",
                                "type":"string",
                                "example":"Acked Events"
                            },
                            "viewTitle":{
                                "description":"The title to display in the view.",
                                "type":"string",
                                "example":"Acked Events"
                            },
                            "leaf":{
                                "description":"Indicates whether this is a leaf node in a hierarchy.",
                                "type":"boolean",
                                "example":true
                            },
                            "iconCls":{
                                "description":"The CSS class for the filter icon.",
                                "type":"string",
                                "example":"icon-filter"
                            },
                            "view":{
                                "description":"The URL or path for navigating to this filter.",
                                "type":"string",
                                "example":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
                            }
                        }
                    },
                    "example":[
                        {
                            "text":"Private Filters",
                            "id":"private",
                            "expanded":false
                        },
                        {
                            "text":"Filters by Group: Global",
                            "id":"1",
                            "expanded":false,
                            "viewTitle":"Global"
                        },
                        {
                            "text":"Filters by MetaTags",
                            "id":"meta",
                            "expanded":false
                        },
                        {
                            "id":"Filter-1-7",
                            "text":"Acked Events",
                            "viewTitle":"Acked Events",
                            "leaf":true,
                            "iconCls":"icon-filter",
                            "view":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

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

{
    "description":"The response body for a successful get 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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The list of event filter groups.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of event filter groups.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The unique identifier for the filter.",
                        "type":"string",
                        "example":"Filter-1-7"
                    },
                    "text":{
                        "description":"The display text for the filter.",
                        "type":"string",
                        "example":"Acked Events"
                    },
                    "viewTitle":{
                        "description":"The title to display in the view.",
                        "type":"string",
                        "example":"Acked Events"
                    },
                    "leaf":{
                        "description":"Indicates whether this is a leaf node in a hierarchy.",
                        "type":"boolean",
                        "example":true
                    },
                    "iconCls":{
                        "description":"The CSS class for the filter icon.",
                        "type":"string",
                        "example":"icon-filter"
                    },
                    "view":{
                        "description":"The URL or path for navigating to this filter.",
                        "type":"string",
                        "example":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
                    }
                }
            },
            "example":[
                {
                    "text":"Private Filters",
                    "id":"private",
                    "expanded":false
                },
                {
                    "text":"Filters by Group: Global",
                    "id":"1",
                    "expanded":false,
                    "viewTitle":"Global"
                },
                {
                    "text":"Filters by MetaTags",
                    "id":"meta",
                    "expanded":false
                },
                {
                    "id":"Filter-1-7",
                    "text":"Acked Events",
                    "viewTitle":"Acked Events",
                    "leaf":true,
                    "iconCls":"icon-filter",
                    "view":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

The list of event filter groups.

Show Source

Array of: object items

{
    "description":"The list of event filter groups.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The unique identifier for the filter.",
                "type":"string",
                "example":"Filter-1-7"
            },
            "text":{
                "description":"The display text for the filter.",
                "type":"string",
                "example":"Acked Events"
            },
            "viewTitle":{
                "description":"The title to display in the view.",
                "type":"string",
                "example":"Acked Events"
            },
            "leaf":{
                "description":"Indicates whether this is a leaf node in a hierarchy.",
                "type":"boolean",
                "example":true
            },
            "iconCls":{
                "description":"The CSS class for the filter icon.",
                "type":"string",
                "example":"icon-filter"
            },
            "view":{
                "description":"The URL or path for navigating to this filter.",
                "type":"string",
                "example":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
            }
        }
    },
    "example":[
        {
            "text":"Private Filters",
            "id":"private",
            "expanded":false
        },
        {
            "text":"Filters by Group: Global",
            "id":"1",
            "expanded":false,
            "viewTitle":"Global"
        },
        {
            "text":"Filters by MetaTags",
            "id":"meta",
            "expanded":false
        },
        {
            "id":"Filter-1-7",
            "text":"Acked Events",
            "viewTitle":"Acked Events",
            "leaf":true,
            "iconCls":"icon-filter",
            "view":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
        }
    ]
}

Example:

[
    {
        "text":"Private Filters",
        "id":"private",
        "expanded":false
    },
    {
        "text":"Filters by Group: Global",
        "id":"1",
        "expanded":false,
        "viewTitle":"Global"
    },
    {
        "text":"Filters by MetaTags",
        "id":"meta",
        "expanded":false
    },
    {
        "id":"Filter-1-7",
        "text":"Acked Events",
        "viewTitle":"Acked Events",
        "leaf":true,
        "iconCls":"icon-filter",
        "view":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
    }
]

Nested Schema : items

Type: object

Show Source

iconCls: string

The CSS class for the filter icon.

Example: icon-filter
id: string

The unique identifier for the filter.

Example: Filter-1-7
leaf: boolean

Indicates whether this is a leaf node in a hierarchy.

Example: true
text: string

The display text for the filter.

Example: Acked Events
view: string

The URL or path for navigating to this filter.

Example: #events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events
viewTitle: string

The title to display in the view.

Example: Acked Events

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the filter.",
            "type":"string",
            "example":"Filter-1-7"
        },
        "text":{
            "description":"The display text for the filter.",
            "type":"string",
            "example":"Acked Events"
        },
        "viewTitle":{
            "description":"The title to display in the view.",
            "type":"string",
            "example":"Acked Events"
        },
        "leaf":{
            "description":"Indicates whether this is a leaf node in a hierarchy.",
            "type":"boolean",
            "example":true
        },
        "iconCls":{
            "description":"The CSS class for the filter icon.",
            "type":"string",
            "example":"icon-filter"
        },
        "view":{
            "description":"The URL or path for navigating to this filter.",
            "type":"string",
            "example":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events"
        }
    }
}

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.