Jump to

• Request
• Response

Create Metrics for Polling Assignments

post

/api/metric/PollingAssignments

Creates metrics that are needed for polling to start working within some applications.

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

• Instances: string
  Comma-separated list of Instances formatted as DeviceID:InstanceID

  Example: [ "765:0", "773:0" ]
• MethodID: integer
  Method ID

  Example: 1
• PollerTemplateID: integer
  Poller Template ID

  Example: 8
• PollTime: integer
  PollTime

  Example: 300
• ThresholdGroupID: integer
  Threshold Group ID

  Example: 5

{
    "properties":{
        "MethodID":{
            "description":"Method ID",
            "type":"integer",
            "example":1
        },
        "PollerTemplateID":{
            "description":"Poller Template ID",
            "type":"integer",
            "example":8
        },
        "ThresholdGroupID":{
            "description":"Threshold Group ID",
            "type":"integer",
            "example":5
        },
        "PollTime":{
            "description":"PollTime",
            "type":"integer",
            "example":300
        },
        "Instances":{
            "description":"Comma-separated list of Instances formatted as DeviceID:InstanceID",
            "type":"string",
            "example":[
                "765:0",
                "773:0"
            ]
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

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

{
    "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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of:

{
    "type":"array",
    "items":{
    }
}

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":{
                "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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top