RESTful API

RESTful API

General

Application use the services of the M2MLabs Mainspring server via standard RESTful web service API's. The WADL RESTful webservice description on a local running server is located under http://localhost/cs-ws/resources/application.wadl

Recommended tools that can be used to test the services via the RESTful APIs.

• for simple GET methods any internet browser or curl
• for POST, PUT, DELETE methods curl or SoapUI
• the graphical admin console of Mainspring located on a local running server at http://localhost/cs-ws

The easiest way to get curl on Windows is to install cygwin.

SoapUI can be downloaded from https://sourceforge.net/projects/soapui/files

---

Reference

Modelling Services

• Owners model entities that own devices, device models, sensor models, actor models and scripts. Entities belonging to an owner are invisible to other owners except the admin owner.
  • Create Owner
  • Read Owner
  • Update Owner
  • Delete Owner
  • Read List of Owners
• Sensor Models model parts of a device model that send data. Each sensor model contains 1..n attributes and their datatype. When a device is sending data it is actually sending timestamped values of attributes defined in the sensor model. A sensor model may be used in one or more device models
  • Create Sensor Model
  • Read Sensor Model
  • Update Sensor Model
  • Delete Sensor Model
  • Read List of Sensor Models
• Actor Models model parts of a device model that execute commands. Each actor model contains 1..n attributes and their datatype. When a device is sending commands it is actually sending values of attributes defined in the actor model. An actor model may be used in one or more device models
  • Create Actor Model
  • Read Actor Model
  • Update Actor Model
  • Delete Actor Model
  • Read List of Actor Models
• Device Models represent a device type of a real device. Individual devices are then created based on the device model. Device models contain sensors and actors
  • Create Device Model
  • Read Device Model
  • Update Device Model
  • Delete Device Model
  • Read List of Device Models
  • Read Sensor Part of Device Models
  • Read Actor Part of Device Models
• Devices represent individual real world devices. They are created either by an administration application or by device self creation
  • Create Device
  • Read Device
  • Update Device
  • Delete Device
  • Read List of Devices
• Device Groups represent groups of devices. They are created either by an administration application or by device self creation
  • Create Device Group
  • Read Device Group
  • Update Device Group
  • Delete Device Group
  • Read List of Device Groups
• Event Models model events sent by a device. Events contain a timestamp, a fixed searchable set of attributes and raw data as String. Raw data can be in any textual format e.g. JSON.
  • Create Event Model
  • Read Event Model
  • Update Event Model
  • Delete Event Model
  • Read List of Event Models

Connector Services

These services are used by devices to send data and synchronize time

• Send Data
• Get Time
• Send Event

Retrieval Services

These services are used by applications to retrieve stored device data

• Retrieve By Device
• Retrieve By Sensor
• Retrieve By Attribute
• Retrieve By Device List
• Retrieve By Device Model
• Retrieve Event By Device

Command Services

These services are used by by applications to create and maintain commands and by devices to poll for commands

• Create Single new Command
• Create Multiple new Commands
• Read Command
• Update Single Command
• Update Multiple Commands
• Delete Command
• Retrieve Command by Device

Script Services

These services are used by by applications to add application specific logic via hooks. Currently there are two hooks defined to execute Groovy, Javascript or Blockly scripts whenever new sensor data is received by the server and to connect devices that use arbitrary HTTP requests to send sensor data instead of the standard HTTP POST web service.

• Create Script
• Read Script
• Update Script
• Delete Script