Jump to

• Request
• Response

Update a Metric Threshold Group

put

/api/metric/ThresholdGroups/{id}

Updates the metric threshold group that matches the specified ID.

Request

Path Parameters

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

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ThresholdGroupName: string
  The threshold group 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: Default Ping
• Thresholds: array Thresholds
  Threshold IDs

{
    "properties":{
        "ThresholdGroupName":{
            "description":"The threshold group 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":"Default Ping"
        },
        "Thresholds":{
            "description":"Threshold IDs",
            "type":"array",
            "items":{
            },
            "example":[
                1
            ]
        }
    },
    "type":"object"
}

Nested Schema : Thresholds

Type: array

Threshold IDs

Show Source

• Array of:

{
    "description":"Threshold IDs",
    "type":"array",
    "items":{
    },
    "example":[
        1
    ]
}

Example:

[
    1
]

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",
                    "description":"The updated metric threshold group.",
                    "items":{
                        "$ref":"#/components/schemas/metricThresholdGroupsRead"
                    }
                }
            }
        }
    ]
}

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
  The updated metric threshold group.
• 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",
            "description":"The updated metric threshold group.",
            "items":{
                "$ref":"#/components/schemas/metricThresholdGroupsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The updated metric threshold group.

Show Source

• Array of: object metricThresholdGroupsRead

{
    "type":"array",
    "description":"The updated metric threshold group.",
    "items":{
        "$ref":"#/components/schemas/metricThresholdGroupsRead"
    }
}

Nested Schema : metricThresholdGroupsRead

Type: object

Show Source

• MeasurementList: string
  Measurement List

  Example: metrictype_Latency <br>metrictype_Packet_Loss <br>metrictype_Ping_Jitter <br>metrictype_Ping_Jitter_Utilization
• MetricTypeNameList: string
  Metric TypeName List

  Example: Latency <br>Packet Loss <br>Ping Jitter <br>Ping Jitter Utilization
• ThresholdCount: integer
  Threshold Count

  Example: 5
• ThresholdGroupID: integer
  Threshold Group ID

  Example: 1
• ThresholdGroupName: string
  Threshold Group Name

  Example: Default Ping
• Thresholds: array Thresholds
  Threshold IDs

{
    "properties":{
        "ThresholdGroupID":{
            "description":"Threshold Group ID",
            "type":"integer",
            "example":"1"
        },
        "ThresholdGroupName":{
            "description":"Threshold Group Name",
            "type":"string",
            "example":"Default Ping"
        },
        "ThresholdCount":{
            "description":"Threshold Count",
            "type":"integer",
            "example":"5"
        },
        "MeasurementList":{
            "description":"Measurement List",
            "type":"string",
            "example":"metrictype_Latency\n<br>metrictype_Packet_Loss\n<br>metrictype_Ping_Jitter\n<br>metrictype_Ping_Jitter_Utilization"
        },
        "MetricTypeNameList":{
            "description":"Metric TypeName List",
            "type":"string",
            "example":"Latency\n<br>Packet Loss\n<br>Ping Jitter\n<br>Ping Jitter Utilization"
        },
        "Thresholds":{
            "description":"Threshold IDs",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Measurement":{
                        "description":"Measurement",
                        "type":"string",
                        "example":"metrictype_Latency"
                    },
                    "ThresholdID":{
                        "description":"Threshold ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "ThresholdName":{
                        "description":"Threshold Name",
                        "type":"string",
                        "example":"Device Down"
                    },
                    "MetricTypeName":{
                        "description":"Metric Type Name",
                        "type":"string",
                        "example":"Latency"
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : Thresholds

Type: array

Threshold IDs

Show Source

• Array of: object items

{
    "description":"Threshold IDs",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Measurement":{
                "description":"Measurement",
                "type":"string",
                "example":"metrictype_Latency"
            },
            "ThresholdID":{
                "description":"Threshold ID",
                "type":"integer",
                "example":"1"
            },
            "ThresholdName":{
                "description":"Threshold Name",
                "type":"string",
                "example":"Device Down"
            },
            "MetricTypeName":{
                "description":"Metric Type Name",
                "type":"string",
                "example":"Latency"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Measurement: string
  Measurement

  Example: metrictype_Latency
• MetricTypeName: string
  Metric Type Name

  Example: Latency
• ThresholdID: integer
  Threshold ID

  Example: 1
• ThresholdName: string
  Threshold Name

  Example: Device Down

{
    "type":"object",
    "properties":{
        "Measurement":{
            "description":"Measurement",
            "type":"string",
            "example":"metrictype_Latency"
        },
        "ThresholdID":{
            "description":"Threshold ID",
            "type":"integer",
            "example":"1"
        },
        "ThresholdName":{
            "description":"Threshold Name",
            "type":"string",
            "example":"Device Down"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Latency"
        }
    }
}

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