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.
- 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)
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)
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.
/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
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
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