REST API

RealityHub REST API.postman_collection.json
52KB
Code
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 contact 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​
GET 
Retrieve a specific resource or a collection of resources and always returns data. GET can be used for:
Engine details (name, status, host id, IP, hostname)
Nodes (All nodes in an active RGraph) 
Node functions (All functions and values of a specific node) 
Node properties (All properties and values that are included in a specific node) 
Rundowns (rundown ID, items, values)
Examples for the GET
End Point
Description
GET /api/rest/v1/engines 
Lists all engines and their information added to the system
Example Response:
JSON
[
  {
    "id": 7,
    "name": "HUBSERVER",
    "ip": "127.0.0.1",
    "role": "Broadcast",
    "status": "connected",
    "cacheDir": "c:\\cache",
    "minimumFreeSpace": 209715200,
    "usedSpace"JSON: 292844453888,
    "diskSpace": 500724768768,
    "canCook": true,
    "displayName": "HUBSERVER",
    "enabled": true,
    "port": 6666,
    "rgraphId": 3,
    "ownerStudioId": 4,
  }
] 
/api/rest/v1/engines/1 
Lists engine information that id equals to “1”
/api/rest/v1/engines/1/nodes 
Lists all nodes on engine that id is equal to “1” 
Example Response:
JSON
[
  {
    "NodePath": "EngineControl"
  },
  {
    "NodePath": "Camera_0"
  },
  {
    "NodePath": "UserTrack_0"
  }
]
/api/rest/v1/engines/1/nodes/EngineControl/properties
 Lists all properties and their values on the EngineControl node 
Example Response:
JSON
[
  {
    "MemberName": "KeepAlive",
    "Value": true,
    "PropertyPath": "Device//KeepAlive/0",
    ...
  },
  {
    "MemberName": "CoordinateSystem",
    "Value": "XYZ",
    "PropertyPath": "Transform Mapping//CoordinateSystem/0",
    ...
  },
  ...
]
/api/rest/v1/engines/1/nodes/EngineControl/functions
Lists all functions and their values on the EngineControl node 
Example Response:
JSON
[
  {
    "FunctionPath": "Default//ForceGarbageCollection/0"
  },
  {
    "FunctionPath": "Default//Sync/0"
  },
  {
    "FunctionPath": "Default//UpdateLicenseInfo/0"
  },
  {
    "FunctionPath": "Default//RemoveWatermark/0"
  },
  {
    "FunctionPath": "Default//Refresh/0"
  }
]
/api/rest/v1/playout/rundowns
Lists all the rundowns and their ID’s. 
Example Response:
JSON
[
  {
    "id": 11,
    "name": "New Rundown"
  }
]
/api/rest/v1/playout/rundowns/12/items
 Lists all the items on rundown that rundown id is equal to “12” 
Example Response:
JSON
  {
    "id": 32,
    "name": "New Form"
  }
]
/api/rest/v1/playout/templates 
Lists all the templates on RealityHub db 
Example Response:
JSON
[
  {
    "id": 12,
    "name": "My First Form"
  },
  {
    "id": 13,
    "name": "Weather_0"
  }
]JSON
POST 
POST method is used for creating new resources and updating values. POST can be used for updating function values clicking buttons, adding rundown items, etc. 
Example: 
/api/rest/v1/engines/1/nodes/EngineControl/functions with this endpoint and GET method, you listed all functions below to EngineControl node, and you want to click to "RemoveWatermark" button with POST method. 
Examples for POST 
POST /api/rest/v1/engines/1/nodes/EngineControl/functions/Default%2F%2FRemoveWatermark%2F0
This call requires no request body
Triggers the “RemoveWatermark” function of the EngineControl node
JSON
{
    "success": true
}
/api/rest/v1/playout/rundowns/12/items
Example Request Body:
JSON
{ 
  "template": "MyTemplate01", 
  "name": "NewRundownItem01" 
} 
Create a new rundown “NewRundownItem01” in the rundown (with ID 12), referencing the template “MyTemplate01”.
Example Response Body:
JSON
{
    "id": 15,
    "name": "NewRundownItem01",
    "template": "MyTemplate01",
    "data": {}
}
PATCH 
The PATCH method is used to make changes to a part of the resource at a location. PATCH can be used for updating a function and property values. 
Examples for PATCH
PATCH /api/rest/v1/engines/1/nodes/Camera_0/properties/Render%2F%2FRenderSize%2F0
Example Request Body:
JSON
{
    "Value": { 
      "X": 1920, 
      "Y": 1080 
    }
} 
 Changes Render Size property value to 1920*1080 on Camera node 
Example Response Body
JSON
{
    "PropertyPath": "Render//RenderSize/0",
    "Value": {
        "X": 1920,
        "Y": 1080
    }
}
PATCH /api/rest/v1/playout/rundowns/12/items/34 
Example Request Body:
JSON
  { 
      "name": "WillBeDeleted" 
  } 
Rename a rundown’s (12) item (34)
Example Response Body:
JSON
{
    "id": 34,
    "name": "WillBeDeleted",
    "template": "MyTemplate01",
    "data": {}
}
DELETE 
The DELETE method requests that the origin server delete the resource recognized by the Request-URL. Returns 204 message 
DELETE can be used to delete a rundown item.
Examples for DELETE
End Point
Description
DELETE /api/rest/v1/playout/rundowns/12/items/34
Deletes rundown with id:12 and item with id:34 
There is no Response Body when an operation is successful.
ALL ENDPOINTS
GET
/api/rest/v1/engines/:engineId?
GET
/api/rest/v1/engines/:engineId/nodes/:nodePath?
GET
/api/rest/v1/engines/:engineId/nodes/:nodePath/properties/:propertyPath?
GET
/api/rest/v1/engines/:engineId/nodes/:nodePath/functions/:functionPath?
PATCH
/api/rest/v1/engines/:engineId/nodes/:nodePath/properties/:propertyPath
POST
/api/rest/v1/engines/:engineId/nodes/:nodePath/functions/:functionPath
GET
/api/rest/v1/playout/rundowns/:rundownId?
POST
/api/rest/v1/playout/rundowns
PATCH
/api/rest/v1/playout/rundowns/:rundownId
DELETE
/api/rest/v1/playout/rundowns/:rundownId
GET
/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId?
POST
/api/rest/v1/playout/rundowns/:rundownId/items
PATCH
/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId
DELETE
/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId
POST
/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId/:buttonId
GET
/api/rest/v1/playout/templates

