Managed Devices

• offset

  Is used to specify the start index of requested managed devices list. It takes an integer value.
  The default value is 0.

• limit

  Is used to specify the no of requested managed devices list. It takes an integer value.
  The default value is 100. The maximum value is 1000.

• sortby

  Is used to sort requested managed devices list by column. The default value is boxid.

• ascending

  Is used to sort requested managed devices list in a specified order. By default, the sort is descending.
  It takes a boolean value.

• filter

  Is used to filter the results. Click Filter to view details of how filters need to be specified in the URL.
  For possible names of property attribute, datatypes, applicable values and whether the results can be sorted based on the parameter click Manage Device Filter

• populateplatformsettings

  A boolean value represents whether to populate platform settings of device or not.

• boxid

  Is used to specify the client box ID. It takes an integer value. The default value is -1. It is a mandatory field.
  To retrieve the value for boxid refer Managed Device call.

• fromtime

  Is used to specify the start time in epoch format. It takes an integer value. The default value is -1.

• totime

  Is used to specify end time in epoch format. It takes an integer value. The default value is – 1.

• type

  Is used to specify the type of performance trend that is required. It takes a string value.
  Possible values are aptraffic and apdatarate. It is a mandatory field.

• ssid

  Is used to specify the list of SSIDs for which the results should be returned. It takes a string value.
  To retrieve the value for SSID refer Get SSIDs Configured on a Managed Device call.

• frequencyband

  Is used to filter the data for the provided frequency band. It takes a string value. Possible values
  are 2.4, 5 and ANY. The default value is ANY.

• time

  Time in milliseconds. It is an integer value. Sample value, 14803236.

• fromvalue

  If type=aptraffic, then the number of bytes transferred in KB.
  If type=apdatarate, then uplink data rate in Kbps. It is an integer value. Sample value, 674.

• tovalue

  If type=aptraffic, then the number of bytes received in KB.
  If type=apdatarate, then downlink data rate in Kbps. It is an integer value.
  Sample value, 532.

• totalvalue

  The total number of bytes transferred and received, or the total data rate. It is an integer value.
  Sample value, 1206.

• totalCount

  The number of data points. It is an integer value. Sample value, 45213.

A sample response is as follows:

{
   "samples":[{
      "time": 1480311900,
      "fromvalue": 0,
      "tovalue": 0,
      "totalvalue": 0
   },
      . . .
	  . . .
	  . . .

   {
      "time": 1480323600,
      "fromvalue": 674,
      "tovalue": 532,
      "totalvalue": 1206
   }],
   "totalCount": 45213
}

• groupby

  Is used to specify the field for the group by. It takes a string value. The applicable values
  are devicename, activestatus, macaddress, ipaddress, capability, model, locationid, timefilter,
  devicetemplate, tag, troubleshooting, quarantinestatus, apmode, upgradestatus,
  configurationstatus, sensortype, meshflag, failsafemode, and powersource.

• group/<groupby value>

  Group by field provided as URL parameter. It is a string value.

• count

  The total number of devices matching the group by criteria. It is an integer value.

• totalCount

  The total number of devices across each group. It is an integer value.

A sample response is as follows:

{
   "samples": [{
      "group": {
         "model": "C-60"
      },
      "count": 1
  },
  {
      "group": {
         "model": "C-75"
      },
      "count": 2
  }],
  "totalCount": 3
}

• devicecategory

  Is used to specify the category of the managed device. It is a mandatory
  field. Possible values are ROUGE, EXTERNAL, UNCATEGORIZED, AUTHORIZED and MANAGED_AP.

• ssid

  Is used to specify a list of SSIDs for which the results should be returned. It takes a string
  value. To retrieve the value for SSID refer Get SSIDs Configured on a Managed Device call.

• fromtime

  Is used to specify the start time in epoch format. It takes an integer value. The default value is -1.

• totime

  Is used to specify end time in epoch format. It takes an integer value. The default value is -1.

• protocol

  Is used to specify the protocol to filter data. It takes a string value. Possible values are A, B, and BG.

• type

  Is used to specify the type of performance trend that is required. It takes String value.
  Possible values are activeapcounthistory, apdatatransferhistory, apassociationhistory, aperrorrate,
  clienttraffic, clientdatarate, apassociation, and clientretransmissionrate. It is a mandatory field.

• boxid

  Is used to specify the client box ID. It takes an integer value. The default value is -1.
  It is a mandatory field. To retrieve the value for boxid refer Managed devices call.

• frequencyband

  Is used to filter the data for the provided frequency band. Possible values are 2.4, 5 and ANY.
  It takes a string value. The default value is ANY.

• value

  Value of the requested trend type. It is an integer value. Sample value, 125986.

• time

  Time in milliseconds. It is an integer value. Sample value, 1480311900.

• totalCount

  No of data points. It is an integer value. Sample value, 1328842.

A sample response is as follows:

{
   "samples":[{
      "value": 125986,
      "time": 1490956200
   },
      . . .
      . . .
      . . .
   {
      "value": 67256,
      "time": 1490959800
   }],
   "totalCount": 1328842
}

• limit

  Is used to specify the number of records to return. It takes an integer value. The default value is 10.

• sortby

  Is used to specify the performance value to sort the data on. It takes a string value.
  Possible values are networktraffic and associations. The default value is networktraffic.

• ascending

  Is set true to sort records in ascending order. It takes a boolean value. The default value is false.

• frequencyband

  Is used to specify filter records of a frequency band. It takes a string value. Possible values are
  BAND_2_4_GHZ, BAND_5_GHZ and ANY. The default value is ANY.

• fromtime

  Is used to specify the start time in epoch format. It takes an integer value. The default value is -1

