REST API for Unified Assurance Core

Create a Metric Threshold Group

post

/api/metric/ThresholdGroups

Creates a metric threshold group.
The minimum required properties in the request body are:

ThresholdGroupName
Thresholds

Request

There are no request parameters for this operation.

Supported Media Types

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
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulAddOperation

The response body for a successful add operation.
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",
                    "description":"The new metric threshold group.",
                    "items":{
                        "$ref":"#/components/schemas/metricThresholdGroupsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

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

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

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

Nested Schema : data

Type: array

The new metric threshold group.

Show Source

Array of: object metricThresholdGroupsRead

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

Nested Schema : metricThresholdGroupsRead

Type: object

Show Source

MeasurementList: string

Measurement List

Example: metrictype_Latency metrictype_Packet_Loss metrictype_Ping_Jitter metrictype_Ping_Jitter_Utilization
MetricTypeNameList: string

Metric TypeName List

Example: Latency Packet Loss Ping Jitter 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

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.