Jump to

• Request
• Response

Create a Poller Template

post

/api/metric/PollerTemplates

Creates a poller template.
The minimum required properties in the request body are:

• TemplateName
• 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

• MetricTypes: array MetricTypes
  Metric Types to be included in the template
• TemplateName: string
  The poller template 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

{
    "properties":{
        "TemplateName":{
            "description":"The poller template 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"
        },
        "MetricTypes":{
            "description":"Metric Types to be included in the template",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                60,
                61,
                62,
                63
            ]
        }
    },
    "type":"object"
}

Nested Schema : MetricTypes

Type: array

Metric Types to be included in the template

Show Source

• Array of: integer

{
    "description":"Metric Types to be included in the template",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        60,
        61,
        62,
        63
    ]
}

Example:

[
    60,
    61,
    62,
    63
]

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",
                    "description":"The new poller template.",
                    "items":{
                        "$ref":"#/components/schemas/metricPollerTemplatesRead"
                    }
                }
            }
        }
    ]
}

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 poller template.
• 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 poller template.",
            "items":{
                "$ref":"#/components/schemas/metricPollerTemplatesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The new poller template.

Show Source

• Array of: object metricPollerTemplatesRead

{
    "type":"array",
    "description":"The new poller template.",
    "items":{
        "$ref":"#/components/schemas/metricPollerTemplatesRead"
    }
}

Nested Schema : metricPollerTemplatesRead

Type: object

Show Source

• MetricTypeList: string
  Metric Type List

  Example: Latency <br>Packet Loss <br>Ping Jitter <br>Ping Jitter Utilization
• MetricTypes: array MetricTypes
  Metric Types to be included in the template
• TemplateID: integer
  Template ID

  Example: 1
• TemplateName: string
  Poller Template Name

  Example: Default Ping

{
    "properties":{
        "TemplateID":{
            "description":"Template ID",
            "type":"integer",
            "example":"1"
        },
        "TemplateName":{
            "description":"Poller Template Name",
            "type":"string",
            "example":"Default Ping"
        },
        "MetricTypeList":{
            "description":"Metric Type List",
            "type":"string",
            "example":"Latency\n<br>Packet Loss\n<br>Ping Jitter\n<br>Ping Jitter Utilization"
        },
        "MetricTypes":{
            "description":"Metric Types to be included in the template",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "MetricTypeID":{
                        "description":"Metric Type ID",
                        "type":"integer",
                        "example":60
                    },
                    "MetricTypeName":{
                        "description":"Metric Type Name",
                        "type":"string",
                        "example":"Latency"
                    }
                }
            },
            "example":[
                {
                    "MetricTypeID":60,
                    "MetricTypeName":"Latency"
                },
                {
                    "MetricTypeID":61,
                    "MetricTypeName":"Packet Loss"
                },
                {
                    "MetricTypeID":62,
                    "MetricTypeName":"Ping Jitter"
                },
                {
                    "MetricTypeID":63,
                    "MetricTypeName":"Ping Jitter Utilization"
                }
            ]
        }
    },
    "type":"object"
}

Nested Schema : MetricTypes

Type: array

Metric Types to be included in the template

Show Source

• Array of: object items

{
    "description":"Metric Types to be included in the template",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "MetricTypeID":{
                "description":"Metric Type ID",
                "type":"integer",
                "example":60
            },
            "MetricTypeName":{
                "description":"Metric Type Name",
                "type":"string",
                "example":"Latency"
            }
        }
    },
    "example":[
        {
            "MetricTypeID":60,
            "MetricTypeName":"Latency"
        },
        {
            "MetricTypeID":61,
            "MetricTypeName":"Packet Loss"
        },
        {
            "MetricTypeID":62,
            "MetricTypeName":"Ping Jitter"
        },
        {
            "MetricTypeID":63,
            "MetricTypeName":"Ping Jitter Utilization"
        }
    ]
}

Example:

[
    {
        "MetricTypeID":60,
        "MetricTypeName":"Latency"
    },
    {
        "MetricTypeID":61,
        "MetricTypeName":"Packet Loss"
    },
    {
        "MetricTypeID":62,
        "MetricTypeName":"Ping Jitter"
    },
    {
        "MetricTypeID":63,
        "MetricTypeName":"Ping Jitter Utilization"
    }
]

Nested Schema : items

Type: object

Show Source

• MetricTypeID: integer
  Metric Type ID

  Example: 60
• MetricTypeName: string
  Metric Type Name

  Example: Latency

{
    "type":"object",
    "properties":{
        "MetricTypeID":{
            "description":"Metric Type ID",
            "type":"integer",
            "example":60
        },
        "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