Jump to

• Request
• Response

Update a Metric

put

/api/metric/Metrics/{id}

Updates the properties of the specified metric.

Request

Path Parameters

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

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CustomMaximum: number
  Metric Custom Maximum to override auto maximum
• DeviceName: string
  The serialized device name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used. The name is followed by the zone ID.

  Example: device.example.com;z1 OR device.example.com
• DeviceZoneName: string
  The zone the device is assigned to. Deprecated. Use serialized device name instead.

  Example: Default First Zone
• Factor: integer
  Factor

  Example: 1
• InstanceID: integer
  ID of Instance from Assure1.metricInstances

  Example: 0
• Maximum: integer
  Maximum

  Example: 100
• MethodID: integer
  ID from Assure1.MetricMethods

  Example: 0
• MetricTypeID: integer
  ID of Metric Type from Assure1.MetricTypes

  Example: 63
• PollTime: integer
  Metric collection interval (used for display only)

  Example: 300
• ShardID: integer
  ID of the shard the metric resides on

  Example: 1
• StatusID: integer
  The metric status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• Thresholds: array Thresholds
  A collection of assigned thresholds.

{
    "properties":{
        "DeviceName":{
            "description":"The serialized device name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used. The name is followed by the zone ID.",
            "type":"string",
            "example":"device.example.com;z1 OR device.example.com"
        },
        "DeviceZoneName":{
            "description":"The zone the device is assigned to. <em>Deprecated</em>. Use serialized device name instead.",
            "type":"string",
            "example":"Default First Zone"
        },
        "InstanceID":{
            "description":"ID of Instance from Assure1.metricInstances",
            "type":"integer",
            "example":"0"
        },
        "MetricTypeID":{
            "description":"ID of Metric Type from Assure1.MetricTypes",
            "type":"integer",
            "example":"63"
        },
        "ShardID":{
            "description":"ID of the shard the metric resides on",
            "type":"integer",
            "example":"1"
        },
        "Factor":{
            "description":"Factor",
            "type":"integer",
            "example":"1"
        },
        "Maximum":{
            "description":"Maximum",
            "type":"integer",
            "example":"100"
        },
        "CustomMaximum":{
            "description":"Metric Custom Maximum to override auto maximum",
            "type":"number"
        },
        "PollTime":{
            "description":"Metric collection interval (used for display only)",
            "type":"integer",
            "example":"300"
        },
        "MethodID":{
            "description":"ID from Assure1.MetricMethods",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"The metric status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "Thresholds":{
            "description":"A collection of assigned thresholds.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                19
            ]
        }
    },
    "type":"object"
}

Nested Schema : Thresholds

Type: array

A collection of assigned thresholds.

Show Source

• Array of: integer

{
    "description":"A collection of assigned thresholds.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        19
    ]
}

Example:

[
    19
]

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/metricMetricsPut"
                    }
                }
            }
        }
    ]
}

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/metricMetricsPut"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricMetricsPut

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

Nested Schema : metricMetricsPut

Type: object

Show Source

• CustomMaximum: number
  Metric Custom Maximum to override auto maximum
• DeviceID: integer
  ID of Device from Assure1.Devices

  Example: 1599
• Factor: integer
  Factor

  Example: 1
• InstanceID: integer
  ID of Instance from Assure1.metricInstances

  Example: 0
• Maximum: integer
  Maximum

  Example: 100
• MethodID: integer
  ID from Assure1.MetricMethods

  Example: 0
• MetricTypeID: integer
  ID of Metric Type from Assure1.MetricTypes

  Example: 63
• PollTime: integer
  Metric collection interval (used for display only)

  Example: 300
• ShardID: integer
  ID of the shard the metric resides on

  Example: 1
• StateID: integer
  Metric Status | Allowed Values: | 0 => Disabled | 1 => Enabled

  Example: 1

{
    "properties":{
        "MetricTypeID":{
            "description":"ID of Metric Type from Assure1.MetricTypes",
            "type":"integer",
            "example":"63"
        },
        "DeviceID":{
            "description":"ID of Device from Assure1.Devices",
            "type":"integer",
            "example":"1599"
        },
        "InstanceID":{
            "description":"ID of Instance from Assure1.metricInstances",
            "type":"integer",
            "example":"0"
        },
        "ShardID":{
            "description":"ID of the shard the metric resides on",
            "type":"integer",
            "example":"1"
        },
        "StateID":{
            "description":"Metric Status\n| Allowed Values:\n|  0 => Disabled\n|  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "Maximum":{
            "description":"Maximum",
            "type":"integer",
            "example":"100"
        },
        "CustomMaximum":{
            "description":"Metric Custom Maximum to override auto maximum",
            "type":"number"
        },
        "Factor":{
            "description":"Factor",
            "type":"integer",
            "example":"1"
        },
        "MethodID":{
            "description":"ID from Assure1.MetricMethods",
            "type":"integer",
            "example":"0"
        },
        "PollTime":{
            "description":"Metric collection interval (used for display only)",
            "type":"integer",
            "example":"300"
        }
    }
}

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