Connectors Reference

Pilot Things

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

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

getAlerts ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer dateStart, [Optional]integer dateEnd)

Get a list of alerts

updateAlertState (string id, string paramJson)

Update alert state

getMeasures ([Optional]boolean detailed, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get a list of measures

getCount ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get measures count

getMeasure (string id, [Optional]boolean detailed)

Get a measure

getMessages ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get a list of messages

getMessagesAndMeasurements ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, string thingId)

Get message list for a thing

addMessage (string thingId, MessageAndMeasurementsRo messageRo)

Add a message

getMessage (string id)

Get a message

getPreviousMessage (string id)

Get previous message

getSites ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get all site

createSite (JsonNode node)

Create new site

getSite (string id)

Get a site

deleteSite (string id)

Delete a site

updateSite (string id, SiteRo siteRo)

Update a site

getTags ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get the list of tags

updateThingTag (ThingTagRo thingTagRo)

Update a tag of thing

addThingTag (string thingId, ThingTagRo thingTagRo)

Add a tag to thing

getThingTag (string id)

Get a tag

getThings ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]boolean detailed)

Get a list of things

addThingsCsv (file file)

Import a csv file

associateThingsWithProduct (ObjectNode json)

Associate a product to a list of things

getThingList (array thingIds)

Get the list of things

getThing (string id, [Optional]boolean detailed)

Get a thing details

ignoreThing (string id, [Optional]boolean force)

Delete a thing

putThing (string id, SingleThingRo thingRo)

Update a thing

getThingActiveModel (string id)

Get the active model of a thing

getCustomField (string id)

Get custom fields list

createCustomField (string id, CustomFieldRo customFieldRo)

Add custom fields

updateCustomField (string id, CustomFieldRo customFieldRo)

Update custom fields

deleteCustomField (string id, string fieldId)

Delete custom fields

getCustomFieldImage (string id, string fieldId)

Get custom fields image

postCustomFieldImage (string id, string fieldId, file file)

Update custom fields image

getThingImage (string id)

Get the picture of the thing

getLastMeasures (string id)

Last measurements of a thing

getLastMessage (string id)

Last message of a thing

getThingMeasures (string id, [Optional]boolean detailed, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get a list of measures of a thing

getThingMessages (string id, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get a list of messages of a thing

deleteThingMessages (string id)

Delete all measures for a thing

createThingMessages (string id, MessageRo messageRo)

All messages of a thing

getThingModel (string id)

Get the active model of a thing

getThingOperations (string id)

Get the list of available operations

executeThingOperation (string id, string operationId, JsonNode placeholdersValues)

Execute an operation on a thing

updateThingFixedPosition (string id, ThingRo thingRo)

Update position of a thing

getThingProduct (string id)

Get the product of a thing

dissociateThingProduct (string id)

Dissociate the thing from the product

associateThingProduct (string id, ProductRo product)

Associate a product to a thing

getFlowsRelatedToThing (string id)

Related flows of a thing

getThingTags (string id)

Get thing tags

getStatsAvg ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

Get stats average

getStatsCount ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

Get stats count

getStatsLast ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get stats last

getThingStatsLast (string thingId, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

Get stats last

getStatsMax ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

Get stats max

getStatsMeasurements ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer time, [Optional]string interval, integer start, integer end)

Get stats measurements

getStatsMin ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

Get stats min

getStatsRepartition (string attribute, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

Get stats repartition

getStatsSum ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer time, [Optional]string interval, integer start, integer end)

Get stats sum

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AlertRo

 

ApplicationTinyRo

 

AttributeRo

 

AttributeTinyRo

 

ConnectivityRo

 

CountRo

 

CustomFieldRo

 

CustomModelTinyRo

 

DecoderTinyRo

 

DeviceRo

 

EncoderTinyRo

 

file

file

FlowTinyRo

 

JsonNode

 

ManufacturerTinyRo

 

MeasureRo

 

MeasureTinyRo

 

MessageAndMeasurementsRo

 

MessageRo

 

MessageTinyRo

 

ModelRo

 

ModelTinyRo

 

ObjectNode

 

OperationRo

 

PageAlertRo

 

PageCustomFieldRo

 

PageFlowRo

 

PageMeasureRo

 

PageMessageRo

 

PageOperationRo

 

PageSingleThingRo

 

PageSiteRo

 

PageStatsMeasureRo

 

PageThingTagRo

 

ProductRo

 

ProductTinyRo

 

QuantityKindRo

 

ResponseEntity

 

SingleThingRo

 

SiteRo

 

StatsCountRo

 

StatsGraphRo

 

StatsMeasureRo

 

TagRo

 

ThingRo

 

ThingTagRo

 

ThingTinyRo

 

URI

 

 

Actions:

getAlerts

Summary: Get a list of alerts

Description: Get a list of alerts

 

Syntax:

PilotThings.getAlerts ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer dateStart, [Optional]integer dateEnd)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

dateStart

integer(int64)

(Timestamp with date start)

Timestamp with date start

False

dateEnd

integer(int64)

(Timestamp with date end)

Timestamp with date end

False

 

Returns:

          Type:PageAlertRo

 

updateAlertState

Summary: Update alert state

Description: Update alert state

 

Syntax:

PilotThings.updateAlertState (string id, string paramJson)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of an alert. Cannot be empty.)

