Get Metric Widget Status
post
/api/diagram/Widgets/readMetricStatus
Gets the metric status for the list of diagram widgets.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
Widgets: array
Widgets
The list of metric widgets with metric parameters.
-
WidgetType: string
The type of metric value to get. Specifying MetricGraph calls the /api/metric/PerformanceData endpoint and returns a graph series. Specifying any other value calls the /api/metric/PerformanceData/readSummary endpoint and returns the threshold status.Example:
MetricGraph
Nested Schema : Widgets
Type:
arrayThe list of metric widgets with metric parameters.
Show Source
Example:
[
{
"WidgetID":"Widget_1-510",
"DeviceName":"device.example.com",
"DeviceZoneName":null,
"DeviceZoneID":null,
"MetricTypeName":"CPU Utilization",
"InstanceName":"Device",
"TimeRange":"now-24h..now",
"ThresholdTypeID":"1",
"MetricField":"undefined",
"WarningThresholdName":"",
"CriticalThresholdName":""
}
]Nested Schema : items
Type:
Show Source
object-
CriticalThresholdName: string
The Critical threshold name.Example:
-
DeviceName: string
The name of an associated device name, if any.Example:
device.example.com -
DeviceZoneID: integer
Device zone ID, if any.Example:
1 -
DeviceZoneName: string
Device Zone name, if any.Example:
Device1 -
InstanceName: string
Name of the instance.Example:
Device -
MetricField: string
The string of the metric that is collected.Example:
undefined -
MetricTypeName: string
Name of the metric type.Example:
CPU Utilization -
ThresholdTypeID: integer
The threshold Type ID.Example:
1 -
TimeRange: string
The time Range.Example:
now-24h..now -
WarningThresholdName: string
The warning threshold name.Example:
-
WidgetID: integer
The Widget ID.Example:
Widget_1-497
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
objectThe response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added record -
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
The status of the metric widget.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : items
Type:
Show Source
object-
Abbr: string
The unit abbreviation.Example:
% -
AverageAvailability: integer
The average availability.Example:
1 -
AverageUtilization: integer
The average (mean) utilization.Example:
28.159722222222232 -
AverageValue: integer
The average (mean) value.Example:
28.15972222222222 -
CriticalThreshold:
Example:
-
Factor: integer
The factor to change units into raw.Example:
1 -
InstanceName: string
The metric instance Name corresponding to MetricInstances.InstanceName.Example:
Device -
LastAvailability: integer
The last availability.Example:
1 -
LastUtilization: integer
The last utilization.Example:
31 -
LastValue: integer
The last value reported.Example:
31 -
Maximum: integer
Metric Maximum (0 for no max)Example:
100 -
MaximumAvailability: integer
The maximum availability.Example:
1 -
MaximumUtilization: integer
The maximum utilization.Example:
51 -
MaximumValue: integer
The maximum value.Example:
51 -
Measurement: string
The measurement or multiple, comma-separated measurements.Example:
metrictype_CPU_Utilization -
MetricInstanceName: string
The metric display (custom) instance name.Example:
Device -
MetricTypeName: string
The metric type name corresponding to MetricTypes.MetricTypeName.Example:
CPU Utilization -
MinimumAvailability: integer
The minimum availability.Example:
1 -
MinimumUtilization: integer
The minimum utilization.Example:
23 -
MinimumValue: integer
The minimum value.Example:
23 -
PollTime: integer
The metric collection interval (used for display only).Example:
300 -
SumValue: integer
The sum of value (over polltime). Not valid for all metrics.Example:
N/A -
Unit: string
The Value unit.Example:
Percent Utilization -
UnitDivision: integer
The unit division factor.Example:
0 -
WarningThreshold:
Example:
-
WidgetID: integer
The Widget ID.Example:
Widget_1-497
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:
arrayThe list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
objectAn error.