REST API for Unified Assurance Core

Get Event Supervised Correlation Policies

get

/api/event/SupervisedCorrelations/

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

Request

Query Parameters

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"
}

limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```

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",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
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.

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 supervised correlation properties that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventSupervisedCorrelationsRead"
                    }
                }
            }
        }
    ]
}

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 supervised correlation properties that match the specified parameters.
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 supervised correlation properties that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventSupervisedCorrelationsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of event supervised correlation properties that match the specified parameters.

Show Source

Array of: object eventSupervisedCorrelationsRead

{
    "description":"The list of event supervised correlation properties that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventSupervisedCorrelationsRead"
    }
}

Nested Schema : eventSupervisedCorrelationsRead

Type: object

Show Source

GroupByFields: string

The event field or fields to group by

Example: Ack
MatchFields: MatchFields

The event fields that must have matching values to fit the cluster
MatchFieldValues: MatchFieldValues

The values of the match fields
MetaEventID: MetaEventID

Meta event to create as the root cause
MinimumMembers: integer

Minimum number of events to establish an event cluster based on the correlation policy definition

Example: 1
RootCause: integer

Root Cause

Example: 1
RootFlags: integer

Root flags

Example: 0
Status: string

Current Status

Example: Enabled
StatusID: integer

The supervised correlation status ID. Either 0 (disabled) or 1 (enabled).

Example: 1
SupervisedCorrelationID: integer

Event to be modified as either the root cause or correlated to another event

Example: 1037
SupervisedCorrelationName: string

Name of the supervised correlation policy

Example: test name
TimeWindow: integer

Length of the time window for the correlation policy, in seconds

Example: 30

{
    "type":"object",
    "properties":{
        "SupervisedCorrelationID":{
            "description":"Event to be modified as either the root cause or correlated to another event",
            "type":"integer",
            "example":"1037"
        },
        "SupervisedCorrelationName":{
            "description":"Name of the supervised correlation policy",
            "type":"string",
            "example":"test name"
        },
        "GroupByFields":{
            "description":"The event field or fields to group by",
            "type":"string",
            "example":"Ack"
        },
        "MinimumMembers":{
            "description":"Minimum number of events to establish an event cluster based on the correlation policy definition",
            "type":"integer",
            "example":"1"
        },
        "TimeWindow":{
            "description":"Length of the time window for the correlation policy, in seconds",
            "type":"integer",
            "example":"30"
        },
        "MetaEventID":{
            "description":"Meta event to create as the root cause",
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"integer"
                }
            ],
            "example":"1"
        },
        "RootCause":{
            "description":"Root Cause",
            "type":"integer",
            "example":"1"
        },
        "StatusID":{
            "description":"The supervised correlation status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "Status":{
            "description":"Current Status",
            "type":"string",
            "example":"Enabled"
        },
        "RootFlags":{
            "description":"Root flags",
            "type":"integer",
            "example":"0"
        },
        "MatchFields":{
            "description":"The event fields that must have matching values to fit the cluster",
            "oneOf":[
                {
                    "type":"array"
                },
                {
                    "type":"string"
                }
            ],
            "example":"SubNode"
        },
        "MatchFieldValues":{
            "description":"The values of the match fields",
            "oneOf":[
                {
                    "type":"array"
                },
                {
                    "type":"string"
                }
            ],
            "example":"test"
        }
    }
}

Nested Schema : MatchFields

The event fields that must have matching values to fit the cluster

Match One Schema

Show Source

array MatchFields-oneOf[0]
string

{
    "description":"The event fields that must have matching values to fit the cluster",
    "oneOf":[
        {
            "type":"array"
        },
        {
            "type":"string"
        }
    ],
    "example":"SubNode"
}

Example:

SubNode

Nested Schema : MatchFieldValues

The values of the match fields

Match One Schema

Show Source

array MatchFieldValues-oneOf[0]
string

{
    "description":"The values of the match fields",
    "oneOf":[
        {
            "type":"array"
        },
        {
            "type":"string"
        }
    ],
    "example":"test"
}

Example:

test

Nested Schema : MetaEventID

Meta event to create as the root cause

Match One Schema

Show Source

string
integer

{
    "description":"Meta event to create as the root cause",
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"integer"
        }
    ],
    "example":"1"
}

Example:

Nested Schema : MatchFields-oneOf[0]

Type: array

Nested Schema : MatchFieldValues-oneOf[0]

Type: array

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.