Skip to main content
Skip table of contents

Getting all devices

Request

To get a list of all devices that are registered with DMM, send a GET request to:

http://<host>:<port>/mib/v1/devices

Headers

  • Content-Type: application/json

Optional parameters

  • limit – the number of records to return
  • page – the page number to return (cannot be used without limit)
    For example:
    • ?limit=10 returns the first 10 records.
    • ?limit=10&page=2 returns the second 10 records.
  • offset – the number of records to skip
  • filter – filters the output. A filter consists of one or more key/value pairs.
    For example,
    • ?filter={"active":true}
    • ?filter={"active":true, "deviceOS":"ANDROID7_TABLET"}
  • sort – sorts the output. The sort expression consists of one or more key/value pairs, where the key is the name of the field to sort on, and the value is the order: 1 for ascending, -1 for descending.
    For example:
    • ?sort="userId,1"
    • ?sort="userId,1,deviceId,1"
  • fields – the fields to include in the output.
    For example:
    • ?fields="topicName,description"

Response

A successful request returns an HTTP 200 status.

An unsuccessful request returns an HTTP 404 status.

A successful request generates a response that looks like this:

CODE
{
    "totalRecords": 2,
    "devices": [
        {
            "deviceId": "5c402613ae0b890001b486e5",
            "active": true,
            "deviceOS": "ANDROID7_TABLET",
            "userId": "EUT24",
            "queueRegistrations": [
                {
                    "enabled": true,
                    "queueApplicationName": "RMQ",
                    "queueRegistrationId": "5c402613ae0b890001b486e5"
                }
            ],
            "topics": [
                "GlobalTopicForAllDevices"
            ]
        },
        {
            "deviceId": "5c6506c564656900017963c6",
            "active": true,
            "deviceOS": "ANDROID7_TABLET",
            "userId": "EUT24",
            "queueRegistrations": [
                {
                    "enabled": true,
                    "lastRegistrationDate": "2019-04-30T11:07:52.935Z",
                    "queueApplicationName": "RMQ",
                    "queueRegistrationId": "5c10ab8154f4a900018a54f1-EUT24-5c6506c564656900017963c6"
                }
            ],
            "topics": [
                "GlobalTopicForAllDevices"
            ]
        }
    ]
}

See also

For full details of this API, see the DMM API documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.