Jump to

• Request
• Response

Add a Device

post

/api/device/Devices

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

• CustomName: string
  Device Custom Name
• DevicePriorityID: integer
  Device Priority ID
• DeviceSNMPAccessID: integer
  SNMP Access Profile ID
• DeviceStateID: integer
  Allowed Values: [ 0, 1, 2, 3, 101, 102 ]

  Device State ID - `0` => New - `1` => Non-discoverable - `2` => Verified (Discovered) - `3` => Discovered (Fully) - `101` => Static (Disabled) - `102` => Virtual (non-device)
• DeviceTypeCategoryID: integer
  Device Type Category ID
• DeviceZoneID: integer
  Device Zone ID
• DNSName: string
  Device DNS Name
• GeoLocation: string
  GeoJSON Point of device location (lon, lat)
• InitialDeviceGroupID: integer
  Initial Device Group ID
• IPv4: string
  IP Address (v4)
• IPv6: string
  IP Address (v6) - hex notation
• MetaData: array MetaData
  MetaData object definitions for device (DeviceMetaTypeID, MetaData)
• ParentDeviceID: integer
  DeviceID of Parent for Virtual Devices
• ShardID: integer
  Shard ID of Device

{
    "properties":{
        "DNSName":{
            "description":"Device DNS Name",
            "type":"string"
        },
        "DeviceStateID":{
            "description":"Device State ID\n\n- `0`   => New\n- `1`   => Non-discoverable\n- `2`   => Verified (Discovered)\n- `3`   => Discovered (Fully)\n- `101` => Static (Disabled)\n- `102` => Virtual (non-device)",
            "type":"integer",
            "enum":[
                0,
                1,
                2,
                3,
                101,
                102
            ]
        },
        "IPv4":{
            "description":"IP Address (v4)",
            "type":"string"
        },
        "IPv6":{
            "description":"IP Address (v6) - hex notation",
            "type":"string"
        },
        "DevicePriorityID":{
            "description":"Device Priority ID",
            "type":"integer"
        },
        "CustomName":{
            "description":"Device Custom Name",
            "type":"string"
        },
        "DeviceZoneID":{
            "description":"Device Zone ID",
            "type":"integer"
        },
        "DeviceTypeCategoryID":{
            "description":"Device Type Category ID",
            "type":"integer"
        },
        "InitialDeviceGroupID":{
            "description":"Initial Device Group ID",
            "type":"integer"
        },
        "DeviceSNMPAccessID":{
            "description":"SNMP Access Profile ID",
            "type":"integer"
        },
        "ParentDeviceID":{
            "description":"DeviceID of Parent for Virtual Devices",
            "type":"integer"
        },
        "GeoLocation":{
            "description":"GeoJSON Point of device location (lon, lat)",
            "type":"string"
        },
        "MetaData":{
            "description":"MetaData object definitions for device (DeviceMetaTypeID, MetaData)",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "ShardID":{
            "description":"Shard ID of Device",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : MetaData

Type: array

MetaData object definitions for device (DeviceMetaTypeID, MetaData)

Show Source

• Array of: object items

{
    "description":"MetaData object definitions for device (DeviceMetaTypeID, MetaData)",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top

Response

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• message: string
  Response message in text

  Example: Added record
• success: boolean
  Success or failure response

  Example: true

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Added record"
        }
    },
    "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