Поделиться через

Pilot Things (Preview)

  • Reference

Pilot Things is a platform to manage, visualize, automate and integrate your IoT device fleet.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Pilot Things
URL https://www.pilot-things.com
Email [email protected]
Connector Metadata
Publisher Pilot Things
Website https://www.pilot-things.com
Categories Internet of Things
Privacy policy https://www.pilot-things.com/privacy

The Pilot Things connectors allows to view and manage your things, their measurements, their statistics, alerts and operations.

Prerequisites

To use this connector, you need a working instance of Pilot Things.

How to get credentials

The credentials this connectors uses are the same that you use to login to the Pilot Things management interface. If you change your password, you'll have to update the connection as well.

Getting started with your connector

Here are a few things you can do with this connector:

  • An app displaying alerts, allowing you to clear their status if desired, using 'getAlerts' and 'updateAlertState'.
  • An app to display certain devices and the latest measurements collected from them, thanks to 'getThing' and 'getThingMeasures'.
  • An app to obtain statistics over a custom timeframe for any device, with the 'getStats*' APIs.

To get started, you just have to add a connection to your application and then all the APIs open up under the name 'PilotThingsAPI'.

Known issues and limitations

Some of the APIs returns data in pages, because they can return immense amounts of data. You'll have to manually paginate results if you desire to use those.

Common errors and remedies

The most common errors are HTTP 404, due to an invalid ID being passed. Verify the ID you entered is correct. If you hit any error in the 5XX range, contact us at [email protected] to get assistance.

FAQ

Can I make charts from sensor data using this connector?

Yes! You can use the 'getStats*' APIs to build charts.

For example, to make a table suitable for use a line chart, use the following (replacing 'MyThing' and 'Temperature' with the right GUIDs):

''' AddColumns( PilotThingsAPI.getStatsMeasurements( Text(DateAdd(Today(), -14), ""), Text(Today(), ""), { filter: "thing.id:eq_MyThing,attribute.id:eq_Temperature"), interval: "day", time: 1 } ), "date", Text(end, DateTimeFormat.ShortDate) ) '''

This code will allow you to make a daily min/max/average line chart for the last two weeks.

Can I make pages bigger?

Yes, if an API is paginated you can pass the 'pageSize' argument if you want bigger pages. Be aware that using sizes which are extremely big may slowdown the server or client, if not both.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Pilot Things host string Specify host for your Pilot Things installation True
Username securestring The username for this Pilot Things installation True
Password securestring The password for this Pilot Things installation True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a message

Add a message
Add a tag to thing

Add a tag to thing
Add custom fields

Add custom fields
All messages of a thing

All messages of a thing
Associate a product to a list of things

Associate a product to a list of things
Associate a product to a thing

Associate a product to a thing
Create new site

Create new site
Delete a site

Delete a site
Delete a thing

Delete a thing
Delete all measures for a thing

Delete all measures for a thing
Delete custom fields

Delete custom fields
Dissociate the thing from the product

Dissociate the thing from the product
Execute an operation on a thing

Execute an operation on a thing
Get a list of alerts

Get a list of alerts
Get a list of measures

Get a list of measures
Get a list of measures of a thing

Get a list of measures of a thing
Get a list of messages

Get a list of messages
Get a list of messages of a thing

Get a list of messages of a thing
Get a list of things

Get a list of things
Get a measure

Get a measure
Get a message

Get a message
Get a site

Get a site
Get a tag

Get a tag
Get a thing details

Get a thing details
Get all site

Get previous message
Get custom fields image

Get custom fields image
Get custom fields list

Get custom fields list
Get measures count

Get measures count
Get message list for a thing

Get message list for a thing
Get previous message

Get previous message
Get stats average

Get stats average
Get stats count

Get stats count
Get stats last

Get stats last
Get stats last

Get stats last
Get stats max

Get stats max
Get stats measurements

Get stats measurements
Get stats min

Get stats min
Get stats repartition

Get stats repartition
Get stats sum

