REST API for Unified Assurance Core

Get Device Availability Details

get

/api/deviceNavigation/Devices/readStatesAvailability

Get availability details about the devices specified in DeviceID to indicate if they have been up or down recently.

Request

Query Parameters

DeviceID(required): string
The comma-separated list of device IDs.
Example:
```
40,10,109,7
```
limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```
start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: object

Show Source

data: array data
message: string

The response message.

Example: Retrieved Availability 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 Availability States"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesAvailability"
            },
            "example":[
                {
                    "DeviceID":"40",
                    "AvailabilityExists":true,
                    "AvailabilitySeverity":"unknown",
                    "Availability":null,
                    "LoadingStates":false
                },
                {
                    "DeviceID":"10",
                    "AvailabilityExists":true,
                    "AvailabilitySeverity":"unknown",
                    "Availability":null,
                    "LoadingStates":false
                },
                {
                    "DeviceID":"109",
                    "AvailabilityExists":true,
                    "AvailabilitySeverity":"normal",
                    "Availability":"100.00",
                    "LoadingStates":false
                },
                {
                    "DeviceID":"7",
                    "AvailabilityExists":true,
                    "AvailabilitySeverity":"normal",
                    "Availability":"100.00",
                    "LoadingStates":false
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object deviceNavigationDevicesReadStatesAvailability

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesAvailability"
    },
    "example":[
        {
            "DeviceID":"40",
            "AvailabilityExists":true,
            "AvailabilitySeverity":"unknown",
            "Availability":null,
            "LoadingStates":false
        },
        {
            "DeviceID":"10",
            "AvailabilityExists":true,
            "AvailabilitySeverity":"unknown",
            "Availability":null,
            "LoadingStates":false
        },
        {
            "DeviceID":"109",
            "AvailabilityExists":true,
            "AvailabilitySeverity":"normal",
            "Availability":"100.00",
            "LoadingStates":false
        },
        {
            "DeviceID":"7",
            "AvailabilityExists":true,
            "AvailabilitySeverity":"normal",
            "Availability":"100.00",
            "LoadingStates":false
        }
    ]
}

Example:

[
    {
        "DeviceID":"40",
        "AvailabilityExists":true,
        "AvailabilitySeverity":"unknown",
        "Availability":null,
        "LoadingStates":false
    },
    {
        "DeviceID":"10",
        "AvailabilityExists":true,
        "AvailabilitySeverity":"unknown",
        "Availability":null,
        "LoadingStates":false
    },
    {
        "DeviceID":"109",
        "AvailabilityExists":true,
        "AvailabilitySeverity":"normal",
        "Availability":"100.00",
        "LoadingStates":false
    },
    {
        "DeviceID":"7",
        "AvailabilityExists":true,
        "AvailabilitySeverity":"normal",
        "Availability":"100.00",
        "LoadingStates":false
    }
]

Nested Schema : deviceNavigationDevicesReadStatesAvailability

Type: object

Show Source

Availability: number

The average availability value ranges between 0 and 100.

Example: 100.00
AvailabilityExists: boolean

Whether availability exists (true) or not (false).

Example: true
AvailabilitySeverity: string
The average availability status values. The possible values are:
- normal: 100%
- critical: 0%
- warning: less than 100 and more than 0
- notConfigured: no metric values.
Example: normal
DeviceID: integer

The device ID.

Example: 40
LoadingStates: boolean

Whether states are loading (true) or not (false).

Example: false

{
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer",
            "example":"40"
        },
        "AvailabilityExists":{
            "description":"Whether availability exists (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":true
        },
        "AvailabilitySeverity":{
            "description":"The average availability status values. \n\nThe possible values are: \n<ul><li><b>normal</b>: 100%</li>\n<li><b>critical</b>: 0%</li>\n<li><b>warning</b>: less than 100 and more than 0</li>\n<li><b>notConfigured</b>: no metric values.</li></ul>",
            "type":"string",
            "example":"normal"
        },
        "Availability":{
            "description":"The average availability value ranges between 0 and 100.",
            "type":"number",
            "example":"100.00"
        },
        "LoadingStates":{
            "description":"Whether states are loading (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":false
        }
    },
    "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":{
                "description":"An error.",
                "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

An error.

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

Nested Schema : items

Type: object

An error.