Systemite is proud to announce the first version of the SystemWeaver REST API.

The SystemWeaver REST API Server allows users to connect to a SystemWeaver server or mirror server through an HTTP interface, enabling better support for integration with tools and applications on non-Windows platforms.

It is installed as an independent executable, connecting to the server Systemite.SystemWeaver.TcpSubServer.exe in a similar way as a standard client, as shown in the picture below.  The SystemWeaver REST API Server is not required to be installed on the same machine as the SystemWeaver server or mirror server that it is connected to, but for performance reasons it is highly recommended, given that the amount of available RAM is sufficient.

It is possible to allow both standard SystemWeaver Clients and REST Clients to connect to the same SystemWeaver server or mirror server. However, for a production environment it is recommended to have one or more mirror servers dedicated for REST API communication, as shown below. This will minimize performance impact on SystemWeaver Client users. Apart from this, the SystemWeaver REST API server follows the same scaling principles as a mirror server.

Outstanding Issues and Features 

The following known items will be addressed in later releases.

Asynchronous calls not supported for a connection

The SystemWeaver REST API does not support asynchronous calls from a single connection. This will be implemented in the next release. If multiple calls are performed at the same time for a connection, the SystemWeaver REST API will throw an error message.

No write operations available

The SystemWeaver REST API has no support for write operations in this release. Support for editing Items, Issues, Libraries, etc. will be incrementally added in upcoming releases.

Attributes

Computed attributes are not managed.

RVF attributes are not managed.

Types

There are no endpoints for Item, Part and Attribute Types.

ISSUE ID: 13314