Jump to

• Request
• Response

Show Devices for Comboboxes and ItemSelectors

get

/api/device/Devices/readForSelect

Request

Query Parameters

• filter: object
  Filter results by most fields (note: Some fields contain state and cannot be filtered)
• limit: integer(int32)
  Number of records to limit results
• query: string
  Query search string (primative filter)
• sort: object
  Sort results by field and direction (note: Some fields contain state and cannot be sorted)
• start: integer(int32)
  Page of results to start from

  Default Value: 1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
  Record(s)
• message: string
  Response message in text

  Example: Loaded 1 entries
• success: boolean
  Success or failure response

  Example: true
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Loaded 1 entries"
        },
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"Record(s)",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceDevicesReadForSelect"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

Record(s)

Show Source

• Array of: object deviceDevicesReadForSelect

{
    "description":"Record(s)",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceDevicesReadForSelect"
    }
}

Nested Schema : deviceDevicesReadForSelect

Type: object

Match All

Show Source

• object deviceDevicesReadForSelect-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "properties":{
                "DeviceID":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/DeviceID"
                },
                "DeviceName":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/DeviceName"
                },
                "IPAddress":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/IPv4"
                },
                "IPv6Address":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/IPv6"
                },
                "ParentDeviceID":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/ParentDeviceID"
                },
                "DNSName":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/DNSName"
                },
                "CustomName":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/CustomName"
                },
                "SysName":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/SysName"
                },
                "GeoLocation":{
                    "$ref":"#/components/schemas/deviceDevicesRead/properties/GeoLocation"
                }
            },
            "type":"object"
        }
    ]
}

Nested Schema : deviceDevicesReadForSelect-allOf[0]

Type: object

Show Source

• CustomName: string
  Custom Name

  Example: Custom Nice Name
• DeviceID: integer
  Device ID

  Example: 1
• DeviceName: string
  Device Name (auto created in order or precidence from CustomName > DNSName > SysName > IPv6Address > IPAddress)

  Example: router.example.com
• DNSName: string
  DNS Name

  Example: router1.example.com
• GeoLocation: string
  GeoJSON Point of device location (lon, lat)

  Example: {"type": "Point", "coordinates": [0, 0]}
• IPAddress: string
  IP Address (v4)

  Example: 192.0.2.1
• IPv6Address: string
  IP Address (v6) - hex notation

  Example: 2001:DB8::1
• ParentDeviceID: integer
  DeviceID of Parent for Virtual Devices

  Example: 0
• SysName: string
  SNMP System Name

  Example: EXAMPLE-ROUTER

{
    "properties":{
        "DeviceID":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/DeviceID"
        },
        "DeviceName":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/DeviceName"
        },
        "IPAddress":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/IPv4"
        },
        "IPv6Address":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/IPv6"
        },
        "ParentDeviceID":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/ParentDeviceID"
        },
        "DNSName":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/DNSName"
        },
        "CustomName":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/CustomName"
        },
        "SysName":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/SysName"
        },
        "GeoLocation":{
            "$ref":"#/components/schemas/deviceDevicesRead/properties/GeoLocation"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  List of errors reported. Validation errors will be keyed by record field.
• message: string
  Response message in text

  Example: Exception thrown
• success: boolean
  Success or failure response

  Example: false

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"List of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

List of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

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