Resources

Tokens

Obtain JWT Tokens used to authenticate with the Web API

APIDescription
POST tokens

Require a new JWT token from the web api. The process to use a JWT token is as follows:

  • Request a new JWT Token from client, by providing a Token Request
  • Receive the token as a string
  • Pass the token as a Bearer token in the Authorization header for every request

If the token is expired, you will receive a 401 Unauthorized http status code.

Sites

Query general information about the sites. Also, provides mechanisms to create new sites and channels and send channel data.

APIDescription
GET sites?siteNameFilter={siteNameFilter}&siteTypeFilter={siteTypeFilter}

Gets a list of all of the sites or a filtered list of sites by name

GET sites/{id}

Gets a specific site based on the id

POST sites

Creates a new site

POST sites/{id}/channels

Creates new channels in the corresponding site

GET sites/{id}/channels

Gets the channel's part of a specific site.

GET sites/{id}/channels/{channelId}

Gets the channel out of an specific site.

GET sites/{id}/channels/{channelId}/data?startDateFilter={startDateFilter}&endDateFilter={endDateFilter}&intervalTypeFilter={intervalTypeFilter}&intervalNumberFilter={intervalNumberFilter}

Returns all data points for the channel, in the range between the start date and the end date, as specified by the siteid, channelid, startdate, and enddate parameters or by the interval type and interval number

GET sites/{id}/data?startDateFilter={startDateFilter}&endDateFilter={endDateFilter}&intervalTypeFilter={intervalTypeFilter}&intervalNumberFilter={intervalNumberFilter}

Returns all channel's data points for the site, in the range between the start date and the end date, as specified by the siteid, channelid, startdate, and enddate parameters or by the interval type and interval number

POST sites/{id}/data

Send a list of values from different channels that belong to the site.

POST sites/{id}/channels/{channelId}/data

Sends a values corresponding to the specific channel, in this case the channel id parameter will override the values sent in the body to identify the channel.

Channels

Query channels information

APIDescription
GET channels/{channelNameFilter}

Gets a list of channels filtered by name.

Units

Query channel units information

APIDescription
GET units

Gets a list of valid names for channel units.

SiteTypes

Query channel units information

APIDescription
GET sitetypes

Gets a list of valid names for site types.