Update an Event Supervised Correlation Policy
put
/api/event/SupervisedCorrelations/{id}
Updates the properties of the event supervised correlation policy that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The event supervised correlation policy ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
GroupByFields: string
The event field or fields to group byExample:
Ack
-
MatchFields:
MatchFields
The event fields that must have matching values to fit the cluster
-
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 definitionExample:
1
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
SupervisedCorrelationName: string
Name of the supervised correlation policyExample:
test tadhg
-
TimeWindow: integer
Length of the time window for the correlation policy, in secondsExample:
30
Nested Schema : MatchFields
The event fields that must have matching values to fit the cluster
Match One Schema
Show Source
Example:
SubNode
Nested Schema : MetaEventID
Meta event to create as the root cause
Match One Schema
Show Source
Example:
1
Nested Schema : MatchFields-oneOf[0]
Type:
array
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the updated event supervised correlation policy.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The properties of the updated event supervised correlation policy.
Show Source
Nested Schema : eventSupervisedCorrelationsRead
Type:
Show Source
object
-
GroupByFields: string
The event field or fields to group byExample:
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 definitionExample:
1
-
RootCause: integer
Root CauseExample:
1
-
RootFlags: integer
Root flagsExample:
0
-
Status: string
Current StatusExample:
Enabled
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
SupervisedCorrelationID: integer
Event to be modified as either the root cause or correlated to another eventExample:
1037
-
SupervisedCorrelationName: string
Name of the supervised correlation policyExample:
test tadhg
-
TimeWindow: integer
Length of the time window for the correlation policy, in secondsExample:
30
Nested Schema : MatchFields
The event fields that must have matching values to fit the cluster
Match One Schema
Show Source
Example:
SubNode
Nested Schema : MatchFieldValues
The values of the match fields
Match One Schema
Show Source
Example:
test
Nested Schema : MetaEventID
Meta event to create as the root cause
Match One Schema
Show Source
Example:
1
Nested Schema : MatchFields-oneOf[0]
Type:
array
Nested Schema : MatchFieldValues-oneOf[0]
Type:
array
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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