Update a Metric Category
put
/api/metric/Categories/{id}
Updates the metric category that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the metric DDO category to update.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
MetricDDOCategoryName: string
Category IDExample:
Health
-
MetricDDOCategoryPath: string
Path to the DDO or custom viewExample:
#metric/allMetrics/index?DeviceID=<DeviceID>&TimeRange=now-24h..now&MetricSource=All
-
MetricTypes: array
MetricTypes
Metric types included in this category
-
TabOrder: integer
The tab order index for the specific categoryExample:
1
Nested Schema : items
Type:
Show Source
object
-
Measurement: string
MeasurementExample:
metrictype_Memory_Used
-
MetricTypeID: integer
Metric Type IDExample:
22
-
MetricTypeName: string
MetricTypeNameExample:
Memory Used
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 : metricCategoriesRead
Type:
Show Source
object
-
MetricDDOCategoryID: integer
Category ID.Example:
1
-
MetricDDOCategoryName: string
Category nameExample:
Health
-
MetricDDOCategoryPath: string
Path to the DDO or custom viewExample:
#metric/allMetrics/index?DeviceID=<DeviceID>&TimeRange=now-24h..now&MetricSource=All
-
MetricTypes: array
MetricTypes
Metric types included in this category
-
TabOrder: integer
The tab order index for the specific categoryExample:
1
Nested Schema : items
Type:
Show Source
object
-
MetricTypeID: integer
Metric Type IDExample:
22
-
MetricTypeName: string
MetricTypeNameExample:
Memory Used
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