Jump to

• Request
• Response

Create a Metric Collection

post

/api/metric/Collections

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

• CollectionName
• Metrics
• TabOrder
• 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

• CollectionDescription: string
  Collection Description

  Example: Description of collection
• CollectionName: string
  The collection 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: Example_Collection
• Metrics: array Metrics
  Array of metrics included in the collection.

{
    "properties":{
        "CollectionName":{
            "description":"The collection 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":"Example_Collection"
        },
        "CollectionDescription":{
            "description":"Collection Description",
            "type":"string",
            "example":"Description of collection"
        },
        "Metrics":{
            "description":"Array of metrics included in the collection.",
            "type":"array",
            "items":{
            },
            "example":[
                49009
            ]
        }
    },
    "type":"object"
}

Nested Schema : Metrics

Type: array

Array of metrics included in the collection.

Show Source

• Array of:

{
    "description":"Array of metrics included in the collection.",
    "type":"array",
    "items":{
    },
    "example":[
        49009
    ]
}

Example:

[
    49009
]

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object metricCollectionsRead

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

Nested Schema : metricCollectionsRead

Type: object

Show Source

• CollectionDescription: string
  Collection Description

  Example: Description of Collection
• CollectionID: integer
  Collection ID

  Example: 35
• CollectionMetricCount: integer
  Collection Metric Count

  Example: 4
• CollectionName: string
  Collection Name

  Example: Example_Collection
• Metrics: array Metrics
  Array of metrics included in the collection.

{
    "properties":{
        "CollectionID":{
            "description":"Collection ID",
            "type":"integer",
            "example":"35"
        },
        "CollectionName":{
            "description":"Collection Name",
            "type":"string",
            "example":"Example_Collection"
        },
        "CollectionDescription":{
            "description":"Collection Description",
            "type":"string",
            "example":"Description of Collection"
        },
        "CollectionMetricCount":{
            "description":"Collection Metric Count",
            "type":"integer",
            "example":"4"
        },
        "Metrics":{
            "description":"Array of metrics included in the collection.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "MetricID":{
                        "description":"Metric ID",
                        "type":"integer",
                        "example":49009
                    },
                    "DeviceName":{
                        "description":"Device Name",
                        "type":"string",
                        "example":"router.example.com"
                    },
                    "InstanceName":{
                        "description":"Instance Name",
                        "type":"string",
                        "example":"ens3"
                    },
                    "MetricTypeName":{
                        "description":"Metric Type Name",
                        "type":"string",
                        "example":"Interface Outbound Bandwidth\""
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : Metrics

Type: array

Array of metrics included in the collection.

Show Source

• Array of: object items

{
    "description":"Array of metrics included in the collection.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "MetricID":{
                "description":"Metric ID",
                "type":"integer",
                "example":49009
            },
            "DeviceName":{
                "description":"Device Name",
                "type":"string",
                "example":"router.example.com"
            },
            "InstanceName":{
                "description":"Instance Name",
                "type":"string",
                "example":"ens3"
            },
            "MetricTypeName":{
                "description":"Metric Type Name",
                "type":"string",
                "example":"Interface Outbound Bandwidth\""
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• DeviceName: string
  Device Name

  Example: router.example.com
• InstanceName: string
  Instance Name

  Example: ens3
• MetricID: integer
  Metric ID

  Example: 49009
• MetricTypeName: string
  Metric Type Name

  Example: Interface Outbound Bandwidth"

{
    "type":"object",
    "properties":{
        "MetricID":{
            "description":"Metric ID",
            "type":"integer",
            "example":49009
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"ens3"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Interface Outbound Bandwidth\""
        }
    }
}

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