Viz Engine Administrator Guide

Version 4.2 | Published December 04, 2020 ©

Viz Engine REST Interface

REST (short for Representational State Transfer) is an architectural paradigm for distributed systems, such as web services. Broadly spoken, REST relates to HTTP in the sense XML relates to HTML; a paradigm of the general concepts behind HTTP with some added restrictions. One such constraint is the statelessness of the communication; which HTTP violates via cookies. The most widely known application of REST, are web pages accessed via HTTP. Each web page is a unique resource, accessed via its URL (Uniform Resource Locator) which can be operated on (for example, GET /books/dune.html). This combination of operation and URL is called a message. In REST, a message has to be self-descriptive, meaning that all the information needed to process the message is required to be contained within the message.

The Viz Engine REST interface can be activated by enabling Webservice in the Global tab of the Communication section of Configuring Viz.

images/download/attachments/62194173/v4_cfg_enable_rest.png

If User Account Control is active, press Install after setting the Port. The default port for the Viz Engine web service is 61000. After restarting Viz, the REST interface can be accessed by navigating a web browser to http://localhost:61000. The landing page displays the status of the Engine, with information on which mode it is running in and its version number.

images/download/attachments/62194173/v4_gs_rest.png

Once the REST interface has been activated, the complete documentation for the Viz Engine REST interface can be accessed by navigating to http://localhost:61000/#/documentation, or by clicking the Documentation link from the landing page.