Skip to content

Commit d1586fb

Browse files
authored
Merge pull request #1567 from telefonicaid/task/add-doc-special-attr-names
[Doc] Add special measures and attributes names
2 parents 8a20fcd + 52aeb3d commit d1586fb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/api.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [IoT Agent information model](#iot-agent-information-model)
99
- [Config groups](#config-groups)
1010
- [Devices](#devices)
11+
- [Special measures and attributes names](#special-measures-and-attributes-names)
1112
- [Entity attributes](#entity-attributes)
1213
- [Multientity support)](#multientity-support)
1314
- [Metadata support](#metadata-support)
@@ -149,6 +150,15 @@ This behavior allows that autoprovisioned parameters can freely established modi
149150
creation using the provisioning API. However, note that if a device (autoprovisioned or not) doesn't have these
150151
parameters defined at device level in database, the parameters are inherit from config group parameters.
151152

153+
## Special measures and attributes names
154+
155+
In case of arriving measures with name `id` or `type`, they are automatically transformed to `measure_id` and
156+
`measure_type` attributes at Context Broker update. The reason behind this is to avoid to collide with the original entity ID and type, as mechanism
157+
that enable store measure values from parameters called with the same name. It only applies to autoprovisioned
158+
attributes and is also available at JEXL context with the same name (`measure_id`or `measure_type`).
159+
160+
In case of provisioning attributes using `id` or `type` as names (please don't do that ;), they are ignored.
161+
152162
## Entity attributes
153163

154164
In the config group/device model there are four list of attributes with different purpose to configure how the

0 commit comments

Comments
 (0)