The RESTful Management API is used to control the OA&M functions of PowerMedia XMS. Normally, this is done through a GUI, running on a client web browser. However, there may be a need to customize system management functionality, or merge it in with other system management tools in use. The RESTful Management API can be used to accomplish this.
The RESTful Management API uses HTTP or secure HTTPS as its transport so that information about the PowerMedia XMS server configuration cannot be intercepted. In the RESTful Management API, the four HTTP methods are translated to the actions shown in the following table.
HTTP Method |
Action |
POST |
Add a new resource |
PUT |
Modify an existing resource |
GET |
Return information about a resource |
DELETE |
Remove a resource |
Request and response payloads must be specified using JavaScript Object Notation (JSON). JSON is a lightweight data-interchange format based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including Java, JavaScript, Perl, and Python.
A reference of RESTful Management resources is found in RESTful Management API Resources. Only a few example resources and JSON payloads will be mentioned in this guide.
The RESTful Management API is active once the PowerMedia XMS is installed and running.