1. Overview

Resource Access Proxy API Description

1.1. Version information

Version : 3.0.0

1.2. License information

License : GNU Lesser General Public License v3.0
License URL : https://github.com/symbiote-h2020/ResourceAccessProxy/blob/master/LICENSE.txt
Terms of service : null

1.3. URI scheme

1.4. Tags

  • rap-edm-controller : RAP Edm Controller

1.5. Produces

  • application/json

2. Resources

2.1. Rap-edm-controller

RAP Edm Controller

2.1.1. Get observations

GET /rap/*('{resourceId}')/*
Description

This is the endpoint for getting observations from the sensors. The form of the endpoint follows an ODATA-like format (e.g. /rap/Sensor('symbIoTeId')/Observations), which can be obtained from the symbIoTe core, as described here and here. You can find examples on how to get observations here and you examples using java clients here.

Parameters
Type Name Description Schema

Header

x-auth-*
required

each SecurityCredentials entry header, they are numbered 1..size

string

Header

x-auth-size
required

securityCredentials set size header

string

Header

x-auth-timestamp
required

timestamp of the request

string

Query

resourceId
required

the symbIoTe id of the resource as obtained from the symbIoTe core

string

Responses
HTTP Code Description Schema

200

An array of observations

< string > array

401

Not authorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.2. Actuate

PUT /rap/*('{resourceId}')/*
Description

This is the endpoint for actuating both on actuators and services. The form of the endpoint follows an ODATA-like format (e.g. /rap/Service('symbIoTeId')), which can be obtained from the symbIoTe core, as described here and here. You can find examples on how to get observations here and you examples using java clients here.

Parameters
Type Name Description Schema

Header

x-auth-*
required

each SecurityCredentials entry header, they are numbered 1..size

string

Header

x-auth-size
required

securityCredentials set size header

string

Header

x-auth-timestamp
required

timestamp of the request

string

Query

resourceId
required

the symbIoTe id of the resource as obtained from the symbIoTe core

string

Responses
HTTP Code Description Schema

200

The service response

string

201

Created

No Content

204

Actuators return NO CONTENT

string

401

Not authorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

3. Definitions

3.1. FeatureOfInterest

Name Schema

description
optional

< string > array

hasProperty
optional

< string > array

name
optional

string

3.2. Location

Name Schema

description
optional

< string > array

name
optional

string

3.3. Observation

Name Schema

location
optional

Location

obsValues
optional

< ObservationValue > array

resourceId
optional

string

resultTime
optional

string

samplingTime
optional

string

3.4. ObservationValue

Name Schema

featureOfInterest
optional

FeatureOfInterest

obsProperty
optional

Property

uom
optional

UnitOfMeasurement

value
optional

string

3.5. Property

Name Schema

description
optional

< string > array

iri
optional

string

name
optional

string

3.6. UnitOfMeasurement

Name Schema

description
optional

< string > array

iri
optional

string

name
optional

string

symbol
optional

string