Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 ID

  Example: 543
• MetricDisplayInstanceName: string
  Custom display name

  Example: 1 Minute Average
• SourceDeviceName: string
  Source device name
• SourceDeviceZoneName: string
  Source device zone name

{
    "properties":{
        "DeviceName":{
            "description":"Device name the new display instance is associated with.",
            "type":"string"
        },
        "DeviceZoneName":{
            "description":"Device zone name the new display instane is associated with",
            "type":"string"
        },
        "MetricDisplayInstanceName":{
            "description":"Custom display name",
            "type":"string",
            "example":"1 Minute Average"
        },
        "InstanceID":{
            "description":"Instance ID",
            "type":"integer",
            "example":"543"
        },
        "SourceDeviceName":{
            "description":"Source device name",
            "type":"string"
        },
        "SourceDeviceZoneName":{
            "description":"Source device zone name",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricDisplayInstancesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricDisplayInstancesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricDisplayInstancesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricDisplayInstancesRead"
    }
}

Nested Schema : metricDisplayInstancesRead

Type: object

Show Source

• DeviceID: integer
  Device ID

  Example: 1
• DeviceName: string
  Device Name

  Example: router.example.com
• DeviceZoneName: string
  Device zone name.

  Example: Default First Zone
• InstanceID: integer
  Instance ID

  Example: 543
• InstanceName: string
  Instance Name

  Example: Load-1
• MetricDisplayInstanceID: integer
  Metric DisplayInstance ID

  Example: 35
• MetricDisplayInstanceName: string
  Custom display name

  Example: 1 Minute Average
• SourceDeviceID: integer
  Source Device ID

  Example: 1
• SourceDeviceName: string
  Source Device Name

  Example: router.example.com
• SourceDeviceZoneName: string
  Source device zone name.

{
    "properties":{
        "InstanceID":{
            "description":"Instance ID",
            "type":"integer",
            "example":"543"
        },
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceZoneName":{
            "description":"Device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "SourceDeviceZoneName":{
            "description":"Source device zone name.",
            "type":"string"
        },
        "MetricDisplayInstanceID":{
            "description":"Metric DisplayInstance ID",
            "type":"integer",
            "example":"35"
        },
        "MetricDisplayInstanceName":{
            "description":"Custom display name",
            "type":"string",
            "example":"1 Minute Average"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"Load-1"
        },
        "SourceDeviceID":{
            "description":"Source Device ID",
            "type":"integer",
            "example":"1"
        },
        "SourceDeviceName":{
            "description":"Source Device Name",
            "type":"string",
            "example":"router.example.com"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top