A REST API is an architectural style for an application program interface (API) that uses HTTP requests to access and use data. That data can be used to GET, POST, PATCH, and DELETE data types, referring to the reading, updating, creating, changing, and deleting operations concerning resources.
REST API is a licensed feature. For more details, please get in touch with our Licensing Team.
Base URL: Your current RealityHub address and port (ex: http://localhost)
Endpoint: Communication channel that you want to do various processes (/api/rest/v1/engines/1/nodes)
If the Endpoint contains characters that the URL doesn't support, those characters should be URL-Encoded. For more information, please visit: HTML URL Encoding Reference
Engine Control
Rundown Control
You can also trigger the Download function of the ExternalData field as shown below:
The path of the node. (The ID of the node if the engine is RE5)
propertyPath*string
The path of the property. (The ID of the pin if the engine is RE5)
Reality Engine 5 supports partial pin update. In order to perform a partial update you need to construct the property path accordingly. Assume we have a mat4 pin and want to update the 'z' attribute of mat4's 'w' field. Then the property path should be ".w.z" The path bits should be delimited by a dot (.) and should be append to the original property path (after a dot).
