1. Overview
Resource Access Proxy API Description
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
Host : https://{interworking-interface-url-of-platform}
BasePath : /
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-* |
each SecurityCredentials entry header, they are numbered 1..size |
string |
Header |
x-auth-size |
securityCredentials set size header |
string |
Header |
x-auth-timestamp |
timestamp of the request |
string |
Query |
resourceId |
the symbIoTe id of the resource as obtained from the symbIoTe core |
string |
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-* |
each SecurityCredentials entry header, they are numbered 1..size |
string |
Header |
x-auth-size |
securityCredentials set size header |
string |
Header |
x-auth-timestamp |
timestamp of the request |
string |
Query |
resourceId |
the symbIoTe id of the resource as obtained from the symbIoTe core |
string |
3. Definitions
3.1. FeatureOfInterest
Name | Schema |
---|---|
description |
< string > array |
hasProperty |
< string > array |
name |
string |
3.3. Observation
Name | Schema |
---|---|
location |
|
obsValues |
< ObservationValue > array |
resourceId |
string |
resultTime |
string |
samplingTime |
string |
3.4. ObservationValue
Name | Schema |
---|---|
featureOfInterest |
|
obsProperty |
|
uom |
|
value |
string |