Jump to

• Request
• Response

Get Device Threshold Details

get

/api/deviceNavigation/Devices/readStatesThresholds

Get threshold details about the devices specified in DeviceID, including the number of thresholds and breached thresholds.

Request

Query Parameters

• DeviceID(required): string
  The comma-separated list of device IDs.

  Example:

  109,7

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  Example:

  1

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

Type: object

Show Source

• data: array data
• message: string
  The response message.

  Example: Retrieved Threshold States
• success: boolean
  Whether the operation was a success (true) or failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Retrieved Threshold States"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesThresholds"
            },
            "example":[
                {
                    "DeviceID":"109",
                    "ThresholdExists":0,
                    "ThresholdSeverity":"normal",
                    "ThresholdData":[
                        [
                            "Metric Thresholds",
                            "Normal",
                            2
                        ],
                        [
                            "Count",
                            0,
                            2
                        ],
                        [
                            "Critical",
                            0
                        ],
                        [
                            "Warning",
                            0
                        ],
                        [
                            "Normal",
                            0,
                            2
                        ]
                    ],
                    "LoadingStates":false
                },
                {
                    "DeviceID":"7",
                    "ThresholdExists":7,
                    "ThresholdSeverity":"critical",
                    "ThresholdData":[
                        [
                            "Metric Thresholds",
                            "Critical",
                            2
                        ],
                        [
                            "Count",
                            7,
                            2
                        ],
                        [
                            "Critical",
                            4
                        ],
                        [
                            "Warning",
                            2
                        ],
                        [
                            "Normal",
                            1,
                            2
                        ]
                    ],
                    "LoadingStates":false
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object deviceNavigationDevicesReadStatesThresholds

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesThresholds"
    },
    "example":[
        {
            "DeviceID":"109",
            "ThresholdExists":0,
            "ThresholdSeverity":"normal",
            "ThresholdData":[
                [
                    "Metric Thresholds",
                    "Normal",
                    2
                ],
                [
                    "Count",
                    0,
                    2
                ],
                [
                    "Critical",
                    0
                ],
                [
                    "Warning",
                    0
                ],
                [
                    "Normal",
                    0,
                    2
                ]
            ],
            "LoadingStates":false
        },
        {
            "DeviceID":"7",
            "ThresholdExists":7,
            "ThresholdSeverity":"critical",
            "ThresholdData":[
                [
                    "Metric Thresholds",
                    "Critical",
                    2
                ],
                [
                    "Count",
                    7,
                    2
                ],
                [
                    "Critical",
                    4
                ],
                [
                    "Warning",
                    2
                ],
                [
                    "Normal",
                    1,
                    2
                ]
            ],
            "LoadingStates":false
        }
    ]
}

Example:

[
    {
        "DeviceID":"109",
        "ThresholdExists":0,
        "ThresholdSeverity":"normal",
        "ThresholdData":[
            [
                "Metric Thresholds",
                "Normal",
                2
            ],
            [
                "Count",
                0,
                2
            ],
            [
                "Critical",
                0
            ],
            [
                "Warning",
                0
            ],
            [
                "Normal",
                0,
                2
            ]
        ],
        "LoadingStates":false
    },
    {
        "DeviceID":"7",
        "ThresholdExists":7,
        "ThresholdSeverity":"critical",
        "ThresholdData":[
            [
                "Metric Thresholds",
                "Critical",
                2
            ],
            [
                "Count",
                7,
                2
            ],
            [
                "Critical",
                4
            ],
            [
                "Warning",
                2
            ],
            [
                "Normal",
                1,
                2
            ]
        ],
        "LoadingStates":false
    }
]

Nested Schema : deviceNavigationDevicesReadStatesThresholds

Type: object

Show Source

• DeviceID: integer
  Device ID

  Example: 40
• LoadingStates: boolean
  Loading States

  Example: false
• ThresholdData: array ThresholdData
  Summary accounting information of violated thresholds status.
• ThresholdExists: boolean
  Threshold Exists

  Example: true
• ThresholdSeverity: string
  The highest severity status of violated metric thresholds. Possible values: "normal", "minor", "critical", "not configured"

  Example: normal

{
    "properties":{
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"40"
        },
        "ThresholdExists":{
            "description":"Threshold Exists",
            "type":"boolean",
            "example":true
        },
        "ThresholdSeverity":{
            "description":"The highest severity status of violated metric thresholds. \n\nPossible values: \"normal\", \"minor\", \"critical\", \"not configured\"",
            "type":"string",
            "example":"normal"
        },
        "ThresholdData":{
            "description":"Summary accounting information of violated thresholds status.",
            "type":"array",
            "items":{
            },
            "example":[
                "Metric Thresholds",
                "Normal",
                2
            ]
        },
        "LoadingStates":{
            "description":"Loading States",
            "type":"boolean",
            "example":false
        }
    },
    "type":"object"
}

Nested Schema : ThresholdData

Type: array

Summary accounting information of violated thresholds status.

Show Source

• Array of:

{
    "description":"Summary accounting information of violated thresholds status.",
    "type":"array",
    "items":{
    },
    "example":[
        "Metric Thresholds",
        "Normal",
        2
    ]
}

Example:

[
    "Metric Thresholds",
    "Normal",
    2
]

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