Jump to

• Request
• Response

Update a Metric Display Instance

put

/api/metric/DisplayInstances/{id}

Updates the metric display instance that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The ID of the display instance to update.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeviceName: string
  Serialized device name the new display instance is associated with.

  Example: router.example.com;z1 OR router.example.com
• DeviceZoneID: integer
  Database ID of the device zone the new display instance is associated with. Deprecated. Use serialized device name instead. Specify either DeviceZoneName or DeviceZoneID.
• DeviceZoneName: string
  Device zone name the new display instance is associated with. Deprecated. Use serialized device name instead. Specify either DeviceZoneName or DeviceZoneID.
• InstanceID: integer
  Instance ID

  Example: 543
• MetricDisplayInstanceName: string
  The custom display name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: 1 Minute Average
• SourceDeviceName: string
  Source device name
• SourceDeviceZoneID: integer
  Database ID of the source device zone. Deprecated. Use serialized device name instead. Specify either SourceDeviceZoneName or SourceDeviceZoneID.
• SourceDeviceZoneName: string
  Source device zone name. Deprecated. Use serialized device name instead. Specify either SourceDeviceZoneName or SourceDeviceZoneID.

{
    "properties":{
        "DeviceName":{
            "description":"Serialized device name the new display instance is associated with.",
            "type":"string",
            "example":"router.example.com;z1 OR router.example.com"
        },
        "DeviceZoneName":{
            "description":"Device zone name the new display instance is associated with. <em>Deprecated</em>. Use serialized device name instead. Specify either <b>DeviceZoneName</b> or <b>DeviceZoneID</b>.",
            "type":"string"
        },
        "DeviceZoneID":{
            "description":"Database ID of the device zone the new display instance is associated with. <em>Deprecated</em>. Use serialized device name instead. Specify either <b>DeviceZoneName</b> or <b>DeviceZoneID</b>.",
            "type":"integer"
        },
        "MetricDisplayInstanceName":{
            "description":"The custom display name.\n <br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "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. <em>Deprecated</em>. Use serialized device name instead. Specify either <b>SourceDeviceZoneName</b> or <b>SourceDeviceZoneID</b>.",
            "type":"string"
        },
        "SourceDeviceZoneID":{
            "description":"Database ID of the source device zone. <em>Deprecated</em>. Use serialized device name instead. Specify either <b>SourceDeviceZoneName</b> or <b>SourceDeviceZoneID</b>.",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "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 : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "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":"Updated 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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top