Get stats sum
Get the active model of a thing

Get the active model of a thing
Get the active model of a thing

Get the active model of a thing
Get the list of available operations

Get the list of available operations
Get the list of tags

Get the list of tags
Get the list of things

Get the list of things
Get the picture of the thing

Get the picture of the thing
Get the product of a thing

Get the product of a thing
Get thing tags

Get thing tags
Import a csv file

Import a csv file
Last measurements of a thing

Last measurements of a thing
Last message of a thing

Last message of a thing
Related flows of a thing

Related flows of a thing
Update a site

Update a site
Update a tag of thing

Update a tag of thing
Update a thing

Update a thing
Update alert state

Update alert state
Update custom fields

Update custom fields
Update custom fields image

Update custom fields image
Update position of a thing

Update position of a thing

Add a message

Operation ID:
addMessage

Add a message

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 thingId True string

Id of a thing. Cannot be empty.
body
 body True string
creationDate
 creationDate True date-time
errorMessage
 errorMessage True string
id
 id string
latitude
 latitude True double
absolute
 absolute boolean
authority
 authority string
fragment
 fragment string
host
 host string
opaque
 opaque boolean
path
 path string
port
 port integer
query
 query string
rawAuthority
 rawAuthority string
rawFragment
 rawFragment string
rawPath
 rawPath string
rawQuery
 rawQuery string
rawSchemeSpecificPart
 rawSchemeSpecificPart string
rawUserInfo
 rawUserInfo string
scheme
 scheme string
schemeSpecificPart
 schemeSpecificPart string
userInfo
 userInfo string
longitude
 longitude True double
measurements
 measurements object
metadata
 metadata True string
number
 number True integer
processed
 processed True string
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
displayName
 displayName string
fixedName
 fixedName string
id
 id string
name
 name True string
nbAlerts
 nbAlerts integer
id
 id string
tag
 tag string
timestamp
 timestamp True date-time
topic
 topic True string

Returns

Body
MessageRo

Add a tag to thing

Operation ID:
addThingTag

Add a tag to thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 thingId True string

Id of a thing. Cannot be empty.
id
 id string
tag
 tag string

Returns

Body
TagRo

Add custom fields

Operation ID:
createCustomField

Add custom fields

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
id
 id string
imageLink
 imageLink string
label
 label string
name
 name string
type
 type string
value
 value string

Returns

Body
CustomFieldRo

All messages of a thing

Operation ID:
createThingMessages

All messages of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
body
 body True string
creationDate
 creationDate True date-time
errorMessage
 errorMessage True string
id
 id string
latitude
 latitude True double
absolute
 absolute boolean
authority
 authority string
fragment
 fragment string
host
 host string
opaque
 opaque boolean
path
 path string
port
 port integer
query
 query string
rawAuthority
 rawAuthority string
rawFragment
 rawFragment string
rawPath
 rawPath string
rawQuery
 rawQuery string
rawSchemeSpecificPart
 rawSchemeSpecificPart string
rawUserInfo
 rawUserInfo string
scheme
 scheme string
schemeSpecificPart
 schemeSpecificPart string
userInfo
 userInfo string
longitude
 longitude True double
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
metadata
 metadata True string
number
 number True integer
processed
 processed True string
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
displayName
 displayName string
fixedName
 fixedName string
id
 id string
name
 name True string
nbAlerts
 nbAlerts integer
id
 id string
tag
 tag string
timestamp
 timestamp True date-time
topic
 topic True string

Returns

Body
MessageRo

Associate a product to a list of things

Operation ID:
associateThingsWithProduct

Associate a product to a list of things

Parameters

Name Key Required Type Description
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean

Returns

response
array of SingleThingRo

Associate a product to a thing

Operation ID:
associateThingProduct

Associate a product to a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
certification
 certification string
connectivityTypes
 connectivityTypes array of string
id
 id string
link
 link string
visible
 visible boolean
description
 description string
id
 id string
link
 link string
generateLinks
 generateLinks boolean
