• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

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

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

• data: array data
  The new metric threshold.
• 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":{
            "type":"array",
            "description":"The new metric threshold.",
            "items":{
                "$ref":"#/components/schemas/metricThresholdsRead"
            }
        }
    }
}

• Array of: object metricThresholdsRead

{
    "type":"array",
    "description":"The new metric threshold.",
    "items":{
        "$ref":"#/components/schemas/metricThresholdsRead"
    }
}

• AbnormalProfileID: integer
  The abnormal profile ID, used by abnormal thresholds only. For all other threshold types, the value of this is 0.

  Example: 0
• AbnormalProfileName: string
  The abnormal profile name, used by abnormal thresholds only. For all other threshold types, the value of this is None.

  Example: None
• CheckLocation: integer
  The location of threshold checking, for standard thresholds only. Allowed Values are 1 for the Threshold Engine or 2 for an application.

  Example: 1
• CheckLocationName: string
  The name of the check location.

  Example: Threshold Engine
• CriticalOperator: string
  The critical threshold comparison operator. Allowed values are:

  • ==
  • !=
  • >
  • >=
  • <
  • <=

  Example: ==
• CriticalSeverity: integer
  The critical severity, used in the warning event. Allowed Values are:

  • 0: Normal
  • 1: Info
  • 2: Unknown
  • 3: Minor
  • 4: Major
  • 5: Critical

  Example: 5
• CriticalValue: number
  The critical value to test for.

  Example: 0
• ForecastTimeRange: string
  Used when Type is set to Trend Prediction. The relative time, starting now, to use when predicting when the metric value will breach the threshold. For example, set it to 6M to notify when the threshold is expected to be breached within six months.
  The format is a combination of a numerical value and one of the following duration values:

  • m: Minutes
  • h: Hours
  • d: Days
  • w: Weeks
  • M: Months
  • Y: Years

  Example: 6M
• Frequency: string
  Used when Type is set to Standard and CheckLocation is set to Threshold Engine. How often the threshold is checked. This should not be less than the PollTime for the Standard Thresholding Engine (default is one minute) or the metric the threshold is for (default is five minutes).
  The format is a combination of a numerical value and one of the following duration values:

  • m: Minutes
  • h: Hours
  • d: Days
  • w: Weeks
  • M: Months
  • Y: Years

  Example: 5m
• Measurement: string
  The string representing the metric stored in the Metric database.

  Example: metrictype_Latency
• Message: string
  The message for the threshold event. Usually appears in an event's Summary field in the event list.

  Example: Performance threshold violation: Device Down
• MetricField: string
  The data type that the threshold checks. Allowed values are:

  • availability
  • utilization
  • value

  Example: availability
• MetricTypeName: string
  The metric type name.

  Example: Latency
• Offset: string
  Used when Type is set to Standard and CheckLocation is set to Threshold Engine. The offset to apply to the time range. For example, set to 5m to go back five minutes when checking the threshold to ensure most recent poll data is considered. Set to 0m for no offset.
  The format is a combination of a numerical value and one of the following duration values:

  • m: Minutes
  • h: Hours
  • d: Days
  • w: Weeks
  • M: Months
  • Y: Years

  Example: 0m
• Status: string
  The metric threshold status. Either Disabled or Enabled.

  Example: Enabled
• StatusIcon: string
  The metric threshold status icon. For example, a green orb for enabled status.

  Example: OrbGreen.png
• StatusID: boolean
  The metric threshold status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• ThresholdFunctionID: integer
  The threshold function ID.

  Example: 1
• ThresholdFunctionName: string
  The threshold function name. Allowed values are:

  • 95th Percentile: Use when you do not want to count infrequently-occurring high outliers and odd values, when most data points will be under a certain value.
  • Count: Use to ensure there is no missing data, when you expect data points frequently. For example, if you expected a data point every minute, checking a TimeRange of X minutes every Y minutes shows if data is missing after the last Y minutes.
  • Maximum: Use to ensure all data is below a certain value.
  • Mean: Use to consider the average of the values.
  • Minimum: Use to ensure the data never falls below a certain value.
  • Standard Deviation: Use when the variation of data points should be below a certain value.

  Example: Mean
• ThresholdID: integer
  The threshold ID.

  Example: 1
• ThresholdName: string
  The threshold name.

  Example: Device Down
• ThresholdTypeID: integer
  The ID of the threshold type. Allowed values are:

  • 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
  The threshold type name

  Example: Standard
