REST API for Unified Assurance Core

Get Polling Policies

get

/api/metric/PollingPolicies

Gets the polling policies that match the specified query parameters. If no parameters are specified, all polling policies 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 polling policies that match the specified query parameters.",
                    "items":{
                        "$ref":"#/components/schemas/metricPollingPoliciesRead"
                    }
                }
            }
        }
    ]
}

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 polling policies 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 polling policies that match the specified query parameters.",
            "items":{
                "$ref":"#/components/schemas/metricPollingPoliciesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The polling policies that match the specified query parameters.

Show Source

Array of: object metricPollingPoliciesRead

{
    "type":"array",
    "description":"The polling policies that match the specified query parameters.",
    "items":{
        "$ref":"#/components/schemas/metricPollingPoliciesRead"
    }
}

Nested Schema : metricPollingPoliciesRead

Type: object

Show Source

Category: string

Category

Example: Any
CIDR: integer

CIDR |Allowed Values: |0 => Disabled |1 => Enabled

Example: 1
CIDRDisplayName: string

A descriptive label for the CIDR flag. Allowed Values are "Disabled" and "Enabled"

Example: Disabled
DeviceDisplayName: string

Device Display Name

Example: Any
DeviceMetaTypeID: integer

Device MetaType ID

Example: 0
DeviceMetaTypeName: string

Device MetaType Name

Example: ADBaseDN
DeviceName: string

Device Name

Example: router.example.com
DeviceNameMatchTypeID: integer

The operator to match device names. Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

Example: 0
DeviceType: string

Device Type

Example: Any
DeviceTypeCategoryID: integer

Device Type Category ID

Example: 0
DeviceTypeMatchTypeID: integer

Device Type Match Type Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

Example: 0
InstanceDisplayName: string

Instance Display Name

Example: LIKE/ens3/
InstanceName: string

Instance Name

Example: ens3
InstanceNameMatchTypeID: integer

The operator to match instance names. Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

Example: 0
InstanceTypeID: integer

Instance Type ID

Example: 1
InstanceTypeName: string

Instance Type Name

Example: SNMP Interface
IPRange: string

IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)

Example:
IPRangeDisplayName: string

IP Range Display Name. It will be the same as IP Range unless IP Range is blank. Then the display name will be "Any".

Example: Any
MetaData: string

MetaData

Example:
MetaDataDisplay: string

The meta data operator and value unless the value is blank. then the display will be "Any".

Example: Any
MetaDataMatchTypeID: integer

Meta Data Match Type Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXP

Example: 0
MethodID: integer

MethodID |Allowed Values: |0 => NA |1 => SNMP |2 => WMI |3 => Other |5 => Transaction

Example: 1
MethodName: string

Method Name

Example: SNMP
PolicyDescription: string

Policy Description

Example:
PolicyID: integer

Policy ID

Example: 5
PolicyName: string

Policy Name

Example: Configure Network Interface Polling - ens3
PollerTemplateID: integer

Poller Template ID

Example: 3
PollTime: integer

PollTime in seconds

Example: 300
StatusIcon: string

Status Icon

Example: OrbGreen.png
StatusID: boolean

The metric policy status ID. Either 0 (disabled) or 1 (enabled).

Example: 1
StatusName: string

Status Name

Example: Enabled
SysObjectID: integer

The device type ID to match

Example: NONE
TemplateName: string

Template Name

Example: Default Network Interface
ThresholdGroupID: integer

Threshold Group ID

Example: 3
ThresholdGroupName: string

Threshold Group Name

Example: Default Network Interface

{
    "properties":{
        "PolicyID":{
            "description":"Policy ID",
            "type":"integer",
            "example":"5"
        },
        "PolicyName":{
            "description":"Policy Name",
            "type":"string",
            "example":"Configure Network Interface Polling - ens3"
        },
        "StatusID":{
            "description":"The metric policy status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"boolean",
            "example":"1"
        },
        "StatusName":{
            "description":"Status Name",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "PolicyDescription":{
            "description":"Policy Description",
            "type":"string",
            "example":""
        },
        "PollTime":{
            "description":"PollTime in seconds",
            "type":"integer",
            "example":"300"
        },
        "IPRange":{
            "description":"IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)",
            "type":"string",
            "example":""
        },
        "IPRangeDisplayName":{
            "description":"IP Range Display Name. It will be the same as IP Range unless IP Range is blank. Then the display name will be \"Any\".",
            "type":"string",
            "example":"Any"
        },
        "CIDR":{
            "description":"CIDR\n|Allowed Values:\n|0 => Disabled\n|1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "CIDRDisplayName":{
            "description":"A descriptive label for the CIDR flag. Allowed Values are \"Disabled\" and \"Enabled\"",
            "type":"string",
            "example":"Disabled"
        },
        "DeviceNameMatchTypeID":{
            "description":"The operator to match device names. \n\nAllowed Values: \n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "InstanceNameMatchTypeID":{
            "description":"The operator to match instance names.\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "InstanceTypeID":{
            "description":"Instance Type ID",
            "type":"integer",
            "example":"1"
        },
        "InstanceTypeName":{
            "description":"Instance Type Name",
            "type":"string",
            "example":"SNMP Interface"
        },
        "MetaData":{
            "description":"MetaData",
            "type":"string",
            "example":""
        },
        "DeviceTypeCategoryID":{
            "description":"Device Type Category ID",
            "type":"integer",
            "example":"0"
        },
        "SysObjectID":{
            "description":"The device type ID to match",
            "type":"integer",
            "example":"NONE"
        },
        "PollerTemplateID":{
            "description":"Poller Template ID",
            "type":"integer",
            "example":"3"
        },
        "TemplateName":{
            "description":"Template Name",
            "type":"string",
            "example":"Default Network Interface"
        },
        "ThresholdGroupID":{
            "description":"Threshold Group ID",
            "type":"integer",
            "example":"3"
        },
        "ThresholdGroupName":{
            "description":"Threshold Group Name",
            "type":"string",
            "example":"Default Network Interface"
        },
        "MethodID":{
            "description":"MethodID\n|Allowed Values:\n|0 => NA\n|1 => SNMP\n|2 => WMI\n|3 => Other\n|5 => Transaction",
            "type":"integer",
            "example":"1"
        },
        "MethodName":{
            "description":"Method Name",
            "type":"string",
            "example":"SNMP"
        },
        "Category":{
            "description":"Category",
            "type":"string",
            "example":"Any"
        },
        "DeviceMetaTypeID":{
            "description":"Device MetaType ID",
            "type":"integer",
            "example":"0"
        },
        "DeviceMetaTypeName":{
            "description":"Device MetaType Name",
            "type":"string",
            "example":"ADBaseDN"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceDisplayName":{
            "description":"Device Display Name",
            "type":"string",
            "example":"Any"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"ens3"
        },
        "InstanceDisplayName":{
            "description":"Instance Display Name",
            "type":"string",
            "example":"LIKE/ens3/"
        },
        "MetaDataMatchTypeID":{
            "description":"Meta Data Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "MetaDataDisplay":{
            "description":"The meta data operator and value unless the value is blank. then the display will be \"Any\".",
            "type":"string",
            "example":"Any"
        },
        "DeviceTypeMatchTypeID":{
            "description":"Device Type Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP",
            "type":"integer",
            "example":"0"
        },
        "DeviceType":{
            "description":"Device Type",
            "type":"string",
            "example":"Any"
        }
    },
    "type":"object"
}

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.