REST API for Unified Assurance Core

Get Availability Data for a Device Group

get

/api/metric/DeviceGroupAvailabilityData

Gets the availability data for the specified device group.

Request

Query Parameters

DeviceGroup(required): string
The device group to get availability for.
Example:
```
//Root//Oracle Lab -  test
```
DisableNavigation(required): boolean
Whether a user can click a navigation folder to load the group's parent or children (0) or not (1). If navigation is disabled (1), all information about child folders and the "Go up" link are removed from the result set.
Example:
```
0
```
StartTime: string
The start time.
Example:
```
now - 24h
```
StopTime: string
The stop time.
Example:
```
now
```
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for StartTime and StopTime.
Example:
```
now-24h..now
```
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

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

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

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

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

{
    "description":"The response body for a successful get 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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data
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",
            "items":{
                "$ref":"#/components/schemas/metricDeviceGroupAvailabilityDataRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object metricDeviceGroupAvailabilityDataRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricDeviceGroupAvailabilityDataRead"
    }
}

Nested Schema : metricDeviceGroupAvailabilityDataRead

Type: object

Show Source

Availability: string

Availability of device

Example: 8.19%
Depth: integer

Example: 0
DeviceZoneID: integer

Device Zone ID

Example: 1
DeviceZoneName: string

Device Zone name.

Example: Default First Zone
ID: integer

Device ID

Example: 1
Name: string

Device Name

Example: Go Up To: Root
OrderPriority: integer

Order Priority

Example: 1
StateIcon: string

State Icon

Example: /resources/assure1/images/OrbYellowDown.png
Type: string

Type

Example: Group
Type_ID: string

Type with device ID

Example: Group_1
TypeIcon: string

Type Icon

Example: /resources/assure1/images/icons/fugue/arrow-curve-090.png

{
    "properties":{
        "OrderPriority":{
            "description":"Order Priority",
            "type":"integer",
            "example":"1"
        },
        "Type":{
            "description":"Type",
            "type":"string",
            "example":"Group"
        },
        "TypeIcon":{
            "description":"Type Icon",
            "type":"string",
            "example":"/resources/assure1/images/icons/fugue/arrow-curve-090.png"
        },
        "StateIcon":{
            "description":"State Icon",
            "type":"string",
            "example":"/resources/assure1/images/OrbYellowDown.png"
        },
        "ID":{
            "description":"Device ID",
            "type":"integer",
            "example":"1"
        },
        "Name":{
            "description":"Device Name",
            "type":"string",
            "example":"Go Up To: Root"
        },
        "DeviceZoneID":{
            "description":"Device Zone ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"Device Zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "Availability":{
            "description":"Availability of device",
            "type":"string",
            "example":"8.19%"
        },
        "Depth":{
            "type":"integer",
            "example":"0"
        },
        "Type_ID":{
            "description":"Type with device ID",
            "type":"string",
            "example":"Group_1"
        }
    },
    "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.