TreeApi: REST API for accessing server items

Overview

The TreeApi extension provides a REST-full web API that can be used to access server items via http(s). The API provides several services that can be used to read and write server items and their properties.

Installation

The TreeApi interface is provided as an extension and is not included within the default setup.

To install the TreeApi interface, open the Core Studio and shutdown the Core Server. Afterwards, start the Extension Manager via the menu Extensions > Manager > Start Extension Manager ....

image-20240821-135737.png

Within the dialog, select "TreeApi" and press the Install button. After having installed the TreeApi interface, close the Core studio and reopen it. Within the Core Studio you will find a new sub menu TreeApi in the menu Modules. It contains entries for all definitions that are necessary for the configuration of the TreeApi interface.

Configuration

Further articles

Interface is available for the following products: 

  • NETx BMS Platform

  • NETx Multi Protocol Server

Changelog

Version

Date

Notes

Version

Date

Notes

1.1.1

Aug 30, 2024

Fixes

  • TreeApi not accessible via cloud connection – fixed.

1.1.0

Aug 21, 2024

Improvements

  • Write item requests must use invariant culture for item values now.

  • New versioning.

2024.3.26

Mar 26, 2024

New features

  • New server to write multiple items.

Improvements

  • Verify that JWT secret is at least 64 characters.

Fixes

  • Generated JWT secret is too short – fixed.

2023.8.2

Aug 2, 2023 

New features

  • First release.

 

Â