REST API for Unified Assurance Core

Get a Metric Threshold

get

/api/metric/Thresholds/{id}

Gets the metric threshold that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The ID of the metric threshold to get.
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
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "description":"The metric threshold that matches the specified ID.",
                    "items":{
                        "$ref":"#/components/schemas/metricThresholdsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

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 metric threshold that matches the specified ID.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"The metric threshold that matches the specified ID.",
            "items":{
                "$ref":"#/components/schemas/metricThresholdsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The metric threshold that matches the specified ID.

Show Source

Array of: object metricThresholdsRead

{
    "type":"array",
    "description":"The metric threshold that matches the specified ID.",
    "items":{
        "$ref":"#/components/schemas/metricThresholdsRead"
    }
}

Nested Schema : metricThresholdsRead

Type: object

Show Source

AbnormalProfileID: integer

Abnormal Profile ID used by Abnormal Thresholds only Allowed Values: - 0 => None

Example: 0
AbnormalProfileName: string

Abnormal Profile Name

Example: None
CheckLocation: integer

Location of threshold checking (Standard only) Allowed Values: - 1 => Threshold Engine - 2 => Application

Example: 1
CheckLocationName: string

Check Location Name

Example: Threshold Engine
CriticalOperator: string

Operator Allowed Values: - == - != - < - > - <= ->=

Example: ==
CriticalSeverity: integer

Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = Critical

Example: 5
CriticalValue: number

Value to test for

Example: 0
ForecastTimeRange: string

(Trend Prediction Only) Relative time from now in a friendly text format

Example:
Frequency: string

If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", how often the threshold is being checked. This should not be less than the PollTime. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for days

Example: 5m
Measurement: string

String representing a metric stored in influx

Example: metrictype_Latency
Message: string

Threshold Message

Example: Performance threshold violation: Device Down
MetricField: string

String of metric being collected

Example: availability
MetricTypeName: string

Metric Type Name

Example: Latency
Offset: string

If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", what offset to apply to the time range, e.g "Go back 5 minutes when checking the threshold to ensure most recent poll data is considered". 0 minutes means no offset. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for days

Example: 0m
Status: string

Status

Example: Enabled
StatusIcon: string

Status Icon

Example: OrbGreen.png
StatusID: boolean

Allowed Values: - 0 => Disabled - 1 => Enabled

Example: 1
ThresholdFunctionID: integer

Threshold Function ID

Example: 1
ThresholdFunctionName: string

Threshold Function Name

Example: Mean
ThresholdID: integer

Threshold ID

Example: 1
ThresholdName: string

Threshold Name

Example: Device Down
ThresholdTypeID: integer

Allowed Values: - 1 => Availability - Standard - 2 => Performance Utilization - Standard - 3 => Performance Value - Standard - 10 => Trend % Daily - Advanced - 14 => Abnormal Daily - Advanced - 16 => Missing Data - Advanced - 20 => Trend Prediction Availability - Advanced - 21 => Trend Prediction Performance Utilization - Advanced - 22 => Trend Prediction Performance Value - Advanced

Example: 1
ThresholdTypeName: string

Threshold Type Name

Example: Standard
TimeRange: string

Unless Type is set to "Abnormal", the period of time where data points will be retrieved and evaluated. This must be a combination of a numerical value and a duration, which must be set to one of the following:- - s for seconds - m for minutes - h for hours - d for days

Example: 15m
WarningOperator: string

Warning Operator

Example:
WarningSeverity: integer

Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = Critical

Example: 3
WarningValue: number

Value to test for

Example: 0

{
    "properties":{
        "ThresholdID":{
            "description":"Threshold ID",
            "type":"integer",
            "example":"1"
        },
        "ThresholdName":{
            "description":"Threshold Name",
            "type":"string",
            "example":"Device Down"
        },
        "Message":{
            "description":"Threshold Message",
            "type":"string",
            "example":"Performance threshold violation: Device Down"
        },
        "ThresholdTypeID":{
            "description":"Allowed Values:\n- 1  => Availability - Standard\n- 2  => Performance Utilization - Standard\n- 3  => Performance Value - Standard\n- 10 => Trend % Daily - Advanced\n- 14 => Abnormal Daily - Advanced\n- 16 => Missing Data - Advanced\n- 20 => Trend Prediction Availability - Advanced\n- 21 => Trend Prediction Performance Utilization - Advanced\n- 22 => Trend Prediction Performance Value - Advanced",
            "type":"integer",
            "example":"1"
        },
        "ThresholdTypeName":{
            "description":"Threshold Type Name",
            "type":"string",
            "example":"Standard"
        },
        "StatusID":{
            "description":"Allowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"boolean",
            "example":"1"
        },
        "Status":{
            "description":"Status",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "AbnormalProfileID":{
            "description":"Abnormal Profile ID used by Abnormal Thresholds only\n\nAllowed Values:\n-  0 => None",
            "type":"integer",
            "example":"0"
        },
        "AbnormalProfileName":{
            "description":"Abnormal Profile Name",
            "type":"string",
            "example":"None"
        },
        "CheckLocation":{
            "description":"Location of threshold checking (Standard only)\nAllowed Values:\n-  1 => Threshold Engine\n-  2 => Application",
            "type":"integer",
            "example":"1"
        },
        "CheckLocationName":{
            "description":"Check Location Name",
            "type":"string",
            "example":"Threshold Engine"
        },
        "Measurement":{
            "description":"String representing a metric stored in influx",
            "type":"string",
            "example":"metrictype_Latency"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Latency"
        },
        "MetricField":{
            "description":"String of metric being collected",
            "type":"string",
            "example":"availability"
        },
        "TimeRange":{
            "description":"Unless Type is set to \"Abnormal\", the period of time where data points will be retrieved and evaluated. This must be a combination of a numerical value and a duration, which must be set to one of the following:-\n- s for seconds\n- m for minutes\n- h for hours\n- d for days",
            "type":"string",
            "example":"15m"
        },
        "Frequency":{
            "description":"If Type is set to \"Standard\" and CheckLocation is set to \"Threshold Engine\", how often the threshold is being checked. This should not be less than the PollTime. It must be a combination of a numerical value and a duration, which must be set to one of the following:\n- s for seconds\n- m for minutes\n- h for hours\n- d for days",
            "type":"string",
            "example":"5m"
        },
        "Offset":{
            "description":"If Type is set to \"Standard\" and CheckLocation is set to \"Threshold Engine\", what offset to apply to the time range, e.g \"Go back 5 minutes when checking the threshold to ensure most recent poll data is considered\". 0 minutes means no offset. It must be a combination of a numerical value and a duration, which must be set to one of the following:\n- s for seconds\n- m for minutes\n- h for hours\n- d for days",
            "type":"string",
            "example":"0m"
        },
        "ThresholdFunctionID":{
            "description":"Threshold Function ID",
            "type":"integer",
            "example":"1"
        },
        "ThresholdFunctionName":{
            "description":"Threshold Function Name",
            "type":"string",
            "example":"Mean"
        },
        "WarningOperator":{
            "description":"Warning Operator",
            "type":"string",
            "example":""
        },
        "WarningValue":{
            "description":"Value to test for",
            "type":"number",
            "example":"0"
        },
        "WarningSeverity":{
            "description":"Severity\n\nAllowed Values:\n- 0 = Normal\n- 1 = Info\n- 2 = Unknown\n- 3 = Minor\n- 4 = Major\n- 5 = Critical",
            "type":"integer",
            "example":"3"
        },
        "CriticalOperator":{
            "description":"Operator\n\nAllowed Values:\n- ==\n- !=\n- <\n- >\n- <=\n- >=",
            "type":"string",
            "example":"=="
        },
        "CriticalValue":{
            "description":"Value to test for",
            "type":"number",
            "example":"0"
        },
        "CriticalSeverity":{
            "description":"Severity\n\nAllowed Values:\n- 0 = Normal\n- 1 = Info\n- 2 = Unknown\n- 3 = Minor\n- 4 = Major\n- 5 = Critical",
            "type":"integer",
            "example":"5"
        },
        "ForecastTimeRange":{
            "description":"(Trend Prediction Only) Relative time from now in a friendly text format",
            "type":"string",
            "example":""
        }
    },
    "type":"object"
}

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