Get an SLM Filter
get
/api/SLM/ServiceFilters/{id}
Gets the SLM filter that matches the specified ID.
Request
Path Parameters
-
id(required): string
The SLM filter ID.Example:
2dc9dcc2-635b-4b63-9a0e-35dcb05458c0
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
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 specified SLM filter.
Nested Schema : SLMServiceFiltersRead
Type:
Show Source
object
-
_id: string
Service IDExample:
2dc9dcc2-635b-4b63-9a0e-35dcb05458c0
-
_parent_id: string
Parent ServiceIDExample:
2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
-
_type: string
Service TypeExample:
ServiceFilter
-
CompareField: string
Compare FieldExample:
Count
-
CompareMetric: string
Compare Metric Allowed Values: - COUNT - SUM - MIN - MAX - AVGExample:
COUNT
-
CompareOperator: string
Compare Operator Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
<=
-
CompareValue: number
Value against which comparison is doneExample:
75
-
icon: string
SLM Filter IconExample:
/resources/assure1/images/icons/fugue/funnel--exclamation.png
-
leaf: boolean
If leaf node or notExample:
true
-
Name: string
Name of the SLM FilterExample:
Some Filter
-
OwnerUserGroupID: integer
ID of group that owns the filterExample:
0
-
OwnerUserID: integer
User Id for owner who owns the filterExample:
0
-
ParentServiceID: string
ServiceID of ParentExample:
2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
-
qtip: string
Filter nameExample:
Some Filter
-
ServiceID: string
Service ID specified for individual CRUD operationsExample:
2dc9dcc2-635b-4b63-9a0e-35dcb05458c0
-
ServiceName: string
Service nameExample:
Some Filter
-
ServiceType: string
Service typeExample:
Filter
-
Status: string
Status of filter i.e. Enabled or DisabledExample:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: integer
Status ID used to determine if the SLM filter is enabled or disabled Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
TimestampModified: integer
Timestamp when the filter is modifiedExample:
1.698332107E12
-
VertexTypes: integer
Vertex TypesExample:
101
-
Viewers: object
Viewers
User groups that have access to view the filter
-
Weight: integer
SLM Weight (weight assigned to the filter)Example:
1
-
WhereClause: string
The clause used to find events to check against threshold.Example:
Nested Schema : Viewers
Type:
object
User groups that have access to view the filter
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