Manualshelf

API Guide

ManualsBrandsDell ManualsC SeriesPowerEdge MX7000
11121314151617181920
Table Of Contents
Overview
RESTful API support in OpenManage Enterprise,
OpenManage Enterprise and OME–Modular
OME–Modular supports RESTful API. Support for APIs has also been improved for OpenManage Enterprise. Improved support
for APIs on these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in
JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs. The APIs enable you to build console
management tools based on common programming and scripting languages such as Python, Java, and C.
For more information about REST, see publically-available resources.
Topics:
• RESTful application programming interface
• OData
• JSON data
• HTTPS communication
• OpenManage Enterprise – Modular Edition
• OpenManage Enterprise
RESTful application programming interface
Representational State Transfer or REST is a software architectural style used within the World Wide Web. REST architectures
are commonly used for many IT solutions, including the definition of web-based APIs. Systems that adhere to REST practices
are often referred to as RESTful interfaces. RESTful interfaces use the HTTP methods—GET, POST, DELETE, and so on—that
web browsers use to access web pages.
OData
OData is an open protocol standard for the definition and exchange of information using RESTful APIs. When implementing
a common interface across multiple vendors, it is important to standardize the data formats. Standardizing the data formats
ensure that the data structures remain interchangeable between different manufacturers.
JSON data
Console API represents data using JSON. JSON is a lightweight data-interchange format that is readable and can also be easily
parsed by machines. JSON is based on a subset of the JavaScript Programming Language. JSON uses a text format that is
language independent but uses conventions familiar to programmers of the C-family of languages such as C, C++, C#, Java,
JavaScript, PERL, and Python. These properties make JSON an ideal data-interchange language.
HTTPS communication
The Hypertext Transfer Protocol or HTTP is an application protocol for distributed, collaborative, hypermedia information
systems. HTTP forms the foundation of data communication for the World Wide Web. Secure HTTP (HTTPS) is a secure
version of HTTP where it operates within a network connection encrypted by TLS or SSL. By enforcing HTTPS, the security of
console management is significantly enhanced.
2
Overview 19