Create several devices of a specific type by providing their IDs
POST /devices
Create several devices of a specific type by providing their IDs
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"originalDevicesIds" : [
"string"
] ,
"groupId" : "string" ,
"type" : "string" ,
"network" : "string" ,
"tags" : [
"string"
]
}
Parameters
Responses PUT /devices
update multiple devices
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"devicesIds" : [
"string"
] ,
"groupId" : "string" ,
"type" : "string" ,
"configuration" : "string"
}
Parameters
Responses POST /devices/delete
delete several devices by providing their IDs
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"deviceIds" : [
"string"
] ,
"groupId" : "string"
}
Parameters
Responses PUT /devices/transfer
Transfer several devices by providing their IDs, the original group and the new group ID
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"deviceIds" : [
"string"
] ,
"groupId" : "string" ,
"toGroupId" : "string"
}
Parameters
Responses Get the information of a particular device
GET /device
Get the information of a particular device by providing its id
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Name In Type Required Description deviceId query string true The device identifier groupId query integer false The group identifier
POST /device
Create a device : it will create its information and its configuration. By default, the configuration will be the default one from the Device Type Information
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"groupId" : "string" ,
"name" : "string" ,
"type" : "string" ,
"originalId" : "string" ,
"network" : "string" ,
"tags" : [
"string"
]
}
Parameters Name In Type Required Description body body DeviceInput true none
Responses PUT /device
update a device
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"deviceId" : "string" ,
"groupId" : "string" ,
"name" : "string" ,
"configuration" : "string" ,
"tags" : [
"string"
]
}
Parameters
Responses DELETE /device
delete a device
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description deviceId query string true The id of the device groupId query string true The id of the owner group of the device
Responses PUT /device/transfer
transfer a device from a groupe A to a group B
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"deviceId" : "string" ,
"groupId" : "string" ,
"toGroupId" : "string"
}
Parameters
Responses GET /device/types
Get all device types
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description limit query integer false The maximum number of items to retrieve nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
Responses Status Meaning Description Schema 200 OK A list of device types Inline 400 Bad Request Bad request None
Response Schema Status Code 200
GET /device/type
Get a device type
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description type query string true none
Responses Change the device type of a device
PUT /device/type
Change the device type of a device
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
"deviceId" : "string" ,
"groupId" : "string" ,
"type" : "string"
}
Parameters
Responses Get the generic data of a particular device
GET /device/data
Get the generic data of a particular device by providing its id
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description deviceId query string true The device identifier limit query integer false none nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. beginDate query string(date) false The begin timestamp of the period to get the data from endDate query string(date) false The end timestamp of the period to get the data from ascending query boolean false The order of the items by default is ascending
Responses Get the event data of a particular device
GET /device/event
Get the event data of a particular device by providing its id
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description deviceId query string true The device identifier limit query integer false The maximum number of items to retrieve nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. beginDate query string(date) false The begin timestamp of the period to get the data from endDate query string(date) false The end timestamp of the period to get the data from ascending query boolean false The order of the items by default is ascending
Responses Get the geolocation data of a particular device
GET /device/geoloc
Get the geolocation data of a particular device by providing its id
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description deviceId query string true The device identifier limit query integer false The maximum number of items to retrieve nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. beginDate query string(date) false The begin timestamp of the period to get the data from endDate query string(date) false The end timestamp of the period to get the data from ascending query boolean false The order of the items by default is ascending
Responses Get the telemetry data of a particular device
GET /device/telemetry
Get the telemetry data of a particular device by providing its id
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description deviceId query string true The device identifier limit query integer false The maximum number of items to retrieve nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. beginDate query string(date) false The begin timestamp of the period to get the data from endDate query string(date) false The end timestamp of the period to get the data from ascending query boolean false The order of the items by default is ascending
Responses Get all metrics of a device
GET /device/metrics
Get all metrics of a device
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Parameters Name In Type Required Description groupId query string true The id of the group device query integer true The id of the device beginDate query string(date) true TThe begin timestamp of the period to get the data from endDate query string(date) true The end timestamp of the period to get the data from timeSpan query string(date) false The timespan between each item in seconds
Responses Schemas
GenericReturn {
"message" : "string"
}
Name Type Required Restrictions Description message string false none none
GenericReturnBoolean {
"message" : "string" ,
"value" : true
}
Name Type Required Restrictions Description message string false none none value boolean false none none
RetryPolicy {
"retryDelay" : 0 ,
"maxRetry" : 0
}
Name Type Required Restrictions Description retryDelay integer false none none maxRetry integer false none none
DataFailurePolicy {
"strongDuration" : 0 ,
"hasData" : true ,
"startTime" : "2019-08-24" ,
"resending" : true
}
Name Type Required Restrictions Description strongDuration integer false none none hasData boolean false none none startTime string(date) false none none resending boolean false none none
Device {
"deviceId" : "string" ,
"groupId" : "string" ,
"name" : "string" ,
"type" : "string" ,
"network" : "string" ,
"originalId" : "string" ,
"battery" : "string" ,
"seenAt" : 0 ,
"createdAt" : "2019-08-24" ,
"updatedAt" : "2019-08-24" ,
"createdBy" : "string" ,
"updatedBy" : "string" ,
"information" : "string" ,
"configuration" : "string" ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description deviceId string true none none groupId string true none none name string true none none type string true none none network string true none none originalId string true none none battery string false none none seenAt integer false none none createdAt string(date) true none none updatedAt string(date) true none none createdBy string true none none updatedBy string true none none information string false none none configuration string false none none tags [string] false none none
DeviceConnection {
"items" : [
{
"deviceId" : "string" ,
"groupId" : "string" ,
"name" : "string" ,
"type" : "string" ,
"network" : "string" ,
"originalId" : "string" ,
"battery" : "string" ,
"seenAt" : 0 ,
"createdAt" : "2019-08-24" ,
"updatedAt" : "2019-08-24" ,
"createdBy" : "string" ,
"updatedBy" : "string" ,
"information" : "string" ,
"configuration" : "string" ,
"tags" : [
"string"
]
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [Device ] false none none
DeviceData {
"deviceId" : "string" ,
"timestamp" : "2019-08-24" ,
"data" : "string" ,
"configuration" : "string" ,
"__raw" : "string" ,
"deviceType" : "string" ,
"mode" : "string" ,
"reason" : "string" ,
"deviceName" : "string" ,
"groupId" : "string"
}
Name Type Required Restrictions Description deviceId string true none none timestamp string(date) true none none data string true none none configuration string false none none __raw string false none none deviceType string false none none mode string false none none reason string false none none deviceName string false none none groupId string false none none
DeviceDataConnection {
"items" : [
{
"deviceId" : "string" ,
"timestamp" : "2019-08-24" ,
"data" : "string" ,
"configuration" : "string" ,
"__raw" : "string" ,
"deviceType" : "string" ,
"mode" : "string" ,
"reason" : "string" ,
"deviceName" : "string" ,
"groupId" : "string"
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [DeviceData ] false none none
DeviceEvent {
"deviceId" : "string" ,
"timestamp" : "2019-08-24" ,
"deviceType" : "string" ,
"groupId" : "string" ,
"message" : "string" ,
"type" : "string" ,
"data" : "string" ,
"severity" : "string"
}
Name Type Required Restrictions Description deviceId string true none none timestamp string(date) true none none deviceType string false none none groupId string false none none message string false none none type string true none none data string false none none severity string false none none
DeviceEventConnection {
"items" : [
{
"deviceId" : "string" ,
"timestamp" : "2019-08-24" ,
"deviceType" : "string" ,
"groupId" : "string" ,
"message" : "string" ,
"type" : "string" ,
"data" : "string" ,
"severity" : "string"
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [DeviceEvent ] false none none
DeviceGeoloc {
"timestamp" : "2019-08-24" ,
"status" : 0 ,
"source" : 0 ,
"radius" : 0 ,
"lat" : 0 ,
"lng" : 0 ,
"groupId" : "string" ,
"deviceId" : "string" ,
"location" : "string" ,
"data" : "string" ,
"__raw" : "string"
}
Name Type Required Restrictions Description timestamp string(date) true none none status integer false none none source integer false none none radius integer false none none lat number(float) false none none lng number(float) false none none groupId string false none none deviceId string true none none location string false none none data string false none none __raw string false none none
DeviceGeolocConnection {
"items" : [
{
"timestamp" : "2019-08-24" ,
"status" : 0 ,
"source" : 0 ,
"radius" : 0 ,
"lat" : 0 ,
"lng" : 0 ,
"groupId" : "string" ,
"deviceId" : "string" ,
"location" : "string" ,
"data" : "string" ,
"__raw" : "string"
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [DeviceGeoloc ] false none none
DeviceType {
"name" : "string" ,
"displayName" : "string" ,
"defaultConfiguration" : "string" ,
"battery" : "string" ,
"firmwareVersion" : "string"
}
Name Type Required Restrictions Description name string false none none displayName string false none none defaultConfiguration string false none none battery string false none none firmwareVersion string false none none
DeviceTypeConnection {
"items" : [
{
"name" : "string" ,
"displayName" : "string" ,
"defaultConfiguration" : "string" ,
"battery" : "string" ,
"firmwareVersion" : "string"
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [DeviceType ] false none none
DeviceTelemetry {
"deviceId" : "string" ,
"timestamp" : "2019-08-24" ,
"deviceType" : "string" ,
"duplicates" : [
"string"
] ,
"data" : "string" ,
"score" : 0 ,
"nbBS" : 0 ,
"rc" : 0 ,
"groupId" : "string"
}
Name Type Required Restrictions Description deviceId string true none none timestamp string(date) true none none deviceType string false none none duplicates [string] false none none data string false none none score integer false none none nbBS integer false none none rc integer false none none groupId string false none none
DeviceTelemetryConnection {
"items" : [
{
"deviceId" : "string" ,
"timestamp" : "2019-08-24" ,
"deviceType" : "string" ,
"duplicates" : [
"string"
] ,
"data" : "string" ,
"score" : 0 ,
"nbBS" : 0 ,
"rc" : 0 ,
"groupId" : "string"
}
] ,
"nextToken" : "string"
}
{
"deviceId" : "string" ,
"groupId" : "string" ,
"toGroupId" : "string"
}
Name Type Required Restrictions Description deviceId string true none none groupId string true none none toGroupId string true none none
{
"groupId" : "string" ,
"name" : "string" ,
"type" : "string" ,
"originalId" : "string" ,
"network" : "string" ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description groupId string true none none name string true none none type string true none none originalId string true none none network string true none none tags [string] false none none
{
"originalDevicesIds" : [
"string"
] ,
"groupId" : "string" ,
"type" : "string" ,
"network" : "string" ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description originalDevicesIds [string] true none none groupId string true none none type string true none none network string true none none tags [string] false none none
{
"devicesIds" : [
"string"
] ,
"groupId" : "string" ,
"type" : "string" ,
"configuration" : "string"
}
Name Type Required Restrictions Description devicesIds [string] false none none groupId string true none none type string true none none configuration string false none none
{
"deviceIds" : [
"string"
] ,
"groupId" : "string" ,
"toGroupId" : "string"
}
Name Type Required Restrictions Description deviceIds [string] true none none groupId string true none none toGroupId string true none none
{
"deviceIds" : [
"string"
] ,
"groupId" : "string"
}
Name Type Required Restrictions Description deviceIds [string] true none none groupId string true none none
{
"deviceId" : "string" ,
"groupId" : "string" ,
"name" : "string" ,
"configuration" : "string" ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description deviceId string true none none groupId string true none none name string false none none configuration string false none none tags [string] false none none
{
"deviceId" : "string" ,
"groupId" : "string" ,
"type" : "string"
}
Name Type Required Restrictions Description deviceId string true none none groupId string true none none type string true none none
{
"displayName" : "string" ,
"name" : "string" ,
"defaultConfiguration" : "string" ,
"battery" : "string" ,
"firmwareVersion" : "string"
}
Name Type Required Restrictions Description displayName string true none none name string true none none defaultConfiguration string true none none battery string true none none firmwareVersion string true none none
{
"displayName" : "string" ,
"name" : "string" ,
"defaultConfiguration" : "string" ,
"battery" : "string" ,
"firmwareVersion" : "string"
}
Name Type Required Restrictions Description displayName string true none none name string true none none defaultConfiguration string false none none battery string false none none firmwareVersion string true none none
{
"deviceId" : "string" ,
"groupId" : "string"
}
Name Type Required Restrictions Description deviceId string true none none groupId string true none none
{
"connectorId" : "string" ,
"groupId" : "string"
}
Name Type Required Restrictions Description connectorId string true none none groupId string true none none
DeviceMetric {
"deviceId" : "string" ,
"groupId" : "string" ,
"timestamp" : "2019-08-24" ,
"totalDeviceData" : 0 ,
"totalDeviceEvent" : 0 ,
"totalDeviceGeoloc" : 0 ,
"totalDeviceTelemetry" : 0 ,
"totalDeviceMessage" : 0 ,
"totalDeviceSigfoxDownlink" : 0 ,
"totalDeviceSigfoxUplink" : 0 ,
"totalSigfoxDataAdvancedMessage" : 0 ,
"totalSigfoxDataMessage" : 0
}
Name Type Required Restrictions Description deviceId string false none none groupId string false none none timestamp string(date) false none none totalDeviceData integer false none none totalDeviceEvent integer false none none totalDeviceGeoloc integer false none none totalDeviceTelemetry integer false none none totalDeviceMessage integer false none none totalDeviceSigfoxDownlink integer false none none totalDeviceSigfoxUplink integer false none none totalSigfoxDataAdvancedMessage integer false none none totalSigfoxDataMessage integer false none none
DeviceMetrics {
"type" : "object" ,
"properties" : {
"deviceId" : null ,
"type" : "string" ,
"groupId" : {
"type" : "string"
} ,
"beginDate" : {
"type" : "string" ,
"format" : "date"
} ,
"endDate" : {
"type" : "string" ,
"format" : "date"
} ,
"totalDeviceData" : {
"type" : "integer"
} ,
"totalDeviceEvent" : {
"type" : "integer"
} ,
"totalDeviceGeoloc" : {
"type" : "integer"
} ,
"totalDeviceTelemetry" : {
"type" : "integer"
} ,
"totalDeviceMessage" : {
"type" : "integer"
} ,
"totalDeviceSigfoxDownlink" : {
"type" : "integer"
} ,
"totalDeviceSigfoxUplink" : {
"type" : "integer"
} ,
"totalSigfoxDataAdvancedMessage" : {
"type" : "integer"
} ,
"totalSigfoxDataMessage" : {
"type" : "integer"
} ,
"items" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"deviceId" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"timestamp" : {
"type" : "string" ,
"format" : "date"
} ,
"totalDeviceData" : {
"type" : "integer"
} ,
"totalDeviceEvent" : {
"type" : "integer"
} ,
"totalDeviceGeoloc" : {
"type" : "integer"
} ,
"totalDeviceTelemetry" : {
"type" : "integer"
} ,
"totalDeviceMessage" : {
"type" : "integer"
} ,
"totalDeviceSigfoxDownlink" : {
"type" : "integer"
} ,
"totalDeviceSigfoxUplink" : {
"type" : "integer"
} ,
"totalSigfoxDataAdvancedMessage" : {
"type" : "integer"
} ,
"totalSigfoxDataMessage" : {
"type" : "integer"
}
}
}
}
}
}
Name Type Required Restrictions Description type any false none none groupId string false none none beginDate string(date) false none none endDate string(date) false none none totalDeviceData integer false none none totalDeviceEvent integer false none none totalDeviceGeoloc integer false none none totalDeviceTelemetry integer false none none totalDeviceMessage integer false none none totalDeviceSigfoxDownlink integer false none none totalDeviceSigfoxUplink integer false none none totalSigfoxDataAdvancedMessage integer false none none totalSigfoxDataMessage integer false none none items [DeviceMetric ] false none none