• totime

  Is used to specify end time in epoch format. It takes an integer value. The default value is -1.

• ssid

  Is used to specify the list of SSIDs for which the results should be returned. It takes a string value.
  To retrieve the value for SSID refer Get SSIDs Configured on a Managed Device call.

• boxid

  Is used to specify the managed device box ID. It takes an integer value. To retrieve the value for boxid
  refer Managed devices call. It is a mandatory parameter.

• isthirdradiosupported

  Is used to filter the devices supporting third radio. It takes a boolean value.

• ismeshenabled

  A true and false value indicates that whether the device is working in mesh mode or not. It takes a boolean value.

• istroubleshootingoff

  Is used to filter the devices on which troubleshooting is ON or OFF. It takes a boolean value.

• boxId

  The system-generated ID of the device. It is an integer value.

• macAddress

  MAC address of the device. It is a string value.

• name

  Name of the device. It is a string value.

• signalStrength

  The signal strength of an observing device. It is an integer value.

• signalVariance

  The signal variance of an observing device. It is an integer value.

• channel2_4Ghz

  Channel number of 2.4Ghz radio. It is an integer value.

• channel5Ghz

  Channel number of 5Ghz radio. It is an integer value.

• numClients2_4Ghz

  The number of clients on the 2.4Ghz radio. It is an integer value.

• numClients5Ghz

  The number of clients on the 5Ghz radio. It is an integer value.

• locationId

  Location identifier for the device. The value is of the type LocationID JSON.

A sample response is as follows:

[{
   "boxId": 892,
   "macAddress": "00:11:74:D4:59:9F",
   "name": "Mojo_D4:59:9F",
   "signalStrength": -33,
   "signalVariance": 0,
   "channel2_4Ghz": 0,
   "channel5Ghz": 0,
   "numClients2_4Ghz": 0,
   "numClients5Ghz": 0,
   "locationId":
      {
         "type": "locallocationid",
         "id": 2
      }
}]

• manageddeviceboxid

  Is used to specify Box ID of the managed device for which the SSIDs have to be fetched.
  If not specified SSIDs configured across all managed devices are returned. It takes an
  integer value.

[
   "WebAppsDev",
   "phi_test",
   "WebAppsDev-a"
]

• offset

  Is used to specify the start index of requested managed devices list. It takes an integer value.
  The default value is 0.

• limit

  Is used to specify the no of requested managed devices list. It takes an integer value.
  The default value is 100. The maximum value is 1000.

• retaintemplate

  A boolean value represents whether to retain the current device template when
  change location action is performed.

• unplacedeviceforlocationchange

  A boolean value indicates that before changing the location, the device is to be unplaced or not.

• boxid

  It is used to specify the device box ID. It takes an integer value. It is a mandatory field.
  To retrieve the value for box Id refer Managed Devices call.

• locationId

  A group of attributes representing the location to be changed. For complete details about the JSON, click Location ID. To retrieve the value for location Id refer Managed Devices call.

A sample request body is as follows:

{
	"manualDeviceUpdateBoxIdWithLocationId":[{
	"boxid": 35,
	"locationId":
	{
		"type": "locallocationid",
		"id": -1
	}
	}],
	"argument":
	{
		"type": "location",
		"locationId":
		{
			"type": "locallocationid",
			"id": 0
		}
	}
}

• locationid

  Location identifier for the managed device. The value is of the type LocationID JSON.

• nodeid

  Is used to specify child node id if the location belongs to the child server.
  It takes an integer value and is an optional parameter.

• fields

  Specifies the attribute to be modified. It takes String value and is a mandatory parameter.

• retaintemplate

  A boolean value represents whether to retain the current device template when
  change location action is performed.

• unplacedeviceforlocationchange

  A boolean value indicates that before changing the location, the device is to be unplaced or not.

{
            "boxId": 1,
            "locationId": {
                "type": "locallocationid",
                "id": 0
            },
            "macaddress": "88:DC:96:69:E8:71"
       }

• retaintemplate

  A boolean value represents whether to retain current device template when change location
  action is performed.

{
    "boxIds":
    [
      2
    ],
    "argument":
	{
      "type": "devicecustomization",
      "customDeviceTemplate":
	  {
         "macAddress": "00:11:74:8C:00:EF",
         "customRadioSettings": 
		 [{
            "enableCustomTxPower": true,
            "customTxPower": 25,
            "transmitPowerConfigured": true,
            "operatingModeConfigured": true,
            "autoChannelSelectionInterval": 600
         }]
      },
      "perDeviceSettings":
	  {
         "macAddress": "00:11:74:8C:00:EF",
         "vlanEnabled": true,
         "vlansToBeMonitored": 2,
         "communicationVLAN": "2"
      }
   }
}

{
   "manualDeviceUpdateBoxIdWithLocationId":
    [{
         "boxid": 35,
         "locationId":
        {
         "type": "locallocationid",
         "id": -1
        }
    }]
}

{
   "manualDeviceUpdateBoxIdWithLocationId":
    [{
        "boxid": 36,
        "locationId":
        {
           "type": "locallocationid",
           "id": -1
        }
   }]
}

{
   "manualDeviceUpdateBoxIdWithLocationId":
   [{
         "boxid": 36,
         "locationId":{
         "type": "locallocationid",
         "id": -1
      }
   }]
}

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

• macaddress

  Macaddress of the managed WiFi device to be deleted. It takes a string value. It is a mandatory field.

• placedsensors

  A boolean value representing whether the managed devices placed on the floor should be deleted or not.
  If set to true it will allow deleting the managed device. If set to false it will return an error on the actions.