REST API for Unified Assurance Core

Get Poller Templates

get

/api/metric/PollerTemplates

Gets the poller templates that match the specified query parameters. If no parameters are specified, all poller templates are returned.

Request

Query Parameters

filter: object

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{ "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "description":"The poller templates that match the specified query parameters.",
                    "items":{
                        "$ref":"#/components/schemas/metricPollerTemplatesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful get 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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The poller templates that match the specified query parameters.
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 poller templates that match the specified query parameters.",
            "items":{
                "$ref":"#/components/schemas/metricPollerTemplatesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The poller templates that match the specified query parameters.

Show Source

Array of: object metricPollerTemplatesRead

{
    "type":"array",
    "description":"The poller templates that match the specified query parameters.",
    "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

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.