hasImage
 hasImage boolean
id
 id string
imageLink
 imageLink string
infoLink
 infoLink string
link
 link string
generateLinks
 generateLinks boolean
id
 id string
link
 link string
name
 name string
manufacturerCategory
 manufacturerCategory string
color
 color string
generateLinks
 generateLinks boolean
icon
 icon string
id
 id string
isCustomModel
 isCustomModel boolean
absolute
 absolute boolean
authority
 authority string
fragment
 fragment string
host
 host string
opaque
 opaque boolean
path
 path string
port
 port integer
query
 query string
rawAuthority
 rawAuthority string
rawFragment
 rawFragment string
rawPath
 rawPath string
rawQuery
 rawQuery string
rawSchemeSpecificPart
 rawSchemeSpecificPart string
rawUserInfo
 rawUserInfo string
scheme
 scheme string
schemeSpecificPart
 schemeSpecificPart string
userInfo
 userInfo string
name
 name string
generateLinks
 generateLinks boolean
id
 id string
link
 link string
name
 name string
name
 name string
readOnly
 readOnly boolean
reference
 reference string
id
 id string
tag
 tag string
displayName
 displayName string
fixedName
 fixedName string
id
 id string
name
 name True string
nbAlerts
 nbAlerts integer
id
 id string
tag
 tag string

Returns

Body
SingleThingRo

Create new site

Operation ID:
createSite

Create new site

Parameters

Name Key Required Type Description
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean

Returns

response
array of SiteRo

Delete a site

Operation ID:
deleteSite

Delete a site

Parameters

Name Key Required Type Description
Id of a site. Cannot be empty.
 id True string

Id of a site. Cannot be empty.

Delete a thing

Operation ID:
ignoreThing

Delete a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
force
 force boolean

force

Delete all measures for a thing

Operation ID:
deleteThingMessages

Delete all measures for a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Delete custom fields

Operation ID:
deleteCustomField

Delete custom fields

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Id of a custom field. Cannot be empty.
 fieldId True string

Id of a custom field. Cannot be empty.

Returns

Body
ResponseEntity

Dissociate the thing from the product

Operation ID:
dissociateThingProduct

Dissociate the thing from the product

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
SingleThingRo

Execute an operation on a thing

Operation ID:
executeThingOperation

Execute an operation on a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Id of an operation. Cannot be empty.
 operationId True string

Id of an operation. Cannot be empty.
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean

Returns

Body
ResponseEntity

Get a list of alerts

Operation ID:
getAlerts

Get a list of alerts

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
Timestamp with date start
 dateStart integer

Timestamp with date start
Timestamp with date end
 dateEnd integer

Timestamp with date end

Returns

Body
PageAlertRo

Get a list of measures

Operation ID:
getMeasures

Get a list of measures

Parameters

Name Key Required Type Description
Boolean for detailed information
 detailed boolean

Boolean for detailed information
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageMeasureRo

Get a list of measures of a thing

Operation ID:
getThingMeasures

Get a list of measures of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Boolean for detailed information.
 detailed boolean

Boolean for detailed information.
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageMeasureRo

Get a list of messages

Operation ID:
getMessages

Get a list of messages

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageMessageRo

Get a list of messages of a thing

Operation ID:
getThingMessages

Get a list of messages of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageMessageRo

Get a list of things

Operation ID:
getThings

Get a list of things

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
Boolean for detailed information.
 detailed boolean

Boolean for detailed information.

Returns

Body
PageSingleThingRo

Get a measure

Operation ID:
getMeasure

Get a measure

Parameters

Name Key Required Type Description
Id of a measure. Cannot be empty.
 id True string

Id of a measure. Cannot be empty.
Boolean for detailed information.
 detailed boolean

Boolean for detailed information

Returns

Body
MeasureRo

Get a message

Operation ID:
getMessage

Get a message

Parameters

Name Key Required Type Description
Id of a message. Cannot be empty.
 id True string

Id of a message. Cannot be empty.

