Pilot Things (Preview)

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
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Pilot Things
URL https://www.pilot-things.com
Email contact@pilot-things.com
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 contact@pilot-things.com 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 Required parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Required 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
Pilot Things host string Specify host for your Pilot Things installation
Username securestring The username for this Pilot Things installation
Password securestring The password for this Pilot Things installation

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 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

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
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

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

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

All messages of a thing

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

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

Associate a product to a thing

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 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

Create new site

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

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

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

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

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

Dissociate the thing from the product

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

Execute an operation on a thing

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

Get a list of alerts

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

Get a list of measures

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

Get a list of measures of a thing

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

Get a list of messages

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

Get a list of messages of a thing

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

Get a list of things

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

Get a measure

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

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

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

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

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

Get all site

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

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

Get custom fields list

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

Get measures count

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

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

Get previous message

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

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

Get stats count

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

Get stats last

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

Get stats last

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

Get stats max

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

Get stats measurements

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

Get stats min

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

Get stats repartition

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

Get stats sum

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

Get the active model of a thing

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

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

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

Get the list of tags

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

Get the list of things

Get the list of things

Parameters

Name Key Required Type Description
string

Returns

Get the picture of the thing

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

Get the product of a thing

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

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

Import a csv file

Import a csv file

Parameters

Name Key Required Type Description
file
file True file

file

Returns

Last measurements of a thing

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

Last message of a thing

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

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

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

Update a tag of thing

Parameters

Name Key Required Type Description
id
id string
tag
tag string

Returns

Body
TagRo

Update a thing

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
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 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

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

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

Update custom fields image

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

Update position of a thing

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

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