• TimeRange: string
  Unless Type is set to Abnormal, the period of time in which data points are retrieved and evaluated.
  This must be a combination of a numerical value and one of the following duration values:

  • m: Minutes
  • h: Hours
  • d: Days
  • w: Weeks
  • M: Months
  • Y: Years

  Example: 15m
• WarningOperator: string
  The warning threshold comparison operator. Allowed values are:

  • ==
  • !=
  • >
  • >=
  • <
  • <=

  Example: !=
• WarningSeverity: integer
  The warning severity, used in the warning event. Allowed Values are:

  • 0: Normal
  • 1: Info
  • 2: Unknown
  • 3: Minor
  • 4: Major
  • 5: Critical

  Example: 3
• WarningValue: number
  The warning value to test for.

  Example: 0

{
    "properties":{
        "ThresholdID":{
            "description":"The threshold ID.",
            "type":"integer",
            "example":"1"
        },
        "ThresholdName":{
            "description":"The threshold name.",
            "type":"string",
            "example":"Device Down"
        },
        "Message":{
            "description":"The message for the threshold event. Usually appears in an event's <b>Summary</b> field in the event list.",
            "type":"string",
            "example":"Performance threshold violation: Device Down"
        },
        "ThresholdTypeID":{
            "description":"The ID of the threshold type. Allowed values are:\n<ul><li><b>1</b>: Availability - Standard</li>\n<li><b>2</b>: Performance Utilization - Standard</li>\n<li><b>3</b>: Performance Value - Standard</li>\n<li><b>10</b>: Trend % Daily - Advanced</li>\n<li><b>14</b>: Abnormal Daily - Advanced</li>\n<li><b>16</b>: Missing Data - Advanced</li>\n<li><b>20</b>: Trend Prediction Availability - Advanced</li>\n<li><b>21</b>: Trend Prediction Performance Utilization - Advanced</li>\n<li><b>22</b>: Trend Prediction Performance Value - Advanced</li></ul>",
            "type":"integer",
            "example":"1"
        },
        "ThresholdTypeName":{
            "description":"The threshold type name",
            "type":"string",
            "example":"Standard"
        },
        "StatusID":{
            "description":"The metric threshold status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"boolean",
            "example":"1"
        },
        "Status":{
            "description":"The metric threshold status. Either <b>Disabled</b> or <b>Enabled</b>.",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"The metric threshold status icon. For example, a green orb for enabled status.",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "AbnormalProfileID":{
            "description":"The abnormal profile ID, used by abnormal thresholds only. For all other threshold types, the value of this is <b>0</b>.",
            "type":"integer",
            "example":"0"
        },
        "AbnormalProfileName":{
            "description":"The abnormal profile name, used by abnormal thresholds only. For all other threshold types, the value of this is <b>None</b>.",
            "type":"string",
            "example":"None"
        },
        "CheckLocation":{
            "description":"The location of threshold checking, for standard thresholds only. \nAllowed Values are <b>1</b> for the Threshold Engine or <b>2</b> for an application.",
            "type":"integer",
            "example":"1"
        },
        "CheckLocationName":{
            "description":"The name of the check location.",
            "type":"string",
            "example":"Threshold Engine"
        },
        "Measurement":{
            "description":"The string representing the metric stored in the Metric database.",
            "type":"string",
            "example":"metrictype_Latency"
        },
        "MetricTypeName":{
            "description":"The metric type name.",
            "type":"string",
            "example":"Latency"
        },
        "MetricField":{
            "description":"The data type that the threshold checks. Allowed values are:\n<ul><li>availability</li>\n<li>utilization</li>\n<li>value</li></ul>",
            "type":"string",
            "example":"availability"
        },
        "TimeRange":{
            "description":"Unless <b>Type</b> is set to <b>Abnormal</b>, the period of time in which data points are retrieved and evaluated.<br>This must be a combination of a numerical value and one of the following duration values:\n<ul><li><b>m</b>: Minutes</li>\n<li><b>h</b>: Hours</li>\n<li><b>d</b>: Days</li>\n<li><b>w</b>: Weeks</li>\n<li><b>M</b>: Months</li>\n<li><b>Y</b>: Years</li></ul>",
            "type":"string",
            "example":"15m"
        },
        "Frequency":{
            "description":"Used when <b>Type</b> is set to <b>Standard</b> and <b>CheckLocation</b> is set to <b>Threshold Engine</b>. How often the threshold is checked. This should not be less than the PollTime for the Standard Thresholding Engine (default is one minute) or the metric the threshold is for (default is five minutes).\n<br>The format is a combination of a numerical value and one of the following duration values:\n <ul><li><b>m</b>: Minutes</li>\n <li><b>h</b>: Hours</li>\n <li><b>d</b>: Days</li>\n <li><b>w</b>: Weeks</li>\n <li><b>M</b>: Months</li>\n <li><b>Y</b>: Years</li></ul>",
            "type":"string",
            "example":"5m"
        },
        "Offset":{
            "description":"Used when <b>Type</b> is set to <b>Standard</b> and <b>CheckLocation</b> is set to <b>Threshold Engine</b>. The offset to apply to the time range. For example, set to <b>5m</b> to go back five minutes when checking the threshold to ensure most recent poll data is considered. Set to <b>0m</b> for no offset.<br>\nThe format is a combination of a numerical value and one of the following duration values:\n<ul><li><b>m</b>: Minutes</li>\n<li><b>h</b>: Hours</li>\n<li><b>d</b>: Days</li>\n<li><b>w</b>: Weeks</li>\n<li><b>M</b>: Months</li>\n<li><b>Y</b>: Years</li></ul>",
            "type":"string",
            "example":"0m"
        },
        "ThresholdFunctionID":{
            "description":"The threshold function ID.",
            "type":"integer",
            "example":"1"
        },
        "ThresholdFunctionName":{
            "description":"The threshold function name. Allowed values are:\n<ul><li><b>95th Percentile</b>: Use when you do not want to count infrequently-occurring high outliers and odd values, when most data points will be under a certain value.</li>\n<li><b>Count</b>: Use to ensure there is no missing data, when you expect data points frequently. For example, if you expected a data point every minute, checking a TimeRange of X minutes every Y minutes shows if data is missing after the last Y minutes.</li>\n<li><b>Maximum</b>: Use to ensure all data is below a certain value.</li>\n <li><b>Mean</b>: Use to consider the average of the values.</li>\n <li><b>Minimum</b>: Use to ensure the data never falls below a certain value.</li>\n <li><b>Standard Deviation</b>: Use when the variation of data points should be below a certain value.</li></ul>",
            "type":"string",
            "example":"Mean"
        },
        "WarningOperator":{
            "description":"The warning threshold comparison operator. Allowed values are:\n <ul><li><b>==</b></li>\n <li><b>!=</b></li>\n <li><b>&gt;</b></li>\n <li><b>&gt;=</b></li>\n <li><b>&lt;</b></li>\n <li><b>&lt;=</b></li></ul>",
            "type":"string",
            "example":"!="
        },
        "WarningValue":{
            "description":"The warning value to test for.",
            "type":"number",
            "example":"0"
        },
        "WarningSeverity":{
            "description":"The warning severity, used in the warning event. Allowed Values are:\n<ul><li><b>0</b>: Normal</li>\n<li><b>1</b>: Info</li>\n<li><b>2</b>: Unknown</li>\n<li><b>3</b>: Minor</li>\n<li><b>4</b>: Major</li>\n<li><b>5</b>: Critical</li></ul>",
            "type":"integer",
            "example":"3"
        },
        "CriticalOperator":{
            "description":"The critical threshold comparison operator. Allowed values are:\n<ul><li><b>==</b></li>\n<li><b>!=</b></li>\n<li><b>&gt;</b></li>\n<li><b>&gt;=</b></li>\n<li><b>&lt;</b></li>\n<li><b>&lt;=</b></li></ul>",
            "type":"string",
            "example":"=="
        },
        "CriticalValue":{
            "description":"The critical value to test for.",
            "type":"number",
            "example":"0"
        },
        "CriticalSeverity":{
            "description":"The critical severity, used in the warning event. Allowed Values are:\n <ul><li><b>0</b>: Normal</li>\n <li><b>1</b>: Info</li>\n <li><b>2</b>: Unknown</li>\n <li><b>3</b>: Minor</li>\n <li><b>4</b>: Major</li>\n <li><b>5</b>: Critical</li></ul>",
            "type":"integer",
            "example":"5"
        },
        "ForecastTimeRange":{
            "description":"Used when <b>Type</b> is set to <b>Trend Prediction</b>. The relative time, starting now, to use when predicting when the metric value will breach the threshold. For example, set it to <b>6M</b> to notify when the threshold is expected to be breached within six months.\n<br>The format is a combination of a numerical value and one of the following duration values:\n<ul><li><b>m</b>: Minutes</li>\n<li><b>h</b>: Hours</li>\n<li><b>d</b>: Days</li>\n<li><b>w</b>: Weeks</li>\n<li><b>M</b>: Months</li>\n<li><b>Y</b>: Years</li></ul>",
            "type":"string",
            "example":"6M"
        }
    },
    "type":"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

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

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