Returns

Body
MessageRo

Get a site

Operation ID:
getSite

Get a site

Parameters

Name Key Required Type Description
Id of a site. Cannot be empty.
 id True string

Id of a site. Cannot be empty.

Returns

Body
SiteRo

Get a tag

Operation ID:
getThingTag

Get a tag

Parameters

Name Key Required Type Description
Id of a tag. Cannot be empty.
 id True string

Id of a tag. Cannot be empty.

Returns

Body
TagRo

Get a thing details

Operation ID:
getThing

Get a thing details

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Boolean for detailed information.
 detailed boolean

Boolean for detailed information.

Returns

Body
SingleThingRo

Get all site

Operation ID:
getSites

Get previous message

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageSiteRo

Get custom fields image

Operation ID:
getCustomFieldImage

Get custom fields image

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Id of a custom field. Cannot be empty.
 fieldId True string

Id of a custom field. Cannot be empty.

Returns

Body
ResponseEntity

Get custom fields list

Operation ID:
getCustomField

Get custom fields list

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
PageCustomFieldRo

Get measures count

Operation ID:
getCount

Get measures count

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
CountRo

Get message list for a thing

Operation ID:
getMessagesAndMeasurements

Get message list for a thing

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
Id of a thing. Cannot be empty.
 thingId True string

Id of a thing. Cannot be empty.

Returns

Body
PageMessageRo

Get previous message

Operation ID:
getPreviousMessage

Get previous message

Parameters

Name Key Required Type Description
Id of a message. Cannot be empty.
 id True string

Id of a message. Cannot be empty.

Returns

Body
MessageRo

Get stats average

Operation ID:
getStatsAvg

Get stats average

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
start
 start integer

start
end
 end integer

end

Returns

Body
PageStatsMeasureRo

Get stats count

Operation ID:
getStatsCount

Get stats count

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
start
 start integer

start
end
 end integer

end

Returns

Body
StatsCountRo

Get stats last

Operation ID:
getThingStatsLast

Get stats last

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 thingId True string

Id of a thing. Cannot be empty
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageStatsMeasureRo

Get stats last

Operation ID:
getStatsLast

Get stats last

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageStatsMeasureRo

Get stats max

Operation ID:
getStatsMax

Get stats max

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
start
 start integer

start
end
 end integer

end

Returns

Body
PageStatsMeasureRo

Get stats measurements

Operation ID:
getStatsMeasurements

Get stats measurements

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
time
 time integer

time
interval
 interval string

interval
start
 start True integer

start
end
 end True integer

end

Returns

response
array of StatsGraphRo

Get stats min

Operation ID:
getStatsMin

Get stats min

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
start
 start integer

start
end
 end integer

end

Returns

Body
PageStatsMeasureRo

Get stats repartition

Operation ID:
getStatsRepartition

Get stats repartition

Parameters

Name Key Required Type Description
attribute
 attribute True string

attribute
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
start
 start integer

start
end
 end integer

end

Returns

response
array of StatsCountRo

Get stats sum

Operation ID:
getStatsSum

Get stats sum

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter
time
 time integer

time
interval
 interval string

interval
start
 start True integer

start
end
 end True integer

end

Returns

response
array of StatsGraphRo

Get the active model of a thing

Operation ID:
getThingModel

Get the active model of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
ModelRo

Get the active model of a thing

Operation ID:
getThingActiveModel

Get the active model of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
ModelRo

Get the list of available operations

Operation ID:
getThingOperations

Get the list of available operations

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
PageOperationRo

Get the list of tags

Operation ID:
getTags

Get the list of tags

Parameters

Name Key Required Type Description
Number of the current page
 page integer

Number of the current page
Number of item in the page
 pageSize integer

Number of item in the page
String for sort value
 sortValues string

String for sort value
String for sort value
 sort string

String for sort value
String for filter
 filter string

String for filter
Sort direction (ASC/DESC)
 dir string