Id of an alert. Cannot be empty.

True

paramJson

string

 

 

True

 

Returns:

          Type:AlertRo

 

getMeasures

Summary: Get a list of measures

Description: Get a list of measures

 

Syntax:

PilotThings.getMeasures ([Optional]boolean detailed, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

detailed

boolean

(Boolean for detailed information)

Boolean for detailed information

False

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageMeasureRo

 

getCount

Summary: Get measures count

Description: Get measures count

 

Syntax:

PilotThings.getCount ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:CountRo

 

getMeasure

Summary: Get a measure

Description: Get a measure

 

Syntax:

PilotThings.getMeasure (string id, [Optional]boolean detailed)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a measure. Cannot be empty.)

Id of a measure. Cannot be empty.

True

detailed

boolean

(Boolean for detailed information.)

Boolean for detailed information

False

 

Returns:

          Type:MeasureRo

 

getMessages

Summary: Get a list of messages

Description: Get a list of messages

 

Syntax:

PilotThings.getMessages ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageMessageRo

 

getMessagesAndMeasurements

Summary: Get message list for a thing

Description: Get message list for a thing

 

Syntax:

PilotThings.getMessagesAndMeasurements ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, string thingId)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

thingId

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:PageMessageRo

 

addMessage

Summary: Add a message

Description: Add a message

 

Syntax:

