LIST Desired Properties History

GET 
/workspaces/:workspaceId/devices/:deviceId/desired-properties/history

Get history of device desired properties version. The versions are ordered from the newest to the oldest where the first version is the current one.

Request

Path Parameters

workspaceId uuidrequired
deviceId stringrequired

Query Parameters

$top int32
from date-time

Responses

200

History of desired properties of the particular device.

application/json

Schema

Schema

• Array [

desiredPropertiesSnapshot

object

property name*

Newtonsoft.Json.Linq.JToken

Array [

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

]

updateDateTime date-time
version int64
iotHubDesiredPropertiesVersion int64

• ]

Example (from schema)

[
  {
    "desiredPropertiesSnapshot": {},
    "updateDateTime": "2024-12-17T17:37:35.184Z",
    "version": 0,
    "iotHubDesiredPropertiesVersion": 0
  }
]

example-1

[
  {
    "desiredPropertiesSnapshot": {
      "prop3": 42,
      "prop4": 42
    },
    "updateDateTime": "2020-09-20T14:44:39.894883+00:00",
    "version": 5
  },
  {
    "desiredPropertiesSnapshot": {
      "prop3": 42
    },
    "updateDateTime": "2020-09-20T14:44:29.951161+00:00",
    "version": 4
  }
]

400

Both query parameters ('$top' and 'from') cannot be used simultaneously and '$top' must be an integer greater than zero.

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"
}

404

Device or 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 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...