Skip to content

Commit 06884a4

Browse files
author
Daria Mitrofanova
committed
update asset history docs
1 parent daec56b commit 06884a4

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

docs/user-api/backend-api/resources/commons/history/history_asset.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,12 @@ Interval will be restricted by store period interval.
8282
"emergency": false,
8383
"employee_id": 4563
8484
},
85-
"asset": {
86-
"id": 1683258,
87-
"type": "employee"
88-
}
85+
"assets": [
86+
{
87+
"id": 1683258,
88+
"type": "employee"
89+
}
90+
]
8991
}],
9092
"limit_exceeded": false,
9193
"total": 150,
@@ -94,7 +96,7 @@ Interval will be restricted by store period interval.
9496
}
9597
```
9698

97-
* `list` - list of zero or more history_entry` objects which described in [Tracker history entry](./index.md#tracker-history-entry) with additional optional asset parameter.
99+
* `list` - list of zero or more history_entry` objects which described in [Tracker history entry](./index.md#tracker-history-entry).
98100
* `limit_exceeded` - boolean. `false` when listed all history entries satisfied with conditions and `true` otherwise.
99101
* `total` - int. Amount of history entries satisfied with conditions.
100102
* `total_unread` - int. Amount of unread history entries satisfied with conditions.

docs/user-api/backend-api/resources/commons/history/index.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,17 @@ Find instructions on getting notifications [here](../../../guides/rules-notifica
4040
"tracker_label": "Tracker label",
4141
"emergency": false,
4242
"employee_id": 4563
43-
}
43+
},
44+
"assets": [
45+
{
46+
"id": 4563,
47+
"type": "employee"
48+
},
49+
{
50+
"id": 6345,
51+
"type": "vehicle"
52+
}
53+
]
4454
}
4555
```
4656

@@ -72,6 +82,9 @@ Find instructions on getting notifications [here](../../../guides/rules-notifica
7282
* `sensor_id` - optional int. Related sensor ID.
7383
* `sensor_name` - optional string. Related sensor name.
7484
* `sensor_calculated_value` - optional string. Related sensor value.
85+
* `assets` - optional array of objects. List of related objects containing identifier and type.
86+
* `id` - int. Identifier of the asset.
87+
* `type` - string. Type of the asset. Can be "vehicle" or "employee".
7588

7689
Date/time type described in [data types description section](../../../getting-started/introduction.md#data-types).
7790

0 commit comments

Comments
 (0)