Jump to

• Request
• Response

Add a Metric Group

post

/api/metric/MetricGroups

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

• MetricGroupName
• Stacked
• MetricTypes

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

• MetricGroupName: string
  The metric group name for displaying metrics together.
  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: Device Health
• MetricTypes: array MetricTypes
  Metric Types in group
• Stacked: integer
  Whether graphed grouped metrics are stacked (1) or not (0).

  Example: 0

{
    "properties":{
        "MetricGroupName":{
            "description":"The metric group name for displaying metrics together.\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":"Device Health"
        },
        "Stacked":{
            "description":"Whether graphed grouped metrics are stacked (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "MetricTypes":{
            "description":"Metric Types in group",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                61
            ]
        }
    },
    "type":"object"
}

Nested Schema : MetricTypes

Type: array

Metric Types in group

Show Source

• Array of: integer

{
    "description":"Metric Types in group",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        61
    ]
}

Example:

[
    61
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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",
                    "items":{
                        "$ref":"#/components/schemas/metricMetricGroupsRead"
                    }
                }
            }
        }
    ]
}

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
• 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/metricMetricGroupsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricMetricGroupsRead

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

Nested Schema : metricMetricGroupsRead

Type: object

Show Source

• MetricGroupID: integer
  Metric Group ID

  Example: 6
• MetricGroupName: string
  Metric Group Name for displaying metrics together

  Example: Device Health
• MetricTypes: array MetricTypes
  Metric Types in group
• Stacked: integer
  Whether graphed grouped metrics are stacked (1) or not (0).

  Example: 0
• TypeCount: integer
  Number of metric types in the group

  Example: 9

{
    "properties":{
        "MetricGroupID":{
            "description":"Metric Group ID",
            "type":"integer",
            "example":"6"
        },
        "MetricGroupName":{
            "description":"Metric Group Name for displaying metrics together",
            "type":"string",
            "example":"Device Health"
        },
        "Stacked":{
            "description":"Whether graphed grouped metrics are stacked (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "TypeCount":{
            "description":"Number of metric types in the group",
            "type":"integer",
            "example":"9"
        },
        "MetricTypes":{
            "description":"Metric Types in group",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "MetricTypeID":{
                        "description":"Metric Type ID",
                        "type":"integer",
                        "example":61
                    },
                    "MetricTypeName":{
                        "description":"Metric Type Name",
                        "type":"string",
                        "example":"Packet Loss"
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : MetricTypes

Type: array

Metric Types in group

Show Source

• Array of: object items

{
    "description":"Metric Types in group",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "MetricTypeID":{
                "description":"Metric Type ID",
                "type":"integer",
                "example":61
            },
            "MetricTypeName":{
                "description":"Metric Type Name",
                "type":"string",
                "example":"Packet Loss"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• MetricTypeID: integer
  Metric Type ID

  Example: 61
• MetricTypeName: string
  Metric Type Name

  Example: Packet Loss

{
    "type":"object",
    "properties":{
        "MetricTypeID":{
            "description":"Metric Type ID",
            "type":"integer",
            "example":61
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Packet Loss"
        }
    }
}

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