Sort direction (ASC/DESC)
Or filter parameter
 orFilter string

Or filter parameter

Returns

Body
PageThingTagRo

Get the list of things

Operation ID:
getThingList

Get the list of things

Parameters

Name Key Required Type Description
thingIds
 thingIds True array of string

Returns

response
array of SingleThingRo

Get the picture of the thing

Operation ID:
getThingImage

Get the picture of the thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
ResponseEntity

Get the product of a thing

Operation ID:
getThingProduct

Get the product of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
ProductRo

Get thing tags

Operation ID:
getThingTags

Get thing tags

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
PageThingTagRo

Import a csv file

Operation ID:
addThingsCsv

Import a csv file

Parameters

Name Key Required Type Description
file
 file True file

file

Returns

Body
ResponseEntity

Last measurements of a thing

Operation ID:
getLastMeasures

Last measurements of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

response
array of MeasureTinyRo

Last message of a thing

Operation ID:
getLastMessage

Last message of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
MessageTinyRo
Operation ID:
getFlowsRelatedToThing

Related flows of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.

Returns

Body
PageFlowRo

Update a site

Operation ID:
updateSite

Update a site

Parameters

Name Key Required Type Description
Id of a site. Cannot be empty.
 id True string

Id of a site. Cannot be empty.
address
 address True string
city
 city True string
id
 id string
latitude
 latitude double
longitude
 longitude double
name
 name True string
postalCode
 postalCode True string

Returns

Body
SiteRo

Update a tag of thing

Operation ID:
updateThingTag

Update a tag of thing

Parameters

Name Key Required Type Description
id
 id string
tag
 tag string

Returns

Body
TagRo

Update a thing

Operation ID:
putThing

Update a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
id
 id string
link
 link string
name
 name string
additionalProperties
 additionalProperties object
id
 id string
rawStatus
 rawStatus string
status
 status string
type
 type string
id
 id string
imageLink
 imageLink string
label
 label string
name
 name string
type
 type string
value
 value string
color
 color string
icon
 icon string
id
 id string
link
 link string
name
 name string
description
 description string
batteryLevel
 batteryLevel integer
batteryStatus
 batteryStatus string
deviceType
 deviceType string
id
 id string
manufacturer
 manufacturer string
memoryFree
 memoryFree integer
memoryTotal
 memoryTotal integer
model
 model string
modelNumber
 modelNumber string
name
 name string
serialNumber
 serialNumber string
status
 status string
displayName
 displayName string
dynamicGps
 dynamicGps boolean
fixedLatitude
 fixedLatitude double
fixedLongitude
 fixedLongitude double
fixedName
 fixedName string
id
 id string
lastActivityDate
 lastActivityDate integer
lastLatitude
 lastLatitude double
lastLongitude
 lastLongitude double
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
lastMessageDate
 lastMessageDate integer
messageActivityTimeoutPeriod
 messageActivityTimeoutPeriod integer
name
 name True string
nbAlerts
 nbAlerts integer
connectivityTypes
 connectivityTypes array of string
generateLinks
 generateLinks boolean
id
 id string
link
 link string
generateLinks
 generateLinks boolean
id
 id string
link
 link string
name
 name string
color
 color string
generateLinks
 generateLinks boolean
icon
 icon string
id
 id string
isCustomModel
 isCustomModel boolean
absolute
 absolute boolean
authority
 authority string
fragment
 fragment string
host
 host string
opaque
 opaque boolean
path
 path string
port
 port integer
query
 query string
rawAuthority
 rawAuthority string
rawFragment
 rawFragment string
rawPath
 rawPath string
rawQuery
 rawQuery string
rawSchemeSpecificPart
 rawSchemeSpecificPart string
rawUserInfo
 rawUserInfo string
scheme
 scheme string
schemeSpecificPart
 schemeSpecificPart string
userInfo
 userInfo string
name
 name string
name
 name string
reference
 reference string
address
 address True string
city
 city True string
id
 id string
latitude
 latitude double
longitude
 longitude double
