Skip to content

Commit

Permalink
Merge pull request #1567 from telefonicaid/task/add-doc-special-attr-…
Browse files Browse the repository at this point in the history
…names

[Doc] Add special measures and attributes names
  • Loading branch information
fgalan authored Feb 2, 2024
2 parents 8a20fcd + 52aeb3d commit d1586fb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [IoT Agent information model](#iot-agent-information-model)
- [Config groups](#config-groups)
- [Devices](#devices)
- [Special measures and attributes names](#special-measures-and-attributes-names)
- [Entity attributes](#entity-attributes)
- [Multientity support)](#multientity-support)
- [Metadata support](#metadata-support)
Expand Down Expand Up @@ -149,6 +150,15 @@ This behavior allows that autoprovisioned parameters can freely established modi
creation using the provisioning API. However, note that if a device (autoprovisioned or not) doesn't have these
parameters defined at device level in database, the parameters are inherit from config group parameters.

## Special measures and attributes names

In case of arriving measures with name `id` or `type`, they are automatically transformed to `measure_id` and
`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
that enable store measure values from parameters called with the same name. It only applies to autoprovisioned
attributes and is also available at JEXL context with the same name (`measure_id`or `measure_type`).

In case of provisioning attributes using `id` or `type` as names (please don't do that ;), they are ignored.

## Entity attributes

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

0 comments on commit d1586fb

Please sign in to comment.