Update a Metric Group
put
/api/metric/MetricGroups/{id}
Updates the metric group that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the metric group to update.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
MetricGroupName: string
Metric Group Name for displaying metrics togetherExample:
Device Health
-
MetricTypes: array
MetricTypes
Metric Types in group
-
Stacked: integer
Stacked determines if graphed group metrics are stacked or not | Allowed Values: | 0 => Not Stacked | 1 => StackedExample:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated 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
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricMetricGroupsRead
Type:
Show Source
object
-
MetricGroupID: integer
Metric Group IDExample:
6
-
MetricGroupName: string
Metric Group Name for displaying metrics togetherExample:
Device Health
-
MetricTypes: array
MetricTypes
Metric Types in group
-
Stacked: integer
Stacked determines if graphed group metrics are stacked or not Allowed Values: - 0 => Not Stacked - 1 => StackedExample:
0
-
TypeCount: integer
Number of metric types in the groupExample:
9
Nested Schema : items
Type:
Show Source
object
-
MetricTypeID: integer
Metric Type IDExample:
61
-
MetricTypeName: string
Metric Type NameExample:
Packet Loss
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