Download OpenAPI specification:Download
The Scailable Data API is responsible for returning cloud data.
The Data API exposes destinations for each device, model and input source. These destinations contain the collected data from the models running on an edge device.
With the calls in this API you can browse the collected data that your devices and models generated.
And for live viewing data can be peeked in realtime.
Get a list of available destinations by sending a GET request to /destinations.
Download the data for a destination by sending a POST request to /destination/download with the selected Device, Model and Input IDs as query parameters.
Use a GET request to /peek/{device}/{model}/{source} to get the newest available datapoint for a given destination.
The Scailable Data API is part of the Scailable Cloud and handles the reading of data from the collected output of the models.
Request download.
Time-out set to 5s. Requires an authenticated user.
| ContentType required | string |
| Device | string <uuid> Identifier |
| DeviceSerial | string |
| Function | string <uuid> Identifier |
| ModelID | string |
| SecuredClient | boolean |
| SourceID required | string |
{- "ContentType": "string",
- "Device": "3edd0e15-e892-4b42-8508-d351e5348df3",
- "DeviceSerial": "string",
- "Function": "8e7b8e71-c3d8-492a-b716-c62c2634a634",
- "ModelID": "string",
- "SecuredClient": true,
- "SourceID": "string"
}{- "ContentType": "string",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "Location": "string"
}Request download.
Time-out set to 5s. Requires an authenticated user.
| Device | string <uuid> Identifier |
| DeviceSerial | string |
| Function | string <uuid> Identifier |
| ModelID | string |
| SecuredClient | boolean |
| SourceID required | string |
| Target required | string |
{- "Device": "3edd0e15-e892-4b42-8508-d351e5348df3",
- "DeviceSerial": "string",
- "Function": "8e7b8e71-c3d8-492a-b716-c62c2634a634",
- "ModelID": "string",
- "SecuredClient": true,
- "SourceID": "string",
- "Target": "string"
}{- "ContentType": "string",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "Location": "string"
}List destinations within the users' organisation.
Time-out set to 5s. Requires an authenticated user.
| Offset | integer Number of items to skip from beginning of list (base 0) |
| Limit | integer Number of items to return |
| OrderBy | string Order the list by these fields. Add a '-' in front of the field to reverse sort and to sort on multiple fields separate them by a comma. |
| Device | string <uuid> filter by device |
[- {
- "AcceptData": true,
- "ApproxStorageSize": 0,
- "DeviceID": "string",
- "DeviceUUID": "470ef8f9-6d56-4b67-81cd-d570dcb05fe9",
- "Downloads": [
- {
- "ContentType": "string",
- "Description": "string"
}
], - "FunctionUUID": "4e2d1d97-5853-4d67-b6bd-1c4d7d9b5207",
- "LastDataAt": "2019-08-24T14:15:22Z",
- "LastTimestampAt": "2019-08-24T14:15:22Z",
- "ModelID": "string",
- "OrganisationUUID": "d4ba3e07-5aa9-46d8-95ab-4d7930a55231",
- "SecuredClient": true,
- "SourceID": "string",
- "TotalDataPoints": 0,
- "Type": "string"
}
]Return the last data point we received. Return type depends on data type.
Time-out set to 1s. Requires an authenticated user.
| device required | any Use device |
| model required | any Use model |
| source required | any Use source |
{- "Message": "string"
}Query data points.
Time-out set to 5s. Requires an authenticated user.
| device required | any Use device |
| model required | any Use model |
| source required | any Use source |
| From | any filter by from |
| To | any filter by to |
| BoundingBoxSize | any filter by boundingboxsize |
| CentroidSize | any filter by centroidsize |
| Aggregate | any filter by aggregate |
{- "Message": "string"
}