How can we help?

Searching:

0 results found

Devices/Get (List)

GET /odata/Devices

Description

Gets a list of all the Devices assigned to the specified application.

To get the details of a specific Device, refer to Devices/Get (Specific).

See the following for request and response details ‒

See Also

Request ‒ Devices/Get (List)

Property Type Description Mandatory
appId String A unique Application identifier that is automatically generated by Axonize when the Applications/Post request is used. Y

Example JSON Devices/Get (List) Request

curl -X GET \

  https://api.stg.axonize.com/odata/devices \

    -H ‘Authorization: Token’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \

Response ‒ Devices/Get (List)

For each Device, the response provides the properties in Devices/Post. In addition, the response that is returned also contains the following properties.

Property Type Description

Mandatory

alarmInstances Array of Objects The list of AlarmInstance IDs active on the device.
alarmInstance/_id String The AlarmInstance ID.
alarmInstance/name String Not in use.
isHub Boolean Specifies whether the device is a gateway (True) or not.
settings/lastSync DateTime The last timestamp when a reading was received from the Device.
settings/reportedValue String The value received from the updated physical Device by the Axonize Device SDK as the updatedValue, after it has been updated. This value should be the same as the desiredValue (described above).
isAlarmed Boolean True if an alarm is currently active in the Axonize System for this Device.

AlarmInstances can be dismissed in the Axonize Portal or using the Axonize Device API.

lastReadingTime Date The time that the last reading was received by the Axonize Server from the Device.
lastReadings An Array of Readings This is the event sent by the Device. This property comprises the following properties.
lastReadings/type Integer The type of this event is defined in the Event Manifest. For example, an event whose type equals 7 represents a temperature event.
lastReadings/datetime Date The timestamp of the event as inserted in the event by the Device. This date includes the time zone of the Device.

Note ‒ The Device can enter any date/time, not necessarily the exact time that the event occurred.

lastReadings/name String The name of the event.
lastReadings/value String The value of the reading. For example, the temperature.
lastReadings/unit String The unit of the reading. For example, whether the temperature is Celsius or Fahrenheit.
lastReadings/deviceId String The unique identifier of the specific Device.
isConnected Boolean Indicates the Device’s connectivity status to the Axonize Server. True indicates that the Device responded to the most recent keepAlive ping by the Axonize Server.

Each Device’s Product has a keepAlive field that indicates the frequency at which the Devices of this Product are checked for connectivity.

In addition, each Device can also have an optional keepAliveThreshold, which specifies the frequency at which this specific Device is checked for connectivity. A value in this field overrides the keepAlive field of the Device’s Product.

additionalProperties Not in use.
token Not in use.
parseReading Not in use.
diagram Not in use.
enableDirectMethod Not in use.
alarmInstancesCount Int Specify the number of active alarm instances on the device

Example JSON Devices/Get (List) Response

Status 200 ‒ OK

{

    “@odata.context”: “http://stg-axonizeapi-axonize.stg-ase-axonize.p.azurewebsites.net/odata/$metadata#Devices”,

    “value”: [

        {

   “productId”: “58564ddd66701d07a838fc48”,

            “productName”: null,

            “serialNumber”: “123456”,

            “topic”: null,

            “groupId”: null,

            “active”: false,

            “firstTimeRegistrationDate”: “0001-01-01T00:00:00Z”,

            “activationDate”: “0001-01-01T00:00:00Z”,

            “token”: null,

            “commandsProtocol”: “Undefined”,

            “lastReadingTime”: “0001-01-01T00:00:00Z”,

            “isConnected”: false,

            “hubId”: null,

            “hubPrimaryKey”: “9hH+rsEQTHw64jS3sum5ZfMeN4F3DNcg7uA4YUULfzA=”,

            “hubSecondaryKey”: “NVKWYAIbcpoJ0vJ+TfyBU8CY8fN5R+mfjkPCIVyODLA=”,

            “customId”: “FMS6320-1”,

            “keepAliveThreshold”: 0,

            “isAlarmed”: false,

            “virtualDeviceStatus”: “NotAvailable”,

            “virtualDeviceEvents”: null,

            “redisKey”: null,

            “diagram”: null,

            “streamUrl”: null,

            “parentId”: null,

            “name”: “new name1”,

            “id”: “58c6898fb88c391588c91b2d”,

            “appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E'”,

            “createDate”: “2017-03-13T11:59:11.61Z”,

            “createUser”: “5851631e4e41925b98f08e15”,

            “updateDate”: “0001-01-01T00:00:00Z”,

            “updateUser”: null,

            “lastReadings”: [],

            “additionalProperties”: [],

            “userDefinedLocation”: null,

            “currentLocation”: null,

            “coords”: null,

            “ancestors”: []

}

]

}