1. REST API for Unified Assurance Core
  2. Tasks
  3. Events
  4. Forensic Views

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
  • Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.
  • The optional display ID for display conversion setting.
  • The field from the Event.Events table.
  • QuerySort indicates the way the event field values are sorted.
    Allowed Values:
    • frequency
    • alphanumeric
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The value of the field to filter on.
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The list of possible values for the given field from the events table.
Show Source
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
  • The value from the given field.
    Example: Packet Loss High with value 100.00 >= 1
  • The number of times the value occurs.
    Example: 135
  • The value from the given field.
    Example: Packet Loss High with value 100.00 >= 1

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top