Release notes
Upgrade compatibility
Good to know: All Octalarm Link APIs remain backward compatible. We increase the API version number only when introducing changes that are not backward compatible.
Changes that are not backward compatible (examples)
- Changing the URL or the request/response models of an application.
- Deleting, renaming, or changing the type of a declared property.
- Deleting or renaming APIs or API parameters.
- Adding a required request header.
Backward compatible changes (examples)
- Adding nullable properties or properties with a default value to an application model.
- Adding properties to a response model.
- Adding a section to a list.
- Introducing paging to existing collections.
- Changing error codes.
- Changing the order of properties.
- Changing the length or format of strings (e.g. resource IDs).
Known issues
| No. | Description |
|---|---|
| 1 | The REST API interface always responds with JSON data, regardless of the Content-Type setting. |
| 2 | When testing the API with OpenAPI (Swagger), you may sometimes receive no response if input is incorrect. |
New features and improvements
| Software version | Description |
|---|---|
| 2.7.1 | No changes to Octalarm Link. |
| 2.7.0 | Adjustable delay for categories available in the Alarms menu. |
| 2.6.0 | MinimalConfig API added (enabling communication with PLCs). |
| 2.5.3 | No changes to Octalarm Link. |
| 2.5.2 | No changes to Octalarm Link. |
| 2.5.1 | No changes to Octalarm Link. |
| 2.5.0 | Limits increased: 1. For messages from 100 to 200 characters 2. For names from 40 to 80 characters. |
| 2.4.9 | No changes to Octalarm Link. |
| 2.4.8 | No changes to Octalarm Link. |
| 2.4.7 | No changes to Octalarm Link. |
| 2.4.6 | No changes to Octalarm Link. |
| 2.4.5 | The version API has been improved: possible to check hardware and branding; very useful to check that the right configuration is connected. |
| 2.4.4 | After updating to version 2.4.4: 1. Are old tokens no longer valid because they contain an error. Restore communication: replace old tokens with new tokens. You generate a new token using the Regenerate token button under Settings | Octalarm Link.2. Changed the limit of the maximum number of categories: increased from 8 to 128 global categories. |
| 2.4.3 | After updating to version 2.4.3: 1. Are old tokens no longer valid due to a library update. Restore communication: replace old tokens with new tokens. You generate a new token using the Regenerate token button under Settings | Octalarm Link.2. Changed the maximum limit of some elements of the alarm API: - the limit for message has been increased from 40 to 100 characters; - the limit for name has been increased from 20 to 40 characters; - the limit for unique_id has been increased from 50 to 120 characters. |
| 2.4.2 | No changes to Octalarm Link. |
| 2.4.1 | No changes to Octalarm Link. |
| 2.4.0 | First release JSON REST API. |