Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api.md #1681

Merged
merged 5 commits into from
Jan 16, 2025
Merged

Update api.md #1681

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6bc7987
Update api.md
AlvaroVega Jan 15, 2025
186f750
Update doc/api.md
AlvaroVega Jan 16, 2025
537407b
Update api.md
AlvaroVega Jan 16, 2025
cf338f6
Update api.md
AlvaroVega Jan 16, 2025
0551e0a
Update api.md
AlvaroVega Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions doc/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1998,14 +1998,10 @@ the API resource fields and the same fields in the database model.
| `internal_attributes` | ✓ | `array` | | List of internal attributes with free format for specific IoT Agent configuration. |
| `explicitAttrs` | ✓ | `boolean` | ✓ | Field to support selective ignore of measures so that IOTA doesn’t progress. See details in [specific section](#explicitly-defined-attributes-explicitattrs) |
| `ngsiVersion` | ✓ | `string` | | string value used in mixed mode to switch between **NGSI-v2** and **NGSI-LD** payloads. The default is `v2`. When not running in mixed mode, this field is ignored. |
| `payloadType` | ✓ | `string` | | optional string value used to switch between **IoTAgent**, **NGSI-v2** and **NGSI-LD** measure payloads types. Possible values are: `iotagent`, `ngsiv2` or `ngsild`. The default is `iotagent`. |

| `storeLastMeasure` | ✓ | `boolean` | | Store in device last measure received. See more info
[in this section](admin.md#storelastmeasure). False by default.

| `useCBflowControl` | ✓ | `boolean` | | Use Context Broker flow control. See more info
[in this section](admin.md#useCBflowControl). False by default.

| `payloadType` | ✓ | `string` | | optional string value used to switch between **IoTAgent**, **NGSI-v2** and **NGSI-LD** measure payloads types. Possible values are: `iotagent`, `ngsiv2` or `ngsild`. The default is `iotagent`. |
| `storeLastMeasure` | ✓ | `boolean` | | Store in device last measure received. See more info [in this section](admin.md#storelastmeasure). False by default. |
| `lastMeasure` | ✓ | `object` | | last measure stored on device when `storeLastMeasure` is enabled. See more info [in this section](admin.md#storelastmeasure). |
| `useCBflowControl` | ✓ | `boolean` | | Use Context Broker flow control. See more info [in this section](admin.md#useCBflowControl). False by default. |
### Device operations

#### Retrieve devices /iot/devices `GET /iot/devices`
Expand Down
Loading