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(required): string
The start time.Example:
now - 24h
-
StopTime(required): string
The stop time.Example:
now
-
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for Start and StopTime.Example:
now-24h..now
-
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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricDeviceGroupAvailabilityDataRead
Type:
Show Source
object
-
Availability: string
Availability of deviceExample:
8.19%
-
Depth: integer
Example:
0
-
DeviceZoneID: integer
Device Zone IDExample:
1
-
DeviceZoneName: string
Device Zone name.Example:
Default First Zone
-
ID: integer
Device IDExample:
1
-
Name: string
Device NameExample:
Go Up To: Root
-
OrderPriority: integer
Order PriorityExample:
1
-
StateIcon: string
State IconExample:
/resources/assure1/images/OrbYellowDown.png
-
Type: string
TypeExample:
Group
-
Type_ID: string
Type with device IDExample:
Group_1
-
TypeIcon: string
Type IconExample:
/resources/assure1/images/icons/fugue/arrow-curve-090.png
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object