name
 name True string
postalCode
 postalCode True string
sourceId
 sourceId string
status
 status string
id
 id string
tag
 tag string

Returns

Body
ThingRo

Update alert state

Operation ID:
updateAlertState

Update alert state

Parameters

Name Key Required Type Description
Id of an alert. Cannot be empty.
 id True string

Id of an alert. Cannot be empty.
Value of state. Cannot be empty.
 paramJson True string

Value of state. Cannot be empty.

Returns

Body
AlertRo

Update custom fields

Operation ID:
updateCustomField

Update custom fields

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
id
 id string
imageLink
 imageLink string
label
 label string
name
 name string
type
 type string
value
 value string

Returns

Body
CustomFieldRo

Update custom fields image

Operation ID:
postCustomFieldImage

Update custom fields image

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
Id of a custom field. Cannot be empty
 fieldId True string

Id of a custom field. Cannot be empty.
Image
 file True file

Image

Returns

Body
ResponseEntity

Update position of a thing

Operation ID:
updateThingFixedPosition

Update position of a thing

Parameters

Name Key Required Type Description
Id of a thing. Cannot be empty.
 id True string

Id of a thing. Cannot be empty.
id
 id string
imageLink
 imageLink string
label
 label string
name
 name string
type
 type string
value
 value string
description
 description string
displayName
 displayName string
dynamicGps
 dynamicGps boolean
fixedLatitude
 fixedLatitude double
fixedLongitude
 fixedLongitude double
fixedName
 fixedName string
id
 id string
lastActivityDate
 lastActivityDate integer
lastLatitude
 lastLatitude double
lastLongitude
 lastLongitude double
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean
lastMessageDate
 lastMessageDate integer
messageActivityTimeoutPeriod
 messageActivityTimeoutPeriod integer
name
 name True string
nbAlerts
 nbAlerts integer
address
 address True string
city
 city True string
id
 id string
latitude
 latitude double
longitude
 longitude double
name
 name True string
postalCode
 postalCode True string
status
 status string
id
 id string
tag
 tag string

Returns

Body
SingleThingRo

Definitions

PageMeasureRo

Name Path Type Description
data
 data array of MeasureRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

StatsGraphRo

Name Path Type Description
count
 count integer
end
 end integer
last
 last integer
max
 max number
min
 min number
start
 start integer
unit
 unit string
value
 value number

JsonNode

Name Path Type Description
array
 array boolean
bigDecimal
 bigDecimal boolean
bigInteger
 bigInteger boolean
binary
 binary boolean
boolean
 boolean boolean
containerNode
 containerNode boolean
double
 double boolean
float
 float boolean
floatingPointNumber
 floatingPointNumber boolean
int
 int boolean
integralNumber
 integralNumber boolean
long
 long boolean
missingNode
 missingNode boolean
nodeType
 nodeType string
null
 null boolean
number
 number boolean
object
 object boolean
pojo
 pojo boolean
short
 short boolean
textual
 textual boolean
valueNode
 valueNode boolean

MeasureRo

Name Path Type Description
attribute
 attribute AttributeTinyRo
dtype
 dtype string
id
 id string
model
 model ModelTinyRo
product
 product ProductTinyRo
thing
 thing ThingTinyRo
timestamp
 timestamp integer
value
 value string

MessageRo

Name Path Type Description
body
 body string
creationDate
 creationDate date-time
errorMessage
 errorMessage string
id
 id string
latitude
 latitude double
link
 link URI
longitude
 longitude double
measurements
 measurements JsonNode
metadata
 metadata string
number
 number integer
processed
 processed string
rawMeasurements
 rawMeasurements JsonNode
thing
 thing ThingTinyRo
timestamp
 timestamp date-time
topic
 topic string

TagRo

Name Path Type Description
id
 id string
tag
 tag string

AlertRo

Name Path Type Description
comment
 comment string
creationDate
 creationDate integer
flowOrigin
 flowOrigin FlowTinyRo
id
 id string
