Skip to content

SemIoT Platform API

Maxim Kolchin edited this page Dec 18, 2015 · 12 revisions

Description of API

NOTE:

  • The names of the sections are named according to the classes and properties defined by Hydra vocabulary (hydra) and others. The vocab prefix refers to http://localhost/doc# describing concepts defined by SemIoT Platform.
  • Hereafter http://localhost will be used instead of the real URL of SemIoT Platform.

hydra:ApiDocumentation

To retrieve the API documentation powered by Hydra, two HTTP requests should be executed as described here.

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#",
    "vocab": "http://localhost/doc#"
  },
  "@id": "http://localhost/doc",
  "@type": "hydra:ApiDocumentation",
  "hydra:entrypoint": "http://localhost/",
  "hydra:supportedClass" : [
    #definitions of classes supported by the API
  ]
}

vocab:Entrypoint

The hydra:ApiDocumentation points to vocab:Entrypoint with hydra:endpoint.

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#",
    "vocab": "http://localhost/doc#"
  },
  "@id": "http://localhost",
  "@type": "vocab:EntryPoint",
  "vocab:EntryPoint/systems": "http://localhost/systems",
  "vocab:EntryPoint/sensors": "http://localhost/sensors"
}

Requirements

The user should be able to ...

  • get the list of systems
  • ... filter by geocoordinates
  • get the list of sensors
  • ... filter by geocoordinates
  • subscribe to observations from a particular system
  • ... sensor
  • query the last observation of a particular system
  • ... sensor
  • query all observations of a particular system...
    • with given date and time range
    • property
  • query all observations of a particular sensor...
    • with given date and time range
    • property
  • execute SPARQL queries
  • execute Triple Pattern Fragments queries
    • ... with geo-coordinates (?)

Clone this wiki locally