RestServer

The RestServer node allows you to create a REST HTTP service and configure it.

Restserver is a single use node. Therefore, only one instance should be declared in a project. It supports communication over HTTP and HTTPS.

Platform support

This node is fully supported on XR-Windows platform.

It is partially supported on XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.

The portable platforms do not support getimage and capture functions.

Message.webport parameter

In order to create the server, the RestServer node must be declared and the config parameter Message.webport must be set to 10667.

If Message.webport is set to -1 the RestServer will not create the HTTP server at startup. There is no way to create the HTTP server at runtime.

Certificates

Rest Server node supports certificates for HTTPS. Contact your IT infrastructure team to get a SSL certificate or you can create a self-signed SSL certificate (not recommended) for testing purposes.

• Installing SSL Certificate to Personal Certificates Store on machine where Rest Server is running.

• Installing SSL Certificate/Root certificate to Trusted Root Certification Authorities Store on client machine that is going to communicate with Rest Server.

Detailed steps to create a self signed certificate and installing it on to server and client are available here.

Commands

The RestServer can support various commands and will answer to GET calls if the commands are registered in the service.

For example, to get an internal value you can access the application from a browser with an URL such as:

http://localhost:10667/getlocal?name=nodeName.fieldName

Or to get the list of all registered commands in the service you can make this call:

http://localhost:10667/help

White List filtering

You can use the whiteList dictionary to restrict the data that is get and set by the calls.

• Any command that gets values (getlocal, getlocals, json/getlocal, getimage) will respond with the requested values only if the requested names are present in the list in the "get" key of this dictionary.

• Any command that sets values (setlocal, setaction, json/setlocal) will set the field only if the specified names are present in the list in the "set" key of this dictionary.

For example:

{get=nodeName.fieldName,textureName}{set=itemName.action\actionName}

In this example, external callers will be able only to:

• Get nodeName.fieldName value using getlocal, json/getlocal or getlocals.

• Get the texture textureName using getimage.

• Set the action state of the itemName action called "actionName" using setaction.

  Note: If the dictionary is not specified, no white list filtering is applied. If no {get=} key is defined, all fields in the project can be read using the REST service.

Remote Debugger

By setting remoteDebug to true, the RestServer node enables XR Remote Debugger to access project data.

For security reasons, the remoteDebug field cannot be changed during runtime and its use should be restricted to the project development phase for testing on portable devices.

Note: There must be only one XR Remote Debugger instance connecting the application and using the RestServer node. 

Debug commands

This is the list of debug commands provided by RestServer.

Code example

This is a code example for the RestServer node.

<RestServer name="rstSrvr" registeredCommands="getlocal,setlocal" active="false" whiteList="{get=omniDefault.attenuationEnd}{set=omniDefault.attenuationEnd,itemName.action}" />

RestServer fields

These are the fields for RestServer node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase > RestServer