cDVR User Guide, Release 2.0
165
APPENDIX A
RESTful
API
This chapter provides information on how to access the Telurio Recording Manager’s Application
Programming Interface (API) in order to develop applications that access the RM software.
In
This
Appendix:
•
•
•
•
“Access and Usage” on page 166
Overview
The RM uses Representation State Transfer (REST), an architectural paradigm that is used to create an
interface using a client-server model.
Functionality
REST is not a specific protocol such as XML-RPC or Thrift. Typically, an HTTP infrastructure is used and
assumed in the design of a RESTful API, but it is not required. Within the HTTP protocol specification a
set of methods are designed that characterize the variation of client-server responses. For example,
one method may be used to retrieve data while another may be used to create data.
Components
The
REST API
uses the following HTTP-based methods:
•
HEAD
•
OPTIONS
•
GET
•
POST
•
PUT
•
PATCH
•
DELETE
