Web Services API Reference
About the Web Services API
The Web Services API provides a RESTful HTTP Web Service interface in . This distributed API provides an HTTP-based integration point to the data model, allowing web-centric read/write access to devices, models, relationships, attributes, actions and alarms. The Web Services API is a core component and is installed along with the core product.
Using the Web Services API, data can be accessed directly from a browser or integrated into your own application. Because of the inherent standards in the REST architecture, the Web Services API makes the data model accessible to many different external development environments and methods. The Web Services API can be used with any language that knows how to manage HTTP integration and provides a lightweight alternative to SOAP services.
By using the Web Services API, you can take advantage of functionality provided by the OneClick server, such as using its search infrastructure to more easily find groups of models. You can also perform many standard functions for a single
SpectroSERVERor in a distributed
SpectroSERVER(DSS) environment, such as the following:
- Access devices, models, relationships, attributes, actions and alarms
- Manage devices, ports, containers, services, and links
- Read, update, and clear alarms
- Manage subscriptions and notifications
You can use the Web Services API to perform these functions and more, similar to those provided by other API tools such as the Command Line Interface (CLI), Modeling Gateway, AlarmNotifier, Southbound Gateway, or the SpectroSERVER Object Request Broker (SSORB) interface.
Representational State Transfer (REST) is a software architectural style that promotes standardized behaviors between interacting elements, or clients and servers. Conforming to the REST constraints is referred to as being RESTful.
The REST architecture is a lightweight HTTP/HTTPS-based approach for SOAPless Web Services using create (POST), read (GET), update (PUT), and delete (DELETE) operations, or verbs.
RESTful architecture and applications are stateless, which means that no client context information is stored between requests. Each request contains all the information necessary to service the request.
The Web Services API supports the REST architecture.
The Web Services API provides a flexible, lightweight RESTful approach for integration of data into your application. As an alternative to CORBA integration, the Web Services API is language-independent and can be integrated into any development platform that supports HTTP integration, such as:
- Ruby on Rails
The Web Services API provides an HTTP/HTTPS interface, is both HTTP and XML/JSON-based, and provides Java Beans for client development.
The Web Services API is a client, very similar to OneClick. Because the Web Services API reuses much of the OneClick server code, performance of a single API client should generally mimic the performance of the comparable OneClick operation. The Web Services API should not alter
SpectroSERVERperformance except through normal request load.
The following can cause performance issues:
- Because data is cached in the OneClick server, large data requests across
multiple clients can cause performance degradation.
- Users can create new, poorly performing searches and execute them through
the Web Services API, resulting in performance degradation.
The following should be considered when using the Web Services API:
- The Web Services API does not provide interfaces for the modeling catalog where data is generally static.
- While an HTML or browser application can be built on top of the Web Services API, the Web Services API itself does not provide HTML.
- The Web Services API accepts XML only for input and produces XML or JSON for output. If you choose JSON as output, you may need to parse it out and produce XML for the next request.
The Web Services API can be used for simple CLI ad hoc commands and as an alternative to complex CLI scripting.
The Web Services API is a powerful tool. It does not provide the safeguards that OneClick does, especially related to modeling. It should be used only by administrators who understand the potentially harmful effects on a network modeling scheme of haphazardly creating and destroying models and modifying model attributes.
This section contains information about the following topics: