Changelog¶

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.4.0] - 2025-10-01¶

Added¶

• Add Fault API endpoints:
• GET /faults - Get all the faults that were active in a specified time range according to the given query parameters.
• GET /faults/{faultId} - Get the specified Fault.
• PATCH /faults/{faultId} - Update the state of Fault.
• GET /faults/{faultId}/occurrences - Get all the occurrences for the given fault.

• GET /fault-statistics - Get fault statistics for the given building.

• Add WorkOrder API endpoints:

• GET /workorders - Get the list of all workorders.
• POST /workorders - Creates a new workorder (supports Alarm-based, Fault-based, and Generic types).
• GET /workorders/{workorderId} - Get the workorder for the given workorderId.
• PATCH /workorders/{workorderId} - Update the workorder for the given workorderId.
• GET /workorders/{workorderId}/assignments - Get a list of assignments for a given workorder id.
• POST /workorders/{workorderId}/assignments - Add assignment to workorder.

• PUT /workorders/{workorderId}/assignments - Set Assignments for the Workorder.

• Add Teams API endpoints:

• GET /teams - Retrieves a list of all teams that match the specified filters.
• POST /teams - Creates a new team for a customer with the specified name, description, domain, and assigned buildings.
• GET /teams/{teamId} - Get the details of specific team.
• PATCH /teams/{teamId} - Updates an existing team's name, description, domain, and buildings.
• GET /teams/{teamId}/members - Retrieves a list of all members within a specific team.
• PATCH /teams/{teamId}/members - Add a list of members within a specific team.

[1.3.17] - 2024-11-12¶

Fixed¶

• Updated changelog.

[1.3.16] - 2024-08-29¶

Fixed¶

• Fix code responses in specification.

[1.3.15] - 2024-08-08¶

Added¶

• Aligned the documentation and corrected spelling errors

[1.3.5] - 2023-06-06¶

Added¶

• 'Add point values' operation. Enabling import of point values. Point value ingestion is exposed for evaluation purposes until the new subscription is released by September 2023.

• 'Create device' operation. Device creation is exposed for evaluation purposes until the new subscription is released by September 2023.

[1.3.0] - 2023-03-20¶

Added¶

• Adding Alarm Configuration management operations
• 'List event transition history'-operation

Updated¶

• Deprecated 'Get Event', which is replaced with 'List event transition history'.

[1.2.0] - 2022-07-07¶

Added¶

• Added multiple new properties to Point model for a uniform access, independent of Edge Application:
  • description
  • isActive
  • unit
  • enum
  • minimum
  • maximum
  • precision
  • commandingSemantic
  • function
• Added new properties to PointValue model for a uniform access, independent of Edge Application:
  • targetValue
  • qualityOfValue

Updated¶

• Removed the pattern definition and any uuid references as IDs may have other formats

[1.0.7] - 2022-05-22¶

Fixed¶

• Multiple minor documentation improvements, regarding include-params and device relationships

[1.0.5] - 2022-04-21¶

Fixed¶

• Removed included from response model of 'Get Single Device' as it is not supported

[1.0.4] - 2022-03-22¶

Added¶

• First version of 'Operations API'