The SICON.OS REST API serves data about devices and their connected information such as events, production status, maintenance status, reports, etc.

### How to connect
* Fill in the hostname to your SICON.OS installation - e.g. `sicon-test.local` or if you use our cloud platform: `yourcompany.cloud.sicon.eco`
* The API is secure, you first need to authenticate with your JWT token. To retrieve that, navigate in SICON.OS to `settings` > `users` and click on "Copy JWT Token".
* Click on Authenticate and paste the token. Afterwards you can test the API with the "try it out" buttons.

**Hint:** When you deploy an app within SICON.OS, we provide the url as `APIBASEURL` environment variable.


### Rest API clients

* You can test out the documentation directly here or use one of the clients:
* JavaScript: [axios](https://www.npmjs.com/package/axios) or [isomorphic fetch](https://www.npmjs.com/package/isomorphic-fetch)
* Shell: curl or wget

SICON Gateway REST API

containerName

dockerImage

enabled

AppID

listed

maxInstances

name

runType

system

Unique **AssetID** - consists out of `ProductID-VendorID-DeviceID-SerialNumber`

AssetID

Code

Column

ColumnOrQuantity

ColumnOrSubitemOrQuantity

Count the found items rather than returning the data objects

count

might have the following values according to the name of the tables in the databases:
* **DeviceControl**
* **ISDU**
* **ProcessData**
* **Reporting**


Group

device

DeviceClassID

DeviceID

Filename

Define a filter criteria based on fields and values

filter

Unlocks a locked process - use with caution

force

Define by what property to group the result by.
This makes the resulting items an object instead of an array.
If multiple properties are listed, the result is nest-grouped,
with each level down in the object mapping to the corresponding nth group parameter.


group

Get the data as nested object based on a built-in preset

grouping

address

index

InterfaceID

limit

LocationPos

LocationTag

Active

AddAddress

AllowCommands

AllowEvent

AllowISDUwr

AllowPDOut

AllowReporting

MainDevice

ClassesID

Single column to fetch from IO_MainDevices table

sdd or iodd config file for the MainDevice

ConfigurationFile

CycleAwareness

IOName

IPAddress

InterfaceName

MqttProtocol

string with the columns **IOName** and **InterfaceID**

MainDeviceName

Port

Protocol

SSLTLS

Subinterfaces

minSamplingRate

NoEPP

For pagination, define offset of items to fetch from

offset

order

Page

ParamName

pathname

Define which properties to include in each item. The format is comma separated.

properties

A list of properties to ask for. If empty, all properties will be returned
The list is comma separated. A list of properties can be retrieved via the ReportingConfig Table (not exposed via API)


Defines the end of the range to search for samples

rangeEnd

Defines the start of the range to search for samples

rangeStart

rangeType

Defines how many samples to return, evenly spreaded across the required `range`.
The default is `2`.


samples

Define from which sources the reporting data is aggregated from.
By default, all sources are used, but can be specified with a comma separated list.


source

ShortName

Subinterface

SubitemOrColumn

**TimeRange** is a string with a character and a number `[x]` afterwards:
* `mi[x]` ( get all entries within the last `x` **minute/s** )
* `h[x]` ( get all entries within the last `x` **hour/s** )
* `d[x]` ( get all entries within the last `x` **day/s** )
* `w[x]` ( get all entries within the last `x` **weak/s** )
* `m[x]` ( get all entries within the last `x` **month/s** )
* `y[x]` ( get all entries within the last `x` **year/s** )
* all ( referring to all entries of the DB)


TimeRange

timeout

TimestampAPPEARS

Type

Consists of VendorID-DeviceID-Identifier. Where Identifier is either one of Serialnumber or Interface_Subinterface

UniqueID

VendorID

BuildID

start

Serves a list of installed apps plus the default one

updates the app - in case of `backend` the whole system

Serves a list of device files, that are installed. Parameters are VendorID, VendorName, DeviceID, ProductName, Filename, Filetype

Serves a list of DeviceClasses that are not populated with a iodd yet

Serves the number of connected and disconnected devices and the maximum number of devices, that can be registered.

Serves the reporting, replay and event count over all devices

Serves a list of objects of device parameters (VendorID, VendorName, DeviceID,  ProductName), whose DeviceInstance is lacking a device description file, like an iodd or an sdd, needed for successful registration

Serves the aggregate values of the event group data for the given device as defined in the event group

Serves all values of the event group data for the given device

Serves the trends of the event group data for the given device

Serves a list of event groups for the given device

Serves  a csv file containing the events of the given device

Serves a csv file containing the reporting data of the given device

Serves the number of occurred event codes of a given device

Serves the number of occurred event types of a given device

updates the device description file of the given device.

check if there is a device description file update available for the given device.

Serves a list of events with resolved x labels

Get a single event with resolved x labels

File upload for io mainDevice configuration file

Server object that overwrites the existing IPs, ports, WLAN Settings and access

server

ping an OT or IT device connected to the sicon box

Scan for IPs on the interfaces of the hardware

Get a changelog of all versions (git tags)

Get latest (on build server) installed version

Get a specific version from upstream build server