Device

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

NameInTypeRequiredDescription
bodybodyCreateDeviceBatchInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyUpdateDeviceBatchInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyDeleteDeviceBatchInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyTransferDeviceBatchInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

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.

Parameters

NameInTypeRequiredDescription
deviceIdquerystringtrueThe device identifier
groupIdqueryintegerfalseThe group identifier

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDevice
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyDeviceInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDevice
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyUpdateDeviceInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDevice
400Bad RequestBad requestNone

DELETE /device
delete a device
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
deviceIdquerystringtrueThe id of the device
groupIdquerystringtrueThe id of the owner group of the device

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDevice
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyTransferDeviceInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDevice
400Bad RequestBad requestNone

GET /device/types
Get all device types
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe 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

StatusMeaningDescriptionSchema
200OKA list of device typesInline
400Bad RequestBad requestNone

Response Schema

Status Code 200
NameTypeRequiredRestrictionsDescription
anonymous[DeviceTypeConnection]falsenonenone

GET /device/type
Get a device type
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
typequerystringtruenone

Responses

StatusMeaningDescriptionSchema
200OKreturning deviceType successfullyDeviceType
405Method Not AllowedInvalid inputNone

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

NameInTypeRequiredDescription
bodybodyChangeDeviceTypeInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDevice
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
deviceIdquerystringtrueThe device identifier
limitqueryintegerfalsenone
nextTokenquerystringfalseThe 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.
beginDatequerystring(date)falseThe begin timestamp of the period to get the data from
endDatequerystring(date)falseThe end timestamp of the period to get the data from
ascendingquerybooleanfalseThe order of the items by default is ascending

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeviceDataConnection
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
deviceIdquerystringtrueThe device identifier
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe 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.
beginDatequerystring(date)falseThe begin timestamp of the period to get the data from
endDatequerystring(date)falseThe end timestamp of the period to get the data from
ascendingquerybooleanfalseThe order of the items by default is ascending

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeviceEventConnection
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
deviceIdquerystringtrueThe device identifier
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe 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.
beginDatequerystring(date)falseThe begin timestamp of the period to get the data from
endDatequerystring(date)falseThe end timestamp of the period to get the data from
ascendingquerybooleanfalseThe order of the items by default is ascending

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeviceGeolocConnection
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
deviceIdquerystringtrueThe device identifier
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe 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.
beginDatequerystring(date)falseThe begin timestamp of the period to get the data from
endDatequerystring(date)falseThe end timestamp of the period to get the data from
ascendingquerybooleanfalseThe order of the items by default is ascending

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeviceTelemetryConnection
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
devicequeryintegertrueThe id of the device
beginDatequerystring(date)trueTThe begin timestamp of the period to get the data from
endDatequerystring(date)trueThe end timestamp of the period to get the data from
timeSpanquerystring(date)falseThe timespan between each item in seconds

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeviceMetrics
400Bad RequestBad requestNone

Schemas

GenericReturn

