White Papers

REST API Guide  OpenManage Essentials | Revision A02
1 Key Integration Concepts
This section covers key integration concepts that are applicable to all of the use cases that are addressed in
the next section.
1.1 Client Integration Overview
The REST client makes standard HTTP(S) requests to the REST API end-point. Each request is sent using a
HTTP verb (for example, PUT, GET, POST, DELETE, HEAD, and OPTIONS) and includes a message body
in XML format. The response uses a standard HTTP status code.
The REST client can be developed in a wide variety of programming languages (for example, C#, Java, and
so on) or scripting languages (for example, Python, Perl, and so on) that have basic support for HTTPS
communication and are capable of constructing and parsing XML payloads.
1.2 Base URI
The base URI for a REST request must be in the following format:
https://<HOST_ADDRESS>:<PORT_NUM>/api/<PRODUCT_NAMESPACE>
The parameters used in the base URI are described in the following table.
Parameter
Description
HOST_ADDRESS
The network address of the system on which the
product is installed. The network address could be
a DNS host name or an IP address.
PORT_NUM
The port number that has been specifically opened
on the web stack for API communication. This
should be the standard port used for SSL
communications or a port that is registered with
Internet Assigned Numbers Authority (IANA) for
that product.
PRODUCT_NAMESPACE
The registered namespace for that product. For
example, OME.svc.
An example of a base URI for OpenManage Essentials is as follows:
https://192.168.0.1:2607/api/OME.svc/
The rest of the document will reference this example as the <BASE_URI>.