PilotThings.addMessage (string thingId, MessageAndMeasurementsRo messageRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

thingId

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

messageRo

MessageAndMeasurementsRo

 

 

True

 

Returns:

          Type:MessageRo

 

getMessage

Summary: Get a message

Description: Get a message

 

Syntax:

PilotThings.getMessage (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a message. Cannot be empty.)

Id of a message. Cannot be empty.

True

 

Returns:

          Type:MessageRo

 

getPreviousMessage

Summary: Get previous message

Description: Get previous message

 

Syntax:

PilotThings.getPreviousMessage (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a message. Cannot be empty.)

Id of a message. Cannot be empty.

True

 

Returns:

          Type:MessageRo

 

getSites

Summary: Get all site

Description: Get previous message

 

Syntax:

PilotThings.getSites ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageSiteRo

 

createSite

Summary: Create new site

Description: Create new site

 

Syntax:

PilotThings.createSite (JsonNode node)

 

Parameters:

Name

Type

Summary

Required

Related Action

node

JsonNode

 

 

True

 

Returns:

          Type:array of (SiteRo)

 

getSite

Summary: Get a site

Description: Get a site

 

Syntax:

PilotThings.getSite (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a site. Cannot be empty.)

Id of a site. Cannot be empty.

True

 

Returns:

          Type:SiteRo

 

deleteSite

Summary: Delete a site

Description: Delete a site

 

Syntax:

PilotThings.deleteSite (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a site. Cannot be empty.)

Id of a site. Cannot be empty.

True

 

Returns:

 

updateSite

Summary: Update a site

Description: Update a site

 

Syntax:

PilotThings.updateSite (string id, SiteRo siteRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a site. Cannot be empty.)

Id of a site. Cannot be empty.

True

siteRo

SiteRo

 

 

True

 

Returns:

          Type:SiteRo

 

getTags

Summary: Get the list of tags

Description: Get the list of tags

 

Syntax:

PilotThings.getTags ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageThingTagRo

 

updateThingTag

Summary: Update a tag of thing

Description: Update a tag of thing

 

Syntax:

PilotThings.updateThingTag (ThingTagRo thingTagRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

thingTagRo

ThingTagRo

 

 

True

 

Returns:

          Type:TagRo

 

addThingTag

Summary: Add a tag to thing

Description: Add a tag to thing

 

Syntax:

PilotThings.addThingTag (string thingId, ThingTagRo thingTagRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

thingId

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

thingTagRo

ThingTagRo

 

 

True

 

Returns:

          Type:TagRo

 

getThingTag

Summary: Get a tag

Description: Get a tag

 

Syntax:

PilotThings.getThingTag (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a tag. Cannot be empty.)

Id of a tag. Cannot be empty.

True

 

Returns:

          Type:TagRo

 

getThings

Summary: Get a list of things

Description: Get a list of things

 

Syntax:

PilotThings.getThings ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]boolean detailed)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

detailed

boolean

(Boolean for detailed information.)

Boolean for detailed information.

False

 

Returns:

          Type:PageSingleThingRo

 

addThingsCsv

Summary: Import a csv file

Description: Import a csv file

 

Syntax:

PilotThings.addThingsCsv (file file)

 

Parameters:

Name

Type

Summary

Required

Related Action

file

file

(file)

file

True

 

Returns:

          Type:ResponseEntity

 

associateThingsWithProduct

Summary: Associate a product to a list of things

Description: Associate a product to a list of things

 

Syntax:

PilotThings.associateThingsWithProduct (ObjectNode json)

 

Parameters:

Name

Type

Summary

Required

Related Action

json

ObjectNode

 

 

True

 

Returns:

          Type:array of (SingleThingRo)

 

getThingList

Summary: Get the list of things

Description: Get the list of things

 

Syntax:

PilotThings.getThingList (array thingIds)

 

Parameters:

Name

Type

Summary

Required

Related Action

thingIds

array of (string)

 

 

True

 

Returns:

          Type:array of (SingleThingRo)

 

getThing

Summary: Get a thing details

Description: Get a thing details

 

Syntax:

PilotThings.getThing (string id, [Optional]boolean detailed)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

detailed

boolean

(Boolean for detailed information.)

Boolean for detailed information.

False

 

Returns:

          Type:SingleThingRo

 

ignoreThing

Summary: Delete a thing

Description: Delete a thing

 

Syntax:

PilotThings.ignoreThing (string id, [Optional]boolean force)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

force

boolean

(force)

force

False

 

Returns:

 

putThing

Summary: Update a thing

Description: Update a thing

 

Syntax:

PilotThings.putThing (string id, SingleThingRo thingRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

thingRo

SingleThingRo

 

 

True

 

Returns:

          Type:ThingRo

 

getThingActiveModel

Summary: Get the active model of a thing

Description: Get the active model of a thing

 

Syntax:

PilotThings.getThingActiveModel (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:ModelRo

 

getCustomField

Summary: Get custom fields list

Description: Get custom fields list

 

Syntax:

PilotThings.getCustomField (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:PageCustomFieldRo

 

createCustomField

Summary: Add custom fields

Description: Add custom fields

 

Syntax:

PilotThings.createCustomField (string id, CustomFieldRo customFieldRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

customFieldRo

CustomFieldRo

 

 

True

 

Returns:

          Type:CustomFieldRo

 

updateCustomField

Summary: Update custom fields

Description: Update custom fields

 

Syntax:

PilotThings.updateCustomField (string id, CustomFieldRo customFieldRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

customFieldRo

CustomFieldRo

 

 

True

 

Returns:

          Type:CustomFieldRo

 

deleteCustomField

Summary: Delete custom fields

Description: Delete custom fields

 

Syntax:

PilotThings.deleteCustomField (string id, string fieldId)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

fieldId

string

(Id of a custom field. Cannot be empty.)

Id of a custom field. Cannot be empty.

True

 

Returns:

          Type:ResponseEntity

 

getCustomFieldImage

Summary: Get custom fields image

Description: Get custom fields image

 

Syntax:

PilotThings.getCustomFieldImage (string id, string fieldId)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

fieldId

string

(Id of a custom field. Cannot be empty.)

Id of a custom field. Cannot be empty.

True

 

Returns:

          Type:ResponseEntity

 

postCustomFieldImage

Summary: Update custom fields image

Description: Update custom fields image

 

Syntax:

PilotThings.postCustomFieldImage (string id, string fieldId, file file)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

fieldId

string

(Id of a custom field. Cannot be empty)

Id of a custom field. Cannot be empty.

True

file

file

(Image)

Image

True

 

Returns:

          Type:ResponseEntity

 

getThingImage

Summary: Get the picture of the thing

Description: Get the picture of the thing

 

Syntax:

PilotThings.getThingImage (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:ResponseEntity

 

getLastMeasures

Summary: Last measurements of a thing

Description: Last measurements of a thing

 

Syntax:

PilotThings.getLastMeasures (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:array of (MeasureTinyRo)

 

getLastMessage

Summary: Last message of a thing

Description: Last message of a thing

 

Syntax:

PilotThings.getLastMessage (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:MessageTinyRo

 

getThingMeasures

Summary: Get a list of measures of a thing

Description: Get a list of measures of a thing

 

Syntax:

PilotThings.getThingMeasures (string id, [Optional]boolean detailed, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

detailed

boolean

(Boolean for detailed information.)

Boolean for detailed information.

False

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageMeasureRo

 

getThingMessages

Summary: Get a list of messages of a thing

Description: Get a list of messages of a thing

 

Syntax:

PilotThings.getThingMessages (string id, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageMessageRo

 

deleteThingMessages

Summary: Delete all measures for a thing

Description: Delete all measures for a thing

 

Syntax:

PilotThings.deleteThingMessages (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

 

createThingMessages

Summary: All messages of a thing

Description: All messages of a thing

 

Syntax:

PilotThings.createThingMessages (string id, MessageRo messageRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

messageRo

MessageRo

 

 

True

 

Returns:

          Type:MessageRo

 

getThingModel

Summary: Get the active model of a thing

Description: Get the active model of a thing

 

Syntax:

PilotThings.getThingModel (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:ModelRo

 

getThingOperations

Summary: Get the list of available operations

Description: Get the list of available operations

 

Syntax:

PilotThings.getThingOperations (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:PageOperationRo

 

executeThingOperation

Summary: Execute an operation on a thing

Description: Execute an operation on a thing

 

Syntax:

PilotThings.executeThingOperation (string id, string operationId, JsonNode placeholdersValues)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

operationId

string

(Id of an operation. Cannot be empty.)

Id of an operation. Cannot be empty.

True

placeholdersValues

JsonNode

 

 

True

 

Returns:

          Type:ResponseEntity

 

updateThingFixedPosition

Summary: Update position of a thing

Description: Update position of a thing

 

Syntax:

PilotThings.updateThingFixedPosition (string id, ThingRo thingRo)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

thingRo

ThingRo

 

 

True

 

Returns:

          Type:SingleThingRo

 

getThingProduct

Summary: Get the product of a thing

Description: Get the product of a thing

 

Syntax:

PilotThings.getThingProduct (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:ProductRo

 

dissociateThingProduct

Summary: Dissociate the thing from the product

Description: Dissociate the thing from the product

 

Syntax:

PilotThings.dissociateThingProduct (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:SingleThingRo

 

associateThingProduct

Summary: Associate a product to a thing

Description: Associate a product to a thing

 

Syntax:

PilotThings.associateThingProduct (string id, ProductRo product)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

product

ProductRo

 

 

True

 

Returns:

          Type:SingleThingRo

 

getFlowsRelatedToThing

Summary: Related flows of a thing

Description: Related flows of a thing

 

Syntax:

PilotThings.getFlowsRelatedToThing (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:PageFlowRo

 

getThingTags

Summary: Get thing tags

Description: Get thing tags

 

Syntax:

PilotThings.getThingTags (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty.

True

 

Returns:

          Type:PageThingTagRo

 

getStatsAvg

Summary: Get stats average

Description: Get stats average

 

Syntax:

PilotThings.getStatsAvg ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

start

integer(int64)

(start)

start

False

end

integer(int64)

(end)

end

False

 

Returns:

          Type:PageStatsMeasureRo

 

getStatsCount

Summary: Get stats count

Description: Get stats count

 

Syntax:

PilotThings.getStatsCount ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

start

integer(int64)

(start)

start

False

end

integer(int64)

(end)

end

False

 

Returns:

          Type:StatsCountRo

 

getStatsLast

Summary: Get stats last

Description: Get stats last

 

Syntax:

PilotThings.getStatsLast ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageStatsMeasureRo

 

getThingStatsLast

Summary: Get stats last

Description: Get stats last

 

Syntax:

PilotThings.getThingStatsLast (string thingId, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

thingId

string

(Id of a thing. Cannot be empty.)

Id of a thing. Cannot be empty

True

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

 

Returns:

          Type:PageStatsMeasureRo

 

getStatsMax

Summary: Get stats max

Description: Get stats max

 

Syntax:

PilotThings.getStatsMax ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

start

integer(int64)

(start)

start

False

end

integer(int64)

(end)

end

False

 

Returns:

          Type:PageStatsMeasureRo

 

getStatsMeasurements

Summary: Get stats measurements

Description: Get stats measurements

 

Syntax:

PilotThings.getStatsMeasurements ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer time, [Optional]string interval, integer start, integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

time

integer(int32)

(time)

time

False

interval

string

(interval)

interval

False

start

integer(int64)

(start)

start

True

end

integer(int64)

(end)

end

True

 

Returns:

          Type:array of (StatsGraphRo)

 

getStatsMin

Summary: Get stats min

Description: Get stats min

 

Syntax:

PilotThings.getStatsMin ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

start

integer(int64)

(start)

start

False

end

integer(int64)

(end)

end

False

 

Returns:

          Type:PageStatsMeasureRo

 

getStatsRepartition

Summary: Get stats repartition

Description: Get stats repartition

 

Syntax:

PilotThings.getStatsRepartition (string attribute, [Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer start, [Optional]integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

attribute

string

(attribute)

attribute

True

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

start

integer(int64)

(start)

start

False

end

integer(int64)

(end)

end

False

 

Returns:

          Type:array of (StatsCountRo)

 

getStatsSum

Summary: Get stats sum

Description: Get stats sum

 

Syntax:

PilotThings.getStatsSum ([Optional]integer page, [Optional]integer pageSize, [Optional]string sortValues, [Optional]string sort, [Optional]string filter, [Optional]string dir, [Optional]string orFilter, [Optional]integer time, [Optional]string interval, integer start, integer end)

 

Parameters:

Name

Type

Summary

Required

Related Action

page

integer(int32)

(Number of the current page)

Number of the current page

False

pageSize

integer(int32)

(Number of item in the page)

Number of item in the page

False

sortValues

string

(String for sort value)

String for sort value

False

sort

string

(String for sort value)

String for sort value

False

filter

string

(String for filter)

String for filter

False

dir

string

(Sort direction (ASC/DESC))Values: [ASC, DESC]

Sort direction (ASC/DESC)

False

orFilter

string

(Or filter parameter)

Or filter parameter

False

time

integer(int32)

(time)

time

False

interval

string

(interval)

interval

False

start

integer(int64)

(start)

start

True

end

integer(int64)

(end)

end

True

 

Returns:

          Type:array of (StatsGraphRo)

 


 

AlertRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

comment

string

 

 

creationDate

integer(int64)

 

 

flowOrigin

FlowTinyRo

 

 

id

string

 

 

lastUpdate

integer(int64)

 

 

level

string

 

Values: [INFO, WARNING, CRITICAL]

message

string

 

 

state

string

 

Values: [OPENED, IGNORED, IN_PROGRESS, RESOLVED]

thing

ThingTinyRo

 

 

username

string

 

 


 

ApplicationTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

link

string

 

 

name

string

 

 


 

AttributeRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

 

 

id

string

 

 

name

string

 

 

type

QuantityKindRo

 

 

unit

string

 

 


 

AttributeTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

type

QuantityKindRo

 

 

unit

string

 

 


 

ConnectivityRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

additionalProperties

AdditionalProperties

 

 

id

string

 

 

rawStatus

string

 

 

status

string

 

Values: [INACTIVE, ONLINE, OFFLINE, ERROR, UNKNOWN]

type

string

 

Values: [LORA, SIGFOX, MQTT, CELLULAR, ETHERNET, WIFI, BLUETOOTH, BACNET, MODBUS, IO_ANALOG, IO_DIGITAL, ENOCEAN, ZIGBEE, ZWAVE, NFC, USB, IEEE_LR_WPAN, DALI, UNKNOWN]

 

AdditionalProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

CountRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

count

integer(int32)

 

 


 

CustomFieldRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

imageLink

string

 

 

label

string

 

 

name

string

 

 

type

string

 

Values: [TEXT, TEXTEREA, FILE]

value

string

 

 


 

CustomModelTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

color

string

 

 

icon

string

 

 

id

string

 

 

link

string

 

 

name

string

 

 


 

DecoderTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

link

string

 

 

visible

boolean

 

 


 

DeviceRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

batteryLevel

integer(int32)

 

 

batteryStatus

string

 

Values: [NORMAL, CHARGING, CHARGE_COMPLETE, DAMAGED, LOW_BATTERY, NOT_INSTALLED, UNKNOWN]

deviceType

string

 

 

id

string

 

 

manufacturer

string

 

 

memoryFree

integer(int32)

 

 

memoryTotal

integer(int32)

 

 

model

string

 

 

modelNumber

string

 

 

name

string

 

 

serialNumber

string

 

 

status

string

 

Values: [RUNNING, HALTED, ERROR, UNKNOWN]


 

EncoderTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

link

string

 

 


 

file

Summary: file

Description: file

 

          Properties:

Name

Type

Summary


 

FlowTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

enabled

boolean

 

 

id

string

 

 

name

string

 

 


 

JsonNode

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

boolean

 

 

bigDecimal

boolean

 

 

bigInteger

boolean

 

 

binary

boolean

 

 

boolean

boolean

 

 

containerNode

boolean

 

 

double

boolean

 

 

float

boolean

 

 

floatingPointNumber

boolean

 

 

int

boolean

 

 

integralNumber

boolean

 

 

long

boolean

 

 

missingNode

boolean

 

 

nodeType

string

 

Values: [ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING]

null

boolean

 

 

number

boolean

 

 

object

boolean

 

 

pojo

boolean

 

 

short

boolean

 

 

textual

boolean

 

 

valueNode

boolean

 

 


 

ManufacturerTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

generateLinks

boolean

 

 

id

string

 

 

link

string

 

 

name

string

 

 


 

MeasureRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

attribute

AttributeTinyRo

 

 

dtype

string

 

 

id

string

 

 

model

ModelTinyRo

 

 

product

ProductTinyRo

 

 

thing

ThingTinyRo

 

 

timestamp

integer(int64)

 

 

value

string

 

 


 

MeasureTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

attribute

AttributeTinyRo

 

 

dtype

string

 

 

id

string

 

 

timestamp

integer(int64)

 

 

value

string

 

 


 

MessageAndMeasurementsRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

body

string

 

 

creationDate

string(date-time)

 

 

errorMessage

string

 

 

id

string

 

 

latitude

number(double)

 

 

link

URI

 

 

longitude

number(double)

 

 

measurements

Measurements

 

 

metadata

string

 

 

number

integer(int64)

 

 

processed

string

 

Values: [TODO, DONE, IN_PROGRESS, ASSOCIATED, TO_BE_FORWARDED, ERROR_CUSTOM, TODO_CUSTOM, ERROR]

rawMeasurements

JsonNode

 

 

thing

ThingTinyRo

 

 

timestamp

string(date-time)

 

 

topic

string

 

 

 

Measurements

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

MessageRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

body

string

 

 

creationDate

string(date-time)

 

 

errorMessage

string

 

 

id

string

 

 

latitude

number(double)

 

 

link

URI

 

 

longitude

number(double)

 

 

measurements

JsonNode

 

 

metadata

string

 

 

number

integer(int64)

 

 

processed

string

 

Values: [TODO, DONE, IN_PROGRESS, ASSOCIATED, TO_BE_FORWARDED, ERROR_CUSTOM, TODO_CUSTOM, ERROR]

rawMeasurements

JsonNode

 

 

thing

ThingTinyRo

 

 

timestamp

string(date-time)

 

 

topic

string

 

 


 

MessageTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

link

URI

 

 

number

integer(int64)

 

 


 

ModelRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

array of (AttributeRo)

 

 

color

string

 

 

icon

string

 

 

id

string

 

 

isCustomModel

boolean

 

 

link

URI

 

 

name

string

 

 

operations

array of (OperationRo)

 

 


 

ModelTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

color

string

 

 

generateLinks

boolean

 

 

icon

string

 

 

id

string

 

 

isCustomModel

boolean

 

 

link

URI

 

 

name

string

 

 


 

ObjectNode

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

boolean

 

 

bigDecimal

boolean

 

 

bigInteger

boolean

 

 

binary

boolean

 

 

boolean

boolean

 

 

containerNode

boolean

 

 

double

boolean

 

 

float

boolean

 

 

floatingPointNumber

boolean

 

 

int

boolean

 

 

integralNumber

boolean

 

 

long

boolean

 

 

missingNode

boolean

 

 

nodeType

string

 

Values: [ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING]

null

boolean

 

 

number

boolean

 

 

object

boolean

 

 

pojo

boolean

 

 

short

boolean

 

 

textual

boolean

 

 

valueNode

boolean

 

 


 

OperationRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

args

string

 

 

description

string

 

 

id

string

 

 

name

string

 

 


 

PageAlertRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (AlertRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageCustomFieldRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (PageCustomFieldRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageFlowRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (PageFlowRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageMeasureRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (MeasureRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageMessageRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (MessageRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageOperationRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (OperationRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageSingleThingRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (SingleThingRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageSiteRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (SiteRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageStatsMeasureRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (StatsMeasureRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

PageThingTagRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (ThingTagRo)

 

 

end

integer(int64)

 

 

page

integer(int64)

 

 

pageSize

integer(int64)

 

 

start

integer(int64)

 

 

totalSize

integer(int64)

 

 


 

ProductRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

certification

string

 

 

connectivityTypes

array of (string)

 

 

decoder

DecoderTinyRo

 

 

description

string

 

 

encoder

EncoderTinyRo

 

 

generateLinks

boolean

 

 

hasImage

boolean

 

 

id

string

 

 

imageLink

string

 

 

infoLink

string

 

 

link

string

 

 

manufacturer

ManufacturerTinyRo

 

 

manufacturerCategory

string

 

 

model

ModelTinyRo

 

 

modelManufacturer

ManufacturerTinyRo

 

 

name

string

 

 

readOnly

boolean

 

 

reference

string

 

 

tags

array of (TagRo)

 

 

things

array of (ThingTinyRo)

 

 


 

ProductTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

connectivityTypes

array of (string)

 

 

generateLinks

boolean

 

 

id

string

 

 

link

string

 

 

manufacturer

ManufacturerTinyRo

 

 

model

ModelTinyRo

 

 

name

string

 

 

reference

string

 

 


 

QuantityKindRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

defaultUnit

string

 

 

name

string

 

 

type

string

 

 


 

ResponseEntity

Summary:

Description:

 

          Properties:

Name

Type

Summary

body

Body

 

 

statusCode

string

 

Values: [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511]

statusCodeValue

integer(int32)

 

 

 

Body

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

SingleThingRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

application

ApplicationTinyRo

 

 

connectivity

ConnectivityRo

 

 

customFields

array of (CustomFieldRo)

 

 

customModel

CustomModelTinyRo

 

 

description

string

 

 

device

DeviceRo

 

 

displayName

string

 

 

dynamicGps

boolean

 

 

fixedLatitude

number(double)

 

 

fixedLongitude

number(double)

 

 

fixedName

string

 

 

id

string

 

 

lastActivityDate

integer(int64)

 

 

lastLatitude

number(double)

 

 

lastLongitude

number(double)

 

 

lastMeasurements

JsonNode

 

 

lastMeasurementsTimestamps

JsonNode

 

 

lastMessageDate

integer(int64)

 

 

messageActivityTimeoutPeriod

integer(int64)

 

 

name

string

 

 

nbAlerts

integer(int64)

 

 

product

ProductTinyRo

 

 

site

SiteRo

 

 

sourceId

string

 

 

status

string

 

Values: [PROVISIONED, PENDING, INACTIVE, ACTIVE, WARNING, SUSPENDED, DELETED, IN_ASSOCIATION, IN_DISSOCIATION, OUT_OF_ORDER, CREATED, VIRTUAL]

tags

array of (ThingTagRo)

 

 


 

SiteRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

 

 

city

string

 

 

id

string

 

 

latitude

number(double)

 

 

longitude

number(double)

 

 

name

string

 

 

postalCode

string

 

 


 

StatsCountRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

value

number

 

 


 

StatsGraphRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

count

integer(int32)

 

 

end

integer(int64)

 

 

last

integer(int64)

 

 

max

number

 

 

min

number

 

 

start

integer(int64)

 

 

unit

string

 

 

value

number

 

 


 

StatsMeasureRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

attribute

AttributeRo

 

 

timestamp

integer(int64)

 

 

value

string

 

 


 

TagRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

tag

string

 

 


 

ThingRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

customFields

array of (CustomFieldRo)

 

 

description

string

 

 

displayName

string

 

 

dynamicGps

boolean

 

 

fixedLatitude

number(double)

 

 

fixedLongitude

number(double)

 

 

fixedName

string

 

 

id

string

 

 

lastActivityDate

integer(int64)

 

 

lastLatitude

number(double)

 

 

lastLongitude

number(double)

 

 

lastMeasurements

JsonNode

 

 

lastMeasurementsTimestamps

JsonNode

 

 

lastMessageDate

integer(int64)

 

 

messageActivityTimeoutPeriod

integer(int64)

 

 

name

string

 

 

nbAlerts

integer(int64)

 

 

site

SiteRo

 

 

status

string

 

Values: [PROVISIONED, PENDING, INACTIVE, ACTIVE, WARNING, SUSPENDED, DELETED, IN_ASSOCIATION, IN_DISSOCIATION, OUT_OF_ORDER, CREATED, VIRTUAL]

tags

array of (ThingTagRo)

 

 


 

ThingTagRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

tag

string

 

 


 

ThingTinyRo

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

 

 

fixedName

string

 

 

id

string

 

 

name

string

 

 

nbAlerts

integer(int64)

 

 

tags

array of (ThingTagRo)

 

 


 

URI

Summary:

Description:

 

          Properties:

Name

Type

Summary

absolute

boolean

 

 

authority

string

 

 

fragment

string

 

 

host

string

 

 

opaque

boolean

 

 

path

string

 

 

port

integer(int32)

 

 

query

string

 

 

rawAuthority

string

 

 

rawFragment

string

 

 

rawPath

string

 

 

rawQuery

string

 

 

rawSchemeSpecificPart

string

 

 

rawUserInfo

string

 

 

scheme

string

 

 

schemeSpecificPart

string

 

 

userInfo

string