Update a Metric Collection
put
/api/metric/Collections/{id}
Updates the metric collection that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the metric collection to update.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CollectionDescription: string
Collection DescriptionExample:
-
CollectionName: string
Collection NameExample:
Example_Collection
-
Metrics: array
Metrics
Array of metrics included in the collection.
Nested Schema : Metrics
Type:
array
Array of metrics included in the collection.
Show Source
Example:
[
49009
]
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 : metricCollectionsRead
Type:
Show Source
object
-
CollectionDescription: string
Collection DescriptionExample:
Description of Collection
-
CollectionID: integer
Collection IDExample:
35
-
CollectionMetricCount: integer
Collection Metric CountExample:
4
-
CollectionName: string
Collection NameExample:
Example_Collection
-
Metrics: array
Metrics
Array of metrics included in the collection.
Nested Schema : items
Type:
Show Source
object
-
DeviceName: string
Device NameExample:
router.example.com
-
InstanceName: string
Instance NameExample:
ens3
-
MetricID: integer
Metric IDExample:
49009
-
MetricTypeName: string
Metric Type NameExample:
Interface Outbound Bandwidth"
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