Jump to

• Request
• Response

Get Possible Values for a Field from the Events Table

get

/api/event/ForensicViews/readFilterOptions

Gets a list of possible values for the given field from the events table.

Request

Query Parameters

• DisableConversions: boolean
  Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.
• DisplayID: integer
  The optional display ID for display conversion setting.
• Field(required): string
  The field from the Event.Events table.
• QuerySort(required): string
  QuerySort indicates the way the event field values are sorted Allowed Values: - frequency - alphanumeric
• filter: object
  The fields to filter the results by. You cannot filter by fields that contain a state.
  This parameter's value uses the following JSON format:
  {
  "property": "property",
  "value": "propertyValue",
  "operator": "operator",
  "conjunction": "conjunction"
  }
  
  If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    Default Value: LIKE

    Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

    The filter operation to use.

    Example: eq
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• id: string
  The value of the field to filter on.
• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• query: string
  A string to search for. This is a primitive filter, generally applied as a filter on a name parameter, but each endpoint implements it differently.

  Example:

  text

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format:
  {
  "property": "property",
  "direction": "direction"
  }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  Example:

  1

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":3
                },
                "data":{
                    "description":"The list of possible values for the given field from the events table.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "Field":{
                                "description":"The value from the given field.",
                                "type":"string",
                                "example":"Packet Loss High  with value 100.00 >= 1"
                            },
                            "ValueID":{
                                "description":"The value from the given field.",
                                "type":"string",
                                "example":"Packet Loss High  with value 100.00 >= 1"
                            },
                            "Frequency":{
                                "description":"The number of times the value occurs.",
                                "type":"integer",
                                "example":"135"
                            }
                        }
                    },
                    "example":[
                        {
                            "Field":"Ping Jitter High  with value 0.00 >= 0.0001",
                            "ValueID":"Ping Jitter High  with value 0.00 >= 0.0001",
                            "Frequency":"208"
                        },
                        {
                            "Field":"Device Down  with availability 0.00% == 0%",
                            "ValueID":"Device Down  with availability 0.00% == 0%",
                            "Frequency":"155"
                        },
                        {
                            "Field":"Packet Loss High  with value 100.00 >= 1",
                            "ValueID":"Packet Loss High  with value 100.00 >= 1",
                            "Frequency":"135"
                        }
                    ]
                }
            }
        }
    ]
}

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
  The list of possible values for the given field from the events table.
• total: integer
  The total number of results regardless of paging.

  Example: 3

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":3
        },
        "data":{
            "description":"The list of possible values for the given field from the events table.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Field":{
                        "description":"The value from the given field.",
                        "type":"string",
                        "example":"Packet Loss High  with value 100.00 >= 1"
                    },
                    "ValueID":{
                        "description":"The value from the given field.",
                        "type":"string",
                        "example":"Packet Loss High  with value 100.00 >= 1"
                    },
                    "Frequency":{
                        "description":"The number of times the value occurs.",
                        "type":"integer",
                        "example":"135"
                    }
                }
            },
            "example":[
                {
                    "Field":"Ping Jitter High  with value 0.00 >= 0.0001",
                    "ValueID":"Ping Jitter High  with value 0.00 >= 0.0001",
                    "Frequency":"208"
                },
                {
                    "Field":"Device Down  with availability 0.00% == 0%",
                    "ValueID":"Device Down  with availability 0.00% == 0%",
                    "Frequency":"155"
                },
                {
                    "Field":"Packet Loss High  with value 100.00 >= 1",
                    "ValueID":"Packet Loss High  with value 100.00 >= 1",
                    "Frequency":"135"
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

The list of possible values for the given field from the events table.

Show Source

• Array of: object items

{
    "description":"The list of possible values for the given field from the events table.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Field":{
                "description":"The value from the given field.",
                "type":"string",
                "example":"Packet Loss High  with value 100.00 >= 1"
            },
            "ValueID":{
                "description":"The value from the given field.",
                "type":"string",
                "example":"Packet Loss High  with value 100.00 >= 1"
            },
            "Frequency":{
                "description":"The number of times the value occurs.",
                "type":"integer",
                "example":"135"
            }
        }
    },
    "example":[
        {
            "Field":"Ping Jitter High  with value 0.00 >= 0.0001",
            "ValueID":"Ping Jitter High  with value 0.00 >= 0.0001",
            "Frequency":"208"
        },
        {
            "Field":"Device Down  with availability 0.00% == 0%",
            "ValueID":"Device Down  with availability 0.00% == 0%",
            "Frequency":"155"
        },
        {
            "Field":"Packet Loss High  with value 100.00 >= 1",
            "ValueID":"Packet Loss High  with value 100.00 >= 1",
            "Frequency":"135"
        }
    ]
}

Example:

[
    {
        "Field":"Ping Jitter High  with value 0.00 >= 0.0001",
        "ValueID":"Ping Jitter High  with value 0.00 >= 0.0001",
        "Frequency":"208"
    },
    {
        "Field":"Device Down  with availability 0.00% == 0%",
        "ValueID":"Device Down  with availability 0.00% == 0%",
        "Frequency":"155"
    },
    {
        "Field":"Packet Loss High  with value 100.00 >= 1",
        "ValueID":"Packet Loss High  with value 100.00 >= 1",
        "Frequency":"135"
    }
]

Nested Schema : items

Type: object

Show Source

• Field: string
  The value from the given field.

  Example: Packet Loss High with value 100.00 >= 1
• Frequency: integer
  The number of times the value occurs.

  Example: 135
• ValueID: string
  The value from the given field.

  Example: Packet Loss High with value 100.00 >= 1

{
    "type":"object",
    "properties":{
        "Field":{
            "description":"The value from the given field.",
            "type":"string",
            "example":"Packet Loss High  with value 100.00 >= 1"
        },
        "ValueID":{
            "description":"The value from the given field.",
            "type":"string",
            "example":"Packet Loss High  with value 100.00 >= 1"
        },
        "Frequency":{
            "description":"The number of times the value occurs.",
            "type":"integer",
            "example":"135"
        }
    }
}

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