{
  "message": "string"
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone

GenericReturnBoolean

{
  "message": "string",
  "value": true
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone
valuebooleanfalsenonenone

RetryPolicy

{
  "retryDelay": 0,
  "maxRetry": 0
}

NameTypeRequiredRestrictionsDescription
retryDelayintegerfalsenonenone
maxRetryintegerfalsenonenone

DataFailurePolicy

{
  "strongDuration": 0,
  "hasData": true,
  "startTime": "2019-08-24",
  "resending": true
}

NameTypeRequiredRestrictionsDescription
strongDurationintegerfalsenonenone
hasDatabooleanfalsenonenone
startTimestring(date)falsenonenone
resendingbooleanfalsenonenone

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"
  ]
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
groupIdstringtruenonenone
namestringtruenonenone
typestringtruenonenone
networkstringtruenonenone
originalIdstringtruenonenone
batterystringfalsenonenone
seenAtintegerfalsenonenone
createdAtstring(date)truenonenone
updatedAtstring(date)truenonenone
createdBystringtruenonenone
updatedBystringtruenonenone
informationstringfalsenonenone
configurationstringfalsenonenone
tags[string]falsenonenone

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

NameTypeRequiredRestrictionsDescription
items[Device]falsenonenone

DeviceData

{
  "deviceId": "string",
  "timestamp": "2019-08-24",
  "data": "string",
  "configuration": "string",
  "__raw": "string",
  "deviceType": "string",
  "mode": "string",
  "reason": "string",
  "deviceName": "string",
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
timestampstring(date)truenonenone
datastringtruenonenone
configurationstringfalsenonenone
__rawstringfalsenonenone
deviceTypestringfalsenonenone
modestringfalsenonenone
reasonstringfalsenonenone
deviceNamestringfalsenonenone
groupIdstringfalsenonenone

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

NameTypeRequiredRestrictionsDescription
items[DeviceData]falsenonenone

DeviceEvent

{
  "deviceId": "string",
  "timestamp": "2019-08-24",
  "deviceType": "string",
  "groupId": "string",
  "message": "string",
  "type": "string",
  "data": "string",
  "severity": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
timestampstring(date)truenonenone
deviceTypestringfalsenonenone
groupIdstringfalsenonenone
messagestringfalsenonenone
typestringtruenonenone
datastringfalsenonenone
severitystringfalsenonenone

DeviceEventConnection

{
  "items": [
    {
      "deviceId": "string",
      "timestamp": "2019-08-24",
      "deviceType": "string",
      "groupId": "string",
      "message": "string",
      "type": "string",
      "data": "string",
      "severity": "string"
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[DeviceEvent]falsenonenone

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

NameTypeRequiredRestrictionsDescription
timestampstring(date)truenonenone
statusintegerfalsenonenone
sourceintegerfalsenonenone
radiusintegerfalsenonenone
latnumber(float)falsenonenone
lngnumber(float)falsenonenone
groupIdstringfalsenonenone
deviceIdstringtruenonenone
locationstringfalsenonenone
datastringfalsenonenone
__rawstringfalsenonenone

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

NameTypeRequiredRestrictionsDescription
items[DeviceGeoloc]falsenonenone

DeviceType

{
  "name": "string",
  "displayName": "string",
  "defaultConfiguration": "string",
  "battery": "string",
  "firmwareVersion": "string"
}

NameTypeRequiredRestrictionsDescription
namestringfalsenonenone
displayNamestringfalsenonenone
defaultConfigurationstringfalsenonenone
batterystringfalsenonenone
firmwareVersionstringfalsenonenone

DeviceTypeConnection

{
  "items": [
    {
      "name": "string",
      "displayName": "string",
      "defaultConfiguration": "string",
      "battery": "string",
      "firmwareVersion": "string"
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[DeviceType]falsenonenone

DeviceTelemetry

{
  "deviceId": "string",
  "timestamp": "2019-08-24",
  "deviceType": "string",
  "duplicates": [
    "string"
  ],
  "data": "string",
  "score": 0,
  "nbBS": 0,
  "rc": 0,
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
timestampstring(date)truenonenone
deviceTypestringfalsenonenone
duplicates[string]falsenonenone
datastringfalsenonenone
scoreintegerfalsenonenone
nbBSintegerfalsenonenone
rcintegerfalsenonenone
groupIdstringfalsenonenone

DeviceTelemetryConnection

{
  "items": [
    {
      "deviceId": "string",
      "timestamp": "2019-08-24",
      "deviceType": "string",
      "duplicates": [
        "string"
      ],
      "data": "string",
      "score": 0,
      "nbBS": 0,
      "rc": 0,
      "groupId": "string"
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[DeviceTelemetry]falsenonenone

TransferDeviceInput

{
  "deviceId": "string",
  "groupId": "string",
  "toGroupId": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
groupIdstringtruenonenone
toGroupIdstringtruenonenone

DeviceInput

{
  "groupId": "string",
  "name": "string",
  "type": "string",
  "originalId": "string",
  "network": "string",
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
namestringtruenonenone
typestringtruenonenone
originalIdstringtruenonenone
networkstringtruenonenone
tags[string]falsenonenone

CreateDeviceBatchInput

{
  "originalDevicesIds": [
    "string"
  ],
  "groupId": "string",
  "type": "string",
  "network": "string",
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
originalDevicesIds[string]truenonenone
groupIdstringtruenonenone
typestringtruenonenone
networkstringtruenonenone
tags[string]falsenonenone

UpdateDeviceBatchInput

{
  "devicesIds": [
    "string"
  ],
  "groupId": "string",
  "type": "string",
  "configuration": "string"
}

NameTypeRequiredRestrictionsDescription
devicesIds[string]falsenonenone
groupIdstringtruenonenone
typestringtruenonenone
configurationstringfalsenonenone

TransferDeviceBatchInput

{
  "deviceIds": [
    "string"
  ],
  "groupId": "string",
  "toGroupId": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIds[string]truenonenone
groupIdstringtruenonenone
toGroupIdstringtruenonenone

DeleteDeviceBatchInput

{
  "deviceIds": [
    "string"
  ],
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIds[string]truenonenone
groupIdstringtruenonenone

UpdateDeviceInput

{
  "deviceId": "string",
  "groupId": "string",
  "name": "string",
  "configuration": "string",
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
groupIdstringtruenonenone
namestringfalsenonenone
configurationstringfalsenonenone
tags[string]falsenonenone

ChangeDeviceTypeInput

{
  "deviceId": "string",
  "groupId": "string",
  "type": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
groupIdstringtruenonenone
typestringtruenonenone

DeviceTypeInput

{
  "displayName": "string",
  "name": "string",
  "defaultConfiguration": "string",
  "battery": "string",
  "firmwareVersion": "string"
}

NameTypeRequiredRestrictionsDescription
displayNamestringtruenonenone
namestringtruenonenone
defaultConfigurationstringtruenonenone
batterystringtruenonenone
firmwareVersionstringtruenonenone

UpdateDeviceTypeInput

{
  "displayName": "string",
  "name": "string",
  "defaultConfiguration": "string",
  "battery": "string",
  "firmwareVersion": "string"
}

NameTypeRequiredRestrictionsDescription
displayNamestringtruenonenone
namestringtruenonenone
defaultConfigurationstringfalsenonenone
batterystringfalsenonenone
firmwareVersionstringtruenonenone

DeleteDeviceInput

{
  "deviceId": "string",
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
groupIdstringtruenonenone

ResendDataInput

{
  "connectorId": "string",
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
connectorIdstringtruenonenone
groupIdstringtruenonenone

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
}

NameTypeRequiredRestrictionsDescription
deviceIdstringfalsenonenone
groupIdstringfalsenonenone
timestampstring(date)falsenonenone
totalDeviceDataintegerfalsenonenone
totalDeviceEventintegerfalsenonenone
totalDeviceGeolocintegerfalsenonenone
totalDeviceTelemetryintegerfalsenonenone
totalDeviceMessageintegerfalsenonenone
totalDeviceSigfoxDownlinkintegerfalsenonenone
totalDeviceSigfoxUplinkintegerfalsenonenone
totalSigfoxDataAdvancedMessageintegerfalsenonenone
totalSigfoxDataMessageintegerfalsenonenone

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

NameTypeRequiredRestrictionsDescription
typeanyfalsenonenone
groupIdstringfalsenonenone
beginDatestring(date)falsenonenone
endDatestring(date)falsenonenone
totalDeviceDataintegerfalsenonenone
totalDeviceEventintegerfalsenonenone
totalDeviceGeolocintegerfalsenonenone
totalDeviceTelemetryintegerfalsenonenone
totalDeviceMessageintegerfalsenonenone
totalDeviceSigfoxDownlinkintegerfalsenonenone
totalDeviceSigfoxUplinkintegerfalsenonenone
totalSigfoxDataAdvancedMessageintegerfalsenonenone
totalSigfoxDataMessageintegerfalsenonenone
items[DeviceMetric]falsenonenone