Getting Started
Base URL
http://{server-ip}:{port}
The default web server port is 59123. All DataSets endpoints are under /api/DataSets/.
Requirements
- Method: POST for all operations
- Content-Type: application/json
- Authorization: JWT token in the Authorization header (obtained via /api/Authenticate)
Quick Example
Step 1 — Create a table:
POST /api/DataSets/Create
{
"ConnectionName": "Local SQLite",
"DataSetName": "Sensors",
"DatabaseName": "PlantData",
"Columns": [
{ "Name": "Id", "DataType": "INTEGER", "IsPrimaryKey": true },
{ "Name": "SensorName", "DataType": "TEXT", "IsNullable": false },
{ "Name": "Location", "DataType": "TEXT" }
]
}
Step 2 — Insert a record:
POST /api/DataSets/Insert
{
"ConnectionName": "Local SQLite",
"DataSetName": "Sensors",
"DatabaseName": "PlantData",
"Record": { "Id": 1, "SensorName": "TT-101", "Location": "Boiler Room" }
}
Step 3 — Query it back:
POST /api/DataSets/Query
{
"ConnectionName": "Local SQLite",
"DataSetName": "Sensors",
"DatabaseName": "PlantData"
}
Full API Reference
For complete request/response examples of every endpoint — including discovery, CRUD operations, RawQuery with JOINs, batch inserts, filtering, pagination, and more — refer to the Stream Platform API Postman collection:
www.streamcontrols.com/api
Import the collection into Postman and explore the DataSets folder, which contains ready-to-run examples organized by operation type.