LIST Devices

GET 
/workspaces/:workspaceId/devices

LIST Devices

Request

Path Parameters

workspaceId uuidrequired

Query Parameters

deviceCategory string
deviceIdPrefix string
deviceIdContains string
continuationToken string
top int32

Possible values: >= 1 and <= 1000

Default value: 100

includeActivity boolean

Responses

200

Devices.

application/json

Schema

Schema

devices

object[]

Array [

deviceId string

timeZone

object

ianaTimeZone stringnullable

windowsTimeZone stringnullable

deviceCategory string

activity

object

isActive boolean

latest

object

activityId stringnullable

dateTime date-time

connection

object

status stringnullable

lastChange date-timenullable

]

totalCount int32
nextPageContinuationToken stringnullable

Example (from schema)

{
  "devices": [
    {
      "deviceId": "string",
      "timeZone": {
        "ianaTimeZone": "string",
        "windowsTimeZone": "string"
      },
      "deviceCategory": "string",
      "activity": {
        "isActive": true,
        "latest": {
          "activityId": "string",
          "dateTime": "2024-09-10T19:24:15.128Z"
        }
      },
      "connection": {
        "status": "string",
        "lastChange": "2024-09-10T19:24:15.128Z"
      }
    }
  ],
  "totalCount": 0,
  "nextPageContinuationToken": "string"
}

example-1

{
  "devices": [
    {
      "deviceId": "device-1",
      "deviceCategory": "DirectlyConnectedDevice",
      "activity": {
        "isActive": false,
        "latest": {
          "activityId": "Cloud.DeviceRegistration",
          "dateTime": "2022-04-12T21:09:02.0234059+00:00"
        }
      },
      "connection": {
        "status": "Disconnected",
        "lastChange": "2023-01-09T15:02:53.5066534+00:00"
      }
    },
    {
      "deviceId": "device-2",
      "deviceCategory": "DirectlyConnectedDevice",
      "activity": {
        "isActive": true,
        "latest": {
          "activityId": "Cloud.DeviceRegistration",
          "dateTime": "2023-01-09T15:02:53.5066534+00:00"
        }
      },
      "connection": {
        "status": "Connected",
        "lastChange": "2023-01-09T15:02:53.5066534+00:00"
      }
    }
  ],
  "totalCount": 850,
  "nextPageContinuationToken": "eyJMYXN0RGV2aWNlSWQiOiIwMGQ5NDZlOC1jNjk0LTQ1NzQtYWZjOS0yYTVjNjJmMDI4NjEifQ=="
}

404

Workspace not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace is disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...