1. REST API for Unified Assurance Core
  2. Tasks
  3. Events
  4. Watcher Policies

Get Event Watcher Policies

get

/api/event/WatcherPolicies

Gets the event watcher policies that match the specified parameters. If no parameters are specified, all event watcher policies are returned.

Request

Query Parameters
  • 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 number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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 event watcher policies that match the specified parameters.
Show Source
Nested Schema : eventWatcherPoliciesRead
Type: object
Show Source
  • Indicates which type of action to take when a threshold is crossed. - event => Meta Event - notification => Notification profile
    Example: event
  • Comma-separated list of notification recipients.
    Example:
  • Filters
    List of Filters with the Watcher
  • ID of the notification profile.
    Example: 0
  • Notification Profile Name
    Example: oracle.doceng.json.BetterJsonNull@3aec2f59
  • ID of the notification template.
    Example: 0
  • Notification Template Name
    Example: oracle.doceng.json.BetterJsonNull@fefd4a2
  • Action associated with the Policy
    Example: Meta Event: Login Failure x3
  • Policy Author
    Example: Administrator
  • Event Watcher Policy Description
    Example: For any Login Failures by Node in the last 15 mins If any login failures occur and the Sum of Count >= 3, create this event.
  • The ID of the Meta Event that should be dispatched if the threshold condition is met for the filtered metrics
    Example: 3
  • The Name of the Meta Event that should be dispatched if the threshold condition is met for the filtered metrics
    Example: Login Failure x3
  • SQL used to select which events will be processed by this CAPE Policy's node(s)
    Example: (EventType = 'LoginLogout' AND Severity > 1 AND LastReported > (UNIX_TIMESTAMP() - 900))
  • A SQL "GROUP BY" clause that allows the filtered metrics to be grouped. Valid format is empty or a comma-delimited list of one or more Event.Events field names
    Example: Node
  • Policy ID specified for individual CRUD operations
    Example: 2
  • Event Watcher Policy Name
    Example: Login Failure x3
  • How often, in seconds, should this policy be checked
    Example: 900
  • Event Watcher Policy Status
    Example: Disabled
  • Event Watcher Policy Status Icon
    Example: OrbRed.png
  • The event watcher policy status ID. Either 0 (disabled) or 1 (enabled).
    Example: 0
  • Overall threshold operation
    Example: sum(Count) >= 3
  • Field from Event.Events DB table to use in threshold calculation. Value must be a field in Events. The Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)'
    Example: Count
  • SQL Function applied to $PolicyThresholdField and compared with the $PolicyThresholdOperatorID operator against $PolicyThresholdValue The Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)' Allowed Values: - count - sum - max - min - avg
    Example: sum
  • The OperatorID of the threshold calculation The Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)' Allowed Values: - 0 => = - 1 => > - 2 => >= - 3 => < - 4 => <= 5 -> !=
    Example: 2
  • The numeric value used in the threshold condition. The Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)'
    Example: 3
  • Indicates which type of search - field => Guided - sql => Manual SQL
    Example: sql
Nested Schema : Filters
Type: array
List of Filters with the Watcher
Show Source
Example:
[
    {
        "FieldName":"Ack",
        "Expression":"0",
        "FieldValue":""
    },
    {
        "FieldName":"Action",
        "Expression":"0",
        "FieldValue":""
    },
    {
        "FieldName":"Actor",
        "Expression":"0",
        "FieldValue":""
    }
]
Nested Schema : items
Type: object
Show Source

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