Organicity Datasource API

Version: 0.1

Organicity Datasource API

Base URL: data.organicity.eu/

Summary

Path Operation Description
/{assetId}/readings GET

Get historical values for all the attributes of one asset

/{assetId}/{attrId}/readings GET

Get historical values for one attribute of one asset

/{assetId}/attributes GET

Get attributes

Paths

datasource

GET /{assetId}/readings

Tags: datasource
To request a list of historical values of all the attributes of an asset. Note that it is necessary to indicate the asset type. The query can be limited by time time and paged by using limit and offset query parameters. Note that to filter by dates, BOTH limits have to be set, if only one is, the filter is not applied

application/json

assetId

Asset identifier

path string
from

Starting date of the records in ISO8601

query string
to

Ending date of the records in ISO8601

query string
limit

Limit of records to retrieve

query string [1, 1000]

default: 1000

offset

Offset of the records according the query parameters

query string default: 0

*/*

200 OK

OK

Reference: Response
404 Not Found

Not Found due to incorrect

datasource

GET /{assetId}/{attr}/readings

Tags: datasource
To request a list of historical values of one asset attribute. Note that it is necessary to indicate the asset type. The query can be limited by time time and paged by using limit and offset query parameters. Note that to filter by dates, BOTH limits have to be set, if only one is, the filter is not applied

application/json

assetId

Asset identifier

path string
attr

Attribute name

path string
from

Starting date of the records in ISO8601

query string
to

Ending date of the records in ISO8601

query string
limit

Limit of records to retrieve

query string [1, 1000]

default: 1000

offset

Offset of the records according the query parameters

query string

default: 0

values

Binary parameter,if set only an array of values is returned

query string

*/*

200 OK

OK

Reference: Response
404 Not Found

Not Found due to incorrect

datasource

GET /{assetId}/attributes

Tags: datasource
To request a list of attributes belonging to one asset that are being recorded.

application/json

assetId

Asset identifier

path string

*/*

200 OK

OK

Reference: Response
404 Not Found

Not Found due to incorrect

Schema definitions

Reading: object

recvTime: string
attrName: string
attrType: string
attrValue: string

Response: object

readings: object[]
Reference: Reading

Response: object

attributes: String[]