Introduction

The Everyware Cloud exposes a comprehensive set of Web Service APIs for application integration purposes. The Everyware Cloud REST API allows you to build applications that use Representational State Transfer HTTP calls to retrieve, modify, or publish platform data. For example through the APIs, you are able to access all the functionality of the Console or to control a device from your application built on top of the Everyware Cloud.

The Everyware Cloud platform conforms to standard REpresentational State Transfer (REST) protocol to expose its Application Programming Interfaces (API). REST has emerged over the past few years as a predominant Web service design model. REST-style architectures consist of clients and servers. Clients initiate requests to servers, while servers process requests and return appropriate responses. Requests and responses are built around the transfer of representations of resources. A resource can be essentially any coherent and meaningful concept that may be addressed. A representation of a resource is typically a document that captures the current or intended state of a resource.

Everyware Cloud RESTful APIs expose the standard action types (create, read, update, delete) over the platform objects. They are capable of retrieving a resource representation in XML or JSON format. You can use the REST HTTP Accept Header to specify the representation requested using the "application/xml" and "application/json" Media Types. As an alternative to the Accept header, you can specify the requested data representation by appending an ".xml" or ".json" suffix to the path part of your request URLs.

For more details on the Eurotech Everyware Cloud REST APIs, please refer to:

REST Resources

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

The REST resources expose a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is also a WADL document describing the REST API.

Data Model

All endpoints act on a common set of data. The data can be represented with difference media (i.e. "MIME") types, depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.

This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.

Namespace "ns0"

Namespace URI: (default namespace)
XSD: ns0.xsd

Data Elements

Data Types

Namespace "ns1"

Namespace URI: http://eurotech.com/esf/2.0
XSD: esf.xsd

Data Elements

Data Types

Namespace "edc"

Namespace URI: http://eurotech.com/edc/2.0
XSD: edc.xsd

Data Elements

Data Types

Namespace "ocd"

Namespace URI: http://www.osgi.org/xmlns/metatype/v1.2.0
XSD: ocd.xsd

Data Elements

Data Types