Jump to

• Request
• Response

Get Event Filter Groups for Tree Grids

get

/api/event/FilterGroups/readForTree

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

Request

Query Parameters

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

  Example:

  1

• node: string
  The node of the tree to get.

  Example:

  root

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
  The response body for a successful get operation.
• oneOf

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "oneOf":[
                {
                    "$ref":"#/components/schemas/eventFilterGroupsReadForTreeIDResponse"
                },
                {
                    "$ref":"#/components/schemas/eventFilterGroupsReadForTreeNodeResponse"
                }
            ]
        }
    ]
}

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

Match One Schema

Show Source

• object eventFilterGroupsReadForTreeIDResponse
• object eventFilterGroupsReadForTreeNodeResponse

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/eventFilterGroupsReadForTreeIDResponse"
        },
        {
            "$ref":"#/components/schemas/eventFilterGroupsReadForTreeNodeResponse"
        }
    ]
}

Nested Schema : eventFilterGroupsReadForTreeIDResponse

Type: object

Show Source

• data: array data
  List of properties of the filter group from root to the given ID.
• total: integer
  The total number of results regardless of paging.

  Example: 2

{
    "type":"object",
    "properties":{
        "data":{
            "description":"List of properties of the filter group from root to the given ID.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "FilterGroupID":{
                        "description":"ID of the filter group.",
                        "type":"integer",
                        "example":"3"
                    },
                    "FilterGroupName":{
                        "description":"Name of the filter group.",
                        "type":"integer",
                        "example":"Global"
                    },
                    "leaf":{
                        "description":"Flag to indicate if this is a filter (leaf=1) or filter group (leaf=0).",
                        "type":"integer",
                        "example":0
                    },
                    "Lft":{
                        "description":"The mysql tree left boundary value.",
                        "type":"integer",
                        "example":"1"
                    },
                    "Rgt":{
                        "description":"The mysql tree right boundary value.",
                        "type":"integer",
                        "example":"2"
                    },
                    "path":{
                        "description":"The full path value.",
                        "type":"string",
                        "example":"/Global"
                    },
                    "depth":{
                        "description":"The tree depth level.",
                        "type":"integer",
                        "example":"1"
                    },
                    "expanded":{
                        "description":"Boolean value that tree node is expanded.",
                        "type":"boolean",
                        "example":true
                    },
                    "data":{
                        "description":"List of children filter groups.",
                        "type":"array",
                        "items":{
                            "type":"object"
                        },
                        "example":[
                            {
                                "FilterGroupID":"3",
                                "FilterGroupName":"Unused",
                                "leaf":"0",
                                "Lft":"4",
                                "Rgt":"7",
                                "path":"/Global/Unused",
                                "depth":2
                            }
                        ]
                    }
                }
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"2"
        }
    }
}

Nested Schema : eventFilterGroupsReadForTreeNodeResponse

Type: object

Show Source

• data: array data
  List of children list groups.
• total: integer
  The total number of results regardless of paging.

  Example: 2

{
    "type":"object",
    "properties":{
        "data":{
            "description":"List of children list groups.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "FilterGroupID":{
                        "description":"Child filter group ID.",
                        "type":"integer",
                        "example":"5"
                    },
                    "FilterGroupName":{
                        "description":"Name of the child filter group.",
                        "type":"string",
                        "example":"Oracle"
                    },
                    "leaf":{
                        "description":"Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).",
                        "type":"boolean",
                        "example":true
                    },
                    "iconCls":{
                        "description":"CSS class for icons.",
                        "type":"string",
                        "example":"x-tree-icon-parent"
                    }
                }
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"2"
        }
    }
}

Nested Schema : data

Type: array

List of properties of the filter group from root to the given ID.

Show Source

• Array of: object items

{
    "description":"List of properties of the filter group from root to the given ID.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "FilterGroupID":{
                "description":"ID of the filter group.",
                "type":"integer",
                "example":"3"
            },
            "FilterGroupName":{
                "description":"Name of the filter group.",
                "type":"integer",
                "example":"Global"
            },
            "leaf":{
                "description":"Flag to indicate if this is a filter (leaf=1) or filter group (leaf=0).",
                "type":"integer",
                "example":0
            },
            "Lft":{
                "description":"The mysql tree left boundary value.",
                "type":"integer",
                "example":"1"
            },
            "Rgt":{
                "description":"The mysql tree right boundary value.",
                "type":"integer",
                "example":"2"
            },
            "path":{
                "description":"The full path value.",
                "type":"string",
                "example":"/Global"
            },
            "depth":{
                "description":"The tree depth level.",
                "type":"integer",
                "example":"1"
            },
            "expanded":{
                "description":"Boolean value that tree node is expanded.",
                "type":"boolean",
                "example":true
            },
            "data":{
                "description":"List of children filter groups.",
                "type":"array",
                "items":{
                    "type":"object"
                },
                "example":[
                    {
                        "FilterGroupID":"3",
                        "FilterGroupName":"Unused",
                        "leaf":"0",
                        "Lft":"4",
                        "Rgt":"7",
                        "path":"/Global/Unused",
                        "depth":2
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• data: array data
  List of children filter groups.
• depth: integer
  The tree depth level.

  Example: 1
• expanded: boolean
  Boolean value that tree node is expanded.

  Example: true
• FilterGroupID: integer
  ID of the filter group.

  Example: 3
• FilterGroupName: integer
  Name of the filter group.

  Example: Global
• leaf: integer
  Flag to indicate if this is a filter (leaf=1) or filter group (leaf=0).

  Example: 0
• Lft: integer
  The mysql tree left boundary value.

  Example: 1
• path: string
  The full path value.

  Example: /Global
• Rgt: integer
  The mysql tree right boundary value.

  Example: 2

{
    "type":"object",
    "properties":{
        "FilterGroupID":{
            "description":"ID of the filter group.",
            "type":"integer",
            "example":"3"
        },
        "FilterGroupName":{
            "description":"Name of the filter group.",
            "type":"integer",
            "example":"Global"
        },
        "leaf":{
            "description":"Flag to indicate if this is a filter (leaf=1) or filter group (leaf=0).",
            "type":"integer",
            "example":0
        },
        "Lft":{
            "description":"The mysql tree left boundary value.",
            "type":"integer",
            "example":"1"
        },
        "Rgt":{
            "description":"The mysql tree right boundary value.",
            "type":"integer",
            "example":"2"
        },
        "path":{
            "description":"The full path value.",
            "type":"string",
            "example":"/Global"
        },
        "depth":{
            "description":"The tree depth level.",
            "type":"integer",
            "example":"1"
        },
        "expanded":{
            "description":"Boolean value that tree node is expanded.",
            "type":"boolean",
            "example":true
        },
        "data":{
            "description":"List of children filter groups.",
            "type":"array",
            "items":{
                "type":"object"
            },
            "example":[
                {
                    "FilterGroupID":"3",
                    "FilterGroupName":"Unused",
                    "leaf":"0",
                    "Lft":"4",
                    "Rgt":"7",
                    "path":"/Global/Unused",
                    "depth":2
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

List of children filter groups.

Show Source

• Array of: object items

{
    "description":"List of children filter groups.",
    "type":"array",
    "items":{
        "type":"object"
    },
    "example":[
        {
            "FilterGroupID":"3",
            "FilterGroupName":"Unused",
            "leaf":"0",
            "Lft":"4",
            "Rgt":"7",
            "path":"/Global/Unused",
            "depth":2
        }
    ]
}

Example:

[
    {
        "FilterGroupID":"3",
        "FilterGroupName":"Unused",
        "leaf":"0",
        "Lft":"4",
        "Rgt":"7",
        "path":"/Global/Unused",
        "depth":2
    }
]

Nested Schema : items

Type: object

Nested Schema : data

Type: array

List of children list groups.

Show Source

• Array of: object items

{
    "description":"List of children list groups.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "FilterGroupID":{
                "description":"Child filter group ID.",
                "type":"integer",
                "example":"5"
            },
            "FilterGroupName":{
                "description":"Name of the child filter group.",
                "type":"string",
                "example":"Oracle"
            },
            "leaf":{
                "description":"Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).",
                "type":"boolean",
                "example":true
            },
            "iconCls":{
                "description":"CSS class for icons.",
                "type":"string",
                "example":"x-tree-icon-parent"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• FilterGroupID: integer
  Child filter group ID.

  Example: 5
• FilterGroupName: string
  Name of the child filter group.

  Example: Oracle
• iconCls: string
  CSS class for icons.

  Example: x-tree-icon-parent
• leaf: boolean
  Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).

  Example: true

{
    "type":"object",
    "properties":{
        "FilterGroupID":{
            "description":"Child filter group ID.",
            "type":"integer",
            "example":"5"
        },
        "FilterGroupName":{
            "description":"Name of the child filter group.",
            "type":"string",
            "example":"Oracle"
        },
        "leaf":{
            "description":"Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).",
            "type":"boolean",
            "example":true
        },
        "iconCls":{
            "description":"CSS class for icons.",
            "type":"string",
            "example":"x-tree-icon-parent"
        }
    }
}

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