Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the specified SLM filter.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SLMServiceFiltersRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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 properties of the specified SLM filter.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the specified SLM filter.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SLMServiceFiltersRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the specified SLM filter.

Show Source

• Array of: object SLMServiceFiltersRead

{
    "description":"The properties of the specified SLM filter.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SLMServiceFiltersRead"
    }
}

Nested Schema : SLMServiceFiltersRead

Type: object

Show Source

• _id: string
  Service ID

  Example: 2dc9dcc2-635b-4b63-9a0e-35dcb05458c0
• _parent_id: string
  Parent ServiceID

  Example: 2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
• _type: string
  Service Type

  Example: ServiceFilter
• CompareField: string
  Compare Field

  Example: Count
• CompareMetric: string
  Compare Metric Allowed Values: - COUNT - SUM - MIN - MAX - AVG

  Example: 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 done

  Example: 75
• icon: string
  SLM Filter Icon

  Example: /resources/assure1/images/icons/fugue/funnel--exclamation.png
• leaf: boolean
  If leaf node or not

  Example: true
• Name: string
  Name of the SLM Filter

  Example: Some Filter
• OwnerUserGroupID: integer
  ID of group that owns the filter

  Example: 0
• OwnerUserID: integer
  User Id for owner who owns the filter

  Example: 0
• ParentServiceID: string
  ServiceID of Parent

  Example: 2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
• qtip: string
  Filter name

  Example: Some Filter
• ServiceID: string
  Service ID specified for individual CRUD operations

  Example: 2dc9dcc2-635b-4b63-9a0e-35dcb05458c0
• ServiceName: string
  Service name

  Example: Some Filter
• ServiceType: string
  Service type

  Example: Filter
• Status: string
  Status of filter i.e. Enabled or Disabled

  Example: Enabled
• StatusIcon: string
  Status Icon

  Example: OrbGreen.png
• StatusID: integer
  Status ID used to determine if the SLM filter is enabled or disabled Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 1
• TimestampModified: integer
  Timestamp when the filter is modified

  Example: 1.698332107E12
• VertexTypes: integer
  Vertex Types

  Example: 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:

{
    "type":"object",
    "properties":{
        "ParentServiceID":{
            "description":"ServiceID of Parent",
            "type":"string",
            "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
        },
        "_type":{
            "description":"Service Type",
            "type":"string",
            "example":"ServiceFilter"
        },
        "WhereClause":{
            "description":"The clause used to find events to check against threshold.",
            "type":"string",
            "example":""
        },
        "Weight":{
            "description":"SLM Weight (weight assigned to the filter)",
            "type":"integer",
            "example":1
        },
        "Name":{
            "description":"Name of the SLM Filter",
            "type":"string",
            "example":"Some Filter"
        },
        "CompareField":{
            "description":"Compare Field",
            "type":"string",
            "example":"Count"
        },
        "CompareOperator":{
            "description":"Compare Operator\n\nAllowed Values:\n- '==' => Equals\n- '>'  => Greater Than\n- '>=' => Greater Than or Equal\n- '<'  => Less Than\n- '<=' => Less Than or Equal\n- '!=' => Not Equals",
            "type":"string",
            "example":"<="
        },
        "CompareMetric":{
            "description":"Compare Metric\n\nAllowed Values:\n- COUNT\n- SUM\n- MIN\n- MAX\n- AVG",
            "type":"string",
            "example":"COUNT"
        },
        "CompareValue":{
            "description":"Value against which comparison is done",
            "type":"number",
            "example":75
        },
        "OwnerUserID":{
            "description":"User Id for owner who owns the filter",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"ID of group that owns the filter",
            "type":"integer",
            "example":"0"
        },
        "_parent_id":{
            "description":"Parent ServiceID",
            "type":"string",
            "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
        },
        "VertexTypes":{
            "description":"Vertex Types",
            "type":"integer",
            "example":101
        },
        "StatusID":{
            "description":"Status ID used to determine if the SLM filter is enabled or disabled\n\nAllowed Values:\n- 0 => Disabled\n- 1 => Enabled",
            "type":"integer",
            "example":1
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "Status":{
            "description":"Status of filter i.e. Enabled or Disabled",
            "type":"string",
            "example":"Enabled"
        },
        "_id":{
            "description":"Service ID",
            "type":"string",
            "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0"
        },
        "TimestampModified":{
            "description":"Timestamp when the filter is modified",
            "type":"integer",
            "example":1.698332107E12
        },
        "ServiceID":{
            "description":"Service ID specified for individual CRUD operations",
            "type":"string",
            "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0"
        },
        "ServiceName":{
            "description":"Service name",
            "type":"string",
            "example":"Some Filter"
        },
        "ServiceType":{
            "description":"Service type",
            "type":"string",
            "example":"Filter"
        },
        "qtip":{
            "description":"Filter name",
            "type":"string",
            "example":"Some Filter"
        },
        "icon":{
            "description":"SLM Filter Icon",
            "type":"string",
            "example":"/resources/assure1/images/icons/fugue/funnel--exclamation.png"
        },
        "leaf":{
            "description":"If leaf node or not",
            "type":"boolean",
            "example":true
        },
        "Viewers":{
            "description":"User groups that have access to view the filter",
            "type":"object",
            "example":[
            ]
        }
    }
}

Nested Schema : Viewers

Type: object

User groups that have access to view the filter

Default Response

Failed operation

Body ()

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":{
                "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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top