lastUpdate
 lastUpdate integer
level
 level string
message
 message string
state
 state string
thing
 thing ThingTinyRo
username
 username string

PageSiteRo

Name Path Type Description
data
 data array of SiteRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

PageStatsMeasureRo

Name Path Type Description
data
 data array of StatsMeasureRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

SingleThingRo

Name Path Type Description
application
 application ApplicationTinyRo
connectivity
 connectivity ConnectivityRo
customFields
 customFields array of CustomFieldRo
customModel
 customModel CustomModelTinyRo
description
 description string
device
 device DeviceRo
displayName
 displayName string
dynamicGps
 dynamicGps boolean
fixedLatitude
 fixedLatitude double
fixedLongitude
 fixedLongitude double
fixedName
 fixedName string
id
 id string
lastActivityDate
 lastActivityDate integer
lastLatitude
 lastLatitude double
lastLongitude
 lastLongitude double
lastMeasurements
 lastMeasurements JsonNode
lastMeasurementsTimestamps
 lastMeasurementsTimestamps JsonNode
lastMessageDate
 lastMessageDate integer
messageActivityTimeoutPeriod
 messageActivityTimeoutPeriod integer
name
 name string
nbAlerts
 nbAlerts integer
product
 product ProductTinyRo
site
 site SiteRo
sourceId
 sourceId string
status
 status string
tags
 tags array of ThingTagRo

EncoderTinyRo

Name Path Type Description
id
 id string
link
 link string

SiteRo

Name Path Type Description
address
 address string
city
 city string
id
 id string
latitude
 latitude double
longitude
 longitude double
name
 name string
postalCode
 postalCode string

DeviceRo

Name Path Type Description
batteryLevel
 batteryLevel integer
batteryStatus
 batteryStatus string
deviceType
 deviceType string
id
 id string
manufacturer
 manufacturer string
memoryFree
 memoryFree integer
memoryTotal
 memoryTotal integer
model
 model string
modelNumber
 modelNumber string
name
 name string
serialNumber
 serialNumber string
status
 status string

FlowTinyRo

Name Path Type Description
enabled
 enabled boolean
id
 id string
name
 name string

PageCustomFieldRo

Name Path Type Description
data
 data array of PageCustomFieldRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

AttributeRo

Name Path Type Description
description
 description string
id
 id string
name
 name string
type
 type QuantityKindRo
unit
 unit string

StatsCountRo

Name Path Type Description
name
 name string
value
 value number

ProductRo

Name Path Type Description
certification
 certification string
connectivityTypes
 connectivityTypes array of string
decoder
 decoder DecoderTinyRo
description
 description string
encoder
 encoder EncoderTinyRo
generateLinks
 generateLinks boolean
hasImage
 hasImage boolean
id
 id string
imageLink
 imageLink string
infoLink
 infoLink string
link
 link string
manufacturer
 manufacturer ManufacturerTinyRo
manufacturerCategory
 manufacturerCategory string
model
 model ModelTinyRo
modelManufacturer
 modelManufacturer ManufacturerTinyRo
name
 name string
readOnly
 readOnly boolean
reference
 reference string
tags
 tags array of TagRo
things
 things array of ThingTinyRo

QuantityKindRo

Name Path Type Description
defaultUnit
 defaultUnit string
name
 name string
type
 type string

DecoderTinyRo

Name Path Type Description
id
 id string
link
 link string
visible
 visible boolean

PageAlertRo

Name Path Type Description
data
 data array of AlertRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

StatsMeasureRo

Name Path Type Description
attribute
 attribute AttributeRo
timestamp
 timestamp integer
value
 value string

OperationRo

Name Path Type Description
args
 args string
description
 description string
id
 id string
name
 name string

ConnectivityRo

Name Path Type Description
additionalProperties
 additionalProperties object
id
 id string
rawStatus
 rawStatus string
status
 status string
type
 type string

CountRo

Name Path Type Description
count
 count integer

MessageTinyRo

Name Path Type Description
id
 id string
