Jump to

• Request
• Response

Update Device State ID

post

/api/device/DeviceManagement/updateDiscovery

Updates the state ID of devices to force rediscovery on the next SNMP run. At minimum, either the DeviceGroupID or Devices property is required in the request body.

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

• DeviceGroupID: integer
  The ID of the device group containing the devices whose state IDs are to be updated. Either Devices or DeviceGroupID parameter is required.
• Devices: integer
  The comma-separated list of device IDs whose state IDs are to be updated. Either Devices or DeviceGroupID parameter is required.
• RecursiveGroup: boolean
  Whether the state IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).

{
    "type":"object",
    "properties":{
        "Devices":{
            "description":"The comma-separated list of device IDs whose state IDs are to be updated. Either Devices or DeviceGroupID parameter is required.",
            "type":"integer"
        },
        "DeviceGroupID":{
            "description":"The ID of the device group containing the devices whose state IDs are to be updated. Either Devices or DeviceGroupID parameter is required.",
            "type":"integer"
        },
        "RecursiveGroup":{
            "description":"Whether the state IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update 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":"Updated record"
        }
    },
    "type":"object"
}

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