RealityHub Open-Source SDK

How to Read this Documentation

Last modified 8mo ago

End Point	Description
GET /api/rest/v1/engines	Lists all engines and their information added to the system Example Response: JSON [ { "id": 7, "name": "HUBSERVER", "ip": "127.0.0.1", "role": "Broadcast", "status": "connected", "cacheDir": "c:\\cache", "minimumFreeSpace": 209715200, "usedSpace"JSON: 292844453888, "diskSpace": 500724768768, "canCook": true, "displayName": "HUBSERVER", "enabled": true, "port": 6666, "rgraphId": 3, "ownerStudioId": 4, } ]
/api/rest/v1/engines/1	Lists engine information that id equals to “1”
/api/rest/v1/engines/1/nodes	Lists all nodes on engine that id is equal to “1” Example Response: JSON [ { "NodePath": "EngineControl" }, { "NodePath": "Camera_0" }, { "NodePath": "UserTrack_0" } ]
/api/rest/v1/engines/1/nodes/EngineControl/properties	Lists all properties and their values on the `EngineControl` node Example Response: JSON [ { "MemberName": "KeepAlive", "Value": true, "PropertyPath": "Device//KeepAlive/0", ... }, { "MemberName": "CoordinateSystem", "Value": "XYZ", "PropertyPath": "Transform Mapping//CoordinateSystem/0", ... }, ... ]
/api/rest/v1/engines/1/nodes/EngineControl/functions	Lists all functions and their values on the `EngineControl` node Example Response: JSON [ { "FunctionPath": "Default//ForceGarbageCollection/0" }, { "FunctionPath": "Default//Sync/0" }, { "FunctionPath": "Default//UpdateLicenseInfo/0" }, { "FunctionPath": "Default//RemoveWatermark/0" }, { "FunctionPath": "Default//Refresh/0" } ]
/api/rest/v1/playout/rundowns	Lists all the rundowns and their ID’s. Example Response: JSON [ { "id": 11, "name": "New Rundown" } ]
/api/rest/v1/playout/rundowns/12/items	Lists all the items on rundown that rundown id is equal to “12” Example Response: JSON { "id": 32, "name": "New Form" } ]
/api/rest/v1/playout/templates	Lists all the templates on RealityHub db Example Response: JSON [ { "id": 12, "name": "My First Form" }, { "id": 13, "name": "Weather_0" } ]JSON

POST /api/rest/v1/engines/1/nodes/EngineControl/functions/Default%2F%2FRemoveWatermark%2F0 This call requires no request body	Triggers the “RemoveWatermark” function of the `EngineControl` node JSON { "success": true }
/api/rest/v1/playout/rundowns/12/items Example Request Body: JSON { "template": "MyTemplate01", "name": "NewRundownItem01" }	Create a new rundown “NewRundownItem01” in the rundown (with ID 12), referencing the template “MyTemplate01”. Example Response Body: JSON { "id": 15, "name": "NewRundownItem01", "template": "MyTemplate01", "data": {} }

PATCH /api/rest/v1/engines/1/nodes/Camera_0/properties/Render%2F%2FRenderSize%2F0 Example Request Body: JSON { "Value": { "X": 1920, "Y": 1080 } }	Changes Render Size property value to 19201080 on Camera node Example Response Body* JSON { "PropertyPath": "Render//RenderSize/0", "Value": { "X": 1920, "Y": 1080 } }
PATCH /api/rest/v1/playout/rundowns/12/items/34 Example Request Body: JSON { "name": "WillBeDeleted" }	Rename a rundown’s (12) item (34) Example Response Body: JSON { "id": 34, "name": "WillBeDeleted", "template": "MyTemplate01", "data": {} }

End Point	Description
DELETE /api/rest/v1/playout/rundowns/12/items/34	Deletes rundown with id:12 and item with id:34 There is no Response Body when an operation is successful.

GET	/api/rest/v1/engines/:engineId?
GET	/api/rest/v1/engines/:engineId/nodes/:nodePath?
GET	/api/rest/v1/engines/:engineId/nodes/:nodePath/properties/:propertyPath?
GET	/api/rest/v1/engines/:engineId/nodes/:nodePath/functions/:functionPath?
PATCH	/api/rest/v1/engines/:engineId/nodes/:nodePath/properties/:propertyPath
POST	/api/rest/v1/engines/:engineId/nodes/:nodePath/functions/:functionPath
GET	/api/rest/v1/playout/rundowns/:rundownId?
POST	/api/rest/v1/playout/rundowns
PATCH	/api/rest/v1/playout/rundowns/:rundownId
DELETE	/api/rest/v1/playout/rundowns/:rundownId
GET	/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId?
POST	/api/rest/v1/playout/rundowns/:rundownId/items
PATCH	/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId
DELETE	/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId
POST	/api/rest/v1/playout/rundowns/:rundownId/items/:rundownItemId/:buttonId
GET	/api/rest/v1/playout/templates