link
 link URI
number
 number integer

URI

Name Path Type Description
absolute
 absolute boolean
authority
 authority string
fragment
 fragment string
host
 host string
opaque
 opaque boolean
path
 path string
port
 port integer
query
 query string
rawAuthority
 rawAuthority string
rawFragment
 rawFragment string
rawPath
 rawPath string
rawQuery
 rawQuery string
rawSchemeSpecificPart
 rawSchemeSpecificPart string
rawUserInfo
 rawUserInfo string
scheme
 scheme string
schemeSpecificPart
 schemeSpecificPart string
userInfo
 userInfo string

PageThingTagRo

Name Path Type Description
data
 data array of ThingTagRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

ThingRo

Name Path Type Description
customFields
 customFields array of CustomFieldRo
description
 description string
displayName
 displayName string
dynamicGps
 dynamicGps boolean
fixedLatitude
 fixedLatitude double
fixedLongitude
 fixedLongitude double
fixedName
 fixedName string
id
 id string
lastActivityDate
 lastActivityDate integer
lastLatitude
 lastLatitude double
lastLongitude
 lastLongitude double
lastMeasurements
 lastMeasurements JsonNode
lastMeasurementsTimestamps
 lastMeasurementsTimestamps JsonNode
lastMessageDate
 lastMessageDate integer
messageActivityTimeoutPeriod
 messageActivityTimeoutPeriod integer
name
 name string
nbAlerts
 nbAlerts integer
site
 site SiteRo
status
 status string
tags
 tags array of ThingTagRo

PageOperationRo

Name Path Type Description
data
 data array of OperationRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

CustomModelTinyRo

Name Path Type Description
color
 color string
icon
 icon string
id
 id string
link
 link string
name
 name string

ModelTinyRo

Name Path Type Description
color
 color string
generateLinks
 generateLinks boolean
icon
 icon string
id
 id string
isCustomModel
 isCustomModel boolean
link
 link URI
name
 name string

MeasureTinyRo

Name Path Type Description
attribute
 attribute AttributeTinyRo
dtype
 dtype string
id
 id string
timestamp
 timestamp integer
value
 value string

AttributeTinyRo

Name Path Type Description
id
 id string
name
 name string
type
 type QuantityKindRo
unit
 unit string

CustomFieldRo

Name Path Type Description
id
 id string
imageLink
 imageLink string
label
 label string
name
 name string
type
 type string
value
 value string

PageMessageRo

Name Path Type Description
data
 data array of MessageRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

ManufacturerTinyRo

Name Path Type Description
generateLinks
 generateLinks boolean
id
 id string
link
 link string
name
 name string

ProductTinyRo

Name Path Type Description
connectivityTypes
 connectivityTypes array of string
generateLinks
 generateLinks boolean
id
 id string
link
 link string
manufacturer
 manufacturer ManufacturerTinyRo
model
 model ModelTinyRo
name
 name string
reference
 reference string

ThingTinyRo

Name Path Type Description
displayName
 displayName string
fixedName
 fixedName string
id
 id string
name
 name string
nbAlerts
 nbAlerts integer
tags
 tags array of ThingTagRo

ResponseEntity

Name Path Type Description
body
 body object
statusCode
 statusCode string
statusCodeValue
 statusCodeValue integer

PageFlowRo

Name Path Type Description
data
 data array of PageFlowRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

PageSingleThingRo

Name Path Type Description
data
 data array of SingleThingRo
end
 end integer
page
 page integer
pageSize
 pageSize integer
start
 start integer
totalSize
 totalSize integer

ThingTagRo

Name Path Type Description
id
 id string
tag
 tag string

ApplicationTinyRo

Name Path Type Description
id
 id string
link
 link string
name
 name string

ModelRo

Name Path Type Description
attributes
 attributes array of AttributeRo
color
 color string
icon
 icon string
id
 id string
isCustomModel
 isCustomModel boolean
link
 link URI
name
 name string
operations
 operations array of OperationRo