Create a Metric Display Instance
post
/api/metric/DisplayInstances
Creates a metric display instance.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceName: string
Device name the new display instance is associated with.
-
DeviceZoneName: string
Device zone name the new display instane is associated with
-
InstanceID: integer
Instance IDExample:
543
-
MetricDisplayInstanceName: string
Custom display nameExample:
1 Minute Average
-
SourceDeviceName: string
Source device name
-
SourceDeviceZoneName: string
Source device zone name
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
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
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricDisplayInstancesRead
Type:
Show Source
object
-
DeviceID: integer
Device IDExample:
1
-
DeviceName: string
Device NameExample:
router.example.com
-
DeviceZoneName: string
Device zone name.Example:
Default First Zone
-
InstanceID: integer
Instance IDExample:
543
-
InstanceName: string
Instance NameExample:
Load-1
-
MetricDisplayInstanceID: integer
Metric DisplayInstance IDExample:
35
-
MetricDisplayInstanceName: string
Custom display nameExample:
1 Minute Average
-
SourceDeviceID: integer
Source Device IDExample:
1
-
SourceDeviceName: string
Source Device NameExample:
router.example.com
-
SourceDeviceZoneName: string
Source device zone name.
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